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

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-export * from './config';
-export * from './constants';
-export * from './metadata';
-export * from './generator';
-export * from './schema';
-export * from './type';
-export * from './utils';
+export * from './config';
+export * from './constants';
+export * from './metadata';
+export * from './generator';
+export * from './schema';
+export * from './type';
+export * from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,30 +1,30 @@
-"use strict";
-/*
- * Copyright (c) 2021.
- * 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("./config"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./metadata"), exports);
-__exportStar(require("./generator"), exports);
-__exportStar(require("./schema"), exports);
-__exportStar(require("./type"), exports);
-__exportStar(require("./utils"), exports);
+"use strict";
+/*
+ * Copyright (c) 2021.
+ * 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("./config"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./metadata"), exports);
+__exportStar(require("./generator"), exports);
+__exportStar(require("./schema"), exports);
+__exportStar(require("./type"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/metadata.d.ts

@@ -1,4 +1,4 @@
-import { DecoratorConfig, DecoratorID, Metadata, Options as MetadataOptions, PresetSchema, TsCompilerOptions, TsConfig, generateMetadata, isMetadata } from '@trapi/metadata';
-import type { CacheOptions } from '@trapi/metadata';
-export { DecoratorConfig, DecoratorID, generateMetadata, isMetadata, CacheOptions, Metadata, MetadataOptions, PresetSchema, TsCompilerOptions, TsConfig, };
+import { DecoratorConfig, DecoratorID, Metadata, Options as MetadataOptions, PresetSchema, TsCompilerOptions, TsConfig, generateMetadata, isMetadata } from '@trapi/metadata';
+import type { CacheOptions } from '@trapi/metadata';
+export { DecoratorConfig, DecoratorID, generateMetadata, isMetadata, CacheOptions, Metadata, MetadataOptions, PresetSchema, TsCompilerOptions, TsConfig, };
 //# sourceMappingURL=metadata.d.ts.map

package/dist/metadata.js

@@ -1,14 +1,14 @@
-"use strict";
-/*
- * Copyright (c) 2021.
- * 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.isMetadata = exports.generateMetadata = exports.DecoratorID = void 0;
-const metadata_1 = require("@trapi/metadata");
-Object.defineProperty(exports, "DecoratorID", { enumerable: true, get: function () { return metadata_1.DecoratorID; } });
-Object.defineProperty(exports, "generateMetadata", { enumerable: true, get: function () { return metadata_1.generateMetadata; } });
-Object.defineProperty(exports, "isMetadata", { enumerable: true, get: function () { return metadata_1.isMetadata; } });
+"use strict";
+/*
+ * Copyright (c) 2021.
+ * 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.isMetadata = exports.generateMetadata = exports.DecoratorID = void 0;
+const metadata_1 = require("@trapi/metadata");
+Object.defineProperty(exports, "DecoratorID", { enumerable: true, get: function () { return metadata_1.DecoratorID; } });
+Object.defineProperty(exports, "generateMetadata", { enumerable: true, get: function () { return metadata_1.generateMetadata; } });
+Object.defineProperty(exports, "isMetadata", { enumerable: true, get: function () { return metadata_1.isMetadata; } });
 //# sourceMappingURL=metadata.js.map

package/dist/schema/constants.d.ts

@@ -1,28 +1,28 @@
-export declare enum TransferProtocol {
-    HTTP = "http",
-    HTTPS = "https",
-    WS = "ws",
-    WSS = "wss"
-}
-export declare enum DataFormatName {
-    INT_32 = "int32",
-    INT_64 = "int64",
-    FLOAT = "float",
-    DOUBLE = "double",
-    BYTE = "byte",
-    BINARY = "binary",
-    DATE = "date",
-    DATE_TIME = "date-time",
-    PASSWORD = "password"
-}
-export declare enum DataTypeName {
-    VOID = "void",
-    INTEGER = "integer",
-    NUMBER = "number",
-    BOOLEAN = "boolean",
-    STRING = "string",
-    ARRAY = "array",
-    OBJECT = "object",
-    FILE = "file"
-}
+export declare enum TransferProtocol {
+    HTTP = "http",
+    HTTPS = "https",
+    WS = "ws",
+    WSS = "wss"
+}
+export declare enum DataFormatName {
+    INT_32 = "int32",
+    INT_64 = "int64",
+    FLOAT = "float",
+    DOUBLE = "double",
+    BYTE = "byte",
+    BINARY = "binary",
+    DATE = "date",
+    DATE_TIME = "date-time",
+    PASSWORD = "password"
+}
+export declare enum DataTypeName {
+    VOID = "void",
+    INTEGER = "integer",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    STRING = "string",
+    ARRAY = "array",
+    OBJECT = "object",
+    FILE = "file"
+}
 //# sourceMappingURL=constants.d.ts.map

package/dist/schema/constants.js

@@ -1,40 +1,40 @@
-"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.DataTypeName = exports.DataFormatName = exports.TransferProtocol = void 0;
-var TransferProtocol;
-(function (TransferProtocol) {
-    TransferProtocol["HTTP"] = "http";
-    TransferProtocol["HTTPS"] = "https";
-    TransferProtocol["WS"] = "ws";
-    TransferProtocol["WSS"] = "wss";
-})(TransferProtocol = exports.TransferProtocol || (exports.TransferProtocol = {}));
-var DataFormatName;
-(function (DataFormatName) {
-    DataFormatName["INT_32"] = "int32";
-    DataFormatName["INT_64"] = "int64";
-    DataFormatName["FLOAT"] = "float";
-    DataFormatName["DOUBLE"] = "double";
-    DataFormatName["BYTE"] = "byte";
-    DataFormatName["BINARY"] = "binary";
-    DataFormatName["DATE"] = "date";
-    DataFormatName["DATE_TIME"] = "date-time";
-    DataFormatName["PASSWORD"] = "password";
-})(DataFormatName = exports.DataFormatName || (exports.DataFormatName = {}));
-var DataTypeName;
-(function (DataTypeName) {
-    DataTypeName["VOID"] = "void";
-    DataTypeName["INTEGER"] = "integer";
-    DataTypeName["NUMBER"] = "number";
-    DataTypeName["BOOLEAN"] = "boolean";
-    DataTypeName["STRING"] = "string";
-    DataTypeName["ARRAY"] = "array";
-    DataTypeName["OBJECT"] = "object";
-    DataTypeName["FILE"] = "file";
-})(DataTypeName = exports.DataTypeName || (exports.DataTypeName = {}));
+"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.DataTypeName = exports.DataFormatName = exports.TransferProtocol = void 0;
+var TransferProtocol;
+(function (TransferProtocol) {
+    TransferProtocol["HTTP"] = "http";
+    TransferProtocol["HTTPS"] = "https";
+    TransferProtocol["WS"] = "ws";
+    TransferProtocol["WSS"] = "wss";
+})(TransferProtocol = exports.TransferProtocol || (exports.TransferProtocol = {}));
+var DataFormatName;
+(function (DataFormatName) {
+    DataFormatName["INT_32"] = "int32";
+    DataFormatName["INT_64"] = "int64";
+    DataFormatName["FLOAT"] = "float";
+    DataFormatName["DOUBLE"] = "double";
+    DataFormatName["BYTE"] = "byte";
+    DataFormatName["BINARY"] = "binary";
+    DataFormatName["DATE"] = "date";
+    DataFormatName["DATE_TIME"] = "date-time";
+    DataFormatName["PASSWORD"] = "password";
+})(DataFormatName = exports.DataFormatName || (exports.DataFormatName = {}));
+var DataTypeName;
+(function (DataTypeName) {
+    DataTypeName["VOID"] = "void";
+    DataTypeName["INTEGER"] = "integer";
+    DataTypeName["NUMBER"] = "number";
+    DataTypeName["BOOLEAN"] = "boolean";
+    DataTypeName["STRING"] = "string";
+    DataTypeName["ARRAY"] = "array";
+    DataTypeName["OBJECT"] = "object";
+    DataTypeName["FILE"] = "file";
+})(DataTypeName = exports.DataTypeName || (exports.DataTypeName = {}));
 //# sourceMappingURL=constants.js.map

package/dist/schema/index.d.ts

@@ -1,5 +1,5 @@
-export * from './v2';
-export * from './v3';
-export * from './constants';
-export * from './type';
+export * from './v2';
+export * from './v3';
+export * from './constants';
+export * from './type';
 //# sourceMappingURL=index.d.ts.map

package/dist/schema/index.js

@@ -1,27 +1,27 @@
-"use strict";
-/*
- * Copyright (c) 2021.
- * 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("./v2"), exports);
-__exportStar(require("./v3"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./type"), exports);
+"use strict";
+/*
+ * Copyright (c) 2021.
+ * 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("./v2"), exports);
+__exportStar(require("./v3"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./type"), exports);
 //# sourceMappingURL=index.js.map

package/dist/schema/type.d.ts

@@ -1,139 +1,139 @@
-import type { CollectionFormat } from '@trapi/metadata';
-import type { DataFormatName, DataTypeName } from './constants';
-import type { ParameterSourceV2 } from './v2';
-export interface BaseSpec {
-    info: Info;
-    tags?: Tag[];
-    externalDocs?: ExternalDocs;
-}
-export type Info = {
-    title: string;
-    version: string;
-    description?: string;
-    termsOfService?: string;
-    contact?: Contact;
-    license?: License;
-};
-type Contact = {
-    name?: string;
-    email?: string;
-    url?: string;
-};
-type License = {
-    name: string;
-    url?: string;
-};
-type ExternalDocs = {
-    url: string;
-    description?: string;
-};
-type Tag = {
-    name: string;
-    description?: string;
-    externalDocs?: ExternalDocs;
-};
-export interface BaseResponse {
-    description: string;
-}
-export interface BaseOperation<P, R> {
-    responses: {
-        [name: string]: R;
-    };
-    summary?: string;
-    description?: string;
-    externalDocs?: ExternalDocs;
-    operationId?: string;
-    consumes?: string[];
-    parameters?: P[];
-    schemes?: string[];
-    deprecated?: boolean;
-    security?: Record<string, string[]>[];
-    tags?: string[];
-}
-export interface Example {
-    value: unknown | unknown[];
-    summary?: string;
-    description?: string;
-}
-export interface BaseSchema<T> {
-    type?: `${DataTypeName}`;
-    format?: `${DataFormatName}`;
-    title?: string;
-    description?: string;
-    default?: string | boolean | number | any;
-    multipleOf?: number;
-    maximum?: number;
-    exclusiveMaximum?: number;
-    minimum?: number;
-    exclusiveMinimum?: number;
-    maxLength?: number;
-    minLength?: number;
-    pattern?: string;
-    maxItems?: number;
-    minItems?: number;
-    uniqueItems?: boolean;
-    maxProperties?: number;
-    minProperties?: number;
-    enum?: Array<string | number | boolean>;
-    'x-enum-varnames'?: string[];
-    items?: T | BaseSchema<T> | any;
-    additionalProperties?: boolean | {
-        [ref: string]: string;
-    } | T;
-    properties?: {
-        [propertyName: string]: T;
-    };
-    discriminator?: string;
-    readOnly?: boolean;
-    xml?: XML;
-    externalDocs?: ExternalDocs;
-    example?: {
-        [exampleName: string]: Example;
-    } | unknown;
-    required?: string[];
-    $ref?: string;
-}
-interface XML {
-    type?: string;
-    namespace?: string;
-    prefix?: string;
-    attribute?: string;
-    wrapped?: boolean;
-}
-export interface BaseParameter {
-    name: string;
-    in: `${ParameterSourceV2}`;
-    required?: boolean;
-    description?: string;
-}
-export interface BodyParameter extends BaseParameter {
-    in: `${ParameterSourceV2.BODY}`;
-}
-export interface QueryParameter extends BaseParameter {
-    in: `${ParameterSourceV2.QUERY}`;
-    allowEmptyValue?: boolean;
-    collectionFormat?: `${CollectionFormat}`;
-}
-export interface PathParameter extends BaseParameter {
-    in: `${ParameterSourceV2.PATH}`;
-}
-export interface HeaderParameter extends BaseParameter {
-    in: `${ParameterSourceV2.HEADER}`;
-}
-export interface FormDataParameter extends BaseParameter {
-    in: `${ParameterSourceV2.FORM_DATA}`;
-    collectionFormat?: `${CollectionFormat}`;
-}
-export interface Path<Operation, Parameter> {
-    $ref?: string;
-    get?: Operation;
-    put?: Operation;
-    post?: Operation;
-    delete?: Operation;
-    options?: Operation;
-    head?: Operation;
-    patch?: Operation;
-    parameters?: Parameter[];
-}
-export {};
+import type { CollectionFormat } from '@trapi/metadata';
+import type { DataFormatName, DataTypeName } from './constants';
+import type { ParameterSourceV2 } from './v2';
+export interface BaseSpec {
+    info: Info;
+    tags?: Tag[];
+    externalDocs?: ExternalDocs;
+}
+export type Info = {
+    title: string;
+    version: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: Contact;
+    license?: License;
+};
+type Contact = {
+    name?: string;
+    email?: string;
+    url?: string;
+};
+type License = {
+    name: string;
+    url?: string;
+};
+type ExternalDocs = {
+    url: string;
+    description?: string;
+};
+type Tag = {
+    name: string;
+    description?: string;
+    externalDocs?: ExternalDocs;
+};
+export interface BaseResponse {
+    description: string;
+}
+export interface BaseOperation<P, R> {
+    responses: {
+        [name: string]: R;
+    };
+    summary?: string;
+    description?: string;
+    externalDocs?: ExternalDocs;
+    operationId?: string;
+    consumes?: string[];
+    parameters?: P[];
+    schemes?: string[];
+    deprecated?: boolean;
+    security?: Record<string, string[]>[];
+    tags?: string[];
+}
+export interface Example {
+    value: unknown | unknown[];
+    summary?: string;
+    description?: string;
+}
+export interface BaseSchema<T> {
+    type?: `${DataTypeName}`;
+    format?: `${DataFormatName}`;
+    title?: string;
+    description?: string;
+    default?: string | boolean | number | any;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: number;
+    minimum?: number;
+    exclusiveMinimum?: number;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    enum?: Array<string | number | boolean>;
+    'x-enum-varnames'?: string[];
+    items?: T | BaseSchema<T> | any;
+    additionalProperties?: boolean | {
+        [ref: string]: string;
+    } | T;
+    properties?: {
+        [propertyName: string]: T;
+    };
+    discriminator?: string;
+    readOnly?: boolean;
+    xml?: XML;
+    externalDocs?: ExternalDocs;
+    example?: {
+        [exampleName: string]: Example;
+    } | unknown;
+    required?: string[];
+    $ref?: string;
+}
+interface XML {
+    type?: string;
+    namespace?: string;
+    prefix?: string;
+    attribute?: string;
+    wrapped?: boolean;
+}
+export interface BaseParameter {
+    name: string;
+    in: `${ParameterSourceV2}`;
+    required?: boolean;
+    description?: string;
+}
+export interface BodyParameter extends BaseParameter {
+    in: `${ParameterSourceV2.BODY}`;
+}
+export interface QueryParameter extends BaseParameter {
+    in: `${ParameterSourceV2.QUERY}`;
+    allowEmptyValue?: boolean;
+    collectionFormat?: `${CollectionFormat}`;
+}
+export interface PathParameter extends BaseParameter {
+    in: `${ParameterSourceV2.PATH}`;
+}
+export interface HeaderParameter extends BaseParameter {
+    in: `${ParameterSourceV2.HEADER}`;
+}
+export interface FormDataParameter extends BaseParameter {
+    in: `${ParameterSourceV2.FORM_DATA}`;
+    collectionFormat?: `${CollectionFormat}`;
+}
+export interface Path<Operation, Parameter> {
+    $ref?: string;
+    get?: Operation;
+    put?: Operation;
+    post?: Operation;
+    delete?: Operation;
+    options?: Operation;
+    head?: Operation;
+    patch?: Operation;
+    parameters?: Parameter[];
+}
+export {};
 //# sourceMappingURL=type.d.ts.map

package/dist/schema/type.js

@@ -1,9 +1,9 @@
-"use strict";
-/*
- * Copyright (c) 2021.
- * 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) 2021.
+ * 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/schema/v2/constants.d.ts

@@ -1,8 +1,8 @@
-export declare enum ParameterSourceV2 {
-    BODY = "body",
-    FORM_DATA = "formData",
-    HEADER = "header",
-    PATH = "path",
-    QUERY = "query"
-}
+export declare enum ParameterSourceV2 {
+    BODY = "body",
+    FORM_DATA = "formData",
+    HEADER = "header",
+    PATH = "path",
+    QUERY = "query"
+}
 //# sourceMappingURL=constants.d.ts.map