chore(release): v1.7.0

.github/workflows/docker-publish.yml

@@ -40,7 +40,7 @@ jobs:
       # https://github.com/docker/login-action
       - name: Log into registry ${{ env.REGISTRY }}
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@a9794064588be971151ec5e7144cb535bcb56e36
+        uses: docker/login-action@553b6f090f15b58451081ce157ff1929a266131d
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -50,14 +50,14 @@ jobs:
       # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@35e9aff4f5d665b5aa8a8f2adffaf8a1b5f49cc0
+        uses: docker/metadata-action@0f8c876bafbf5dbce05c36682ec68e9a0274a48a
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
       # Build and push Docker image with Buildx (don't push on PR)
       # https://github.com/docker/build-push-action
       - name: Build and push Docker image
-        uses: docker/build-push-action@4fad532b9fdbfb80f436784834374a1c11834153
+        uses: docker/build-push-action@9311bf5263ae5b36f3ec67aff768790c6e2344ad
         with:
           context: .
           push: ${{ github.event_name != 'pull_request' }}

.github/workflows/jest-coverage.yml

@@ -17,7 +17,7 @@ jobs:
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
       - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2.2.4
+      - uses: pnpm/action-setup@v2.4.0
         with:
           version: latest
       - uses: ArtiomTr/jest-coverage-report-action@v2

.github/workflows/node.js.yml

@@ -22,7 +22,7 @@ jobs:
     name: Node ${{ matrix.node }} sample
     steps:
       - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2.2.4
