@visulima/jsdoc-open-api 3.0.0-alpha.3 → 3.0.0-alpha.5

package/dist/packem_shared/validate-FKieC3ln.cjs

@@ -0,0 +1,37 @@
+'use strict';
+
+const SwaggerParser = require('@apidevtools/swagger-parser');
+
+const _interopDefaultCompat = e => e && typeof e === 'object' && 'default' in e ? e.default : e;
+
+const SwaggerParser__default = /*#__PURE__*/_interopDefaultCompat(SwaggerParser);
+
+const DEFAULT_EXCLUDE = [
+  "coverage/**",
+  ".github/**",
+  "**/*.d.ts",
+  "**/test{,s}/**",
+  "**/test{,-*}.{js,cjs,mjs,ts,tsx,jsx,yaml,yml}",
+  "**/*{.,-}test.{js,cjs,mjs,ts,tsx,jsx,yaml,yml}",
+  "**/__tests__/**",
+  "**/{ava,babel,nyc}.config.{js,cjs,mjs}",
+  "**/jest.config.{js,cjs,mjs,ts}",
+  "**/{karma,rollup,webpack}.config.js",
+  "**/.{eslint,mocha}rc.{js,cjs}",
+  "**/.{travis,yarnrc}.yml",
+  "**/{docker-compose,docker}.yml",
+  "**/.yamllint.{yaml,yml}",
+  "**/node_modules/**",
+  "**/{pnpm-workspace,pnpm-lock}.yaml",
+  "**/{package,package-lock}.json",
+  "**/yarn.lock",
+  "**/package.json5",
+  "**/.next/**"
+];
+
+const validate = async (spec) => {
+  await SwaggerParser__default.validate(spec);
+};
+
+exports.DEFAULT_EXCLUDE = DEFAULT_EXCLUDE;
+exports.validate = validate;

package/dist/packem_shared/yamlLoc-BLoIYoXs.cjs

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

package/dist/packem_shared/yamlLoc-Cmx4vbRt.mjs

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

package/dist/parse-file.d.cts

@@ -0,0 +1,9 @@
+import type { OpenApiObject } from "./exported.d.cts";
+declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[], verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+export = parseFile;

package/dist/parse-file.d.mts

@@ -0,0 +1,9 @@
+import type { OpenApiObject } from "./exported.d.mts";
+declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[], verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+export default parseFile;

package/dist/parse-file.d.ts

@@ -0,0 +1,9 @@
+import type { OpenApiObject } from "./exported.d.ts";
+declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[], verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+export = parseFile;

package/dist/spec-builder.d.cts

@@ -0,0 +1,14 @@
+import type { BaseDefinition, ComponentsObject, ExternalDocumentationObject, InfoObject, OpenApiObject, PathsObject, SecurityRequirementObject, ServerObject, TagObject } from "./exported.d.cts";
+declare class SpecBuilder implements OpenApiObject {
+    components?: ComponentsObject;
+    externalDocs?: ExternalDocumentationObject;
+    info: InfoObject;
+    openapi: string;
+    paths: PathsObject;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    tags?: TagObject[];
+    constructor(baseDefinition: BaseDefinition);
+    addData(parsedFile: OpenApiObject[]): void;
+}
+export = SpecBuilder;

package/dist/spec-builder.d.mts

@@ -0,0 +1,14 @@
+import type { BaseDefinition, ComponentsObject, ExternalDocumentationObject, InfoObject, OpenApiObject, PathsObject, SecurityRequirementObject, ServerObject, TagObject } from "./exported.d.mts";
+declare class SpecBuilder implements OpenApiObject {
+    components?: ComponentsObject;
+    externalDocs?: ExternalDocumentationObject;
+    info: InfoObject;
+    openapi: string;
+    paths: PathsObject;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    tags?: TagObject[];
+    constructor(baseDefinition: BaseDefinition);
+    addData(parsedFile: OpenApiObject[]): void;
+}
+export default SpecBuilder;

package/dist/spec-builder.d.ts

@@ -0,0 +1,14 @@
+import type { BaseDefinition, ComponentsObject, ExternalDocumentationObject, InfoObject, OpenApiObject, PathsObject, SecurityRequirementObject, ServerObject, TagObject } from "./exported.d.ts";
+declare class SpecBuilder implements OpenApiObject {
+    components?: ComponentsObject;
+    externalDocs?: ExternalDocumentationObject;
+    info: InfoObject;
+    openapi: string;
+    paths: PathsObject;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    tags?: TagObject[];
+    constructor(baseDefinition: BaseDefinition);
+    addData(parsedFile: OpenApiObject[]): void;
+}
+export = SpecBuilder;

