@visulima/jsdoc-open-api 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,303 @@
+import { Configuration } from 'webpack';
+
+interface BaseDefinition {
+    openapi: string;
+    info: InfoObject;
+    servers?: ServerObject[];
+    paths?: PathsObject;
+    components?: ComponentsObject;
+    security?: SecurityRequirementObject[];
+    tags?: TagObject[];
+    externalDocs?: ExternalDocumentationObject;
+}
+
+interface OpenApiObject extends BaseDefinition {
+    paths: PathsObject;
+}
+
+interface InfoObject {
+    title: string;
+    version: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: ContactObject;
+    license?: LicenseObject;
+}
+
+interface ContactObject {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+
+interface LicenseObject {
+    name: string;
+    url?: string;
+}
+
+interface ServerObject {
+    url: string;
+    description?: string;
+    variables?: Map<ServerVariable>;
+}
+
+interface ServerVariable {
+    default: string;
+    enum?: string[];
+    description?: string;
+}
+
+interface ComponentsObject {
+    schemas?: Map<SchemaObject | ReferenceObject>;
+    responses?: Map<ResponseObject | ReferenceObject>;
+    parameters?: Map<ParameterObject | ReferenceObject>;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    requestBodies?: Map<RequestBodyObject | ReferenceObject>;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    securitySchemes?: Map<
+    ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject | ReferenceObject
+    >;
+    links?: Map<LinkObject | ReferenceObject>;
+    callbacks?: Map<CallbackObject | ReferenceObject>;
+}
+
+interface PathsObject {
+    [path: string]: PathItemObject;
+}
+
+interface PathItemObject {
+    $ref?: string;
+    summary?: string;
+    description?: string;
+    get?: OperationObject;
+    put?: OperationObject;
+    post?: OperationObject;
+    delete?: OperationObject;
+    options?: OperationObject;
+    head?: OperationObject;
+    patch?: OperationObject;
+    trace?: OperationObject;
+    servers?: ServerObject[];
+    parameters?: (ParameterObject | ReferenceObject)[];
+}
+
+interface OperationObject {
+    responses: ResponsesObject;
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    operationId?: string;
+    parameters?: (ParameterObject | ReferenceObject)[];
+    requestBody?: RequestBodyObject | ReferenceObject;
+    callbacks?: Map<CallbackObject | ReferenceObject>;
+    deprecated?: boolean;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+}
+
+interface ExternalDocumentationObject {
+    url: string;
+    description?: string;
+}
+
+interface ParameterObject {
+    name: string;
+    in: string;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    //
+    style?: string;
+    explode?: string;
+    allowReserved?: boolean;
+    schema?: SchemaObject | ReferenceObject;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    //
+    content?: Map<MediaTypeObject>;
+    // ignoring stylings: matrix, label, form, simple, spaceDelimited,
+    // pipeDelimited and deepObject
+}
+
+interface RequestBodyObject {
+    content: Map<MediaTypeObject>;
+    description?: string;
+    required?: boolean;
+}
+
+interface MediaTypeObject {
+    schema?: SchemaObject | ReferenceObject;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    encoding?: Map<EncodingObject>;
+}
+
+interface EncodingObject {
+    contentType?: string;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+}
+
+interface ResponsesObject {
+    [code: string]: ResponseObject | ReferenceObject;
+}
+
+interface ResponseObject {
+    description: string;
+    headers?: Map<HeaderObject | ReferenceObject>;
+    content?: Map<MediaTypeObject>;
+    links?: Map<LinkObject | ReferenceObject>;
+}
+
+interface CallbackObject {
+    [expression: string]: PathItemObject;
+}
+
+interface ExampleObject {
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: string;
+}
+
+interface LinkObject {
+    operationRef?: string;
+    operationId?: string;
+    parameters?: Map<any>;
+    requestBody?: any;
+    description?: string;
+    server?: ServerObject;
+}
+
+interface HeaderObject {
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    //
+    style?: string;
+    explode?: string;
+    allowReserved?: boolean;
+    schema?: SchemaObject | ReferenceObject;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    //
+    content?: Map<MediaTypeObject>;
+    // ignoring stylings: matrix, label, form, simple, spaceDelimited,
+    // pipeDelimited and deepObject
+}
+
+interface TagObject {
+    name: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+}
+
+interface ReferenceObject {
+    $ref: string;
+}
+
+// TODO: this could be expanded on.
+interface SchemaObject {
+    [key: string]: any;
+}
+
+interface ApiKeySecuritySchemeObject {
+    type: string;
+    description?: string;
+    name: string;
+    in: string;
+}
+
+interface HttpSecuritySchemeObject {
+    type: string;
+    description?: string;
+    scheme: string;
+    bearerFormat?: string;
+}
+
+interface Oauth2SecuritySchemeObject {
+    type: string;
+    description?: string;
+    flows: OAuthFlowsObject;
+}
+
+interface OpenIdConnectSecuritySchemeObject {
+    type: string;
+    description?: string;
+    openIdConnectUrl: string;
+}
+
+interface OAuthFlowsObject {
+    implicit?: OAuthFlowObject;
+    password?: OAuthFlowObject;
+    clientCredentials?: OAuthFlowObject;
+    authorizationCode?: OAuthFlowObject;
+}
+
+interface OAuthFlowObject {
+    authorizationUrl?: string; // required for some?
+    tokenUrl?: string; // required for some?
+    refreshUrl: string;
+    scopes: Map<string>;
+}
+
+interface SecurityRequirementObject {
+    [name: string]: string[];
+}
+
+interface Map<T> {
+    [key: string]: T;
+}
+
+declare class SpecBuilder implements OpenApiObject {
+    openapi: string;
+    info: InfoObject;
+    servers?: ServerObject[];
+    paths: PathsObject;
+    components?: ComponentsObject;
+    security?: SecurityRequirementObject[];
+    tags?: TagObject[];
+    externalDocs?: ExternalDocumentationObject;
+    constructor(baseDefinition: BaseDefinition);
+    addData(parsedFile: OpenApiObject[]): void;
+}
+
+declare const parseFile: (file: string, commentsToOpenApi: (fileContent: string, verbose?: boolean) => {
+    spec: OpenApiObject;
+    loc: number;
+}[], verbose?: boolean) => {
+    spec: OpenApiObject;
+    loc: number;
+}[];
+
+declare function yamlLoc(string: string): number;
+
+declare class SwaggerCompilerPlugin {
+    private readonly swaggerDefinition;
+    private readonly sources;
+    private readonly verbose;
+    private ignore;
+    assetsPath: string;
+    constructor(assetsPath: string, sources: string[], swaggerDefinition: BaseDefinition, options: {
+        verbose?: boolean;
+        ignore?: string | ReadonlyArray<string>;
+    });
+    apply(compiler: Configuration): void;
+}
+
+declare const commentsToOpenApi$1: (fileContents: string, verbose?: boolean) => {
+    spec: OpenApiObject;
+    loc: number;
+}[];
+
+declare const commentsToOpenApi: (fileContents: string, verbose?: boolean) => {
+    spec: OpenApiObject;
+    loc: number;
+}[];
+
+export { BaseDefinition, OpenApiObject, SpecBuilder, SwaggerCompilerPlugin, commentsToOpenApi$1 as jsDocumentCommentsToOpenApi, parseFile, commentsToOpenApi as swaggerJsDocumentCommentsToOpenApi, yamlLoc };