@tsed/schema 7.79.4 → 7.80.0

package/lib/types-esm/utils/defineStatusModel.d.ts

@@ -0,0 +1,3 @@
+import { Type } from "@tsed/core";
+export declare function defineStatusModel(status: number, model: Type<any>): void;
+export declare function getStatusModel(status: number): Type<any> | undefined;

package/lib/types-esm/utils/from.d.ts

@@ -0,0 +1,190 @@
+import { Type } from "@tsed/core";
+import { JsonSchema } from "../domain/JsonSchema.js";
+/**
+ * Create a new model from the given type.
+ *
+ * ```typescript
+ * from(String)
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function from(type?: Type<any>): JsonSchema;
+/**
+ * Declare a new number model.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function number(): JsonSchema;
+/**
+ * Declare a new integer model.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function integer(): JsonSchema;
+/**
+ * Declare a new string model.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function string(): JsonSchema;
+/**
+ * Declare a new boolean model.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function boolean(): JsonSchema;
+/**
+ * Declare a new string model with `format: date`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function date(): JsonSchema;
+/**
+ * Declare a new string model with `format: datetime`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function datetime(): JsonSchema;
+/**
+ * Declare a new string model with `format: time`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function time(): JsonSchema;
+/**
+ * Declare a new string model with `format: email`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function email(): JsonSchema;
+/**
+ * Declare a new string model with `format: uri`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function uri(): JsonSchema;
+/**
+ * Declare a new string model with `format: url`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function url(): JsonSchema;
+/**
+ * Declare a new object model with `additionalProperties: true`.
+ *
+ * ```json
+ * {
+ *   "type": "array"
+ * }
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function array(): JsonSchema;
+/**
+ * Declare a new object model with `additionalProperties: true`.
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "additionalProperties": true
+ * }
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function map(): JsonSchema;
+/**
+ * Declare a new array model with `uniqueItems: true`.
+ *
+ * ```json
+ * {
+ *   "type": "array",
+ *   "uniqueItems": true
+ * }
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function set(): JsonSchema;
+/**
+ * Declare a new object model.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function object(properties?: {
+    [key: string]: JsonSchema;
+}): JsonSchema;
+/**
+ * Declare a model with any type (By default: `integer`, `number`, `string`, `boolean`, `array`, `object`, `null`)
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function any(...types: any[]): JsonSchema;
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
+ * @schemaFunctional
+ */
+export declare function anyOf(...anyOf: any[]): JsonSchema;
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
+ */
+export declare function oneOf(...oneOf: any[]): JsonSchema;
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
+ * @schemaFunctional
+ */
+export declare function allOf(...allOf: any[]): JsonSchema;
+/**
+ * Declare a sub schema which will be resolved later. Use this function when you have a circular reference between two schemes.
+ *
+ * @schemaFunctional
+ */
+export declare function lazyRef(cb: () => Type<any>): any;
+export declare function enums(e: Record<string, any>): JsonSchema;

package/lib/types-esm/utils/generateSpec.d.ts

@@ -0,0 +1,16 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+import { JsonTokenOptions, SpecSerializerOptions } from "./getSpec.js";
+export interface GenerateSpecOptions extends Omit<SpecSerializerOptions, "specType"> {
+    tokens: JsonTokenOptions;
+    version?: string;
+    acceptMimes?: string;
+    specPath?: string;
+    specVersion?: string;
+    spec?: any;
+}
+/**
+ * Generate OpenAPI spec from multiple sources (models, files, conf)
+ * @param tokens
+ * @param options
+ */
+export declare function generateSpec({ tokens, ...options }: GenerateSpecOptions): Promise<OpenSpec2 | OpenSpec3>;

package/lib/types-esm/utils/generics.d.ts

@@ -0,0 +1,50 @@
+import { Type } from "@tsed/core";
+import { JsonSchema } from "../domain/JsonSchema.js";
+export type GenericValue = Type<any> | JsonSchema | any;
+/**
+ * @ignore
+ */
+export type GenericsMap = Map<string, GenericValue>;
+/**
+ * @ignore
+ */
+export interface GenericTypes {
+    genericTypes: Type<any>[];
+    [key: string]: any;
+}
+/**
+ * @ignore
+ */
+export interface GenericLabels {
+    genericLabels: string[];
+    [key: string]: any;
+}
+/**
+ * @ignore
+ */
+export interface NestedGenerics {
+    nestedGenerics: GenericValue[][];
+    [key: string]: any;
+}
+/**
+ * @ignore
+ */
+export interface GenericsContext extends GenericTypes, GenericLabels, NestedGenerics {
+    generics: GenericsMap;
+}
+/**
+ * @ignore
+ * @param genericLabels
+ * @param genericTypes
+ */
+export declare function getGenericsMap(genericLabels: string[], genericTypes: GenericValue[]): GenericsMap;
+/**
+ * @ignore
+ * @param options
+ */
+export declare function mapGenericsOptions(options: Partial<GenericTypes & GenericLabels>): Partial<GenericTypes & GenericLabels>;
+/**
+ * @ignore
+ * @param value
+ */
+export declare function popGenerics(value: NestedGenerics): NestedGenerics & GenericTypes;

