@visulima/jsdoc-open-api 3.0.0-alpha.10 → 3.0.0-alpha.12

package/dist/exported.d.mts

@@ -1,198 +0,0 @@
-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/exported.d.ts

@@ -1,198 +0,0 @@
-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/jsdoc/comments-to-open-api.d.cts

@@ -1,6 +0,0 @@
-import type { OpenApiObject } from "../exported.d.cts";
-declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export = commentsToOpenApi;

package/dist/jsdoc/comments-to-open-api.d.mts

@@ -1,6 +0,0 @@
-import type { OpenApiObject } from "../exported.d.mts";
-declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export default commentsToOpenApi;

package/dist/jsdoc/comments-to-open-api.d.ts

@@ -1,6 +0,0 @@
-import type { OpenApiObject } from "../exported.d.ts";
-declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export = commentsToOpenApi;

package/dist/parse-file.d.cts

@@ -1,9 +0,0 @@
-import type { OpenApiObject } from "./exported.d.cts";
-declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[], verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export = parseFile;

package/dist/parse-file.d.mts

@@ -1,9 +0,0 @@
-import type { OpenApiObject } from "./exported.d.mts";
-declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[], verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export default parseFile;

package/dist/parse-file.d.ts

@@ -1,9 +0,0 @@
-import type { OpenApiObject } from "./exported.d.ts";
-declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[], verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export = parseFile;

package/dist/spec-builder.d.cts

@@ -1,14 +0,0 @@
-import type { BaseDefinition, ComponentsObject, ExternalDocumentationObject, InfoObject, OpenApiObject, PathsObject, SecurityRequirementObject, ServerObject, TagObject } from "./exported.d.cts";
-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;
-}
-export = SpecBuilder;

package/dist/spec-builder.d.mts

@@ -1,14 +0,0 @@
-import type { BaseDefinition, ComponentsObject, ExternalDocumentationObject, InfoObject, OpenApiObject, PathsObject, SecurityRequirementObject, ServerObject, TagObject } from "./exported.d.mts";
-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;
-}
-export default SpecBuilder;

package/dist/spec-builder.d.ts

@@ -1,14 +0,0 @@
-import type { BaseDefinition, ComponentsObject, ExternalDocumentationObject, InfoObject, OpenApiObject, PathsObject, SecurityRequirementObject, ServerObject, TagObject } from "./exported.d.ts";
-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;
-}
-export = SpecBuilder;

package/dist/swagger-jsdoc/comments-to-open-api.d.cts

@@ -1,6 +0,0 @@
-import type { OpenApiObject } from "../exported.d.cts";
-declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export = commentsToOpenApi;

package/dist/swagger-jsdoc/comments-to-open-api.d.mts

@@ -1,6 +0,0 @@
-import type { OpenApiObject } from "../exported.d.mts";
-declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export default commentsToOpenApi;

package/dist/swagger-jsdoc/comments-to-open-api.d.ts

@@ -1,6 +0,0 @@
-import type { OpenApiObject } from "../exported.d.ts";
-declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
-    loc: number;
-    spec: OpenApiObject;
-}[];
-export = commentsToOpenApi;

package/dist/swagger-jsdoc/organize-swagger-object.d.cts

@@ -1,7 +0,0 @@
-/**
- * @param {object} swaggerObject
- * @param {object} annotation
- * @param {string} property
- */
-declare const organizeSwaggerObject: (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string) => void;
-export = organizeSwaggerObject;

package/dist/swagger-jsdoc/organize-swagger-object.d.mts

@@ -1,7 +0,0 @@
-/**
- * @param {object} swaggerObject
- * @param {object} annotation
- * @param {string} property
- */
-declare const organizeSwaggerObject: (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string) => void;
-export default organizeSwaggerObject;

package/dist/swagger-jsdoc/organize-swagger-object.d.ts

@@ -1,7 +0,0 @@
-/**
- * @param {object} swaggerObject
- * @param {object} annotation
- * @param {string} property
- */
-declare const organizeSwaggerObject: (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string) => void;
-export = organizeSwaggerObject;

package/dist/swagger-jsdoc/utils.d.cts

