@visulima/jsdoc-open-api 1.3.9 → 1.3.11

package/dist/cli/commander/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/cli/commander/command/init-command.ts","../../../src/cli/commander/command/generate-command.ts"],"names":["exit","initCommand","program","commandName","description","configName","init_command_default","error","generateCommand","paths","options","generate_command_default"],"mappings":"qFAEA,OAAS,QAAAA,MAAY,UAIrB,IAAMC,EAAc,CAChBC,EACAC,EAAsB,OACtBC,EAAsB,+DACtBC,EAAqB,kBACd,CACPH,EACK,QAAQC,CAAW,EACnB,YAAYC,CAAW,EACvB,OAAO,IAAM,CACV,GAAI,CACAE,EAAgBD,CAAU,CAC9B,OAASE,EAAP,CAEE,QAAQ,MAAMA,CAAK,EACnBP,EAAK,CAAC,CACV,CACJ,CAAC,CACT,EAEOM,EAAQL,ECxBf,OAAS,QAAAD,MAAY,UAIrB,IAAMQ,EAAkB,CAACN,EAAkBC,EAAsB,WAAYE,EAAqB,kBAA0B,CACxHH,EACK,QAAQC,CAAW,EACnB,YAAY,wDAAwD,EACpE,MAAM,sBAAsB,EAC5B,SAAS,aAAc,wCAAwC,EAC/D,OAAO,+BAAgC,4CAA4C,EACnF,OAAO,kCAAmC,+BAA+B,EACzE,OAAO,gBAAiB,iBAAiB,EACzC,OAAO,sBAAuB,sBAAsB,EAEpD,OAAO,MAAOM,EAAOC,IAAY,CAC9B,GAAI,CACA,MAAMC,EAAoBN,EAAYI,EAAOC,CAAO,CACxD,OAASH,EAAP,CAEE,QAAQ,MAAMA,CAAK,EACnBP,EAAK,CAAC,CACV,CACJ,CAAC,CACT,EAEOW,EAAQH","sourcesContent":["// eslint-disable-next-line import/no-extraneous-dependencies\nimport type { Command } from \"commander\";\nimport { exit } from \"node:process\";\n\nimport baseInitCommand from \"../../command/init-command\";\n\nconst initCommand = (\n    program: Command,\n    commandName: string = \"init\",\n    description: string = \"Inits a pre-configured @visulima/jsdoc-open-api config file.\",\n    configName: string = \".openapirc.js\",\n): void => {\n    program\n        .command(commandName)\n        .description(description)\n        .action(() => {\n            try {\n                baseInitCommand(configName);\n            } catch (error) {\n                // eslint-disable-next-line no-console\n                console.error(error);\n                exit(1);\n            }\n        });\n};\n\nexport default initCommand;\n","// eslint-disable-next-line import/no-extraneous-dependencies\nimport type { Command } from \"commander\";\nimport { exit } from \"node:process\";\n\nimport baseGenerateCommand from \"../../command/generate-command\";\n\nconst generateCommand = (program: Command, commandName: string = \"generate\", configName: string = \".openapirc.js\"): void => {\n    program\n        .command(commandName)\n        .description(\"Generates OpenAPI (Swagger) documentation from JSDoc's\")\n        .usage(\"[options] <path ...>\")\n        .argument(\"[path ...]\", \"Paths to files or directories to parse\")\n        .option(\"-c, --config [.openapirc.js]\", \"@visulima/jsdoc-open-api config file path.\")\n        .option(\"-o, --output [swaggerSpec.json]\", \"Output swagger specification.\")\n        .option(\"-v, --verbose\", \"Verbose output.\")\n        .option(\"-vv, --very-verbose\", \"Very verbose output.\")\n        // eslint-disable-next-line sonarjs/cognitive-complexity\n        .action(async (paths, options) => {\n            try {\n                await baseGenerateCommand(configName, paths, options);\n            } catch (error) {\n                // eslint-disable-next-line no-console\n                console.error(error);\n                exit(1);\n            }\n        });\n};\n\nexport default generateCommand;\n"]}
+{"version":3,"sources":["../../../src/cli/commander/command/generate-command.ts","../../../src/cli/commander/command/init-command.ts"],"names":["exit","generateCommand","program","commandName","configName","paths","options","generate_command_default","error","initCommand","description","init_command_default"],"mappings":"qFACA,OAAS,QAAAA,MAAY,UAIrB,IAAMC,EAAkB,CAACC,EAAkBC,EAAc,WAAYC,EAAa,kBAA0B,CACxGF,EACK,QAAQC,CAAW,EACnB,YAAY,wDAAwD,EACpE,MAAM,sBAAsB,EAC5B,SAAS,aAAc,wCAAwC,EAC/D,OAAO,+BAAgC,4CAA4C,EACnF,OAAO,kCAAmC,+BAA+B,EACzE,OAAO,gBAAiB,iBAAiB,EACzC,OAAO,sBAAuB,sBAAsB,EAEpD,OAAO,MAAOE,EAAOC,IAAY,CAC9B,GAAI,CACA,MAAMC,EAAoBH,EAAYC,EAAOC,CAAO,CACxD,OAASE,EAAO,CACZ,QAAQ,MAAMA,CAAK,EACnBR,EAAK,CAAC,CACV,CACJ,CAAC,CACT,EAEOO,EAAQN,ECzBf,OAAS,QAAAD,MAAY,UAIrB,IAAMS,EAAc,CAChBP,EACAC,EAAc,OACdO,EAAc,+DACdN,EAAa,kBACN,CACPF,EACK,QAAQC,CAAW,EACnB,YAAYO,CAAW,EACvB,OAAO,IAAM,CACV,GAAI,CACAC,EAAgBP,CAAU,CAC9B,OAASI,EAAO,CACZ,QAAQ,MAAMA,CAAK,EACnBR,EAAK,CAAC,CACV,CACJ,CAAC,CACT,EAEOW,EAAQF","sourcesContent":["import type { Command } from \"commander\";\nimport { exit } from \"node:process\";\n\nimport baseGenerateCommand from \"../../command/generate-command\";\n\nconst generateCommand = (program: Command, commandName = \"generate\", configName = \".openapirc.js\"): void => {\n    program\n        .command(commandName)\n        .description(\"Generates OpenAPI (Swagger) documentation from JSDoc's\")\n        .usage(\"[options] <path ...>\")\n        .argument(\"[path ...]\", \"Paths to files or directories to parse\")\n        .option(\"-c, --config [.openapirc.js]\", \"@visulima/jsdoc-open-api config file path.\")\n        .option(\"-o, --output [swaggerSpec.json]\", \"Output swagger specification.\")\n        .option(\"-v, --verbose\", \"Verbose output.\")\n        .option(\"-vv, --very-verbose\", \"Very verbose output.\")\n\n        .action(async (paths, options) => {\n            try {\n                await baseGenerateCommand(configName, paths, options);\n            } catch (error) {\n                console.error(error);\n                exit(1);\n            }\n        });\n};\n\nexport default generateCommand;\n","import type { Command } from \"commander\";\nimport { exit } from \"node:process\";\n\nimport baseInitCommand from \"../../command/init-command\";\n\nconst initCommand = (\n    program: Command,\n    commandName = \"init\",\n    description = \"Inits a pre-configured @visulima/jsdoc-open-api config file.\",\n    configName = \".openapirc.js\",\n): void => {\n    program\n        .command(commandName)\n        .description(description)\n        .action(() => {\n            try {\n                baseInitCommand(configName);\n            } catch (error) {\n                console.error(error);\n                exit(1);\n            }\n        });\n};\n\nexport default initCommand;\n"]}