package/lib/types-esm/utils/getComputedType.d.ts

@@ -0,0 +1,5 @@
+import { Type } from "@tsed/core";
+/**
+ * @ignore
+ */
+export declare function getComputedType(target: any): Type<any>;

package/lib/types-esm/utils/getInheritedStores.d.ts

@@ -0,0 +1,8 @@
+import { Type } from "@tsed/core";
+import type { JsonClassStore } from "../domain/JsonClassStore.js";
+/**
+ * Return store and his inherited stores
+ * @param target
+ * @ignore
+ */
+export declare function getInheritedStores(target: Type<any> | any): Map<Type<any>, JsonClassStore>;

package/lib/types-esm/utils/getJsonEntityStore.d.ts

@@ -0,0 +1,15 @@
+import { Type } from "@tsed/core";
+import { JsonEntityStore } from "../domain/JsonEntityStore.js";
+import { JsonClassStore } from "../domain/JsonClassStore.js";
+import { JsonPropertyStore } from "../domain/JsonPropertyStore.js";
+import { JsonParameterStore } from "../domain/JsonParameterStore.js";
+import { JsonMethodStore } from "../domain/JsonMethodStore.js";
+/**
+ * Get entity store from decorator args
+ * @param target
+ */
+export declare function getJsonEntityStore<T extends JsonClassStore = JsonClassStore>(target: Type<any>): T;
+export declare function getJsonEntityStore<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any, propertyKey: string | symbol): T;
+export declare function getJsonEntityStore<T extends JsonParameterStore = JsonParameterStore>(target: Type<any> | any, propertyKey: string | symbol, index: number): T;
+export declare function getJsonEntityStore<T extends JsonMethodStore = JsonMethodStore>(target: Type<any> | any, propertyKey: string | symbol, descriptor: PropertyDescriptor): T;
+export declare function getJsonEntityStore<T extends JsonEntityStore = JsonEntityStore>(...args: any[]): T;

package/lib/types-esm/utils/getJsonPathParameters.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @ignore
+ */
+export declare function getJsonPathParameters(base: string, path?: string | RegExp | (string | RegExp)[]): {
+    path: string;
+    parameters: any[];
+}[];

package/lib/types-esm/utils/getJsonSchema.d.ts

@@ -0,0 +1,4 @@
+import { Type } from "@tsed/core";
+import "../components/index";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
+export declare function getJsonSchema(model: Type<any> | any, options?: JsonSchemaOptions): any;

package/lib/types-esm/utils/getJsonType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @ignore
+ */
+export declare const JSON_TYPES: string[];
+export declare function getJsonType(value: any): string;

package/lib/types-esm/utils/getOperationsRoutes.d.ts

@@ -0,0 +1,10 @@
+import { Type } from "@tsed/core";
+import { OperationVerbs } from "../constants/OperationVerbs.js";
+import { JsonMethodStore } from "../domain/JsonMethodStore.js";
+import { JsonOperationRoute } from "../domain/JsonOperationRoute.js";
+export interface GetOperationsRoutesOptions {
+    withChildren?: boolean;
+    basePath?: string;
+    allowedVerbs?: OperationVerbs[];
+}
+export declare function getOperationsRoutes<Entity extends JsonMethodStore = JsonMethodStore>(token: Type<any> | any, options?: GetOperationsRoutesOptions): JsonOperationRoute<Entity>[];

package/lib/types-esm/utils/getOperationsStores.d.ts

@@ -0,0 +1,6 @@
+import { Type } from "@tsed/core";
+import { JsonMethodStore } from "../domain/JsonMethodStore.js";
+/**
+ * @ignore
+ */
+export declare function getOperationsStores<T extends JsonMethodStore = JsonMethodStore>(target: Type<any> | any): Map<string, T>;

package/lib/types-esm/utils/getPropertiesStores.d.ts

