openapi-jsonrpc-jsdoc 1.2.5 → 1.3.0

package/README.md

@@ -2,8 +2,8 @@
 
 ## Install
 
-```fish
-npm i openapi-jsonrpc-jsdoc --save-dev
+```bash
+npm i openapi-jsonrpc-jsdoc
 ```
 
 ## Examples

package/{index.js → index.mjs}

@@ -1,6 +1,6 @@
-const jsdocx = require('jsdoc-x');
+import jsdocx from 'jsdoc-x';
 
-async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, servers, api = '/' }) {
+export default async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, servers, api = '/' }) {
   const [package_, ...documents] = await jsdocx.parse({
     files,
     package: packageUrl,
@@ -77,7 +77,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
     if (!isJsonRpc) {
       continue prepare;
     }
-    const apiName = module.meta.filename.replace(/.js$/, '');
+    const apiName = module.meta.filename.replace(/\.js$/, '');
 
     const schema = {
       post: {
@@ -103,7 +103,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
             content: {
               'application/json': {
                 schema: {
-                  $ref: '#/components/schemas/Error'
+                  $ref: '#/components/schemas/Error',
                 }
               }
             }
@@ -167,21 +167,30 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
           }
           let items;
           let enumData;
+          let oneOf;
 
           switch (type) {
             case 'Array.<string>': {
               type = 'array';
-              items = { type: 'number' };
+              items = { type: 'string' };
               break;
             }
             case 'Array.<number>': {
               type = 'array';
-              items = { type: 'string' };
+              items = { type: 'number' };
               break;
             }
             case 'enum': {
               enumData = parameter.type.names;
-              if (parameter.type.names.every(n => !Number.isNaN(Number(n)))) {
+              oneOf = parameter.type.names.map((n) => {
+                if (!Number.isNaN(Number(n))) {
+                  return Number(n);
+                }
+                return n;
+              });
+              if (parameter.type.names.every(n => Number.isInteger(Number(n)))) {
+                type = 'integer';
+              } else if (parameter.type.names.every(n => !Number.isNaN(Number(n)))) {
                 type = 'number';
               } else {
                 type = 'string';
@@ -215,6 +224,9 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
           if (enumData) {
             accumulator.properties[name].enum = enumData;
           }
+          if (oneOf) {
+            accumulator.properties[name].oneOf = oneOf;
+          }
 
           return accumulator;
         },
@@ -233,5 +245,3 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
   }
   return temporaryDocument;
 }
-
-module.exports = openapiJsonrpcJsdoc;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "openapi-jsonrpc-jsdoc",
-  "version": "1.2.5",
-  "description": "Transform JSDoc-annotated JSON-RPC 2.0 methods into OpenAPI 3.0 specifications. Auto-generates REST API documentation with complete schemas, parameters, and endpoint definitions.",
+  "version": "1.3.0",
+  "description": "Transform JSDoc-annotated JSON-RPC 2.0 methods into OpenAPI specifications.",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "test": "NODE_NO_WARNINGS=1 ava test/*.test.js"
   },
@@ -14,8 +15,8 @@
     "openapi jsdoc",
     "open api js doc",
     "postman jsdoc",
-    "swagger jsondoc",
-    "openapi jsondoc",
+    "swagger jsdoc",
+    "openapi jsdoc",
     "json-rpc openapi",
     "json-rpc swagger",
     "jsonrpc openapi",
@@ -31,11 +32,11 @@
     "jsdoc-x": "~4.1.0"
   },
   "devDependencies": {
-    "ava": "~3.15.0",
-    "express": "~5.1.0",
-    "express-openapi-validator": "~5.6.0"
+    "ava": "~6.4.1",
+    "express": "~5.2.1",
+    "express-openapi-validator": "~5.6.1"
   },
   "engines": {
-    "node": ">= 18"
+    "node": ">= 22"
   }
 }