openapi-jsonrpc-jsdoc 1.3.1 → 1.4.0

package/index.mjs

@@ -1,19 +1,17 @@
-import jsdocx from 'jsdoc-x';
+import jsdoc from 'jsdoc-api';
 
 export default async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, servers, api = '/' }) {
-  const [package_, ...documents] = await jsdocx.parse({
-    files,
+  const allData = await jsdoc.explain({
+    files: Array.isArray(files) ? files : [files],
     package: packageUrl,
     access: 'public',
     encoding: 'utf8',
-    module: true,
     undocumented: false,
-    sort: 'scope',
     allowUnknownTags: true,
     dictionaries: ['jsdoc'],
-    hierarchy: true,
   });
-  const tags = new Set();
+  const package_ = allData.find(item => item.kind === 'package');
+  const documents = allData.filter(item => item.kind !== 'package');
   const temporaryDocument = {
     'x-send-defaults': true,
     'openapi': '3.0.0',
@@ -35,22 +33,22 @@ export default async function openapiJsonrpcJsdoc({ files, securitySchemes = {},
       schemas: {
         Error: {
           required: [
-            "error",
-            "id",
-            "jsonrpc"
+            'error',
+            'id',
+            'jsonrpc',
           ],
           properties: {
-            "id": {
-              "type": "integer",
-              "format": "int32"
+            id: {
+              type: 'integer',
+              format: 'int32',
             },
-            "error": {
-              "type": "object"
+            error: {
+              type: 'object',
             },
-            "jsonrpc": {
-              "type": "string"
-            }
-          }
+            jsonrpc: {
+              type: 'string',
+            },
+          },
         },
       }
     },
@@ -64,12 +62,13 @@ export default async function openapiJsonrpcJsdoc({ files, securitySchemes = {},
   const requiredSchema = ['method', 'jsonrpc'];
   prepare: for (const module of documents) {
     let isJsonRpc = false;
+    const tags = new Set();
 
     if (module.tags && Array.isArray(module.tags)) {
       for (const {title, value} of module.tags) {
         if (title === 'json-rpc') {
           isJsonRpc = true;
-        } else if (title === 'tags' && value) {
+        } else if (value && ['tags', 'tag'].includes(title)) {
           value.split(',').map(t => t.trim()).forEach(t => tags.add(t));
         }
       }
@@ -77,11 +76,12 @@ export default async function openapiJsonrpcJsdoc({ files, securitySchemes = {},
     if (!isJsonRpc) {
       continue prepare;
     }
-    const apiName = module.meta.filename.replace(/\.js$/, '');
+    const {filename} = module.meta;
+    const apiName = filename.replace(/\.js$/, '');
 
     const schema = {
       post: {
-        operationId: `${module.meta.filename}`,
+        operationId: filename,
         deprecated: module.deprecated || false,
         summary: `/${apiName}`,
         description: module.description,
@@ -90,13 +90,13 @@ export default async function openapiJsonrpcJsdoc({ files, securitySchemes = {},
         responses: {
           '200': {
             description: 'OK',
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object"
-                }
-              }
-            }
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'object',
+                },
+              },
+            },
           },
           default: {
             description: 'unexpected error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-jsonrpc-jsdoc",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Transform JSDoc-annotated JSON-RPC 2.0 methods into OpenAPI specifications.",
   "main": "index.mjs",
   "type": "module",
@@ -29,12 +29,12 @@
   },
   "homepage": "https://github.com/qertis/openapi-jsonrpc-jsdoc#readme",
   "dependencies": {
-    "jsdoc-x": "~4.1.0"
+    "jsdoc-api": "~9.3.5"
   },
   "devDependencies": {
     "ava": "~6.4.1",
     "express": "~5.2.1",
-    "express-openapi-validator": "~5.6.1"
+    "express-openapi-validator": "~5.6.2"
   },
   "engines": {
     "node": ">= 22"