@@ -1,22 +0,0 @@
-import type { Spec } from "comment-parser";
-/**
- * A recursive deep-merge that ignores null values when merging.
- * This returns the merged object and does not mutate.
- * @param first the first object to get merged
- * @param second the second object to get merged
- */
-export declare const mergeDeep: (first?: object, second?: object) => object;
-/**
- * Checks if there is any properties of the input object which are an empty object.
- * @param object the object to check
- * @returns boolean
- */
-export declare const hasEmptyProperty: (object: Record<string, any>) => boolean;
-/**
- * Checks whether the given tag is present in tags.
- * @param tag
- * @param tags
- * @returns boolean
- */
-export declare const isTagPresentInTags: (tag: Spec, tags: Spec[]) => boolean;
-export declare const getSwaggerVersionFromSpec: (tag: Spec) => "v2" | "v3" | "v4";

package/dist/swagger-jsdoc/utils.d.mts

@@ -1,22 +0,0 @@
-import type { Spec } from "comment-parser";
-/**
- * A recursive deep-merge that ignores null values when merging.
- * This returns the merged object and does not mutate.
- * @param first the first object to get merged
- * @param second the second object to get merged
- */
-export declare const mergeDeep: (first?: object, second?: object) => object;
-/**
- * Checks if there is any properties of the input object which are an empty object.
- * @param object the object to check
- * @returns boolean
- */
-export declare const hasEmptyProperty: (object: Record<string, any>) => boolean;
-/**
- * Checks whether the given tag is present in tags.
- * @param tag
- * @param tags
- * @returns boolean
- */
-export declare const isTagPresentInTags: (tag: Spec, tags: Spec[]) => boolean;
-export declare const getSwaggerVersionFromSpec: (tag: Spec) => "v2" | "v3" | "v4";

package/dist/swagger-jsdoc/utils.d.ts

@@ -1,22 +0,0 @@
-import type { Spec } from "comment-parser";
-/**
- * A recursive deep-merge that ignores null values when merging.
- * This returns the merged object and does not mutate.
- * @param first the first object to get merged
- * @param second the second object to get merged
- */
-export declare const mergeDeep: (first?: object, second?: object) => object;
-/**
- * Checks if there is any properties of the input object which are an empty object.
- * @param object the object to check
- * @returns boolean
- */
-export declare const hasEmptyProperty: (object: Record<string, any>) => boolean;
-/**
- * Checks whether the given tag is present in tags.
- * @param tag
- * @param tags
- * @returns boolean
- */
-export declare const isTagPresentInTags: (tag: Spec, tags: Spec[]) => boolean;
-export declare const getSwaggerVersionFromSpec: (tag: Spec) => "v2" | "v3" | "v4";

package/dist/util/customizer.d.cts

@@ -1,2 +0,0 @@
-declare const customizer: (objectValue: unknown, sourceValue: unknown[]) => unknown[] | undefined;
-export = customizer;

package/dist/util/customizer.d.mts

@@ -1,2 +0,0 @@
-declare const customizer: (objectValue: unknown, sourceValue: unknown[]) => unknown[] | undefined;
-export default customizer;

package/dist/util/customizer.d.ts

@@ -1,2 +0,0 @@
-declare const customizer: (objectValue: unknown, sourceValue: unknown[]) => unknown[] | undefined;
-export = customizer;

package/dist/util/object-merge.d.cts

@@ -1,2 +0,0 @@
-declare const objectMerge: <T>(a: T, b: T) => void;
-export = objectMerge;

package/dist/util/object-merge.d.mts

@@ -1,2 +0,0 @@
-declare const objectMerge: <T>(a: T, b: T) => void;
-export default objectMerge;

package/dist/util/object-merge.d.ts

@@ -1,2 +0,0 @@
-declare const objectMerge: <T>(a: T, b: T) => void;
-export = objectMerge;

package/dist/util/yaml-loc.d.cts

@@ -1,2 +0,0 @@
-declare const yamlLoc: (string: string) => number;
-export = yamlLoc;

package/dist/util/yaml-loc.d.mts

@@ -1,2 +0,0 @@
-declare const yamlLoc: (string: string) => number;
-export default yamlLoc;

package/dist/util/yaml-loc.d.ts

@@ -1,2 +0,0 @@
-declare const yamlLoc: (string: string) => number;
-export = yamlLoc;

package/dist/validate.d.cts

@@ -1,2 +0,0 @@
-declare const validate: (spec: Record<string, unknown>) => Promise<void>;
-export = validate;

package/dist/validate.d.mts

@@ -1,2 +0,0 @@
-declare const validate: (spec: Record<string, unknown>) => Promise<void>;
-export default validate;

package/dist/validate.d.ts

@@ -1,2 +0,0 @@
-declare const validate: (spec: Record<string, unknown>) => Promise<void>;
-export = validate;