package/dist/cli/index.d.mts

@@ -0,0 +1,10 @@
+declare const generateCommand: (configName: string, paths: string[], options: {
+    config?: string;
+    output?: string;
+    verbose?: boolean;
+    veryVerbose?: boolean;
+}) => Promise<void>;
+
+declare const initCommand: (configName: string, packageJsonPath?: string) => void;
+
+export { generateCommand, initCommand };

package/dist/cli/index.d.ts

@@ -1,5 +1,3 @@
-declare const initCommand: (configName: string, packageJsonPath?: string) => void;
-
 declare const generateCommand: (configName: string, paths: string[], options: {
     config?: string;
     output?: string;
@@ -7,4 +5,6 @@ declare const generateCommand: (configName: string, paths: string[], options: {
     veryVerbose?: boolean;
 }) => Promise<void>;
 
+declare const initCommand: (configName: string, packageJsonPath?: string) => void;
+
 export { generateCommand, initCommand };

package/dist/cli/index.js

@@ -1,17 +1,17 @@
 'use strict';
 
-var chunkTDDRTX7G_js = require('../chunk-TDDRTX7G.js');
-require('../chunk-I7ZHNMGN.js');
+var chunkLJ3K3FMO_js = require('../chunk-LJ3K3FMO.js');
+require('../chunk-D7VYGB4A.js');
 
 
 
 Object.defineProperty(exports, 'generateCommand', {
 	enumerable: true,
-	get: function () { return chunkTDDRTX7G_js.b; }
+	get: function () { return chunkLJ3K3FMO_js.a; }
 });
 Object.defineProperty(exports, 'initCommand', {
 	enumerable: true,
-	get: function () { return chunkTDDRTX7G_js.a; }
+	get: function () { return chunkLJ3K3FMO_js.b; }
 });
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package/dist/cli/index.mjs

@@ -1,4 +1,4 @@
-export { b as generateCommand, a as initCommand } from '../chunk-KUMMB3O5.mjs';
-import '../chunk-SMHWGAPA.mjs';
+export { a as generateCommand, b as initCommand } from '../chunk-NLSOZGMI.mjs';
+import '../chunk-WHYPHVY6.mjs';
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map

package/dist/index.d.mts

@@ -0,0 +1,291 @@
+import { Compiler } from 'webpack';
+
+interface BaseDefinition {
+    components?: ComponentsObject;
+    externalDocs?: ExternalDocumentationObject;
+    info: InfoObject;
+    openapi: string;
+    paths?: PathsObject;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    tags?: TagObject[];
+}
+
+interface OpenApiObject extends BaseDefinition {
+    paths?: PathsObject;
+}
+
+interface InfoObject {
+    contact?: ContactObject;
+    description?: string;
+    license?: LicenseObject;
+    termsOfService?: string;
+    title: string;
+    version: string;
+}
+
+interface ContactObject {
+    email?: string;
+    name?: string;
+    url?: string;
+}
+
+interface LicenseObject {
+    name: string;
+    url?: string;
+}
+
+interface ServerObject {
+    description?: string;
+    url: string;
+    variables?: Map<ServerVariable>;
+}
+
+interface ServerVariable {
+    default: string;
+    description?: string;
+    enum?: string[];
+}
+
+interface ComponentsObject {
+    callbacks?: Map<CallbackObject | ReferenceObject>;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    links?: Map<LinkObject | ReferenceObject>;
+    parameters?: Map<ParameterObject | ReferenceObject>;
+    requestBodies?: Map<ReferenceObject | RequestBodyObject>;
+    responses?: Map<ReferenceObject | ResponseObject>;
+    schemas?: Map<ReferenceObject | SchemaObject>;
+    securitySchemes?: Map<
+        ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject | ReferenceObject
+    >;
+}
+
+type PathsObject = Record<string, PathItemObject>;
+
+interface PathItemObject {
+    $ref?: string;
+    delete?: OperationObject;
+    description?: string;
+    get?: OperationObject;
+    head?: OperationObject;
+    options?: OperationObject;
+    parameters?: (ParameterObject | ReferenceObject)[];
+    patch?: OperationObject;
+    post?: OperationObject;
+    put?: OperationObject;
+    servers?: ServerObject[];
+    summary?: string;
+    trace?: OperationObject;
+}
+
+interface OperationObject {
+    callbacks?: Map<CallbackObject | ReferenceObject>;
+    deprecated?: boolean;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    operationId?: string;
+    parameters?: (ParameterObject | ReferenceObject)[];
+    requestBody?: ReferenceObject | RequestBodyObject;
+    responses: ResponsesObject;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    summary?: string;
+    tags?: string[];
+}
+
+interface ExternalDocumentationObject {
+    description?: string;
+    url: string;
+}
+
+interface ParameterObject {
+    allowEmptyValue?: boolean;
+    allowReserved?: boolean;
+    //
+    content?: Map<MediaTypeObject>;
+    deprecated?: boolean;
+    description?: string;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    explode?: string;
+    in: string;
+    name: string;
+    required?: boolean;
+    schema?: ReferenceObject | SchemaObject;
+    //
+    style?: string;
+    // ignoring stylings: matrix, label, form, simple, spaceDelimited,
+    // pipeDelimited and deepObject
+}
+
+interface RequestBodyObject {
+    content: Map<MediaTypeObject>;
+    description?: string;
+    required?: boolean;
+}
+
+interface MediaTypeObject {
+    encoding?: Map<EncodingObject>;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    schema?: ReferenceObject | SchemaObject;
+}
+
+interface EncodingObject {
+    allowReserved?: boolean;
+    contentType?: string;
+    explode?: boolean;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    style?: string;
+}
+
+type ResponsesObject = Record<string, ReferenceObject | ResponseObject>;
+
+interface ResponseObject {
+    content?: Map<MediaTypeObject>;
+    description: string;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    links?: Map<LinkObject | ReferenceObject>;
+}
+
+type CallbackObject = Record<string, PathItemObject>;
+
+interface ExampleObject {
+    description?: string;
+    externalValue?: string;
+    summary?: string;
+    value?: any;
+}
+
+interface LinkObject {
+    description?: string;
+    operationId?: string;
+    operationRef?: string;
+    parameters?: Map<any>;
+    requestBody?: any;
+    server?: ServerObject;
+}
+
+interface HeaderObject {
+    allowEmptyValue?: boolean;
+    allowReserved?: boolean;
+    //
+    content?: Map<MediaTypeObject>;
+    deprecated?: boolean;
+    description?: string;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    explode?: string;
+    required?: boolean;
+    schema?: ReferenceObject | SchemaObject;
+    //
+    style?: string;
+    // ignoring stylings: matrix, label, form, simple, spaceDelimited,
+    // pipeDelimited and deepObject
+}
+
+interface TagObject {
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    name: string;
+}
+
+interface ReferenceObject {
+    $ref: string;
+}
+
+// TODO: this could be expanded on.
+type SchemaObject = Record<string, any>;
+
+interface ApiKeySecuritySchemeObject {
+    description?: string;
+    in: string;
+    name: string;
+    type: string;
+}
+
+interface HttpSecuritySchemeObject {
+    bearerFormat?: string;
+    description?: string;
+    scheme: string;
+    type: string;
+}
+
+interface Oauth2SecuritySchemeObject {
+    description?: string;
+    flows: OAuthFlowsObject;
+    type: string;
+}
+
+interface OpenIdConnectSecuritySchemeObject {
+    description?: string;
+    openIdConnectUrl: string;
+    type: string;
+}
+
+interface OAuthFlowsObject {
+    authorizationCode?: OAuthFlowObject;
+    clientCredentials?: OAuthFlowObject;
+    implicit?: OAuthFlowObject;
+    password?: OAuthFlowObject;
+}
+
+interface OAuthFlowObject {
+    authorizationUrl?: string; // required for some?
+    refreshUrl: string;
+    scopes: Map<string>;
+    tokenUrl?: string; // required for some?
+}
+
+type SecurityRequirementObject = Record<string, string[]>;
+
+type Map<T> = Record<string, T>;
+
+declare const commentsToOpenApi$1: (fileContents: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+
+declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[], verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+
+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;
+}
+
+declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
+    loc: number;
+    spec: OpenApiObject;
+}[];
+
+declare const yamlLoc: (string: string) => number;
+
+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?: ReadonlyArray<string> | string;
+        verbose?: boolean;
+    });
+    apply(compiler: Compiler): void;
+}
+
+export { BaseDefinition, OpenApiObject, SpecBuilder, SwaggerCompilerPlugin, commentsToOpenApi$1 as jsDocumentCommentsToOpenApi, parseFile, commentsToOpenApi as swaggerJsDocumentCommentsToOpenApi, yamlLoc };