chore: Upgrade jsdoc-api to v9 (#911)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Valentin Agachi <[email protected]>

.github/workflows/ci.yaml

@@ -35,6 +35,20 @@ jobs:
         env:
           MONGOMS_VERSION: ${{ matrix.mongodb }}
 
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          filter: tree:0
+      - uses: pnpm/[email protected]
+      - uses: actions/[email protected]
+        with:
+          node-version-file: 'package.json'
+          cache: 'pnpm'
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build:docs && git diff
+
   lint:
     runs-on: ubuntu-latest
     steps:

docs/build.js

@@ -99,7 +99,7 @@ for (const doc of DOCS) {
 
   const sourceTranspiled = transpileTS(source);
 
-  const jsdoc = jsdocApi.explainSync({ source: sourceTranspiled });
+  const jsdoc = await jsdocApi.explain({ source: sourceTranspiled });
   const parsed = jsdocParse(jsdoc);
 
   const intro = parsed.find((item) => item.kind === 'module' && item.name === 'intro');

package.json

@@ -39,7 +39,8 @@
   },
   "scripts": {
     "build": "./build.sh",
-    "docs": "node docs/build.js && docsify serve ./docs",
+    "build:docs": "node docs/build.js",
+    "docs": "pnpm build:docs && docsify serve ./docs",
     "benchmark": "pnpm build && node --experimental-specifier-resolution=node ./benchmark/run.js",
     "lint:ci": "./tests/build.sh && eslint .",
     "lint": "eslint .",
@@ -75,7 +76,7 @@
     "globals": "15.9.0",
     "husky": "9.1.4",
     "jest": "29.7.0",
-    "jsdoc-api": "8.1.1",
+    "jsdoc-api": "9.3.1",
     "jsdoc-parse": "6.2.1",
     "lint-staged": "15.2.9",
     "mongodb": "6.9.0",