package/dist/swagger-jsdoc/comments-to-open-api.d.cts

@@ -0,0 +1,6 @@
+import type { OpenApiObject } from "../exported.d.cts";
+declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+export = commentsToOpenApi;

package/dist/swagger-jsdoc/comments-to-open-api.d.mts

@@ -0,0 +1,6 @@
+import type { OpenApiObject } from "../exported.d.mts";
+declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+export default commentsToOpenApi;

package/dist/swagger-jsdoc/comments-to-open-api.d.ts

@@ -0,0 +1,6 @@
+import type { OpenApiObject } from "../exported.d.ts";
+declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+export = commentsToOpenApi;

package/dist/swagger-jsdoc/organize-swagger-object.d.cts

@@ -0,0 +1,7 @@
+/**
+ * @param {object} swaggerObject
+ * @param {object} annotation
+ * @param {string} property
+ */
+declare const organizeSwaggerObject: (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string) => void;
+export = organizeSwaggerObject;

package/dist/swagger-jsdoc/organize-swagger-object.d.mts

@@ -0,0 +1,7 @@
+/**
+ * @param {object} swaggerObject
+ * @param {object} annotation
+ * @param {string} property
+ */
+declare const organizeSwaggerObject: (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string) => void;
+export default organizeSwaggerObject;

package/dist/swagger-jsdoc/organize-swagger-object.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param {object} swaggerObject
+ * @param {object} annotation
+ * @param {string} property
+ */
+declare const organizeSwaggerObject: (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string) => void;
+export = organizeSwaggerObject;

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

@@ -0,0 +1,21 @@
+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
+ */
+export declare const mergeDeep: (first?: object, second?: object) => 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;
+/**
+ * @param tag
+ * @param tags
+ * @returns boolean
+ */
+export declare const isTagPresentInTags: (tag: Spec, tags: Spec[]) => boolean;
+export declare const getSwaggerVersionFromSpec: (tag: Spec) => "v2" | "v3" | "v4";

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

@@ -0,0 +1,21 @@
+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
+ */
+export declare const mergeDeep: (first?: object, second?: object) => 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;
+/**
+ * @param tag
+ * @param tags
+ * @returns boolean
+ */
+export declare const isTagPresentInTags: (tag: Spec, tags: Spec[]) => boolean;
+export declare const getSwaggerVersionFromSpec: (tag: Spec) => "v2" | "v3" | "v4";

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

@@ -0,0 +1,21 @@
+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
+ */
+export declare const mergeDeep: (first?: object, second?: object) => 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;
+/**
+ * @param tag
+ * @param tags
+ * @returns boolean
+ */
+export declare const isTagPresentInTags: (tag: Spec, tags: Spec[]) => boolean;
+export declare const getSwaggerVersionFromSpec: (tag: Spec) => "v2" | "v3" | "v4";

package/dist/util/customizer.d.cts

@@ -0,0 +1,2 @@
+declare const customizer: (objectValue: unknown, sourceValue: unknown[]) => unknown[] | undefined;
+export = customizer;

package/dist/util/customizer.d.mts

@@ -0,0 +1,2 @@
+declare const customizer: (objectValue: unknown, sourceValue: unknown[]) => unknown[] | undefined;
+export default customizer;

package/dist/util/customizer.d.ts

@@ -0,0 +1,2 @@
+declare const customizer: (objectValue: unknown, sourceValue: unknown[]) => unknown[] | undefined;
+export = customizer;

package/dist/util/object-merge.d.cts

@@ -0,0 +1,2 @@
+declare const objectMerge: <T>(a: T, b: T) => void;
+export = objectMerge;

package/dist/util/object-merge.d.mts

@@ -0,0 +1,2 @@
+declare const objectMerge: <T>(a: T, b: T) => void;
+export default objectMerge;

package/dist/util/object-merge.d.ts

@@ -0,0 +1,2 @@
+declare const objectMerge: <T>(a: T, b: T) => void;
+export = objectMerge;

package/dist/util/yaml-loc.d.cts

@@ -0,0 +1,2 @@
+declare const yamlLoc: (string: string) => number;
+export = yamlLoc;

package/dist/util/yaml-loc.d.mts

@@ -0,0 +1,2 @@
+declare const yamlLoc: (string: string) => number;
+export default yamlLoc;

package/dist/util/yaml-loc.d.ts

@@ -0,0 +1,2 @@
+declare const yamlLoc: (string: string) => number;
+export = yamlLoc;

package/dist/validate.d.cts

