@tsed/schema 7.86.3 → 7.87.0

package/lib/types/components/default/classMapper.d.ts

@@ -1,3 +1,3 @@
 import { JsonSchema } from "../../domain/JsonSchema.js";
 import { JsonSchemaOptions } from "../../interfaces/JsonSchemaOptions.js";
-export declare function classMapper(value: JsonSchema, options: JsonSchemaOptions): any;
+export declare function classMapper(value: JsonSchema, options: JsonSchemaOptions): import("json-schema").JSONSchema7;

package/lib/types/components/default/genericsMapper.d.ts

@@ -1,5 +1,12 @@
-import { GenericsContext } from "../../utils/generics.js";
+import type { JSONSchema7 } from "json-schema";
+import { JsonSchema } from "../../domain/JsonSchema.js";
+import type { JsonSchemaOptions } from "../../interfaces/JsonSchemaOptions.js";
 /**
  * @ignore
  */
-export declare function genericsMapper(obj: any, options: GenericsContext): any;
+export declare function genericsMapper(baseObj: JSONSchema7, schema: JsonSchema, options: JsonSchemaOptions): JSONSchema7 | {
+    allOf: (JSONSchema7 | {
+        properties: JSONSchema7;
+        type: string;
+    })[];
+};

package/lib/types/components/default/lazyRefMapper.d.ts

@@ -1,3 +1,3 @@
 import { JsonLazyRef } from "../../domain/JsonLazyRef.js";
 import { JsonSchemaOptions } from "../../interfaces/JsonSchemaOptions.js";
-export declare function lazyRefMapper(jsonLazyRef: JsonLazyRef, options: JsonSchemaOptions): any;
+export declare function lazyRefMapper(jsonLazyRef: JsonLazyRef, options: JsonSchemaOptions): import("json-schema").JSONSchema7;

package/lib/types/components/default/nextMapper.d.ts

@@ -0,0 +1,5 @@
+import { type Type } from "@tsed/core";
+import { JsonSchema } from "../../domain/JsonSchema.js";
+import type { JsonSchemaOptions } from "../../interfaces/JsonSchemaOptions.js";
+export declare function itemMapper(input: JsonSchema | Type, options: JsonSchemaOptions): any;
+export declare function nextMapper(input: JsonSchema | Type | any, options: JsonSchemaOptions): any;

package/lib/types/components/default/ofMapper.d.ts

@@ -1,3 +1,3 @@
 import type { JsonSchema } from "../../domain/JsonSchema.js";
 import type { JsonSchemaOptions } from "../../interfaces/JsonSchemaOptions.js";
-export declare function ofMapper(input: (any | JsonSchema)[], options: JsonSchemaOptions, parent: JsonSchema): any[];
+export declare function ofMapper(input: (any | JsonSchema)[], options: JsonSchemaOptions): any[];

package/lib/types/components/index.d.ts

@@ -1,24 +1,18 @@
 /**
  * @file Automatically generated by @tsed/barrels.
  */
-export * from "./async-api/channelsMapper.js";
-export * from "./async-api/generate.js";
-export * from "./async-api/messageMapper.js";
-export * from "./async-api/payloadMapper.js";
-export * from "./async-api/responseMapper.js";
 export * from "./default/anyMapper.js";
 export * from "./default/classMapper.js";
 export * from "./default/discriminatorMappingMapper.js";
 export * from "./default/enumsMapper.js";
 export * from "./default/genericsMapper.js";
 export * from "./default/inheritedClassMapper.js";
-export * from "./default/itemMapper.js";
 export * from "./default/lazyRefMapper.js";
 export * from "./default/mapMapper.js";
+export * from "./default/nextMapper.js";
 export * from "./default/nullableMapper.js";
 export * from "./default/objectMapper.js";
 export * from "./default/ofMapper.js";
-export * from "./default/propertiesMapper.js";
 export * from "./default/requiredMapper.js";
 export * from "./default/schemaMapper.js";
 export * from "./open-spec/discriminatorMappingMapper.js";

