@trapi/swagger 1.0.0-alpha.11 → 1.0.0-alpha.12

package/dist/config/index.d.ts

@@ -1,3 +1,3 @@
-export * from './type';
-export * from './utils';
+export * from './type';
+export * from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/config/index.js

@@ -1,25 +1,25 @@
-"use strict";
-/*
- * Copyright (c) 2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./type"), exports);
-__exportStar(require("./utils"), exports);
+"use strict";
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./type"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/config/type.d.ts

@@ -1,83 +1,83 @@
-import type { CollectionFormat, Metadata, Options as MetadataOptions } from '@trapi/metadata';
-import type { SecurityDefinitions } from '../type';
-export type ServerOption = {
-    url: string;
-    description?: string;
-};
-export interface Options {
-    /**
-     * Generate a yaml file
-     */
-    yaml?: boolean;
-    /**
-     * Specify if an output file should be generated.
-     *
-     * default: true
-     */
-    output: boolean;
-    /**
-     * Generated swagger.{json|yaml} will output here.
-     *
-     * default: process.cwd()
-     */
-    outputDirectory: string;
-    /**
-     * Generated documentation base file name.
-     *
-     * default: swagger
-     */
-    outputFileName: string;
-    /**
-     * API host, expressTemplate.g. localhost:3000 or https://myapi.com
-     */
-    servers?: ServerOption[];
-    /**
-     * Metadata options or metadata itself.
-     */
-    metadata?: MetadataOptions | Metadata;
-    /**
-     * API version number; defaults to npm package version
-     */
-    version?: string;
-    /**
-     * API name; defaults to npm package name
-     */
-    name?: string;
-    /**
-     * 'API description; defaults to npm package description
-     */
-    description?: string;
-    /**
-     * API license; defaults to npm package license
-     */
-    license?: string;
-    /**
-     * Extend generated swagger spec with this object
-     * Note that generated properties will always take precedence over what get specified here
-     */
-    specificationExtra?: Record<string, any>;
-    /**
-     * Security Definitions Object
-     * A declaration of the security schemes available to be used in the
-     * specification. This does not enforce the security schemes on the operations
-     * and only serves to provide the relevant details for each scheme.
-     */
-    securityDefinitions?: SecurityDefinitions;
-    /**
-     * Default consumes property for the entire API
-     */
-    consumes?: string[];
-    /**
-     * Default produces property for the entire API
-     */
-    produces?: string[];
-    /**
-     * Default collectionFormat property for query parameters of array type.
-     * Possible values are `csv`, `ssv`, `tsv`, `pipes`, `multi`. If not specified, Swagger defaults to `csv`.
-     */
-    collectionFormat?: `${CollectionFormat}`;
-}
-export type OptionsInput = Omit<Partial<Options>, 'servers'> & {
-    servers?: string | string[] | ServerOption | ServerOption[];
-};
+import type { CollectionFormat, Metadata, Options as MetadataOptions } from '@trapi/metadata';
+import type { SecurityDefinitions } from '../type';
+export type ServerOption = {
+    url: string;
+    description?: string;
+};
+export interface Options {
+    /**
+     * Generate a yaml file
+     */
+    yaml?: boolean;
+    /**
+     * Specify if an output file should be generated.
+     *
+     * default: true
+     */
+    output: boolean;
+    /**
+     * Generated swagger.{json|yaml} will output here.
+     *
+     * default: process.cwd()
+     */
+    outputDirectory: string;
+    /**
+     * Generated documentation base file name.
+     *
+     * default: swagger
+     */
+    outputFileName: string;
+    /**
+     * API host, expressTemplate.g. localhost:3000 or https://myapi.com
+     */
+    servers?: ServerOption[];
+    /**
+     * Metadata options or metadata itself.
+     */
+    metadata?: MetadataOptions | Metadata;
+    /**
+     * API version number; defaults to npm package version
+     */
+    version?: string;
+    /**
+     * API name; defaults to npm package name
+     */
+    name?: string;
+    /**
+     * 'API description; defaults to npm package description
+     */
+    description?: string;
+    /**
+     * API license; defaults to npm package license
+     */
+    license?: string;
+    /**
+     * Extend generated swagger spec with this object
+     * Note that generated properties will always take precedence over what get specified here
+     */
+    specificationExtra?: Record<string, any>;
+    /**
+     * Security Definitions Object
+     * A declaration of the security schemes available to be used in the
+     * specification. This does not enforce the security schemes on the operations
+     * and only serves to provide the relevant details for each scheme.
+     */
+    securityDefinitions?: SecurityDefinitions;
+    /**
+     * Default consumes property for the entire API
+     */
+    consumes?: string[];
+    /**
+     * Default produces property for the entire API
+     */
+    produces?: string[];
+    /**
+     * Default collectionFormat property for query parameters of array type.
+     * Possible values are `csv`, `ssv`, `tsv`, `pipes`, `multi`. If not specified, Swagger defaults to `csv`.
+     */
+    collectionFormat?: `${CollectionFormat}`;
+}
+export type OptionsInput = Omit<Partial<Options>, 'servers'> & {
+    servers?: string | string[] | ServerOption | ServerOption[];
+};
 //# sourceMappingURL=type.d.ts.map

