@tsed/schema 6.95.9 → 6.96.2

package/lib/cjs/utils/from.d.ts

@@ -1,189 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonSchema } from "../domain/JsonSchema";
-/**
- * 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;

package/lib/cjs/utils/generics.d.ts

@@ -1,50 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonSchema } from "../domain";
-export declare type GenericValue = Type<any> | JsonSchema | any;
-/**
- * @ignore
- */
-export declare 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/cjs/utils/getComputedType.d.ts

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

package/lib/cjs/utils/getInheritedStores.d.ts

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

package/lib/cjs/utils/getJsonEntityStore.d.ts

@@ -1,15 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonEntityStore } from "../domain/JsonEntityStore";
-import { JsonClassStore } from "../domain/JsonClassStore";
-import { JsonPropertyStore } from "../domain/JsonPropertyStore";
-import { JsonParameterStore } from "../domain/JsonParameterStore";
-import { JsonMethodStore } from "../domain/JsonMethodStore";
-/**
- * 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/cjs/utils/getJsonPathParameters.d.ts

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

package/lib/cjs/utils/getJsonSchema.d.ts

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

package/lib/cjs/utils/getJsonType.d.ts

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

package/lib/cjs/utils/getOperationsRoutes.d.ts

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

package/lib/cjs/utils/getOperationsStores.d.ts

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

package/lib/cjs/utils/getPropertiesStores.d.ts

@@ -1,20 +0,0 @@
-import { Type } from "@tsed/core";
-import type { JsonPropertyStore } from "../domain/JsonPropertyStore";
-/**
- * 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/cjs/utils/getRequiredProperties.d.ts

@@ -1,6 +0,0 @@
-import type { JsonSchema } from "../domain/JsonSchema";
-import type { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
-/**
- * @ignore
- */
-export declare function getRequiredProperties(obj: any, schema: JsonSchema, options: JsonSchemaOptions): any;

package/lib/cjs/utils/getSpec.d.ts

@@ -1,49 +0,0 @@
-import { Type } from "@tsed/core";
-import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
-import { SpecTypes } from "../domain/SpecTypes";
-import { JsonSchemaOptions } from "../interfaces";
-export interface SpecSerializerOptions extends JsonSchemaOptions {
-    specType?: SpecTypes.SWAGGER | SpecTypes.OPENAPI;
-    /**
-     * Paths
-     */
-    paths?: 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;
-}
-export interface OS3SpecSerializerOptions extends SpecSerializerOptions {
-    /**
-     * Define Spec types level
-     */
-    specType: SpecTypes.OPENAPI;
-}
-export interface OS2SpecSerializerOptions extends SpecSerializerOptions {
-    /**
-     * Define Spec types level
-     */
-    specType: SpecTypes.SWAGGER;
-}
-/**
- * Return the swagger or open spec for the given class.
- * @param model
- * @param options
- */
-export declare function getSpec(model: Type<any>, options: OS2SpecSerializerOptions): Partial<OpenSpec2>;
-export declare function getSpec(model: Type<any>): Partial<OpenSpec2>;
-export declare function getSpec(model: Type<any>, options: SpecSerializerOptions): Partial<OpenSpec2>;
-/**
- * Return the swagger or open spec for the given class.
- * @param model
- * @param options
- */
-export declare function getSpec(model: Type<any>, options: OS3SpecSerializerOptions): Partial<OpenSpec3>;

package/lib/cjs/utils/isJsonClass.d.ts

@@ -1,4 +0,0 @@
-/**
- * @ignore
- */
-export declare function isJsonClass(type: any): boolean;

package/lib/cjs/utils/isSuccessStatus.d.ts

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

package/lib/cjs/utils/mapHeaders.d.ts

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

package/lib/cjs/utils/mapNullableType.d.ts

@@ -1,3 +0,0 @@
-import type { JsonSchema } from "../domain/JsonSchema";
-import type { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
-export declare function mapNullableType(obj: any, schema: JsonSchema, options: JsonSchemaOptions): any;

package/lib/cjs/utils/mapRouteOptions.d.ts

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

package/lib/cjs/utils/matchGroups.d.ts

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

package/lib/cjs/utils/mergeOperation.d.ts

@@ -1,17 +0,0 @@
-import { SpecTypes } from "../domain/SpecTypes";
-/**
- * @ignore
- */
-export interface MergeOperationOptions {
-    rootPath: string;
-    specType: SpecTypes;
-    operationId: (path: string) => string | undefined;
-    defaultTags: string[];
-    tags: string[];
-    path: string;
-    method: string;
-}
-/**
- * @ignore
- */
-export declare function mergeOperation(obj: any, operation: any, { rootPath, specType, operationId, defaultTags, tags, path, method }: MergeOperationOptions): any;

package/lib/cjs/utils/mergeSpec.d.ts

@@ -1,23 +0,0 @@
-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/cjs/utils/operationIdFormatter.d.ts

@@ -1,4 +0,0 @@
-/**
- * @ignore
- */
-export declare function operationIdFormatter(pattern?: string): (name: string, propertyKey: string, path?: string) => string;

package/lib/cjs/utils/ref.d.ts

@@ -1,14 +0,0 @@
-import type { JsonSchema } from "../domain/JsonSchema";
-import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
-/**
- * @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/cjs/utils/toJsonMapCollection.d.ts

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

package/lib/cjs/utils/toJsonRegex.d.ts

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