package/lib/types/components/open-spec/nullableMapper.d.ts

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

package/lib/types/components/open-spec/operationInQueryMapper.d.ts

@@ -1,2 +1,2 @@
 import type { JsonParameterOptions } from "./operationInParameterMapper.js";
-export declare function operationInQueryMapper(parameter: any, { jsonSchema, jsonParameters, ...options }: JsonParameterOptions): any;
+export declare function operationInQueryMapper(parameter: any, { jsonSchema, ...options }: JsonParameterOptions): any;

package/lib/types/constants/VendorKeys.d.ts

@@ -0,0 +1,10 @@
+export declare enum VendorKeys {
+    GENERIC_LABELS = "genericLabels",
+    GENERIC_LABEL = "genericLabel",
+    GENERIC_OF = "genericOf",
+    NULLABLE = "nullable",
+    FORWARD_GROUPS = "forwardGroups",
+    GROUPS = "groups",
+    GROUPS_NAME = "groupsName",
+    ALLOWED_GROUPS = "allowedGroups"
+}

package/lib/types/decorators/collections/collectionOf.d.ts

@@ -1,5 +1,6 @@
 export interface ArrayOfChainedDecorators {
     (...args: any): any;
+    Nested(...generics: any[]): this;
     /**
      * An array instance is valid against `minItems` if its size is greater than, or equal to, the value of this keyword.
      *
@@ -10,6 +11,7 @@ export interface ArrayOfChainedDecorators {
      * ::: tip
      * Omitting this keyword has the same behavior as a value of 0.
      * :::
+     * @deprecated Since 2025-05-12. Use MinItems decorator instead.
      */
     MinItems(minItems: number): this;
     /**
@@ -20,6 +22,7 @@ export interface ArrayOfChainedDecorators {
      * :: warning
      * The value `maxItems` MUST be a non-negative integer.
      * :::
+     * @deprecated Since 2025-05-12. Use MaxItems decorator instead.
      */
     MaxItems(maxItems: number): this;
     /**
@@ -30,6 +33,7 @@ export interface ArrayOfChainedDecorators {
     Contains(): this;
     /**
      * If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.
+     * @deprecated Since 2025-05-12. Use UniqueItems decorator instead.
      */
     UniqueItems(uniqueItems?: boolean): this;
 }
@@ -41,6 +45,7 @@ export interface MapOfChainedDecorators {
      * ::: warning
      * The value of this keyword MUST be a non-negative integer.
      * :::
+     * @deprecated Since 2025-05-12. Use MinProperties decorator instead.
      */
     MinProperties(minProperties: number): this;
     /**
@@ -49,6 +54,7 @@ export interface MapOfChainedDecorators {
      * ::: warning
      * The value of this keyword MUST be a non-negative integer.
      * :::
+     * @deprecated Since 2025-05-12. Use MaxProperties decorator instead.
      */
     MaxProperties(maxProperties: number): this;
 }

package/lib/types/decorators/generics/genericOf.d.ts

@@ -1,4 +1,7 @@
 import { GenericValue } from "../../utils/generics.js";
+/**
+ * @ignore
+ */
 export interface GenericOfChainedDecorators {
     (...args: any): any;
     /**

package/lib/types/decorators/generics/generics.d.ts

@@ -3,12 +3,12 @@
  *
  * See @@GenericOf@@ decorator for more details.
  *
- * @param generics
  * @decorator
  * @validation
  * @swagger
  * @schema
  * @input
  * @generics
+ * @param genericLabels
  */
-export declare function Generics(...generics: string[]): (target: any) => void;
+export declare function Generics(...genericLabels: string[]): ClassDecorator;

package/lib/types/decorators/operations/acceptMime.d.ts

@@ -16,4 +16,4 @@
  * @operation
  * @response
  */
-export declare function AcceptMime(...mimes: string[]): Function;
+export declare function AcceptMime(...mimes: string[]): ClassDecorator & MethodDecorator;

package/lib/types/decorators/operations/consumes.d.ts

@@ -16,4 +16,4 @@
  * @classDecorator
  * @operation
  */
-export declare function Consumes(...consumes: string[]): (...args: any[]) => any;
+export declare function Consumes(...consumes: string[]): ClassDecorator & MethodDecorator;

package/lib/types/decorators/operations/header.d.ts

@@ -46,4 +46,4 @@ import { JsonHeader, JsonHeaders } from "../../interfaces/JsonOpenSpec.js";
  * @operation
  * @response
  */
-export declare function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader): Function;
+export declare function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader): import("./returns.js").ReturnsChainedDecorators;