+      - uses: pnpm/action-setup@v2.4.0
         with:
           version: latest
       - name: Use Node.js ${{ matrix.node-version }}

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.7.0](https://github.com/djdembeck/audnexus/compare/v1.6.0...v1.7.0) (2023-08-19)
+
+
+### Features
+
+* **helper:** :sparkles: remove links, emails, and handles from descriptions ([e80819d](https://github.com/djdembeck/audnexus/commit/e80819dbfd069c5ac6581d669a1979a4b3695935))
+* **schema:** :sparkles: add `copyright` and `isbn` fields ([d9bf840](https://github.com/djdembeck/audnexus/commit/d9bf840ffe58a89ce2e931234f2c88bdd885600e))
+* **schema:** :sparkles: use `adult` data from audible in form of `isAdult` ([feec8d8](https://github.com/djdembeck/audnexus/commit/feec8d80916eeee48cf65598f8d3838ed7d6f414))
+
 ## [1.6.0](https://github.com/djdembeck/audnexus/compare/v1.5.0...v1.6.0) (2023-07-30)
 
 

README.md

@@ -86,7 +86,7 @@ Pre-rendered HTML documentation is also included in docs/index.html.
 HTML can be re-generated from the spec, using:
 
 ```
-redoc-cli build docs/spec/audnexus.yaml -o docs/index.html
+pnpm run build-docs
 ```
 
 ## 🚀 Deployment <a name = "deployment"></a>

docker-compose.yml

@@ -1,19 +1,19 @@
-version: '3.7'
+version: "3.7"
 
 services:
   node-server:
     image: ghcr.io/laxamentumtech/audnexus:develop
     restart: always
     environment:
-      - ADP_TOKEN=${NODE_ADP_TOKEN}
-      - MAX_REQUESTS=${NODE_MAX_REQUESTS}
-      - MONGODB_URI=${NODE_MONGODB_URI}
-      - PRIVATE_KEY=${NODE_PRIVATE_KEY}
-      - REDIS_URL=${NODE_REDIS_URL}
-      - UPDATE_INTERVAL=${NODE_UPDATE_INTERVAL}
-      - UPDATE_THRESHOLD=${NODE_UPDATE_THRESHOLD}
+      ADP_TOKEN: ${NODE_ADP_TOKEN}
+      MAX_REQUESTS: ${NODE_MAX_REQUESTS:-300}
+      MONGODB_URI: ${NODE_MONGODB_URI:-mongodb://mongo:27017/audnexus}
+      PRIVATE_KEY: ${NODE_PRIVATE_KEY}
+      REDIS_URL: ${NODE_REDIS_URL:-redis://redis:6379}
+      UPDATE_INTERVAL: ${NODE_UPDATE_INTERVAL:-30}
+      UPDATE_THRESHOLD: ${NODE_UPDATE_THRESHOLD:-7}
     ports:
-      - '3000:3000'
+      - "3000:3000"
     depends_on:
       - mongo
       - redis
@@ -22,12 +22,12 @@ services:
       - internal
     deploy:
       labels:
-        - 'traefik.enable=true'
-        - 'traefik.docker.network=traefik-overlay'
-        - 'traefik.http.routers.node-server.rule=Host(`${TRAEFIK_DOMAIN}`)'
-        - 'traefik.http.routers.node-server.entrypoints=websecure'
-        - 'traefik.http.routers.redirs.entrypoints=websecure'
-        - 'traefik.http.services.node-server.loadbalancer.server.port=3000'
+        - "traefik.enable=true"
+        - "traefik.docker.network=traefik-overlay"
+        - "traefik.http.routers.node-server.rule=Host(`${TRAEFIK_DOMAIN}`)"
+        - "traefik.http.routers.node-server.entrypoints=websecure"
+        - "traefik.http.routers.redirs.entrypoints=websecure"
+        - "traefik.http.services.node-server.loadbalancer.server.port=3000"
       replicas: 15
 
   mongo:
@@ -48,15 +48,15 @@ services:
     image: traefik:v3.0
     restart: always
     command:
-      - '--providers.docker=true'
-      - '--entryPoints.websecure.address=:443'
-      - '--providers.docker.exposedbydefault=false'
-      - '--entrypoints.websecure.http.tls=true'
-      - '--certificatesresolvers.myresolver.acme.tlschallenge=true'
-      - '--certificatesresolvers.myresolver.acme.email=${TRAEFIK_EMAIL}'
-      - '--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json'
+      - "--providers.docker=true"
+      - "--entryPoints.websecure.address=:443"
+      - "--providers.docker.exposedbydefault=false"
+      - "--entrypoints.websecure.http.tls=true"
+      - "--certificatesresolvers.myresolver.acme.tlschallenge=true"
+      - "--certificatesresolvers.myresolver.acme.email=${TRAEFIK_EMAIL}"
+      - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
     ports:
-      - '443:443'
+      - "443:443"
     volumes:
       - /mnt/docker/letsencrypt:/letsencrypt
       - /var/run/docker.sock:/var/run/docker.sock:ro

docs/spec/audnexus.yaml

@@ -7,7 +7,7 @@ info:
   license:
     name: GPL v3
     url: "https://www.gnu.org/licenses/gpl-3.0.en.html"
-  version: 1.4.0
+  version: 1.7.0
 externalDocs:
   description: Find out more about Audnexus
   url: "https://github.com/djdembeck/audnexus"
@@ -87,8 +87,9 @@ paths:
                   value:
                     asin: B08G9PRS1K
                     authors:
-                      - name: Andy Weir
-                        asin: B00G0WYW92
+                      - asin: B00G0WYW92
+                        name: Andy Weir
+                    copyright: 2021
                     description: "Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish. Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it...."
                     formatType: unabridged
                     genres:
@@ -108,6 +109,8 @@ paths:
                         name: Space Opera
                         type: tag
                     image: "https://m.media-amazon.com/images/I/91vS2L5YfEL.jpg"
+                    isAdult: false
+                    isbn: "9781603935470"
                     language: english
                     narrators:
                       - name: Ray Porter
@@ -116,7 +119,7 @@ paths:
                     region: us
                     releaseDate: "2021-05-04T00:00:00.000Z"
                     runtimeLengthMin: 970
-                    summary: "<p><b>Winner of the 2022 Audie Awards Audiobook of the Year.</b></p> <p><b>Number-One Audible and</b><b><i> New York Times</i></b><b> Audio Best Seller</b></p> <p><b>A lone astronaut must save the earth from disaster in this incredible new science-based thriller from the number-one </b><b><i>New York Times</i></b><b> best-selling author of </b><b><i>The Martian</i></b><b>.</b></p> <p>Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish.</p> <p>Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it.</p> <p>All he knows is that he's been asleep for a very, very long time. And he's just been awakened to find himself millions of miles from home, with nothing but two corpses for company.</p> <p>His crewmates dead, his memories fuzzily returning, he realizes that an impossible task now confronts him. Alone on this tiny ship that's been cobbled together by every government and space agency on the planet and hurled into the depths of space, it's up to him to conquer an extinction-level threat to our species.</p> <p>And thanks to an unexpected ally, he just might have a chance.</p> <p>Part scientific mystery, part dazzling interstellar journey, <i>Project Hail Mary</i> is a tale of discovery, speculation, and survival to rival <i>The Martian</i> - while taking us to places it never dreamed of going.</p> <p>PLEASE NOTE: To accommodate this audio edition, some changes to the original text have been made with the approval of author Andy Weir.</p>"
+                    summary: "<p><b><i>Winner of the 2022 Audie Awards' Audiobook of the Year</i></b></p> <p><b><i>Number-One Audible and </i></b><b>New York Times</b><b><i> Audio Best Seller</i></b></p> <p><b><i>More than one million audiobooks sold</i></b></p> <p><b>A lone astronaut must save the earth from disaster in this incredible new science-based thriller from the number-one </b><b><i>New York Times</i></b><b> best-selling author of </b><b><i>The Martian</i></b><b>.</b></p> <p>Ryland Grace is the sole survivor on a desperate, last-chance mission - and if he fails, humanity and the Earth itself will perish.</p> <p>Except that right now, he doesn't know that. He can't even remember his own name, let alone the nature of his assignment or how to complete it.</p> <p>All he knows is that he's been asleep for a very, very long time. And he's just been awakened to find himself millions of miles from home, with nothing but two corpses for company.</p> <p>His crewmates dead, his memories fuzzily returning, he realizes that an impossible task now confronts him. Alone on this tiny ship that's been cobbled together by every government and space agency on the planet and hurled into the depths of space, it's up to him to conquer an extinction-level threat to our species.</p> <p>And thanks to an unexpected ally, he just might have a chance.</p> <p>Part scientific mystery, part dazzling interstellar journey, <i>Project Hail Mary</i> is a tale of discovery, speculation, and survival to rival <i>The Martian</i> - while taking us to places it never dreamed of going.</p> <p>PLEASE NOTE: To accommodate this audio edition, some changes to the original text have been made with the approval of author Andy Weir.</p>"
                     title: Project Hail Mary
             application/xml:
               schema:
@@ -892,6 +895,10 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/Person"
+        copyright:
+          type: integer
+          minimum: 4
+          maximum: 4
         description:
           type: string
         formatType:
@@ -903,6 +910,10 @@ components:
         image:
           type: string
           format: uri
+        isAdult:
+          type: boolean
+        isbn:
+          type: string
         language:
           type: string
         narrators:

package.json

@@ -1,17 +1,18 @@
 {
 	"name": "audnexus",
-	"version": "1.6.0",
+	"version": "1.7.0",
 	"description": "An API for aggregating audiobook data",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/djdembeck/audnexus"
 	},
 	"scripts": {
+		"build-docs": "redocly build-docs docs/spec/audnexus.yaml -o docs/index.html",
 		"build-ts": "tsc",
 		"build": "pnpm run build-ts",
 		"debug": "pnpm run build && pnpm run watch-debug",
-		"format": "prettier --config .prettierrc --ignore-path .gitignore --write --plugin-search-dir=. 'src/**/*.ts'",
-		"lint": "prettier --config .prettierrc --ignore-path .gitignore --check --plugin-search-dir=. 'src/**/*.ts' && tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix",
+		"format": "prettier --config .prettierrc --ignore-path .gitignore --write 'src/**/*.ts'",
+		"lint": "prettier --config .prettierrc --ignore-path .gitignore --check 'src/**/*.ts' && tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix --ignore-path .gitignore",
 		"preinstall": "npx only-allow pnpm",
 		"release": "standard-version",
 		"serve-debug": "nodemon --inspect dist/server.js",
@@ -35,37 +36,37 @@
 		"axios": "^1.2.4",
 		"cheerio": "1.0.0-rc.12",
 		"domhandler": "5.0.3",
-		"fastify": "4.20.0",
+		"fastify": "4.21.0",
 		"html-to-text": "9.0.5",
-		"jest-mock-extended": "3.0.4",
+		"jest-mock-extended": "3.0.5",
 		"jsrsasign": "^10.8.6",
 		"lodash": "4.17.21",
 		"module-alias": "2.2.3",
 		"moment": "^2.29.4",
 		"mongodb": "5.7.0",
-		"papr": "13.1.0",
+		"papr": "14.0.0",
 		"toad-scheduler": "^3.0.0",
 		"typescript": "5.1.6",
 		"zod": "^3.20.6"
 	},
 	"devDependencies": {
 		"@jest/types": "29.6.1",
+		"@redocly/cli": "^1.0.2",
 		"@types/html-to-text": "9.0.1",
 		"@types/jest": "29.5.3",
 		"@types/jsrsasign": "10.5.8",
-		"@types/lodash": "4.14.195",
-		"@types/node": "18.16.19",
-		"@typescript-eslint/eslint-plugin": "5.38.1",
-		"@typescript-eslint/parser": "5.38.1",
+		"@types/lodash": "4.14.197",
+		"@types/node": "18.17.5",
+		"@typescript-eslint/eslint-plugin": "6.3.0",
+		"@typescript-eslint/parser": "6.3.0",
 		"concurrently": "8.2.0",
-		"eslint": "8.24.0",
-		"eslint-config-prettier": "8.5.0",
-		"eslint-plugin-jest": "27.0.4",
+		"eslint": "8.46.0",
+		"eslint-config-prettier": "9.0.0",
+		"eslint-plugin-jest": "27.2.3",
 		"eslint-plugin-simple-import-sort": "10.0.0",
-		"jest": "29.6.1",
-		"nodemon": "2.0.22",
-		"prettier": "2.8.8",
-		"redoc-cli": "^0.13.21",
+		"jest": "29.6.2",
+		"nodemon": "3.0.1",
+		"prettier": "3.0.1",
 		"standard-version": "9.5.0",
 		"ts-jest": "29.1.1",
 		"ts-node": "10.9.1"