package/dist/config/type.js

@@ -1,9 +1,9 @@
-"use strict";
-/*
- * Copyright (c) 2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=type.js.map

package/dist/config/utils.d.ts

@@ -1,3 +1,3 @@
-import type { Options, OptionsInput } from './type';
-export declare function buildOptions(input: OptionsInput): Options;
+import type { Options, OptionsInput } from './type';
+export declare function buildOptions(input: OptionsInput): Options;
 //# sourceMappingURL=utils.d.ts.map

package/dist/config/utils.js

@@ -1,54 +1,54 @@
-"use strict";
-/*
- * Copyright (c) 2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildOptions = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const node_process_1 = __importDefault(require("node:process"));
-function buildOptions(input) {
-    const servers = [];
-    if (input.servers) {
-        if (Array.isArray(input.servers)) {
-            for (let i = 0; i < input.servers.length; i++) {
-                const server = input.servers[i];
-                if (typeof server === 'string') {
-                    servers.push({ url: server });
-                }
-                else {
-                    servers.push(server);
-                }
-            }
-        }
-        else if (typeof input.servers === 'string') {
-            servers.push({ url: input.servers });
-        }
-        else {
-            servers.push(input.servers);
-        }
-    }
-    let outputDirectory;
-    if (input.outputDirectory) {
-        outputDirectory = node_path_1.default.isAbsolute(input.outputDirectory) ?
-            input.outputDirectory :
-            node_path_1.default.join(node_process_1.default.cwd(), input.outputDirectory);
-    }
-    else {
-        outputDirectory = node_process_1.default.cwd();
-    }
-    return {
-        ...input,
-        output: input.output ?? true,
-        outputDirectory,
-        outputFileName: input.outputFileName || 'swagger',
-        servers,
-    };
-}
-exports.buildOptions = buildOptions;
+"use strict";
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildOptions = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_process_1 = __importDefault(require("node:process"));
+function buildOptions(input) {
+    const servers = [];
+    if (input.servers) {
+        if (Array.isArray(input.servers)) {
+            for (let i = 0; i < input.servers.length; i++) {
+                const server = input.servers[i];
+                if (typeof server === 'string') {
+                    servers.push({ url: server });
+                }
+                else {
+                    servers.push(server);
+                }
+            }
+        }
+        else if (typeof input.servers === 'string') {
+            servers.push({ url: input.servers });
+        }
+        else {
+            servers.push(input.servers);
+        }
+    }
+    let outputDirectory;
+    if (input.outputDirectory) {
+        outputDirectory = node_path_1.default.isAbsolute(input.outputDirectory) ?
+            input.outputDirectory :
+            node_path_1.default.join(node_process_1.default.cwd(), input.outputDirectory);
+    }
+    else {
+        outputDirectory = node_process_1.default.cwd();
+    }
+    return {
+        ...input,
+        output: input.output ?? true,
+        outputDirectory,
+        outputFileName: input.outputFileName || 'swagger',
+        servers,
+    };
+}
+exports.buildOptions = buildOptions;
 //# sourceMappingURL=utils.js.map

package/dist/constants.d.ts

@@ -1,15 +1,15 @@
-export declare enum Version {
-    V2 = "v2",
-    V3 = "v3"
-}
-export declare enum DocumentFormat {
-    YAML = "yaml",
-    JSON = "json"
-}
-export declare enum SecurityType {
-    API_KEY = "apiKey",
-    BASIC = "basic",
-    HTTP = "http",
-    OAUTH2 = "oauth2"
-}
+export declare enum Version {
+    V2 = "v2",
+    V3 = "v3"
+}
+export declare enum DocumentFormat {
+    YAML = "yaml",
+    JSON = "json"
+}
+export declare enum SecurityType {
+    API_KEY = "apiKey",
+    BASIC = "basic",
+    HTTP = "http",
+    OAUTH2 = "oauth2"
+}
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,27 +1,27 @@
-"use strict";
-/*
- * Copyright (c) 2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecurityType = exports.DocumentFormat = exports.Version = void 0;
-var Version;
-(function (Version) {
-    Version["V2"] = "v2";
-    Version["V3"] = "v3";
-})(Version = exports.Version || (exports.Version = {}));
-var DocumentFormat;
-(function (DocumentFormat) {
-    DocumentFormat["YAML"] = "yaml";
-    DocumentFormat["JSON"] = "json";
-})(DocumentFormat = exports.DocumentFormat || (exports.DocumentFormat = {}));
-var SecurityType;
-(function (SecurityType) {
-    SecurityType["API_KEY"] = "apiKey";
-    SecurityType["BASIC"] = "basic";
-    SecurityType["HTTP"] = "http";
-    SecurityType["OAUTH2"] = "oauth2";
-})(SecurityType = exports.SecurityType || (exports.SecurityType = {}));
+"use strict";
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityType = exports.DocumentFormat = exports.Version = void 0;
+var Version;
+(function (Version) {
+    Version["V2"] = "v2";
+    Version["V3"] = "v3";
+})(Version = exports.Version || (exports.Version = {}));
+var DocumentFormat;
+(function (DocumentFormat) {
+    DocumentFormat["YAML"] = "yaml";
+    DocumentFormat["JSON"] = "json";
+})(DocumentFormat = exports.DocumentFormat || (exports.DocumentFormat = {}));
+var SecurityType;
+(function (SecurityType) {
+    SecurityType["API_KEY"] = "apiKey";
+    SecurityType["BASIC"] = "basic";
+    SecurityType["HTTP"] = "http";
+    SecurityType["OAUTH2"] = "oauth2";
+})(SecurityType = exports.SecurityType || (exports.SecurityType = {}));
 //# sourceMappingURL=constants.js.map

package/dist/generator/abstract.d.ts

@@ -1,35 +1,35 @@
-import type { BaseType, EnumType, Extension, IntersectionType, Metadata, NestedObjectLiteralType, Parameter, ParameterSource, RefAliasType, RefEnumType, RefObjectType, ReferenceType, ResolverProperty, UnionType, Validators, VariableType } from '@trapi/metadata';
-import type { Options, OptionsInput } from '../config';
-import type { DocumentFormat } from '../constants';
-import type { DocumentFormatData } from '../type';
-import type { BaseSchema, Info, SchemaV2, SchemaV3, SpecV2, SpecV3 } from '../schema';
-export declare abstract class AbstractSpecGenerator<Spec extends SpecV2 | SpecV3, Schema extends SchemaV3 | SchemaV2> {
-    protected spec: Spec | undefined;
-    protected readonly metadata: Metadata;
-    protected readonly config: Options;
-    constructor(metadata: Metadata, config: OptionsInput);
-    save(): Promise<Record<`${DocumentFormat}`, DocumentFormatData>>;
-    abstract build(): Promise<Spec>;
-    protected buildInfo(): Info;
-    protected getSchemaForType(type: BaseType): Schema | BaseSchema<Schema>;
-    protected abstract getSchemaForIntersectionType(type: IntersectionType): Schema;
-    protected abstract getSchemaForEnumType(enumType: EnumType): Schema;
-    private getSchemaForPrimitiveType;
-    private getSchemaForArrayType;
-    getSchemaForObjectLiteralType(objectLiteral: NestedObjectLiteralType): BaseSchema<Schema>;
-    protected abstract getSchemaForReferenceType(referenceType: ReferenceType): Schema;
-    protected abstract getSchemaForUnionType(type: UnionType): Schema;
-    protected abstract buildSchemaForRefAlias(referenceType: RefAliasType): Schema;
-    protected abstract buildSchemaForRefEnum(referenceType: RefEnumType): Schema;
-    protected abstract buildSchemaForRefObject(referenceType: RefObjectType): Schema;
-    protected buildSchemasForReferenceTypes(extendFn?: (output: Schema, input: ReferenceType) => void): Record<string, Schema>;
-    protected isUndefinedProperty(input: ResolverProperty): boolean;
-    protected abstract buildProperties(properties: ResolverProperty[]): Record<string, Schema>;
-    protected determineTypesUsedInEnum(anEnum: Array<string | number | boolean | null>): VariableType[];
-    protected decideEnumType(input: Array<string | number | boolean>): 'string' | 'number' | 'boolean';
-    protected getOperationId(name: string): string;
-    protected groupParameters(items: Parameter[]): Partial<Record<ParameterSource, Parameter[]>>;
-    protected transformExtensions(input?: Extension[]): Record<string, any>;
-    protected transformValidators(input?: Validators): Record<string, any>;
-}
+import type { BaseType, EnumType, Extension, IntersectionType, Metadata, NestedObjectLiteralType, Parameter, ParameterSource, RefAliasType, RefEnumType, RefObjectType, ReferenceType, ResolverProperty, UnionType, Validators, VariableType } from '@trapi/metadata';
+import type { Options, OptionsInput } from '../config';
+import type { DocumentFormat } from '../constants';
+import type { DocumentFormatData } from '../type';
+import type { BaseSchema, Info, SchemaV2, SchemaV3, SpecV2, SpecV3 } from '../schema';
+export declare abstract class AbstractSpecGenerator<Spec extends SpecV2 | SpecV3, Schema extends SchemaV3 | SchemaV2> {
+    protected spec: Spec | undefined;
+    protected readonly metadata: Metadata;
+    protected readonly config: Options;
+    constructor(metadata: Metadata, config: OptionsInput);
+    save(): Promise<Record<`${DocumentFormat}`, DocumentFormatData>>;
+    abstract build(): Promise<Spec>;
+    protected buildInfo(): Info;
+    protected getSchemaForType(type: BaseType): Schema | BaseSchema<Schema>;
+    protected abstract getSchemaForIntersectionType(type: IntersectionType): Schema;
+    protected abstract getSchemaForEnumType(enumType: EnumType): Schema;
+    private getSchemaForPrimitiveType;
+    private getSchemaForArrayType;
+    getSchemaForObjectLiteralType(objectLiteral: NestedObjectLiteralType): BaseSchema<Schema>;
+    protected abstract getSchemaForReferenceType(referenceType: ReferenceType): Schema;
+    protected abstract getSchemaForUnionType(type: UnionType): Schema;
+    protected abstract buildSchemaForRefAlias(referenceType: RefAliasType): Schema;
+    protected abstract buildSchemaForRefEnum(referenceType: RefEnumType): Schema;
+    protected abstract buildSchemaForRefObject(referenceType: RefObjectType): Schema;
+    protected buildSchemasForReferenceTypes(extendFn?: (output: Schema, input: ReferenceType) => void): Record<string, Schema>;
+    protected isUndefinedProperty(input: ResolverProperty): boolean;
+    protected abstract buildProperties(properties: ResolverProperty[]): Record<string, Schema>;
+    protected determineTypesUsedInEnum(anEnum: Array<string | number | boolean | null>): VariableType[];
+    protected decideEnumType(input: Array<string | number | boolean>): 'string' | 'number' | 'boolean';
+    protected getOperationId(name: string): string;
+    protected groupParameters(items: Parameter[]): Partial<Record<ParameterSource, Parameter[]>>;
+    protected transformExtensions(input?: Extension[]): Record<string, any>;
+    protected transformValidators(input?: Validators): Record<string, any>;
+}
 //# sourceMappingURL=abstract.d.ts.map