package/lib/types/decorators/operations/operationId.d.ts

@@ -7,4 +7,4 @@
  * @schema
  * @operation
  */
-export declare function OperationId(operationId: string): (...args: any[]) => any;
+export declare function OperationId(operationId: string): MethodDecorator;

package/lib/types/decorators/operations/operationPath.d.ts

@@ -5,7 +5,7 @@ import { OperationVerbs } from "../../constants/OperationVerbs.js";
  * ::: warning
  * Don't use decorator with Ts.ED application.
  *
- * Use theses decorators instead:
+ * Use these decorators instead:
  *
  * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
  *

package/lib/types/decorators/operations/path.d.ts

@@ -12,4 +12,4 @@
  * @classDecorator
  * @operation
  */
-export declare function Path(path: string): (...args: any[]) => any;
+export declare function Path(path: string): ClassDecorator;

package/lib/types/decorators/operations/returns.d.ts

@@ -88,8 +88,10 @@ export interface ReturnsChainedDecorators {
     /**
      * Add an inline title for the return model.
      * @param title
+     * @deprecated use Label instead
      */
     Title(title: string): this;
+    Label(label: string): this;
     /**
      * Use group to filter model
      * @param groups
@@ -170,7 +172,7 @@ export interface ReturnsChainedDecorators {
  *
  * Deprecated version:
  *
- * ```typescript
+ * ```ts
  * import {ReturnsArray} from "@tsed/common";
  * import {Returns} from "@tsed/schema";
  *
@@ -183,14 +185,14 @@ export interface ReturnsChainedDecorators {
  *
  * ### Declaring a generic model <Badge text="6+"/>
  *
- * Sometime, it might be useful to use generic models. TypeScript doesn't store the generic type in the metadata. This is why we need to
+ * Sometimes, it might be useful to use generic models. TypeScript doesn't store the generic type in the metadata. This is why we need to
  * declare explicitly the generic models with the decorators.
  *
- * One of the generic's usage, can be a paginated list. With Returns decorator it's now possible to declare generic type and generate the appropriate OpenSpec documentation.
+ * One of the generic's usage can be a paginated list. With Returns decorator it's now possible to declare a generic type and generate the appropriate OpenSpec documentation.
  *
  * Starting with the pagination model, by using @@Generics@@ and @@CollectionOf@@:
  *
- * ```typescript
+ * ```ts
  * @Generics("T")
  * class Pagination<T> {
  *  @CollectionOf("T")
@@ -213,7 +215,7 @@ export interface ReturnsChainedDecorators {
  * }
  * ```
  *
- * Finally, we can use our models on a method as following:
+ * Finally, we can use our models on a method as follows:
  *
  * ```typescript
  * class Controller {
@@ -225,11 +227,11 @@ export interface ReturnsChainedDecorators {
  * }
  * ```
  *
- * ### Declaring a nested generics models <Badge text="6+"/>
+ * ### Declaring nested generics models <Badge text="6+"/>
  *
- * It's also possible to declare a nested generics models in order to have this type `Pagination<Submission<Product>>`:
+ * It's also possible to declare a nested generics model to have this type `Pagination<Submission<Product>>`:
  *
- * ```typescript
+ * ```ts
  * import {Generics, Property, Returns} from "@tsed/schema";
  * import {Post} from "@tsed/common";
  *
@@ -244,7 +246,7 @@ export interface ReturnsChainedDecorators {
  *
  * And here is the Submission model:
  *
- * ```typescript
+ * ```ts
  * import {Generics, Property} from "@tsed/schema";
  *
  * @Generics("T")

package/lib/types/decorators/operations/tags.d.ts

@@ -1,6 +1,6 @@
 import { OpenSpecTag } from "@tsed/openspec";
 /**
- * Add tags metadata on the decorated element.
+ * Add metadata tags to the decorated element (class or method).
  *
  * ## Examples
  * ### On method
@@ -12,6 +12,15 @@ import { OpenSpecTag } from "@tsed/openspec";
  *  get() {}
  * }
  * ```
+ * ### On Class
+ *
+ * ```typescript
+ * @Controller("/")
+ * @Tags("api")
+ * class MyController {
+ *  get() {}
+ * }
+ * ```
  *
  * @param tags
  * @decorator
@@ -20,4 +29,4 @@ import { OpenSpecTag } from "@tsed/openspec";
  * @classDecorator
  * @operation
  */
-export declare function Tags(...tags: (string | OpenSpecTag)[]): (...args: any[]) => any;
+export declare function Tags(...tags: (string | OpenSpecTag)[]): ClassDecorator & MethodDecorator;

package/lib/types/domain/JsonClassStore.d.ts

@@ -1,6 +1,6 @@
+import { JsonEntityStore } from "./JsonEntityStore.js";
 import type { JsonMethodStore } from "./JsonMethodStore.js";
 import type { JsonPropertyStore } from "./JsonPropertyStore.js";
-import { JsonEntityStore } from "./JsonEntityStore.js";
 export declare class JsonClassStore extends JsonEntityStore {
     /**
      * List of children JsonEntityStore (properties or methods or params)

package/lib/types/domain/JsonEntityStore.d.ts

@@ -51,16 +51,26 @@ export declare abstract class JsonEntityStore implements JsonEntityStoreOptions
     readonly isStore = true;
     readonly parent: JsonEntityStore;
     readonly target: Type<any>;
+    constructor(options: JsonEntityStoreOptions);
     /**
      *
      */
     protected _type: Type<any>;
+    [key: string]: any;
+    get type(): Type<any> | any;
+    /**
+     * Get original type without transformation
+     * @param value
+     */
+    set type(value: Type<any> | any);
     /**
      * Ref to JsonSchema
      */
     protected _schema: JsonSchema;
-    [key: string]: any;
-    constructor(options: JsonEntityStoreOptions);
+    /**
+     * Return the JsonSchema
+     */
+    get schema(): JsonSchema;
     /**
      * Return the class name of the entity.
      * @returns {string}
@@ -73,26 +83,16 @@ export declare abstract class JsonEntityStore implements JsonEntityStoreOptions
     get isDate(): boolean;
     get isObject(): boolean;
     get isClass(): boolean;
-    /**
-     * Return the JsonSchema
-     */
-    get schema(): JsonSchema;
-    get nestedGenerics(): Type<any>[][];
-    set nestedGenerics(nestedGenerics: Type<any>[][]);
-    get type(): Type<any> | any;
-    /**
-     * Get original type without transformation
-     * @param value
-     */
-    set type(value: Type<any> | any);
     /**
      * Return the itemSchema computed type. if the type is a function used for recursive model, the function will be called to
      * get the right type.
      */
-    get computedType(): any;
+    get computedType(): Type<any>;
     get itemSchema(): JsonSchema;
     get parentSchema(): JsonSchema;
     get isDiscriminatorChild(): boolean;
+    get path(): string;
+    set path(path: string);
     static from<T extends JsonClassStore = JsonClassStore>(target: Type<any>): T;
     static from<T extends JsonPropertyStore = JsonPropertyStore>(target: Type<any> | any, propertyKey: string | symbol): T;
     static from<T extends JsonParameterStore = JsonParameterStore>(target: Type<any> | any, propertyKey: string | symbol, index: number): T;
@@ -104,7 +104,11 @@ export declare abstract class JsonEntityStore implements JsonEntityStoreOptions
     get<T = any>(key: string, defaultValue?: any): T;
     set(key: string, value?: any): Store;
     toString(): string;
+    getBestType(): any;
+    is(input: DecoratorTypes.CLASS): this is JsonClassStore;
+    is(input: DecoratorTypes.PROP): this is JsonPropertyStore;
+    is(input: DecoratorTypes.METHOD): this is JsonMethodStore;
+    is(input: DecoratorTypes.PARAM): this is JsonParameterStore;
     protected abstract build(): void;
     protected buildType(type: any): void;
-    getBestType(): any;
 }

package/lib/types/domain/JsonMedia.d.ts

@@ -3,9 +3,8 @@ import { JsonMap } from "./JsonMap.js";
 import { JsonSchema } from "./JsonSchema.js";
 export declare class JsonMedia extends JsonMap<OS3MediaType<JsonSchema>> {
     $kind: string;
-    groups: string[];
-    groupsName: string;
-    allowedGroups?: Set<string>;
-    schema(schema: JsonSchema): this;
-    examples(examples: any): this;
+    constructor(obj?: Partial<OS3MediaType<JsonSchema>>);
+    schema(schema?: JsonSchema): JsonSchema;
+    examples(examples?: any): this;
+    type(type: any): this;
 }

package/lib/types/domain/JsonMethodStore.d.ts

@@ -39,6 +39,12 @@ export declare class JsonMethodStore extends JsonEntityStore {
      * @param descriptor
      */
     static get(target: Type<any>, propertyKey: string | symbol, descriptor?: PropertyDescriptor): JsonMethodStore;
+    /**
+     * TODO must be located on JsonOperation level directly
+     * @param status
+     * @param contentType
+     * @param includes
+     */
     getResponseOptions(status: number, { contentType, includes }?: {
         contentType?: string;
         includes?: string[];
@@ -73,10 +79,11 @@ export declare class JsonMethodStore extends JsonEntityStore {
 /**
  * EndpointMetadata contains metadata about a controller and his method.
  * Each annotation (@Get, @Body...) attached to a method are stored into endpoint.
- * EndpointMetadata convert this metadata to an array which contain arguments to call an Express method.
+ * EndpointMetadata converts this metadata to an array which contain arguments to call an Express method.
  *
  * Example :
- *```typescript
+ *
+ *```ts
  * @Controller("/my-path")
  * provide MyClass {
  *

package/lib/types/domain/JsonOperation.d.ts

@@ -4,10 +4,12 @@ import { JsonMap } from "./JsonMap.js";
 import { JsonParameter } from "./JsonParameter.js";
 import { JsonResponse } from "./JsonResponse.js";
 import { JsonSchema } from "./JsonSchema.js";
-export interface JsonMethodPath {
-    path: string | RegExp;
+export declare class JsonMethodPath extends JsonMap<any> {
     method: string;
-    [key: string]: any;
+    path: string | RegExp;
+    constructor(method: string, path: string | RegExp);
+    summary(summary: string): this;
+    description(description: string): this;
 }
 export interface JsonOperationOptions extends OS3Operation<JsonSchema, JsonParameter, JsonMap<JsonResponse>> {
     consumes: string[];
@@ -41,11 +43,12 @@ export declare class JsonOperation extends JsonMap<JsonOperationOptions> {
     addSecurityScopes(name: string, scopes: string[]): this;
     description(description: string): this;
     deprecated(deprecated: boolean): this;
+    addAllowedGroupsParameter(allowedGroups: string[]): this;
     parameters(parameters: JsonParameter[]): this;
     addParameter(index: number, parameter: JsonParameter): void;
     consumes(consumes: string[]): this;
     produces(produces: string[]): this;
     addProduce(produce: string): void;
-    addOperationPath(method: string, path: string | RegExp, options?: any): this;
+    addOperationPath(method: string, path: string | RegExp): JsonMethodPath;
     getAllowedOperationPath(allowedVerbs?: string[]): JsonMethodPath[];
 }

package/lib/types/domain/JsonParameter.d.ts

@@ -1,22 +1,19 @@
-import { Type } from "@tsed/core";
 import { OpenSpecHash, OpenSpecRef, OS3Example, OS3Parameter } from "@tsed/openspec";
 import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
-import { NestedGenerics } from "../utils/generics.js";
 import { JsonMap } from "./JsonMap.js";
 import { JsonSchema } from "./JsonSchema.js";
-export declare class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> implements NestedGenerics {
+export declare class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> {
     $kind: string;
-    nestedGenerics: Type<any>[][];
-    groups: string[];
-    groupsName: string;
-    $schema: JsonSchema;
     expression: string;
+    constructor(obj?: Partial<OS3Parameter<JsonSchema>>);
     getName(): any;
     name(name: string): this;
     examples(examples: OpenSpecHash<OS3Example | OpenSpecRef>): this;
     description(description: string): this;
     in(inType: string, expression?: string | any): this;
     required(required: boolean): this;
+    schema(): JsonSchema;
     schema(schema: JsonSchema): this;
+    itemSchema(schema?: JsonSchema): JsonSchema;
     toJSON(options?: JsonSchemaOptions): any;
 }

package/lib/types/domain/JsonParameterStore.d.ts

@@ -2,7 +2,6 @@ import { Type } from "@tsed/core";
 import { JsonEntityStore, JsonEntityStoreOptions } from "./JsonEntityStore.js";
 import type { JsonMethodStore } from "./JsonMethodStore.js";
 import { JsonParameter } from "./JsonParameter.js";
-import { JsonSchema } from "./JsonSchema.js";
 export interface JsonParameterStoreOptions extends JsonEntityStoreOptions {
     dataPath?: string;
     paramType?: string;
@@ -25,8 +24,6 @@ export declare class JsonParameterStore extends JsonEntityStore {
     readonly parameter: JsonParameter;
     readonly parent: JsonMethodStore;
     constructor(options: JsonParameterStoreOptions);
-    get nestedGenerics(): Type<any>[][];
-    set nestedGenerics(nestedGenerics: Type<any>[][]);
     /**
      * Return the required state.
      * @returns {boolean}
@@ -34,6 +31,7 @@ export declare class JsonParameterStore extends JsonEntityStore {
     get required(): boolean;
     set required(value: boolean);
     get allowedRequiredValues(): any[];
+    get schema(): import("./JsonSchema.js").JsonSchema;
     static getParams<T extends JsonParameterStore = JsonParameterStore>(target: Type<any>, propertyKey: string | symbol): T[];
     static get(target: Type<any>, propertyKey: string | symbol, index: number): JsonParameterStore;
     /**
@@ -42,7 +40,6 @@ export declare class JsonParameterStore extends JsonEntityStore {
      * @returns {boolean}
      */
     isRequired(value: any): boolean;
-    protected getSchema(type: any): JsonSchema;
     protected build(): void;
 }
 /**

package/lib/types/domain/JsonPropertyStore.d.ts

@@ -1,29 +1,10 @@
 import { Type } from "@tsed/core";
-import { JsonEntityStore } from "./JsonEntityStore.js";
 import type { JsonClassStore } from "./JsonClassStore.js";
+import { JsonEntityStore } from "./JsonEntityStore.js";
 export declare class JsonPropertyStore extends JsonEntityStore {
     readonly parent: JsonClassStore;
-    /**
-     * Return the required state.
-     * @returns {boolean}
-     */
-    get required(): boolean;
-    /**
-     * Change the state of the required data.
-     * @param value
-     */
-    set required(value: boolean);
-    get allowedRequiredValues(): any[];
-    discriminatorKey(): this;
-    isDiscriminatorKey(): boolean;
-    /**
-     * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
-     * @param value
-     * @returns {boolean}
-     */
-    isRequired(value: any): boolean;
-    protected build(): void;
     static get(target: Type<any>, propertyKey: string | symbol): JsonPropertyStore;
+    protected build(): void;
 }
 /**
  * @alias JsonPropertyStore