@@ -0,0 +1,20 @@
+import { Type } from "@tsed/core";
+import type { JsonPropertyStore } from "../domain/JsonPropertyStore.js";
+/**
+ * Return the list of properties including properties from inherited classes
+ * @param target
+ * @ignore
+ */
+export declare function getPropertiesStores<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any): Map<string | symbol | number, T>;
+/**
+ * @ignore
+ */
+export interface GetPropertiesOptions {
+    withIgnoredProps?: boolean;
+    groups?: string[] | false;
+    [type: string]: any;
+}
+/**
+ * @ignore
+ */
+export declare function getProperties<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any, options?: GetPropertiesOptions): Map<string | number | symbol, T>;

package/lib/types-esm/utils/getSpec.d.ts

@@ -0,0 +1,34 @@
+import { Type } from "@tsed/core";
+import { OpenSpec3 } from "@tsed/openspec";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
+export type JsonTokenOptions = ({
+    token: Type<any>;
+} & Partial<SpecSerializerOptions>)[];
+export interface SpecSerializerOptions extends JsonSchemaOptions {
+    /**
+     * Paths
+     */
+    paths?: Record<string, any>;
+    /**
+     * Channels
+     */
+    channels?: Record<string, any>;
+    /**
+     * Root path. This paths will be added to all generated paths Object.
+     */
+    rootPath?: string;
+    /**
+     * A function to generate the operationId.
+     */
+    operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;
+    /**
+     * A pattern to generate the operationId.
+     */
+    operationIdPattern?: string;
+}
+/**
+ * Return the swagger or open spec for the given class.
+ * @param model
+ * @param options
+ */
+export declare function getSpec(model: Type<any> | JsonTokenOptions, options?: SpecSerializerOptions): Partial<OpenSpec3>;

package/lib/types-esm/utils/getSpecType.d.ts

@@ -0,0 +1,12 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+import { SpecTypes } from "../domain/SpecTypes.js";
+/**
+ * @ignore
+ * @param version
+ */
+export declare function getSpecType(version: string): SpecTypes.SWAGGER | SpecTypes.OPENAPI;
+/**
+ * @ignore
+ * @param spec
+ */
+export declare function getSpecTypeFromSpec(spec: Partial<OpenSpec2 | OpenSpec3>): SpecTypes.SWAGGER | SpecTypes.OPENAPI;

package/lib/types-esm/utils/isSuccessStatus.d.ts

@@ -0,0 +1,2 @@
+export declare const isSuccessStatus: (code: string | number | undefined) => boolean | 0;
+export declare const isRedirectionStatus: (code: string | number | undefined) => boolean | 0;

package/lib/types-esm/utils/mapHeaders.d.ts

@@ -0,0 +1,9 @@
+import { JsonHeader, JsonHeaders } from "../interfaces/JsonOpenSpec.js";
+/**
+ * Map input header to a standard open spec header
+ * @param headers
+ * @ignore
+ */
+export declare function mapHeaders(headers: JsonHeaders): {
+    [key: string]: JsonHeader;
+};

package/lib/types-esm/utils/mapOpenSpec.d.ts

@@ -0,0 +1,10 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param spec
+ * @param fileSpec
+ * @param version
+ * @param acceptMimes
+ * @param specVersion
+ */
+export declare function mapOpenSpec(spec: any, { fileSpec, acceptMimes, specVersion, version }: any): Partial<OpenSpec2 | OpenSpec3>;

package/lib/types-esm/utils/mapOpenSpec2.d.ts

@@ -0,0 +1,9 @@
+import { OpenSpec2 } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ * @param acceptMimes
+ */
+export declare function mapOpenSpec2(spec: Partial<OpenSpec2>, { version, specVersion, acceptMimes }: any): Partial<OpenSpec2>;

package/lib/types-esm/utils/mapOpenSpec3.d.ts

@@ -0,0 +1,8 @@
+import { OpenSpec3 } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ */
+export declare function mapOpenSpec3(spec: any, { specVersion }: any): Partial<OpenSpec3>;

package/lib/types-esm/utils/mapOpenSpecInfo.d.ts

@@ -0,0 +1,6 @@
+import { OpenSpecInfo } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param info
+ */
+export declare function mapOpenSpecInfo(info: Partial<OpenSpecInfo>): OpenSpecInfo;

package/lib/types-esm/utils/mapOperationOptions.d.ts

@@ -0,0 +1,5 @@
+export declare function mapOperationOptions(args: any[]): {
+    path: undefined;
+    method: undefined;
+    use: any[];
+};

package/lib/types-esm/utils/matchGroups.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @ignore
+ */
+export declare function matchGroups(groups: string[], compareWith?: string[]): boolean;

package/lib/types-esm/utils/mergeSpec.d.ts

