@visulima/jsdoc-open-api 3.0.0-alpha.7 → 3.0.0-alpha.8

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## @visulima/jsdoc-open-api [3.0.0-alpha.8](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.7...@visulima/jsdoc-open-api@3.0.0-alpha.8) (2026-04-21)
+
+### Bug Fixes
+
+* **api:** resolve eslint and type-safety issues across api packages ([3601491](https://github.com/visulima/visulima/commit/3601491261de56b5cfad87c97daafd458e4ee3b6))
+* **jsdoc-open-api:** drop redundant String() conversion in init-command ([1b2384e](https://github.com/visulima/visulima/commit/1b2384e917687beaf464e18e24595c7d4214c94e))
+* **jsdoc-open-api:** relax type overrides for parser code, preserve JSON roundtrip for undefined stripping ([be896e2](https://github.com/visulima/visulima/commit/be896e2e724396bcb74fbbd3161d29213a9984d6))
+
+### Miscellaneous Chores
+
+* bump engines.node to ^22.14.0 || >=24.10.0 ([c3d0931](https://github.com/visulima/visulima/commit/c3d0931d1504e4f21ebf50ea680cfa7ce4ba15ce))
+* fixed jsr.json ([5d85e51](https://github.com/visulima/visulima/commit/5d85e5179de38e284ec433b14d77c71a1619c8d6))
+* **jsdoc-open-api:** apply formatter updates ([57231bd](https://github.com/visulima/visulima/commit/57231bd235fa16768802306aa6e906a4558c579c))
+* **jsdoc-open-api:** apply pending lint and source updates ([0669fd3](https://github.com/visulima/visulima/commit/0669fd3d46ad0787ef6709cc8cad67b7ff7495f7))
+* **jsdoc-open-api:** enforce curly braces and apply lint fixes ([606641f](https://github.com/visulima/visulima/commit/606641f7a29eaa5707ae27c57ed02a91adf950b5))
+
+
+### Dependencies
+
+* **@visulima/fs:** upgraded to 5.0.0-alpha.9
+
 ## @visulima/jsdoc-open-api [3.0.0-alpha.7](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.6...@visulima/jsdoc-open-api@3.0.0-alpha.7) (2026-04-08)
 
 ### Miscellaneous Chores

package/dist/cli/commander/index.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 
-const generateCommand = require('../../packem_shared/generateCommand-CmyavGTZ.cjs');
+const generateCommand = require('../../packem_shared/generateCommand-RY4QFtm7.cjs');
 const initCommand = require('../../packem_shared/initCommand-D3yVEMwO.cjs');
 
 

package/dist/cli/commander/index.mjs

@@ -1,2 +1,2 @@
-export { default as generateCommand } from '../../packem_shared/generateCommand-B1t3VSDX.mjs';
+export { default as generateCommand } from '../../packem_shared/generateCommand-DRMkfIle.mjs';
 export { default as initCommand } from '../../packem_shared/initCommand-B6Z9EXHP.mjs';

package/dist/cli/index.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 
-const generateCommand = require('../packem_shared/generateCommand-Cu0UQUh8.cjs');
+const generateCommand = require('../packem_shared/generateCommand-MwnCNgEE.cjs');
 const initCommand = require('../packem_shared/initCommand-Ch-72dKZ.cjs');
 
 

package/dist/cli/index.mjs

@@ -1,2 +1,2 @@
-export { default as generateCommand } from '../packem_shared/generateCommand-CZEFuXr9.mjs';
+export { default as generateCommand } from '../packem_shared/generateCommand-a9_RAbug.mjs';
 export { default as initCommand } from '../packem_shared/initCommand-zE4VRDGW.mjs';

package/dist/index.cjs

@@ -2,12 +2,12 @@
 
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 
-const jsDocumentCommentsToOpenApi = require('./packem_shared/jsDocumentCommentsToOpenApi-C8kxIQH2.cjs');
-const parseFile = require('./packem_shared/parseFile-BJwu_na4.cjs');
+const jsDocumentCommentsToOpenApi = require('./packem_shared/jsDocumentCommentsToOpenApi-C7yMeXJ5.cjs');
+const parseFile = require('./packem_shared/parseFile-Dk7Bw7lt.cjs');
 const SpecBuilder = require('./packem_shared/SpecBuilder-CCESkmm5.cjs');
-const swaggerJsDocumentCommentsToOpenApi = require('./packem_shared/swaggerJsDocumentCommentsToOpenApi-JFymRz50.cjs');
-const yamlLoc = require('./packem_shared/yamlLoc-BLoIYoXs.cjs');
-const SwaggerCompilerPlugin = require('./packem_shared/SwaggerCompilerPlugin-BHbHAPK-.cjs');
+const swaggerJsDocumentCommentsToOpenApi = require('./packem_shared/swaggerJsDocumentCommentsToOpenApi-BuB7eE94.cjs');
+const yamlLoc = require('./packem_shared/yamlLoc-CEvBiR4K.cjs');
+const SwaggerCompilerPlugin = require('./packem_shared/SwaggerCompilerPlugin-BkYJzU4f.cjs');
 
 
 

package/dist/index.mjs

@@ -1,6 +1,6 @@
-export { default as jsDocumentCommentsToOpenApi } from './packem_shared/jsDocumentCommentsToOpenApi-eOlxMuMO.mjs';
-export { default as parseFile } from './packem_shared/parseFile-Bxis7tbW.mjs';
+export { default as jsDocumentCommentsToOpenApi } from './packem_shared/jsDocumentCommentsToOpenApi-DtrIZ2lK.mjs';
+export { default as parseFile } from './packem_shared/parseFile-BE-sKiRK.mjs';
 export { default as SpecBuilder } from './packem_shared/SpecBuilder-B7YiF7zR.mjs';
-export { default as swaggerJsDocumentCommentsToOpenApi } from './packem_shared/swaggerJsDocumentCommentsToOpenApi-Cb5s1J29.mjs';
-export { default as yamlLoc } from './packem_shared/yamlLoc-Cmx4vbRt.mjs';
-export { default as SwaggerCompilerPlugin } from './packem_shared/SwaggerCompilerPlugin-BEbFO9Dt.mjs';
+export { default as swaggerJsDocumentCommentsToOpenApi } from './packem_shared/swaggerJsDocumentCommentsToOpenApi-B7g9rVr5.mjs';
+export { default as yamlLoc } from './packem_shared/yamlLoc-C7iHWvdq.mjs';
+export { default as SwaggerCompilerPlugin } from './packem_shared/SwaggerCompilerPlugin-DZ7tIJ8x.mjs';

package/dist/packem_shared/{SwaggerCompilerPlugin-BHbHAPK-.cjs → SwaggerCompilerPlugin-BkYJzU4f.cjs}

@@ -5,10 +5,10 @@ const path = require('node:path');
 const node_process = require('node:process');
 const fs = require('@visulima/fs');
 const validate = require('./validate-FKieC3ln.cjs');
-const jsDocumentCommentsToOpenApi = require('./jsDocumentCommentsToOpenApi-C8kxIQH2.cjs');
-const parseFile = require('./parseFile-BJwu_na4.cjs');
+const jsDocumentCommentsToOpenApi = require('./jsDocumentCommentsToOpenApi-C7yMeXJ5.cjs');
+const parseFile = require('./parseFile-Dk7Bw7lt.cjs');
 const SpecBuilder = require('./SpecBuilder-CCESkmm5.cjs');
-const swaggerJsDocumentCommentsToOpenApi = require('./swaggerJsDocumentCommentsToOpenApi-JFymRz50.cjs');
+const swaggerJsDocumentCommentsToOpenApi = require('./swaggerJsDocumentCommentsToOpenApi-BuB7eE94.cjs');
 
 const errorHandler = (error) => {
   if (error) {
@@ -34,7 +34,7 @@ class SwaggerCompilerPlugin {
     compiler.hooks.make.tapAsync("SwaggerCompilerPlugin", async (_, callback) => {
       console.log("Build paused, switching to swagger build");
       const spec = new SpecBuilder(this.swaggerDefinition);
-      for await (const dir of this.sources) {
+      for (const dir of this.sources) {
         const files = await fs.collect(dir, {
           extensions: [".js", ".cjs", ".mjs", ".ts", ".tsx", ".jsx", ".yaml", ".yml"],
           includeDirs: false,
@@ -62,9 +62,9 @@ class SwaggerCompilerPlugin {
       try {
         if (this.verbose) {
           console.log("Validating swagger spec");
-          console.log(JSON.stringify(spec, null, 2));
+          console.log(JSON.stringify(spec, void 0, 2));
         }
-        await validate.validate(JSON.parse(JSON.stringify(spec)));
+        await validate.validate(structuredClone(spec));
       } catch (error) {
         console.error(error.toJSON());
         node_process.exit(1);
@@ -74,7 +74,7 @@ class SwaggerCompilerPlugin {
         if (error) {
           errorHandler(error);
         }
-        node_fs.writeFile(assetsPath, JSON.stringify(spec, null, 2), errorHandler);
+        node_fs.writeFile(assetsPath, JSON.stringify(spec, void 0, 2), errorHandler);
       });
       if (this.verbose) {
         console.log(`Written swagger spec to "${this.assetsPath}" file`);

package/dist/packem_shared/{SwaggerCompilerPlugin-BEbFO9Dt.mjs → SwaggerCompilerPlugin-DZ7tIJ8x.mjs}

@@ -3,10 +3,10 @@ import { dirname } from 'node:path';
 import { exit } from 'node:process';
 import { collect } from '@visulima/fs';
 import { v as validate, D as DEFAULT_EXCLUDE } from './validate-DZHaKH07.mjs';
-import commentsToOpenApi from './jsDocumentCommentsToOpenApi-eOlxMuMO.mjs';
-import parseFile from './parseFile-Bxis7tbW.mjs';
+import commentsToOpenApi from './jsDocumentCommentsToOpenApi-DtrIZ2lK.mjs';
+import parseFile from './parseFile-BE-sKiRK.mjs';
 import SpecBuilder from './SpecBuilder-B7YiF7zR.mjs';
-import commentsToOpenApi$1 from './swaggerJsDocumentCommentsToOpenApi-Cb5s1J29.mjs';
+import commentsToOpenApi$1 from './swaggerJsDocumentCommentsToOpenApi-B7g9rVr5.mjs';
 
 const errorHandler = (error) => {
   if (error) {
@@ -32,7 +32,7 @@ class SwaggerCompilerPlugin {
     compiler.hooks.make.tapAsync("SwaggerCompilerPlugin", async (_, callback) => {
       console.log("Build paused, switching to swagger build");
       const spec = new SpecBuilder(this.swaggerDefinition);
-      for await (const dir of this.sources) {
+      for (const dir of this.sources) {
         const files = await collect(dir, {
           extensions: [".js", ".cjs", ".mjs", ".ts", ".tsx", ".jsx", ".yaml", ".yml"],
           includeDirs: false,
@@ -60,9 +60,9 @@ class SwaggerCompilerPlugin {
       try {
         if (this.verbose) {
           console.log("Validating swagger spec");
-          console.log(JSON.stringify(spec, null, 2));
+          console.log(JSON.stringify(spec, void 0, 2));
         }
-        await validate(JSON.parse(JSON.stringify(spec)));
+        await validate(structuredClone(spec));
       } catch (error) {
         console.error(error.toJSON());
         exit(1);
@@ -72,7 +72,7 @@ class SwaggerCompilerPlugin {
         if (error) {
           errorHandler(error);
         }
-        writeFile(assetsPath, JSON.stringify(spec, null, 2), errorHandler);
+        writeFile(assetsPath, JSON.stringify(spec, void 0, 2), errorHandler);
       });
       if (this.verbose) {
         console.log(`Written swagger spec to "${this.assetsPath}" file`);

package/dist/packem_shared/{generateCommand-B1t3VSDX.mjs → generateCommand-DRMkfIle.mjs}

@@ -1,5 +1,5 @@
 import { exit } from 'node:process';
-import generateCommand$1 from './generateCommand-CZEFuXr9.mjs';
+import generateCommand$1 from './generateCommand-a9_RAbug.mjs';
 
 const generateCommand = (program, commandName = "generate", configName = ".openapirc.js") => {
   program.command(commandName).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]", "Paths to files or directories to parse").option("-c, --config [.openapirc.js]", "@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]", "Output swagger specification.").option("-v, --verbose", "Verbose output.").option("-d, --very-verbose", "Very verbose output.").action(async (paths, options) => {

package/dist/packem_shared/{generateCommand-Cu0UQUh8.cjs → generateCommand-MwnCNgEE.cjs}

@@ -6,16 +6,13 @@ const node_url = require('node:url');
 const fs = require('@visulima/fs');
 const cliProgress = require('cli-progress');
 const validate = require('./validate-FKieC3ln.cjs');
-const jsDocumentCommentsToOpenApi = require('./jsDocumentCommentsToOpenApi-C8kxIQH2.cjs');
-const parseFile = require('./parseFile-BJwu_na4.cjs');
+const jsDocumentCommentsToOpenApi = require('./jsDocumentCommentsToOpenApi-C7yMeXJ5.cjs');
+const parseFile = require('./parseFile-Dk7Bw7lt.cjs');
 const SpecBuilder = require('./SpecBuilder-CCESkmm5.cjs');
-const swaggerJsDocumentCommentsToOpenApi = require('./swaggerJsDocumentCommentsToOpenApi-JFymRz50.cjs');
+const swaggerJsDocumentCommentsToOpenApi = require('./swaggerJsDocumentCommentsToOpenApi-BuB7eE94.cjs');
 
 const generateCommand = async (configName, paths, options) => {
-  let openapiConfig = {
-    exclude: [],
-    swaggerDefinition: {}
-  };
+  let openapiConfig;
   try {
     let config = await import(node_url.pathToFileURL(path.normalize(options.config ?? configName)).href);
     if (config?.default) {
@@ -36,7 +33,7 @@ const generateCommand = async (configName, paths, options) => {
   );
   const spec = new SpecBuilder(openapiConfig.swaggerDefinition);
   const skip = /* @__PURE__ */ new Set([...validate.DEFAULT_EXCLUDE, ...openapiConfig.exclude]);
-  for await (const dir of paths) {
+  for (const dir of paths) {
     (await promises.lstat(dir)).isDirectory();
     const realDirectory = await promises.realpath(dir);
     const files = await fs.collect(realDirectory, {
@@ -68,16 +65,16 @@ Found ${String(files.length)} files in ${realDirectory}`);
     console.log("Validating swagger spec");
   }
   if (options.veryVerbose) {
-    console.log(JSON.stringify(spec, null, 2));
+    console.log(JSON.stringify(spec, void 0, 2));
   }
-  await validate.validate(JSON.parse(JSON.stringify(spec)));
+  await validate.validate(structuredClone(spec));
   const output = options.output ?? "swagger.json";
   multibar.stop();
   if (options.verbose) {
     console.log(`Written swagger spec to "${output}" file`);
   }
   await promises.mkdir(path.dirname(output), { recursive: true });
-  await promises.writeFile(output, JSON.stringify(spec, null, 2));
+  await promises.writeFile(output, JSON.stringify(spec, void 0, 2));
   console.log(`
 Swagger specification is ready, check the "${output}" file.`);
 };

package/dist/packem_shared/{generateCommand-CmyavGTZ.cjs → generateCommand-RY4QFtm7.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 const node_process = require('node:process');
-const generateCommand$1 = require('./generateCommand-Cu0UQUh8.cjs');
+const generateCommand$1 = require('./generateCommand-MwnCNgEE.cjs');
 
 const generateCommand = (program, commandName = "generate", configName = ".openapirc.js") => {
   program.command(commandName).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]", "Paths to files or directories to parse").option("-c, --config [.openapirc.js]", "@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]", "Output swagger specification.").option("-v, --verbose", "Verbose output.").option("-d, --very-verbose", "Very verbose output.").action(async (paths, options) => {

package/dist/packem_shared/{generateCommand-CZEFuXr9.mjs → generateCommand-a9_RAbug.mjs}

@@ -4,16 +4,13 @@ import { pathToFileURL } from 'node:url';
 import { collect } from '@visulima/fs';
 import { MultiBar, Presets } from 'cli-progress';
 import { v as validate, D as DEFAULT_EXCLUDE } from './validate-DZHaKH07.mjs';
-import commentsToOpenApi from './jsDocumentCommentsToOpenApi-eOlxMuMO.mjs';
-import parseFile from './parseFile-Bxis7tbW.mjs';
+import commentsToOpenApi from './jsDocumentCommentsToOpenApi-DtrIZ2lK.mjs';
+import parseFile from './parseFile-BE-sKiRK.mjs';
 import SpecBuilder from './SpecBuilder-B7YiF7zR.mjs';
-import commentsToOpenApi$1 from './swaggerJsDocumentCommentsToOpenApi-Cb5s1J29.mjs';
+import commentsToOpenApi$1 from './swaggerJsDocumentCommentsToOpenApi-B7g9rVr5.mjs';
 
 const generateCommand = async (configName, paths, options) => {
-  let openapiConfig = {
-    exclude: [],
-    swaggerDefinition: {}
-  };
+  let openapiConfig;
   try {
     let config = await import(pathToFileURL(normalize(options.config ?? configName)).href);
     if (config?.default) {
@@ -34,7 +31,7 @@ const generateCommand = async (configName, paths, options) => {
   );
   const spec = new SpecBuilder(openapiConfig.swaggerDefinition);
   const skip = /* @__PURE__ */ new Set([...DEFAULT_EXCLUDE, ...openapiConfig.exclude]);
-  for await (const dir of paths) {
+  for (const dir of paths) {
     (await lstat(dir)).isDirectory();
     const realDirectory = await realpath(dir);
     const files = await collect(realDirectory, {
@@ -66,16 +63,16 @@ Found ${String(files.length)} files in ${realDirectory}`);
     console.log("Validating swagger spec");
   }
   if (options.veryVerbose) {
-    console.log(JSON.stringify(spec, null, 2));
+    console.log(JSON.stringify(spec, void 0, 2));
   }
-  await validate(JSON.parse(JSON.stringify(spec)));
+  await validate(structuredClone(spec));
   const output = options.output ?? "swagger.json";
   multibar.stop();
   if (options.verbose) {
     console.log(`Written swagger spec to "${output}" file`);
   }
   await mkdir(dirname(output), { recursive: true });
-  await writeFile(output, JSON.stringify(spec, null, 2));
+  await writeFile(output, JSON.stringify(spec, void 0, 2));
   console.log(`
 Swagger specification is ready, check the "${output}" file.`);
 };

package/dist/packem_shared/{jsDocumentCommentsToOpenApi-C8kxIQH2.cjs → jsDocumentCommentsToOpenApi-C7yMeXJ5.cjs}

@@ -8,6 +8,10 @@ const _interopDefaultCompat = e => e && typeof e === 'object' && 'default' in e
 
 const mergeWith__default = /*#__PURE__*/_interopDefaultCompat(mergeWith);
 
+const ARRAY_SUFFIX_REGEX = /\[\]$/;
+const DESCRIPTION_DASH_REGEX = /^- /u;
+const PARAM_SUFFIX_REGEX = /Param$/u;
+const OPEN_API_REGEX = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \/.*$/;
 const fixSecurityObject = (thing) => {
   if (thing.security) {
     thing.security = Object.keys(thing.security).map((s) => {
@@ -32,7 +36,7 @@ const formatMap = {
 const parseDescription = (tag) => {
   const rawType = tag.type;
   const isArray = rawType.endsWith("[]");
-  const parsedType = rawType.replace(/\[]$/, "");
+  const parsedType = rawType.replace(ARRAY_SUFFIX_REGEX, "");
   const isPrimitive = primitiveTypes.has(parsedType);
   const isFormat = Object.keys(formatMap).includes(parsedType);
   let defaultValue;
@@ -79,7 +83,7 @@ const parseDescription = (tag) => {
   if (parsedType === "") {
     schema = void 0;
   }
-  let description = tag.description.trim().replace(/^- /u, "");
+  let description = tag.description.trim().replace(DESCRIPTION_DASH_REGEX, "");
   if (description === "") {
     description = void 0;
   }
@@ -91,7 +95,7 @@ const parseDescription = (tag) => {
     schema
   };
 };
-const tagsToObjects = (tags, verbose) => tags.map((tag) => {
+const tagsToObjects = (tags, _verbose) => tags.map((tag) => {
   const parsedResponse = parseDescription(tag);
   let nameAndDescription = "";
   if (parsedResponse.name) {
@@ -158,7 +162,7 @@ const tagsToObjects = (tags, verbose) => tags.map((tag) => {
         parameters: [
           {
             description: parsedResponse.description,
-            in: tag.tag.replace(/Param$/u, ""),
+            in: tag.tag.replace(PARAM_SUFFIX_REGEX, ""),
             name: parsedResponse.name,
             required: parsedResponse.required,
             schema: parsedResponse.schema
@@ -309,9 +313,8 @@ const tagsToObjects = (tags, verbose) => tags.map((tag) => {
   }
 });
 const commentsToOpenApi = (fileContents, verbose) => {
-  const openAPIRegex = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \/.*$/;
   const jsDocumentComments = commentParser.parse(fileContents, { spacing: "preserve" });
-  return jsDocumentComments.filter((comment) => openAPIRegex.test(comment.description.trim())).map((comment) => {
+  return jsDocumentComments.filter((comment) => OPEN_API_REGEX.test(comment.description.trim())).map((comment) => {
     const loc = comment.tags.length + 1;
     const result = mergeWith__default({}, ...tagsToObjects(comment.tags), customizer.customizer);
     fixSecurityObject(result);

package/dist/packem_shared/{jsDocumentCommentsToOpenApi-eOlxMuMO.mjs → jsDocumentCommentsToOpenApi-DtrIZ2lK.mjs}

@@ -2,6 +2,10 @@ import { parse } from 'comment-parser';
 import mergeWith from 'lodash.mergewith';
 import { c as customizer } from './customizer-CoMXMU7a.mjs';
 
+const ARRAY_SUFFIX_REGEX = /\[\]$/;
+const DESCRIPTION_DASH_REGEX = /^- /u;
+const PARAM_SUFFIX_REGEX = /Param$/u;
+const OPEN_API_REGEX = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \/.*$/;
 const fixSecurityObject = (thing) => {
   if (thing.security) {
     thing.security = Object.keys(thing.security).map((s) => {
@@ -26,7 +30,7 @@ const formatMap = {
 const parseDescription = (tag) => {
   const rawType = tag.type;
   const isArray = rawType.endsWith("[]");
-  const parsedType = rawType.replace(/\[]$/, "");
+  const parsedType = rawType.replace(ARRAY_SUFFIX_REGEX, "");
   const isPrimitive = primitiveTypes.has(parsedType);
   const isFormat = Object.keys(formatMap).includes(parsedType);
   let defaultValue;
@@ -73,7 +77,7 @@ const parseDescription = (tag) => {
   if (parsedType === "") {
     schema = void 0;
   }
-  let description = tag.description.trim().replace(/^- /u, "");
+  let description = tag.description.trim().replace(DESCRIPTION_DASH_REGEX, "");
   if (description === "") {
     description = void 0;
   }
@@ -85,7 +89,7 @@ const parseDescription = (tag) => {
     schema
   };
 };
-const tagsToObjects = (tags, verbose) => tags.map((tag) => {
+const tagsToObjects = (tags, _verbose) => tags.map((tag) => {
   const parsedResponse = parseDescription(tag);
   let nameAndDescription = "";
   if (parsedResponse.name) {
@@ -152,7 +156,7 @@ const tagsToObjects = (tags, verbose) => tags.map((tag) => {
         parameters: [
           {
             description: parsedResponse.description,
-            in: tag.tag.replace(/Param$/u, ""),
+            in: tag.tag.replace(PARAM_SUFFIX_REGEX, ""),
             name: parsedResponse.name,
             required: parsedResponse.required,
             schema: parsedResponse.schema
@@ -303,9 +307,8 @@ const tagsToObjects = (tags, verbose) => tags.map((tag) => {
   }
 });
 const commentsToOpenApi = (fileContents, verbose) => {
-  const openAPIRegex = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \/.*$/;
   const jsDocumentComments = parse(fileContents, { spacing: "preserve" });
-  return jsDocumentComments.filter((comment) => openAPIRegex.test(comment.description.trim())).map((comment) => {
+  return jsDocumentComments.filter((comment) => OPEN_API_REGEX.test(comment.description.trim())).map((comment) => {
     const loc = comment.tags.length + 1;
     const result = mergeWith({}, ...tagsToObjects(comment.tags), customizer);
     fixSecurityObject(result);

package/dist/packem_shared/{parseFile-Bxis7tbW.mjs → parseFile-BE-sKiRK.mjs}

@@ -1,7 +1,7 @@
 import { readFileSync } from 'node:fs';
 import path from 'node:path';
 import yaml from 'yaml';
-import yamlLoc from './yamlLoc-Cmx4vbRt.mjs';
+import yamlLoc from './yamlLoc-C7iHWvdq.mjs';
 
 const ALLOWED_KEYS = /* @__PURE__ */ new Set(["components", "externalDocs", "info", "openapi", "paths", "security", "servers", "tags"]);
 class ParseError extends Error {

package/dist/packem_shared/{parseFile-BJwu_na4.cjs → parseFile-Dk7Bw7lt.cjs}

@@ -3,7 +3,7 @@
 const node_fs = require('node:fs');
 const path = require('node:path');
 const yaml = require('yaml');
-const yamlLoc = require('./yamlLoc-BLoIYoXs.cjs');
+const yamlLoc = require('./yamlLoc-CEvBiR4K.cjs');
 
 const _interopDefaultCompat = e => e && typeof e === 'object' && 'default' in e ? e.default : e;
 

package/dist/packem_shared/{swaggerJsDocumentCommentsToOpenApi-Cb5s1J29.mjs → swaggerJsDocumentCommentsToOpenApi-B7g9rVr5.mjs}

@@ -3,7 +3,12 @@ import mergeWith from 'lodash.mergewith';
 import yaml from 'yaml';
 import { c as customizer } from './customizer-CoMXMU7a.mjs';
 
-const mergeDeep = (first, second) => mergeWith({}, first, second, (a, b) => b === null ? a : void 0);
+const mergeDeep = (first, second) => mergeWith({}, first, second, (a, b) => {
+  if (b === null) {
+    return a;
+  }
+  return void 0;
+});
 const hasEmptyProperty = (object) => Object.keys(object).map((key) => object[key]).every((keyObject) => typeof keyObject === "object" && Object.keys(keyObject).every((key) => !(key in keyObject)));
 const isTagPresentInTags = (tag, tags) => tags.some((targetTag) => tag.name === targetTag.name);
 const getSwaggerVersionFromSpec = (tag) => {
@@ -71,28 +76,24 @@ const specificationTemplate = {
   v4: ["components", "channels"]
 };
 const tagsToObjects = (specs, verbose) => specs.map((spec) => {
-  const hasContent = spec.description !== "" || spec.name !== void 0 && (spec.name.startsWith("/") || spec.name.endsWith(":"));
+  const hasContent = spec.description !== "" || spec.name.startsWith("/") || spec.name.endsWith(":");
   if ((spec.tag === "openapi" || spec.tag === "swagger" || spec.tag === "asyncapi") && hasContent) {
     let yamlContent = spec.description;
-    if (spec.name !== void 0 && (spec.name.startsWith("/") || spec.name.endsWith(":"))) {
+    if (spec.name.startsWith("/") || spec.name.endsWith(":")) {
       yamlContent = yamlContent.trim() === "" ? spec.name : `${spec.name}
 ${yamlContent}`;
     }
     const parsed = yaml.parseDocument(yamlContent);
     if (parsed.errors.length > 0) {
-      parsed.errors.map((error) => {
-        const newError = error;
-        newError.annotation = yamlContent;
-        return newError;
+      parsed.errors.forEach((error) => {
+        error.annotation = yamlContent;
       });
       let errorString = "Error parsing YAML in @openapi spec:";
-      errorString += verbose ? parsed.errors.map(
-        (error) => `${error.toString()}
+      errorString += verbose ? parsed.errors.map((error) => `${error.toString()}
 Imbedded within:
 \`\`\`
   ${error.annotation?.replaceAll("\n", "\n  ")}
-\`\`\``
-      ).join("\n") : parsed.errors.map((error) => error.toString()).join("\n");
+\`\`\``).join("\n") : parsed.errors.map((error) => error.toString()).join("\n");
       throw new Error(errorString);
     }
     const parsedDocument = parsed.toJSON();
@@ -100,7 +101,7 @@ Imbedded within:
       tags: []
     };
     specificationTemplate[getSwaggerVersionFromSpec(spec)].forEach((property) => {
-      specification[property] = specification[property] || {};
+      specification[property] = specification[property] ?? {};
     });
     Object.keys(parsedDocument).forEach((property) => {
       organizeSwaggerObject(specification, parsedDocument, property);

package/dist/packem_shared/{swaggerJsDocumentCommentsToOpenApi-JFymRz50.cjs → swaggerJsDocumentCommentsToOpenApi-BuB7eE94.cjs}

@@ -10,7 +10,12 @@ const _interopDefaultCompat = e => e && typeof e === 'object' && 'default' in e
 const mergeWith__default = /*#__PURE__*/_interopDefaultCompat(mergeWith);
 const yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
 
-const mergeDeep = (first, second) => mergeWith__default({}, first, second, (a, b) => b === null ? a : void 0);
+const mergeDeep = (first, second) => mergeWith__default({}, first, second, (a, b) => {
+  if (b === null) {
+    return a;
+  }
+  return void 0;
+});
 const hasEmptyProperty = (object) => Object.keys(object).map((key) => object[key]).every((keyObject) => typeof keyObject === "object" && Object.keys(keyObject).every((key) => !(key in keyObject)));
 const isTagPresentInTags = (tag, tags) => tags.some((targetTag) => tag.name === targetTag.name);
 const getSwaggerVersionFromSpec = (tag) => {
@@ -78,28 +83,24 @@ const specificationTemplate = {
   v4: ["components", "channels"]
 };
 const tagsToObjects = (specs, verbose) => specs.map((spec) => {
-  const hasContent = spec.description !== "" || spec.name !== void 0 && (spec.name.startsWith("/") || spec.name.endsWith(":"));
+  const hasContent = spec.description !== "" || spec.name.startsWith("/") || spec.name.endsWith(":");
   if ((spec.tag === "openapi" || spec.tag === "swagger" || spec.tag === "asyncapi") && hasContent) {
     let yamlContent = spec.description;
-    if (spec.name !== void 0 && (spec.name.startsWith("/") || spec.name.endsWith(":"))) {
+    if (spec.name.startsWith("/") || spec.name.endsWith(":")) {
       yamlContent = yamlContent.trim() === "" ? spec.name : `${spec.name}
 ${yamlContent}`;
     }
     const parsed = yaml__default.parseDocument(yamlContent);
     if (parsed.errors.length > 0) {
-      parsed.errors.map((error) => {
-        const newError = error;
-        newError.annotation = yamlContent;
-        return newError;
+      parsed.errors.forEach((error) => {
+        error.annotation = yamlContent;
       });
       let errorString = "Error parsing YAML in @openapi spec:";
-      errorString += verbose ? parsed.errors.map(
-        (error) => `${error.toString()}
+      errorString += verbose ? parsed.errors.map((error) => `${error.toString()}
 Imbedded within:
 \`\`\`
   ${error.annotation?.replaceAll("\n", "\n  ")}
-\`\`\``
-      ).join("\n") : parsed.errors.map((error) => error.toString()).join("\n");
+\`\`\``).join("\n") : parsed.errors.map((error) => error.toString()).join("\n");
       throw new Error(errorString);
     }
     const parsedDocument = parsed.toJSON();
@@ -107,7 +108,7 @@ Imbedded within:
       tags: []
     };
     specificationTemplate[getSwaggerVersionFromSpec(spec)].forEach((property) => {
-      specification[property] = specification[property] || {};
+      specification[property] = specification[property] ?? {};
     });
     Object.keys(parsedDocument).forEach((property) => {
       organizeSwaggerObject(specification, parsedDocument, property);

package/dist/packem_shared/{yamlLoc-Cmx4vbRt.mjs → yamlLoc-C7iHWvdq.mjs}

@@ -1,7 +1,9 @@
+const LINE_SPLIT_REGEX = /\r\n|\r|\n/u;
+const COMMENT_OR_EMPTY_REGEX = /^\s*(#\s*(?:\S.*)?)?$/u;
 const yamlLoc = (string) => {
-  const split = string.split(/\r\n|\r|\n/u);
+  const split = string.split(LINE_SPLIT_REGEX);
   const filtered = split.filter((line) => {
-    if (/^\s*(#\s*(?:\S.*)?)?$/u.test(line)) {
+    if (COMMENT_OR_EMPTY_REGEX.test(line)) {
       return false;
     }
     return line.trim().length > 0;

package/dist/packem_shared/{yamlLoc-BLoIYoXs.cjs → yamlLoc-CEvBiR4K.cjs}

@@ -1,9 +1,11 @@
 'use strict';
 
+const LINE_SPLIT_REGEX = /\r\n|\r|\n/u;
+const COMMENT_OR_EMPTY_REGEX = /^\s*(#\s*(?:\S.*)?)?$/u;
 const yamlLoc = (string) => {
-  const split = string.split(/\r\n|\r|\n/u);
+  const split = string.split(LINE_SPLIT_REGEX);
   const filtered = split.filter((line) => {
-    if (/^\s*(#\s*(?:\S.*)?)?$/u.test(line)) {
+    if (COMMENT_OR_EMPTY_REGEX.test(line)) {
       return false;
     }
     return line.trim().length > 0;

package/dist/swagger-jsdoc/utils.d.cts

@@ -3,16 +3,17 @@ import type { Spec } from "comment-parser";
  * A recursive deep-merge that ignores null values when merging.
  * This returns the merged object and does not mutate.
  * @param first the first object to get merged
- * @param {object} second the second object to get merged
+ * @param second the second object to get merged
  */
 export declare const mergeDeep: (first?: object, second?: object) => object;
 /**
- * Checks if there is any properties of the input object which are an empty object
+ * Checks if there is any properties of the input object which are an empty object.
  * @param object the object to check
  * @returns boolean
  */
 export declare const hasEmptyProperty: (object: Record<string, any>) => boolean;
 /**
+ * Checks whether the given tag is present in tags.
  * @param tag
  * @param tags
  * @returns boolean

package/dist/swagger-jsdoc/utils.d.mts

@@ -3,16 +3,17 @@ import type { Spec } from "comment-parser";
  * A recursive deep-merge that ignores null values when merging.
  * This returns the merged object and does not mutate.
  * @param first the first object to get merged
- * @param {object} second the second object to get merged
+ * @param second the second object to get merged
  */
 export declare const mergeDeep: (first?: object, second?: object) => object;
 /**
- * Checks if there is any properties of the input object which are an empty object
+ * Checks if there is any properties of the input object which are an empty object.
  * @param object the object to check
  * @returns boolean
  */
 export declare const hasEmptyProperty: (object: Record<string, any>) => boolean;
 /**
+ * Checks whether the given tag is present in tags.
  * @param tag
  * @param tags
  * @returns boolean

package/dist/swagger-jsdoc/utils.d.ts

@@ -3,16 +3,17 @@ import type { Spec } from "comment-parser";
  * A recursive deep-merge that ignores null values when merging.
  * This returns the merged object and does not mutate.
  * @param first the first object to get merged
- * @param {object} second the second object to get merged
+ * @param second the second object to get merged
  */
 export declare const mergeDeep: (first?: object, second?: object) => object;
 /**
- * Checks if there is any properties of the input object which are an empty object
+ * Checks if there is any properties of the input object which are an empty object.
  * @param object the object to check
  * @returns boolean
  */
 export declare const hasEmptyProperty: (object: Record<string, any>) => boolean;
 /**
+ * Checks whether the given tag is present in tags.
  * @param tag
  * @param tags
  * @returns boolean

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/jsdoc-open-api",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-alpha.8",
   "description": "Generates swagger doc based on JSDoc.",
   "keywords": [
     "visulima",
@@ -101,7 +101,7 @@
   ],
   "dependencies": {
     "@apidevtools/swagger-parser": "^12.1.0",
-    "@visulima/fs": "5.0.0-alpha.7",
+    "@visulima/fs": "5.0.0-alpha.9",
     "comment-parser": "1.4.6",
     "lodash.mergewith": "^4.6.2",
     "yaml": "2.8.3"
@@ -109,10 +109,10 @@
   "optionalDependencies": {
     "cli-progress": "^3.12.0",
     "commander": "^14.0.3",
-    "webpack": "^5.106.0"
+    "webpack": "^5.106.2"
   },
   "engines": {
-    "node": ">=22.13 <=25.x"
+    "node": "^22.14.0 || >=24.10.0"
   },
   "os": [
     "darwin",