@visulima/jsdoc-open-api 3.0.0-alpha.11 → 3.0.0-alpha.13

package/dist/cli/commander/index.mjs

@@ -1,2 +1 @@
-export { default as generateCommand } from '../../packem_shared/generateCommand-DRMkfIle.mjs';
-export { default as initCommand } from '../../packem_shared/initCommand-B6Z9EXHP.mjs';
+import{default as m}from"../../packem_shared/generateCommand-Bn19mSDL.mjs";import{default as t}from"../../packem_shared/initCommand-Bm4veOwd.mjs";export{m as generateCommand,t as initCommand};

package/dist/cli/index.cjs

@@ -1,11 +1 @@
-'use strict';
-
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
-
-const generateCommand = require('../packem_shared/generateCommand-MwnCNgEE.cjs');
-const initCommand = require('../packem_shared/initCommand-Ch-72dKZ.cjs');
-
-
-
-exports.generateCommand = generateCommand;
-exports.initCommand = initCommand;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("../packem_shared/generateCommand-DPOEw62Z.cjs"),t=require("../packem_shared/initCommand-CiV7G3q4.cjs");exports.generateCommand=e;exports.initCommand=t;

package/dist/cli/index.d.cts

@@ -1,2 +1,8 @@
-export { default as generateCommand } from "./command/generate-command.d.cts";
-export { default as initCommand } from "./command/init-command.d.cts";
+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.mts

@@ -1,2 +1,8 @@
-export { default as generateCommand } from "./command/generate-command.d.mts";
-export { default as initCommand } from "./command/init-command.d.mts";
+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,2 +1,8 @@
-export { default as generateCommand } from "./command/generate-command.d.ts";
-export { default as initCommand } from "./command/init-command.d.ts";
+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.mjs

@@ -1,2 +1 @@
-export { default as generateCommand } from '../packem_shared/generateCommand-a9_RAbug.mjs';
-export { default as initCommand } from '../packem_shared/initCommand-zE4VRDGW.mjs';
+import{default as m}from"../packem_shared/generateCommand-DLJ2Ac1D.mjs";import{default as t}from"../packem_shared/initCommand-CwoPwelm.mjs";export{m as generateCommand,t as initCommand};

package/dist/index.cjs

@@ -1,19 +1 @@
-'use strict';
-
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
-
-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-BuB7eE94.cjs');
-const yamlLoc = require('./packem_shared/yamlLoc-CEvBiR4K.cjs');
-const SwaggerCompilerPlugin = require('./packem_shared/SwaggerCompilerPlugin-BkYJzU4f.cjs');
-
-
-
-exports.jsDocumentCommentsToOpenApi = jsDocumentCommentsToOpenApi;
-exports.parseFile = parseFile;
-exports.SpecBuilder = SpecBuilder;
-exports.swaggerJsDocumentCommentsToOpenApi = swaggerJsDocumentCommentsToOpenApi;
-exports.yamlLoc = yamlLoc;
-exports.SwaggerCompilerPlugin = SwaggerCompilerPlugin;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./packem_shared/jsDocumentCommentsToOpenApi-DBYlHL5i.cjs"),r=require("./packem_shared/parseFile-C7tyTcIn.cjs"),i=require("./packem_shared/SpecBuilder-CR4EZk93.cjs"),o=require("./packem_shared/swaggerJsDocumentCommentsToOpenApi-Bo1geBuG.cjs"),u=require("./packem_shared/yamlLoc-DyGcp8YC.cjs"),m=require("./packem_shared/SwaggerCompilerPlugin-lwIg0m84.cjs");exports.jsDocumentCommentsToOpenApi=e;exports.parseFile=r;exports.SpecBuilder=i;exports.swaggerJsDocumentCommentsToOpenApi=o;exports.yamlLoc=u;exports.SwaggerCompilerPlugin=m;

package/dist/index.d.cts

@@ -1,7 +1,247 @@
-export type { BaseDefinition, OpenApiObject } from "./exported.d.cts";
-export { default as jsDocumentCommentsToOpenApi } from "./jsdoc/comments-to-open-api.d.cts";
-export { default as parseFile } from "./parse-file.d.cts";
-export { default as SpecBuilder } from "./spec-builder.d.cts";
-export { default as swaggerJsDocumentCommentsToOpenApi } from "./swagger-jsdoc/comments-to-open-api.d.cts";
-export { default as yamlLoc } from "./util/yaml-loc.d.cts";
-export { default as SwaggerCompilerPlugin } from "./webpack/swagger-compiler-plugin.d.cts";
+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) => {
+  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;
+type WebpackCompiler = undefined;
+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: WebpackCompiler): void;
+}
+export { type BaseDefinition, type OpenApiObject, SpecBuilder, SwaggerCompilerPlugin, commentsToOpenApi$1 as jsDocumentCommentsToOpenApi, parseFile, commentsToOpenApi as swaggerJsDocumentCommentsToOpenApi, yamlLoc };

package/dist/index.d.mts

@@ -1,7 +1,247 @@
-export type { BaseDefinition, OpenApiObject } from "./exported.d.mts";
-export { default as jsDocumentCommentsToOpenApi } from "./jsdoc/comments-to-open-api.d.mts";
-export { default as parseFile } from "./parse-file.d.mts";
-export { default as SpecBuilder } from "./spec-builder.d.mts";
-export { default as swaggerJsDocumentCommentsToOpenApi } from "./swagger-jsdoc/comments-to-open-api.d.mts";
-export { default as yamlLoc } from "./util/yaml-loc.d.mts";
-export { default as SwaggerCompilerPlugin } from "./webpack/swagger-compiler-plugin.d.mts";
+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) => {
+  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;
+type WebpackCompiler = undefined;
+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: WebpackCompiler): void;
+}
+export { type BaseDefinition, type OpenApiObject, SpecBuilder, SwaggerCompilerPlugin, commentsToOpenApi$1 as jsDocumentCommentsToOpenApi, parseFile, commentsToOpenApi as swaggerJsDocumentCommentsToOpenApi, yamlLoc };