@tsed/schema 7.86.2 → 7.87.0

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

@@ -1,67 +1,99 @@
-import { Hooks, Type, ValueOf } from "@tsed/core";
-import type { JSONSchema6, JSONSchema6Definition, JSONSchema6Type, JSONSchema6TypeName, JSONSchema6Version } from "json-schema";
+import { Type, ValueOf, Hooks } from "@tsed/core";
+import type { JSONSchema7, JSONSchema7Definition, JSONSchema7Type, JSONSchema7TypeName, JSONSchema7Version } from "json-schema";
+import { VendorKeys } from "../constants/VendorKeys.js";
 import { IgnoreCallback } from "../interfaces/IgnoreCallback.js";
 import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
-import { NestedGenerics } from "../utils/generics.js";
+import { type GenericsMap, GenericValue } from "../utils/generics.js";
 import { AliasMap, AliasType } from "./JsonAliasMap.js";
 import { Discriminator } from "./JsonDiscriminator.js";
 import { JsonFormatTypes } from "./JsonFormatTypes.js";
 import { JsonLazyRef } from "./JsonLazyRef.js";
-export interface JsonSchemaObject extends JSONSchema6, Record<string, any> {
-    type: (any | JSONSchema6TypeName) | (any | JSONSchema6TypeName)[];
-    additionalProperties?: boolean | JSONSchema6 | any;
-    propertyNames?: boolean | JSONSchema6 | any;
-    items?: (any | JSONSchema6Definition) | (any | JSONSchema6Definition)[];
+export interface JsonSchemaObject extends Omit<JSONSchema7, "type" | "additionalProperties" | "items"> {
+    type?: Type | JSONSchema7["type"] | null | (String | null | Date | Number | Object | Boolean)[];
+    additionalProperties?: boolean | JSONSchema7 | Type | JsonSchema;
+    items?: (Type | JSONSchema7Definition | JsonSchema) | (Type | JSONSchema7Definition | JsonSchema)[];
 }
-export type AnyJsonSchema = Partial<JsonSchemaObject> | JsonSchema | JsonLazyRef | any;
-export declare class JsonSchema extends Map<string, any> implements NestedGenerics {
+export type AnyJsonSchema = JsonSchemaObject | JSONSchema7 | JsonSchema | JsonLazyRef | {
+    label?: string;
+} | Type;
+export declare class JsonSchema extends Map<string, any> {
     #private;
     readonly $kind: string;
     readonly $isJsonDocument = true;
     readonly $hooks: Hooks;
-    readonly $required: Set<string>;
     readonly $allow: any[];
     $selfRequired: boolean;
-    $forwardGroups: boolean;
     $ignore: boolean | IgnoreCallback;
     isDiscriminatorKey: boolean;
     isDiscriminator: boolean;
     constructor(obj?: JsonSchema | Partial<JsonSchemaObject>);
     get alias(): AliasMap;
-    get nestedGenerics(): any[];
-    set nestedGenerics(value: any[]);
-    get genericLabels(): string[];
-    set genericLabels(value: string[]);
     get isClass(): boolean;
     /**
-     * Current schema is a collection
+     * The current schema is a collection
      */
     get isCollection(): boolean;
+    /**
+     * The current schema is a reference to another schema
+     * to link property/param to a class schema (if the reference exists).
+     */
+    get isLocalSchema(): boolean;
     /**
      * Current schema is a generic
      */
     get isGeneric(): boolean;
     get discriminatorAncestor(): any;
     /**
-     * Current schema has generics items
+     * Return the itemSchema computed type.
+     * If the type is a function used for a recursive model,
+     * the function will be called to get the right type.
+     */
+    get class(): Type<any>;
+    /**
+     * Return the itemSchema computed type.
      */
-    get hasGenerics(): boolean;
-    get genericType(): string;
-    get class(): any;
+    get collectionClass(): Type<any>;
     get canRef(): boolean;
     get isNullable(): boolean;
     get isReadOnly(): any;
     get isWriteOnly(): any;
     get hasDiscriminator(): boolean;
-    static from(obj?: Partial<JsonSchemaObject>): JsonSchema;
-    nullable(value: boolean): void;
+    static from(item?: Partial<JsonSchemaObject> | Type<any> | JsonSchema): JsonSchema;
+    /**
+     * Check if the schema as key, #key or x-key
+     * @param key
+     */
+    has(key: string): boolean;
+    /**
+     * Get the value of the schema by key, #key or x-key.
+     * @param key
+     * @param defaultValue
+     */
+    get<T = any>(key: string, defaultValue: T): T;
+    get<T = any>(key: string, defaultValue?: T): T | undefined;
+    forwardGroups(bool?: boolean): this;
+    groups(groups?: string[], isProperty?: boolean): this;
+    groupsName(groupsName?: string): this;
+    allowedGroups(groups?: string[]): this;
+    /**
+     * Assign the Generic Labels used over a class or a schema.
+     * @param genericLabels
+     */
+    genericLabels(genericLabels: string[]): this;
+    genericLabel(genericLabel: string): this;
+    /**
+     * Assign the types of the generics that must be used for the property
+     * @param generics
+     */
+    genericOf(...generics: GenericValue[][]): this;
+    nullable(value: boolean): this;
     itemSchema(obj?: AnyJsonSchema): JsonSchema;
     getAliasOf(property: AliasType): AliasType | undefined;
     addAlias(property: AliasType, alias: AliasType): this;
     removeAlias(property: AliasType): this;
     $id($id: string): this;
     $ref($ref: string): this;
-    $schema($schema: JSONSchema6Version): this;
+    $schema($schema: JSONSchema7Version): this;
     /**
      * Create a ref and use name to sharing schema
      * @param name
@@ -74,12 +106,12 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
      * It is RECOMMENDED that a default value be valid against the associated schema.
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.3
      */
-    default(value: JSONSchema6Type | undefined | (() => JSONSchema6Type)): this;
+    default(value: JSONSchema7Type | undefined | (() => JSONSchema7Type)): this;
     /**
      * More readible form of a one-element "enum"
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.24
      */
-    const(value: JSONSchema6Type): this;
+    const(value: JSONSchema7Type): this;
     /**
      * This attribute is a string that provides a full description of the of purpose the instance property.
      *
@@ -103,17 +135,17 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
      * An array instance is valid against "contains" if at least one of its elements is valid against the given schema.
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.14
      */
-    contains(contains: JSONSchema6Definition): this;
+    contains(contains: JSONSchema7Definition): this;
     /**
      * Array of examples with no validation effect the value of "default" is usable as an example without repeating it under this keyword
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.4
      */
-    examples(examples: JSONSchema6Type[]): this;
+    examples(examples: JSONSchema7Type[]): this;
     /**
      * Array of examples with no validation effect the value of "default" is usable as an example without repeating it under this keyword
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.4
      */
-    example(...examples: JSONSchema6Type[]): this;
+    example(...examples: JSONSchema7Type[]): this;
     /**
      * This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
      * Omitting this keyword has the same behavior as an empty schema.
@@ -166,6 +198,7 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
     addRequired(property: string): this;
     removeRequired(property: string): this;
     isRequired(property: string): boolean;
+    getRequiredFields(): string[];
     /**
      * This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself.
      * Validation succeeds if, for each name that appears in both the instance and as a name within this keyword's value,
@@ -210,7 +243,7 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.21
      */
     dependencies(dependencies: {
-        [p: string]: JSONSchema6Definition | JsonSchema | string[];
+        [p: string]: JSONSchema7Definition | JsonSchema | string[];
     }): this;
     /**
      * Takes a schema which validates the names of all properties rather than their values.
@@ -218,7 +251,7 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
      * Omitting this keyword has the same behavior as an empty schema.
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.22
      */
-    propertyNames(propertyNames: JSONSchema6Definition | JsonSchema): this;
+    propertyNames(propertyNames: JSONSchema7Definition | JsonSchema): this;
     /**
      * This provides an enumeration of all possible values that are valid
      * for the instance property. This MUST be an array, and each item in
@@ -303,7 +336,7 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
      * A single type, or a union of simple types
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.25
      */
-    type(type: any | JSONSchema6TypeName | JSONSchema6TypeName[]): this;
+    type(type: any | JSONSchema7TypeName | JSONSchema7TypeName[]): this;
     any(...types: any[]): this;
     integer(): this;
     /**
@@ -315,26 +348,36 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
     readOnly(readOnly: boolean): this;
     writeOnly(readOnly: boolean): this;
     customKey(key: string, value: any): this;
+    vendorKey(key: VendorKeys, value: any): this;
     toObject(options?: JsonSchemaOptions): any;
     toJSON(options?: JsonSchemaOptions): any;
-    assign(obj?: JsonSchema | Partial<JsonSchemaObject>): this;
+    assign(obj?: AnyJsonSchema): this;
     set(key: string, value: any): this;
-    /**
-     * 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.
-     */
-    getComputedType(): any;
-    getComputedItemType(): any;
     /**
      * Return the Json type as string
      */
     getJsonType(): string | string[];
     getTarget(): Type<any>;
+    getAllowedGroups(): Set<string> | undefined;
+    getAllowedRequiredValues(): any[];
+    getGroups(): string[] | undefined;
+    getGroupsName(): string | undefined;
     /**
      * Get the symbolic name of the entity
      */
     getName(): any;
     clone(): JsonSchema;
+    getGenericLabels(): string[] | undefined;
+    getGenericOf(): GenericsMap | undefined;
+    /**
+     * Returns the reference schema for class-based schemas.
+     * Used to get the original schema definition when this schema is a local reference.
+     * @returns The reference schema or undefined if not applicable
+     */
+    getRefSchema(): JsonSchema | undefined;
+    propertyKey(s: string): this;
+    getPropertyKey(): string | symbol | undefined;
+    target(target: any): void;
+    isRequiredValue(property: string, value: any): boolean;
     protected setManyOf(keyword: "oneOf" | "anyOf" | "allOf", value: AnyJsonSchema[]): this | undefined;
 }

package/lib/types/domain/__fixtures__/inspectOperationsPaths.d.ts

@@ -0,0 +1,5 @@
+import type { JsonMethodStore } from "../JsonMethodStore.js";
+export declare function inspectOperationsPaths(endpoint: JsonMethodStore): {
+    method: string;
+    path: string | RegExp;
+}[];

package/lib/types/index.d.ts

@@ -1,24 +1,18 @@
 /**
  * @file Automatically generated by @tsed/barrels.
  */
-export * from "./components/async-api/channelsMapper.js";
-export * from "./components/async-api/generate.js";
-export * from "./components/async-api/messageMapper.js";
-export * from "./components/async-api/payloadMapper.js";
-export * from "./components/async-api/responseMapper.js";
 export * from "./components/default/anyMapper.js";
 export * from "./components/default/classMapper.js";
 export * from "./components/default/discriminatorMappingMapper.js";
 export * from "./components/default/enumsMapper.js";
 export * from "./components/default/genericsMapper.js";
 export * from "./components/default/inheritedClassMapper.js";
-export * from "./components/default/itemMapper.js";
 export * from "./components/default/lazyRefMapper.js";
 export * from "./components/default/mapMapper.js";
+export * from "./components/default/nextMapper.js";
 export * from "./components/default/nullableMapper.js";
 export * from "./components/default/objectMapper.js";
 export * from "./components/default/ofMapper.js";
-export * from "./components/default/propertiesMapper.js";
 export * from "./components/default/requiredMapper.js";
 export * from "./components/default/schemaMapper.js";
 export * from "./components/index.js";
@@ -38,6 +32,7 @@ export * from "./components/open-spec/pathsMapper.js";
 export * from "./constants/httpStatusMessages.js";
 export * from "./constants/jsonSchemaProperties.js";
 export * from "./constants/OperationVerbs.js";
+export * from "./constants/VendorKeys.js";
 export * from "./decorators/class/children.js";
 export * from "./decorators/class/discriminatorValue.js";
 export * from "./decorators/collections/collectionContains.js";
@@ -118,6 +113,7 @@ export * from "./decorators/operations/subscribe.js";
 export * from "./decorators/operations/summary.js";
 export * from "./decorators/operations/tags.js";
 export * from "./decorators/operations/view.js";
+export * from "./domain/__fixtures__/inspectOperationsPaths.js";
 export * from "./domain/DecoratorContext.js";
 export * from "./domain/JsonAliasMap.js";
 export * from "./domain/JsonClassStore.js";
@@ -190,12 +186,12 @@ export * from "./utils/mapOpenSpec3.js";
 export * from "./utils/mapOpenSpecInfo.js";
 export * from "./utils/mapOperationOptions.js";
 export * from "./utils/matchGroups.js";
+export * from "./utils/mergeSchema.js";
 export * from "./utils/mergeSpec.js";
 export * from "./utils/operationIdFormatter.js";
 export * from "./utils/ref.js";
 export * from "./utils/removeHiddenOperation.js";
 export * from "./utils/serializeEnumValues.js";
-export * from "./utils/somethingOf.js";
 export * from "./utils/toJsonMapCollection.js";
 export * from "./utils/toJsonRegex.js";
 export * from "./utils/transformToOS2.js";

package/lib/types/interfaces/JsonSchemaOptions.d.ts

@@ -1,4 +1,5 @@
 import { SpecTypes } from "../domain/SpecTypes.js";
+import type { GenericsMap } from "../utils/generics.js";
 export interface JsonSchemaOptions {
     /**
      * Map properties with the alias name. By default, false
@@ -13,12 +14,16 @@ export interface JsonSchemaOptions {
      */
     specType?: SpecTypes;
     /**
-     * Define a groups restriction to generate the JsonSchema.
+     * Define the spec version for OPENAPI (3.1.0, 3.0.3, 3.0.2, 3.0.1, 3.0.0)
+     */
+    specVersion?: string;
+    /**
+     * Define a group restriction to generate the JsonSchema.
      * Set false to disable groups.
      */
     groups?: string[] | false;
     /**
-     * Set the postfix groups name for generated model and ref.
+     * Set the postfix groups name for a generated model and ref.
      */
     groupsName?: string;
     /**
@@ -29,5 +34,14 @@ export interface JsonSchemaOptions {
      * Inline enums when enum instead of using $ref.
      */
     inlineEnums?: boolean;
+    /**
+     * Represents optional generic definitions that adhere to the JSON Schema standard.
+     *
+     * This property allows the specification of generics when constructing or representing a JSON schema.
+     * It can be used to define reusable and parameterized components within the schema structure.
+     *
+     * @type {GenericsMap|undefined}
+     */
+    generics?: GenericsMap;
     [key: string]: any;
 }

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

@@ -1,50 +1,9 @@
 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;
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
+export type GenericValue = Type<any> | JsonSchema | String | Number | Boolean | Object | Date;
+export type GenericsMap = Record<string, [GenericValue] | [GenericValue, GenericsMap]>;
+export declare function getGenericsOptions(value: JsonSchema, options: JsonSchemaOptions): {
+    generics: GenericsMap | undefined;
+    mapper: string;
+};

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

@@ -1,9 +1,9 @@
 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 { JsonEntityStore } from "../domain/JsonEntityStore.js";
 import { JsonMethodStore } from "../domain/JsonMethodStore.js";
+import { JsonParameterStore } from "../domain/JsonParameterStore.js";
+import { JsonPropertyStore } from "../domain/JsonPropertyStore.js";
 /**
  * Get entity store from decorator args
  * @param target

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

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

package/lib/types/utils/mergeSchema.d.ts

@@ -0,0 +1,2 @@
+import type { JSONSchema7 } from "json-schema";
+export declare function mergeSchema(schema1: JSONSchema7, schema2: JSONSchema7): JSONSchema7;

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

@@ -1,5 +1,7 @@
+import type { JSONSchema7 } from "json-schema";
 import type { JsonSchema } from "../domain/JsonSchema.js";
 import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions.js";
+export declare function getSchemaFromRef($ref: string | undefined, options: JsonSchemaOptions): JSONSchema7 | undefined;
 /**
  * @ignore
  */
@@ -7,8 +9,8 @@ export declare function createRefName(name: string, options: JsonSchemaOptions):
 /**
  * @ignore
  */
-export declare function createRef(name: string, schema: JsonSchema, options: JsonSchemaOptions): any;
+export declare function createRef(name: string, schema: JsonSchema, options: JsonSchemaOptions): JSONSchema7;
 /**
  * @ignore
  */
-export declare function toRef(value: JsonSchema, schema: unknown | undefined, options: JsonSchemaOptions): any;
+export declare function toRef(value: JsonSchema, schema: JSONSchema7 | undefined | null, options: JsonSchemaOptions): JSONSchema7;

package/lib/types-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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-esm/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')" />
  *