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

package/dist/cli/commander/index.mjs

@@ -1,30 +1 @@
-import { generate_command_default, init_command_default } from '../../chunk-KI63G47G.mjs';
-import '../../chunk-46IWFMQ2.mjs';
-import { exit } from 'process';
-
-var 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) => {
-    try {
-      await generate_command_default(configName, paths, options);
-    } catch (error) {
-      console.error(error);
-      exit(1);
-    }
-  });
-};
-var generate_command_default2 = generateCommand;
-var initCommand = (program, commandName = "init", description = "Inits a pre-configured @visulima/jsdoc-open-api config file.", configName = ".openapirc.js") => {
-  program.command(commandName).description(description).action(() => {
-    try {
-      init_command_default(configName);
-    } catch (error) {
-      console.error(error);
-      exit(1);
-    }
-  });
-};
-var init_command_default2 = initCommand;
-
-export { generate_command_default2 as generateCommand, init_command_default2 as initCommand };
-//# sourceMappingURL=index.mjs.map
-//# sourceMappingURL=index.mjs.map
+import{default as m}from"../../packem_shared/generateCommand-DEhmHbRZ.mjs";import{default as t}from"../../packem_shared/initCommand-1O6IuWJv.mjs";export{m as generateCommand,t as initCommand};

package/dist/cli/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("../packem_shared/generateCommand-CEP0sWth.cjs"),t=require("../packem_shared/initCommand-DvNH61Z4.cjs");exports.generateCommand=e;exports.initCommand=t;

package/dist/cli/index.d.cts

@@ -0,0 +1,9 @@
+declare const generateCommand: (configName: string, paths: string[], options: {
+  config?: string;
+  definition?: 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.mts

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

package/dist/cli/index.mjs

@@ -1,4 +1 @@
-export { generate_command_default as generateCommand, init_command_default as initCommand } from '../chunk-KI63G47G.mjs';
-import '../chunk-46IWFMQ2.mjs';
-//# sourceMappingURL=index.mjs.map
-//# sourceMappingURL=index.mjs.map
+import{default as m}from"../packem_shared/generateCommand-CkcShFNr.mjs";import{default as t}from"../packem_shared/initCommand-Ca1hGdYS.mjs";export{m as generateCommand,t as initCommand};

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const i=require("./packem_shared/jsDocumentCommentsToOpenApi-CMbdb0uR.cjs"),r=require("./packem_shared/DEFAULT_OPTIONS-CP1lNs-k.cjs"),e=require("./packem_shared/parseFile-CPb-Kglh.cjs"),o=require("./packem_shared/SpecBuilder-C_KcIxW-.cjs"),u=require("./packem_shared/swaggerJsDocumentCommentsToOpenApi-rMEaS4lg.cjs"),l=require("./packem_shared/loadDefinition-ah20Zy-G.cjs"),t=require("./packem_shared/yamlLoc-DC_7PYVS.cjs"),n=require("./packem_shared/validate-DLmCjOPl.cjs"),a=require("./packem_shared/SwaggerCompilerPlugin-Bd9L4Djt.cjs");exports.jsDocumentCommentsToOpenApi=i;exports.DEFAULT_OPTIONS=r;exports.parseFile=e.default;exports.parseFileMulti=e.parseFileMulti;exports.SpecBuilder=o;exports.swaggerJsDocumentCommentsToOpenApi=u;exports.loadDefinition=l;exports.yamlLoc=t;exports.validate=n;exports.SwaggerCompilerPlugin=a;

package/dist/index.d.cts

@@ -0,0 +1,266 @@
+import { Block } from 'comment-parser';
+import 'buffer';
+import 'http';
+import 'https';
+import 'inspector';
+import 'net';
+import 'url';
+import 'vm';
+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;
+}
+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;
+}
+interface TagObject {
+  description?: string;
+  externalDocs?: ExternalDocumentationObject;
+  name: string;
+}
+interface ReferenceObject {
+  $ref: string;
+}
+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;
+  refreshUrl: string;
+  scopes: Map<string>;
+  tokenUrl?: string;
+}
+type SecurityRequirementObject = Record<string, string[]>;
+type Map<T> = Record<string, T>;
+declare const commentsToOpenApi$1: (fileContents: string, verbose?: boolean, comments?: Block[]) => {
+  loc: number;
+  spec: OpenApiObject;
+}[];
+declare const DEFAULT_OPTIONS: {
+  cwd: undefined;
+  exclude: string[];
+  excludeNodeModules: boolean;
+  extension: string[];
+  include: string[];
+  verbose: boolean;
+};
+type CommentsToOpenApi = (fileContent: string, verbose?: boolean, comments?: Block[]) => {
+  loc: number;
+  spec: OpenApiObject;
+}[];
+declare const parseFile$1: (file: string, commentsToOpenApi: CommentsToOpenApi, verbose?: boolean) => {
+  loc: number;
+  spec: OpenApiObject;
+}[];
+declare const parseFileMulti: (file: string, translators: CommentsToOpenApi[], 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, comments?: Block[]) => {
+  loc: number;
+  spec: OpenApiObject;
+}[];
+declare const parseFile: (file: string) => BaseDefinition;
+declare const yamlLoc: (string: string) => number;
+declare const validate: (spec: Record<string, unknown>) => Promise<void>;
+type WebpackCompiler = undefined;
+declare class SwaggerCompilerPlugin {
+  private readonly assetsPath;
+  private readonly ignore;
+  private readonly silent;
+  private readonly sources;
+  private readonly swaggerDefinition;
+  private readonly verbose;
+  constructor(assetsPath: string, sources: string[], swaggerDefinition: BaseDefinition, options: {
+    ignore?: (RegExp | string)[];
+    silent?: boolean;
+    verbose?: boolean;
+  });
+  apply(compiler: WebpackCompiler): void;
+  private log;
+}
+export { type BaseDefinition, type CommentsToOpenApi, DEFAULT_OPTIONS, type OpenApiObject, SpecBuilder, SwaggerCompilerPlugin, commentsToOpenApi$1 as jsDocumentCommentsToOpenApi, parseFile as loadDefinition, parseFile$1 as parseFile, parseFileMulti, commentsToOpenApi as swaggerJsDocumentCommentsToOpenApi, validate, yamlLoc };