@@ -0,0 +1,2 @@
+declare const validate: (spec: Record<string, unknown>) => Promise<void>;
+export = validate;

package/dist/validate.d.mts

@@ -0,0 +1,2 @@
+declare const validate: (spec: Record<string, unknown>) => Promise<void>;
+export default validate;

package/dist/validate.d.ts

@@ -0,0 +1,2 @@
+declare const validate: (spec: Record<string, unknown>) => Promise<void>;
+export = validate;

package/dist/webpack/swagger-compiler-plugin.d.cts

@@ -0,0 +1,15 @@
+import type { Compiler } from "webpack";
+import type { BaseDefinition } from "../exported.d.cts";
+declare class SwaggerCompilerPlugin {
+    private readonly assetsPath;
+    private readonly ignore;
+    private readonly sources;
+    private readonly swaggerDefinition;
+    private readonly verbose;
+    constructor(assetsPath: string, sources: string[], swaggerDefinition: BaseDefinition, options: {
+        ignore?: (RegExp | string)[];
+        verbose?: boolean;
+    });
+    apply(compiler: Compiler): void;
+}
+export = SwaggerCompilerPlugin;

package/dist/webpack/swagger-compiler-plugin.d.mts

@@ -0,0 +1,15 @@
+import type { Compiler } from "webpack";
+import type { BaseDefinition } from "../exported.d.mts";
+declare class SwaggerCompilerPlugin {
+    private readonly assetsPath;
+    private readonly ignore;
+    private readonly sources;
+    private readonly swaggerDefinition;
+    private readonly verbose;
+    constructor(assetsPath: string, sources: string[], swaggerDefinition: BaseDefinition, options: {
+        ignore?: (RegExp | string)[];
+        verbose?: boolean;
+    });
+    apply(compiler: Compiler): void;
+}
+export default SwaggerCompilerPlugin;

package/dist/webpack/swagger-compiler-plugin.d.ts

@@ -0,0 +1,15 @@
+import type { Compiler } from "webpack";
+import type { BaseDefinition } from "../exported.d.ts";
+declare class SwaggerCompilerPlugin {
+    private readonly assetsPath;
+    private readonly ignore;
+    private readonly sources;
+    private readonly swaggerDefinition;
+    private readonly verbose;
+    constructor(assetsPath: string, sources: string[], swaggerDefinition: BaseDefinition, options: {
+        ignore?: (RegExp | string)[];
+        verbose?: boolean;
+    });
+    apply(compiler: Compiler): void;
+}
+export = SwaggerCompilerPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/jsdoc-open-api",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.5",
   "description": "Generates swagger doc based on JSDoc.",
   "keywords": [
     "visulima",
@@ -41,40 +41,53 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
       "import": {
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       }
     },
     "./cli": {
-      "require": {
-        "types": "./dist/cli/index.d.ts",
-        "default": "./dist/cli/index.js"
-      },
       "import": {
         "types": "./dist/cli/index.d.mts",
         "default": "./dist/cli/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cli/index.d.cts",
+        "default": "./dist/cli/index.cjs"
       }
     },
     "./cli/commander": {
-      "require": {
-        "types": "./dist/cli/commander/index.d.ts",
-        "default": "./dist/cli/commander/index.js"
-      },
       "import": {
         "types": "./dist/cli/commander/index.d.mts",
         "default": "./dist/cli/commander/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cli/commander/index.d.cts",
+        "default": "./dist/cli/commander/index.cjs"
       }
     },
     "./package.json": "./package.json"
   },
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "typesVersions": {
+    ">=5.0": {
+      ".": [
+        "./dist/index.d.ts"
+      ],
+      "cli": [
+        "./dist/cli/index.d.ts"
+      ],
+      "cli/commander": [
+        "./dist/cli/commander/index.d.ts"
+      ]
+    }
+  },
   "bin": {
     "jsdoc-open-api": "./bin/index.js"
   },
@@ -88,15 +101,15 @@
   ],
   "dependencies": {
     "@apidevtools/swagger-parser": "^12.1.0",
-    "comment-parser": "^1.4.1",
+    "@visulima/fs": "5.0.0-alpha.5",
+    "comment-parser": "^1.4.5",
     "lodash.mergewith": "^4.6.2",
-    "read-pkg-up": "^7.0.1",
-    "yaml": "^2.8.2"
+    "yaml": "2.8.3"
   },
   "optionalDependencies": {
     "cli-progress": "^3.12.0",
-    "commander": "^14.0.2",
-    "webpack": "^5.104.1"
+    "commander": "^14.0.3",
+    "webpack": "^5.105.4"
   },
   "engines": {
     "node": ">=22.13 <=25.x"