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

package/dist/exported.d.ts

@@ -0,0 +1,198 @@
+export interface BaseDefinition {
+    components?: ComponentsObject;
+    externalDocs?: ExternalDocumentationObject;
+    info: InfoObject;
+    openapi: string;
+    paths?: PathsObject;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    tags?: TagObject[];
+}
+export interface OpenApiObject extends BaseDefinition {
+    paths?: PathsObject;
+}
+export interface InfoObject {
+    contact?: ContactObject;
+    description?: string;
+    license?: LicenseObject;
+    termsOfService?: string;
+    title: string;
+    version: string;
+}
+export interface ContactObject {
+    email?: string;
+    name?: string;
+    url?: string;
+}
+export interface LicenseObject {
+    name: string;
+    url?: string;
+}
+export interface ServerObject {
+    description?: string;
+    url: string;
+    variables?: Map<ServerVariable>;
+}
+export interface ServerVariable {
+    default: string;
+    description?: string;
+    enum?: string[];
+}
+export 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>;
+}
+export type PathsObject = Record<string, PathItemObject>;
+export 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;
+}
+export 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[];
+}
+export interface ExternalDocumentationObject {
+    description?: string;
+    url: string;
+}
+export 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;
+}
+export interface RequestBodyObject {
+    content: Map<MediaTypeObject>;
+    description?: string;
+    required?: boolean;
+}
+export interface MediaTypeObject {
+    encoding?: Map<EncodingObject>;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    schema?: ReferenceObject | SchemaObject;
+}
+export interface EncodingObject {
+    allowReserved?: boolean;
+    contentType?: string;
+    explode?: boolean;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    style?: string;
+}
+export type ResponsesObject = Record<string, ReferenceObject | ResponseObject>;
+export interface ResponseObject {
+    content?: Map<MediaTypeObject>;
+    description: string;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    links?: Map<LinkObject | ReferenceObject>;
+}
+export type CallbackObject = Record<string, PathItemObject>;
+export interface ExampleObject {
+    description?: string;
+    externalValue?: string;
+    summary?: string;
+    value?: any;
+}
+export interface LinkObject {
+    description?: string;
+    operationId?: string;
+    operationRef?: string;
+    parameters?: Map<any>;
+    requestBody?: any;
+    server?: ServerObject;
+}
+export 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;
+}
+export interface TagObject {
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    name: string;
+}
+export interface ReferenceObject {
+    $ref: string;
+}
+export type SchemaObject = Record<string, any>;
+export interface ApiKeySecuritySchemeObject {
+    description?: string;
+    in: string;
+    name: string;
+    type: string;
+}
+export interface HttpSecuritySchemeObject {
+    bearerFormat?: string;
+    description?: string;
+    scheme: string;
+    type: string;
+}
+export interface Oauth2SecuritySchemeObject {
+    description?: string;
+    flows: OAuthFlowsObject;
+    type: string;
+}
+export interface OpenIdConnectSecuritySchemeObject {
+    description?: string;
+    openIdConnectUrl: string;
+    type: string;
+}
+export interface OAuthFlowsObject {
+    authorizationCode?: OAuthFlowObject;
+    clientCredentials?: OAuthFlowObject;
+    implicit?: OAuthFlowObject;
+    password?: OAuthFlowObject;
+}
+export interface OAuthFlowObject {
+    authorizationUrl?: string;
+    refreshUrl: string;
+    scopes: Map<string>;
+    tokenUrl?: string;
+}
+export type SecurityRequirementObject = Record<string, string[]>;
+export type Map<T> = Record<string, T>;

package/dist/index.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+
+const jsDocumentCommentsToOpenApi = require('./packem_shared/jsDocumentCommentsToOpenApi-C8kxIQH2.cjs');
+const parseFile = require('./packem_shared/parseFile-BJwu_na4.cjs');
+const SpecBuilder = require('./packem_shared/SpecBuilder-CCESkmm5.cjs');
+const swaggerJsDocumentCommentsToOpenApi = require('./packem_shared/swaggerJsDocumentCommentsToOpenApi-JFymRz50.cjs');
+const yamlLoc = require('./packem_shared/yamlLoc-BLoIYoXs.cjs');
+const SwaggerCompilerPlugin = require('./packem_shared/SwaggerCompilerPlugin-BHbHAPK-.cjs');
+
+
+
+exports.jsDocumentCommentsToOpenApi = jsDocumentCommentsToOpenApi;
+exports.parseFile = parseFile;
+exports.SpecBuilder = SpecBuilder;
+exports.swaggerJsDocumentCommentsToOpenApi = swaggerJsDocumentCommentsToOpenApi;
+exports.yamlLoc = yamlLoc;
+exports.SwaggerCompilerPlugin = SwaggerCompilerPlugin;

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+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";

package/dist/index.d.mts

@@ -1,248 +1,7 @@
-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;
-}
-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;
-
-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 };
+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";