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

package/dist/index.d.mts

@@ -1,248 +1,266 @@
-import { Compiler } from 'webpack';
-
+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[];
+  components?: ComponentsObject;
+  externalDocs?: ExternalDocumentationObject;
+  info: InfoObject;
+  openapi: string;
+  paths?: PathsObject;
+  security?: SecurityRequirementObject[];
+  servers?: ServerObject[];
+  tags?: TagObject[];
 }
 interface OpenApiObject extends BaseDefinition {
-    paths?: PathsObject;
+  paths?: PathsObject;
 }
 interface InfoObject {
-    contact?: ContactObject;
-    description?: string;
-    license?: LicenseObject;
-    termsOfService?: string;
-    title: string;
-    version: string;
+  contact?: ContactObject;
+  description?: string;
+  license?: LicenseObject;
+  termsOfService?: string;
+  title: string;
+  version: string;
 }
 interface ContactObject {
-    email?: string;
-    name?: string;
-    url?: string;
+  email?: string;
+  name?: string;
+  url?: string;
 }
 interface LicenseObject {
-    name: string;
-    url?: string;
+  name: string;
+  url?: string;
 }
 interface ServerObject {
-    description?: string;
-    url: string;
-    variables?: Map<ServerVariable>;
+  description?: string;
+  url: string;
+  variables?: Map<ServerVariable>;
 }
 interface ServerVariable {
-    default: string;
-    description?: string;
-    enum?: string[];
+  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>;
+  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;
+  $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[];
+  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;
+  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;
+  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;
+  content: Map<MediaTypeObject>;
+  description?: string;
+  required?: boolean;
 }
 interface MediaTypeObject {
-    encoding?: Map<EncodingObject>;
-    example?: any;
-    examples?: Map<ExampleObject | ReferenceObject>;
-    schema?: ReferenceObject | SchemaObject;
+  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;
+  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>;
+  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;
+  description?: string;
+  externalValue?: string;
+  summary?: string;
+  value?: any;
 }
 interface LinkObject {
-    description?: string;
-    operationId?: string;
-    operationRef?: string;
-    parameters?: Map<any>;
-    requestBody?: any;
-    server?: ServerObject;
+  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;
+  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;
+  description?: string;
+  externalDocs?: ExternalDocumentationObject;
+  name: string;
 }
 interface ReferenceObject {
-    $ref: string;
+  $ref: string;
 }
 type SchemaObject = Record<string, any>;
 interface ApiKeySecuritySchemeObject {
-    description?: string;
-    in: string;
-    name: string;
-    type: string;
+  description?: string;
+  in: string;
+  name: string;
+  type: string;
 }
 interface HttpSecuritySchemeObject {
-    bearerFormat?: string;
-    description?: string;
-    scheme: string;
-    type: string;
+  bearerFormat?: string;
+  description?: string;
+  scheme: string;
+  type: string;
 }
 interface Oauth2SecuritySchemeObject {
-    description?: string;
-    flows: OAuthFlowsObject;
-    type: string;
+  description?: string;
+  flows: OAuthFlowsObject;
+  type: string;
 }
 interface OpenIdConnectSecuritySchemeObject {
-    description?: string;
-    openIdConnectUrl: string;
-    type: string;
+  description?: string;
+  openIdConnectUrl: string;
+  type: string;
 }
 interface OAuthFlowsObject {
-    authorizationCode?: OAuthFlowObject;
-    clientCredentials?: OAuthFlowObject;
-    implicit?: OAuthFlowObject;
-    password?: OAuthFlowObject;
+  authorizationCode?: OAuthFlowObject;
+  clientCredentials?: OAuthFlowObject;
+  implicit?: OAuthFlowObject;
+  password?: OAuthFlowObject;
 }
 interface OAuthFlowObject {
-    authorizationUrl?: string;
-    refreshUrl: string;
-    scopes: Map<string>;
-    tokenUrl?: string;
+  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 commentsToOpenApi$1: (fileContents: string, verbose?: boolean, comments?: Block[]) => {
+  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 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) => {
-    loc: number;
-    spec: 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 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 { type BaseDefinition, type OpenApiObject, SpecBuilder, SwaggerCompilerPlugin, commentsToOpenApi$1 as jsDocumentCommentsToOpenApi, parseFile, commentsToOpenApi as swaggerJsDocumentCommentsToOpenApi, yamlLoc };
+  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 };