@@ -0,0 +1,23 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+/**
+ * @ignore
+ */
+export declare const schemesReducer: (collection: any[], value: any, options: import("@tsed/core").DeepMergeOptions) => any[];
+/**
+ * @ignore
+ */
+export declare const parameters: (collection: any[], value: any, options: import("@tsed/core").DeepMergeOptions) => any[];
+/**
+ * @ignore
+ */
+export declare const security: (collection: any[], value: any, options: import("@tsed/core").DeepMergeOptions) => any[];
+/**
+ * @ignore
+ */
+export declare const tagsReducer: (collection: any[], value: any, options: import("@tsed/core").DeepMergeOptions) => any[];
+/**
+ * Merge two spec
+ * @param spec
+ * @param input
+ */
+export declare function mergeSpec<Spec = OpenSpec2 | OpenSpec3>(spec: Partial<Spec>, input: Partial<Spec>): Partial<Spec>;

package/lib/types-esm/utils/operationIdFormatter.d.ts

@@ -0,0 +1,6 @@
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
+/**
+ * @ignore
+ */
+export declare function operationIdFormatter(pattern?: string): (name: string, propertyKey: string, path?: string) => string;
+export declare function getOperationId(path: string, { store, operationIdFormatter }: JsonSchemaOptions): any;

package/lib/types-esm/utils/ref.d.ts

@@ -0,0 +1,14 @@
+import type { JsonSchema } from "../domain/JsonSchema.js";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
+/**
+ * @ignore
+ */
+export declare function createRefName(name: string, options: JsonSchemaOptions): string;
+/**
+ * @ignore
+ */
+export declare function createRef(name: string, schema: JsonSchema, options: JsonSchemaOptions): any;
+/**
+ * @ignore
+ */
+export declare function toRef(value: JsonSchema, schema: any, options: JsonSchemaOptions): any;

package/lib/types-esm/utils/removeHiddenOperation.d.ts

@@ -0,0 +1,2 @@
+import { JsonMethodStore } from "../domain/JsonMethodStore.js";
+export declare function removeHiddenOperation(operationStore: JsonMethodStore): boolean;

package/lib/types-esm/utils/serializeEnumValues.d.ts

@@ -0,0 +1,5 @@
+export declare const serializeEnum: (enumValue: any) => any;
+export declare function serializeEnumValues(enumValues: any[]): {
+    values: any[];
+    types: any;
+};

package/lib/types-esm/utils/somethingOf.d.ts

@@ -0,0 +1 @@
+export declare function makeOf(key: string, schemes: unknown[]): unknown;

package/lib/types-esm/utils/toJsonMapCollection.d.ts

@@ -0,0 +1,7 @@
+import { JsonMap } from "../domain/JsonMap.js";
+/**
+ * @ignore
+ */
+export declare function toJsonMapCollection(content: {
+    [key: string]: any;
+}, klass?: typeof JsonMap): JsonMap<any>;

package/lib/types-esm/utils/toJsonRegex.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @ignore
+ * @param pattern
+ */
+export declare function toJsonRegex(pattern: string | RegExp): string;

package/lib/types-esm/utils/transformToOS2.d.ts

@@ -0,0 +1,25 @@
+import { OpenSpec2, OpenSpec3, OS3Operation } from "@tsed/openspec";
+export declare function transformSecurity(securitySchemes: any): {};
+export declare function transformInformation(server: any): {
+    host: string | undefined;
+    basePath: string;
+    schemes: string[] | undefined;
+};
+export declare class Converter {
+    private spec;
+    constructor(spec: Partial<OpenSpec3>);
+    convertInfos(): {};
+    resolveReference(base: any, obj: any, shouldClone: boolean): any;
+    convert(): any;
+    convertOperations(paths: any, spec: any): any;
+    convertOperationParameters(operation: OS3Operation): void;
+    convertParameters(obj: any): void;
+    copySchemaProperties(obj: any, props: any[]): void;
+    copySchemaXProperties(obj: Record<string, any>): void;
+    convertResponses(operation: Record<string, any>): void;
+    convertSchema(def: any, operationDirection?: any): void;
+    convertSchemas(): void;
+    convertDiscriminatorMapping(mapping: any): void;
+    convertSecurityDefinitions(): void;
+}
+export declare function transformToOS2(spec: any): Partial<OpenSpec2>;

package/lib/types-esm/utils/withErrorMsg.d.ts

@@ -0,0 +1,6 @@
+export interface ErrorChainedMethods<T> {
+    <T>(target: Object, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<T> | number): any;
+    Error(msg: string): this;
+}
+export type ErrorChainedDecorator<Decorator extends (...args: any[]) => any> = (...args: Parameters<Decorator>) => ErrorChainedMethods<Decorator>;
+export declare function withErrorMsg<Decorator extends (...args: any[]) => any>(errorKey: string, originalDecorator: Decorator): ErrorChainedDecorator<Decorator>;