@tsed/schema 8.17.2 → 8.18.0

package/lib/types/fn/boolean.d.ts

@@ -1,7 +1,8 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new boolean model.
  *
- *  * See @@JsonSchema@@ to discover available methods.
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function boolean(): JsonSchema;
+export declare function boolean(): import("../index.js").JsonSchema<boolean>;

package/lib/types/fn/collection.d.ts

@@ -1,43 +1,56 @@
 import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
- * Declare a new object model with `additionalProperties: true`.
+ * Declare a new array model. If an item schema is provided, it will be set as `items` and its type will be inferred.
  *
  * ```json
- * {
- *   "type": "array"
- * }
+ * { "type": "array" }
  * ```
  *
- *  * See @@JsonSchema@@ to discover available methods.
+ * See @@JsonSchema@@ to discover available methods.
  *
  * @schemaFunctional
  */
-export declare function array(): JsonSchema;
+export declare function array(): JsonSchema<any[]>;
+export declare function array<I>(item: JsonSchema<I>): JsonSchema<I[]>;
 /**
- * Declare a new object model with `additionalProperties: true`.
+ * Declare a new object model with `additionalProperties: true` (map-like). If a value schema is provided, it is used
+ * as `additionalProperties` and its type will be inferred.
  *
  * ```json
- * {
- *   "type": "object",
- *   "additionalProperties": true
- * }
+ * { "type": "object", "additionalProperties": true }
  * ```
  *
- *  * See @@JsonSchema@@ to discover available methods.
+ * See @@JsonSchema@@ to discover available methods.
  *
  * @schemaFunctional
  */
-export declare function map(): JsonSchema;
+export declare function map(): JsonSchema<Record<string, any>>;
+export declare function map<V>(value: JsonSchema<V>): JsonSchema<Map<string, V>>;
 /**
- * Declare a new array model with `uniqueItems: true`.
+ * Declare a new array model representing a Set with `uniqueItems: true`. If an item schema is provided, it will be set
+ * as `items` and its type will be inferred as `Set<I>`.
  *
  * ```json
- * {
- *   "type": "array",
- *   "uniqueItems": true
- * }
+ * { "type": "array", "uniqueItems": true }
  * ```
  *
- *  * See @@JsonSchema@@ to discover available methods.
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export declare function set(): JsonSchema<Set<any>>;
+export declare function set<I>(item: JsonSchema<I>): JsonSchema<Set<I>>;
+/**
+ * Declare a new object model with `additionalProperties: true` (record-like). If a value schema is provided, it is used
+ * as `additionalProperties` and its type will be inferred as `Record<string, V>`.
+ *
+ * ```json
+ * { "type": "object", "additionalProperties": true }
+ * ```
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function set(): JsonSchema;
+export declare function record<K extends string | number | symbol = string, V = any>(): JsonSchema<Record<K, V>>;
+export declare function record<V>(value: JsonSchema<V>): JsonSchema<Record<string, V>>;

package/lib/types/fn/date.d.ts

@@ -1,19 +1,24 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new string model with `format: date`.
  *
  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function date(): JsonSchema;
+export declare function date(): import("../index.js").JsonSchema<Date>;
 /**
  * Declare a new string model with `format: datetime`.
  *
  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function datetime(): JsonSchema;
+export declare function datetime(): import("../index.js").JsonSchema<Date>;
 /**
  * Declare a new string model with `format: time`.
  *
  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function time(): JsonSchema;
+export declare function time(): import("../index.js").JsonSchema<Date>;

package/lib/types/fn/email.d.ts

@@ -1,4 +1,3 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new string model with `format: email`.
  *
@@ -10,5 +9,7 @@ import type { JsonSchema } from "../domain/JsonSchema.js";
  * const schema = email();
  * // Results in: { type: "string", format: "email" }
  * ```
+ *
+ * @schemaFunctional
  */
-export declare function email(): JsonSchema;
+export declare function email(): import("../index.js").JsonSchema<string>;

package/lib/types/fn/enums.d.ts

@@ -1 +1,11 @@
-export declare function enums(e: Record<string, any>): import("../index.js").JsonSchema;
+import type { JsonSchema } from "../domain/JsonSchema.js";
+/**
+ * Declare a new enum model.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ * @param e
+ */
+export declare function enums<E extends Record<string, string | number>>(e: E): JsonSchema<E[keyof E]>;
+export declare function enums<T extends readonly (string | number)[]>(e: T): JsonSchema<T[number]>;

package/lib/types/fn/from.d.ts

@@ -1,5 +1,6 @@
 import { Type } from "@tsed/core";
 import { JsonSchema } from "../domain/JsonSchema.js";
+import type { CtorToType } from "../domain/types.js";
 /**
  * Create a new model from the given type.
  *
@@ -11,4 +12,5 @@ import { JsonSchema } from "../domain/JsonSchema.js";
  *
  * @schemaFunctional
  */
-export declare function from(type?: Type<any>): JsonSchema;
+export declare function from<TC extends Type<any> = Type<any>>(): JsonSchema<CtorToType<ObjectConstructor>>;
+export declare function from<TC extends Type<any> = Type<any>>(type?: TC): JsonSchema<CtorToType<TC>>;

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

@@ -1,10 +1,13 @@
+import type { Infer } from "../domain/types.js";
 import { allOf } from "./allOf.js";
+import { any } from "./any.js";
 import { anyOf } from "./anyOf.js";
 import { boolean } from "./boolean.js";
-import { array, map, set } from "./collection.js";
+import { array, map, record, set } from "./collection.js";
 import { date, datetime, time } from "./date.js";
 import { email } from "./email.js";
 import { enums } from "./enums.js";
+import { from } from "./from.js";
 import { integer } from "./integer.js";
 import { lazyRef } from "./lazyRef.js";
 import { number } from "./number.js";
@@ -13,13 +16,20 @@ import { oneOf } from "./oneOf.js";
 import { string } from "./string.js";
 import { uri } from "./uri.js";
 import { url } from "./url.js";
+/**
+ * A namespace of all schema builder functions.
+ * @schemaFunctional
+ */
 export declare const s: {
+    readonly from: typeof from;
     readonly allOf: typeof allOf;
     readonly anyOf: typeof anyOf;
+    readonly any: typeof any;
     readonly boolean: typeof boolean;
     readonly array: typeof array;
     readonly map: typeof map;
     readonly set: typeof set;
+    readonly record: typeof record;
     readonly date: typeof date;
     readonly datetime: typeof datetime;
     readonly time: typeof time;
@@ -34,3 +44,6 @@ export declare const s: {
     readonly uri: typeof uri;
     readonly url: typeof url;
 };
+export declare namespace s {
+    type infer<S> = Infer<S>;
+}

package/lib/types/fn/integer.d.ts

@@ -1,10 +1,9 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new integer model.
  *
  * See @@JsonSchema@@ to discover available methods.
  *
- * @returns {JsonSchema} A schema configured for integer values
- * @function
+ * @returns A schema configured for integer values
+ * @schemaFunctional
  */
-export declare function integer(): JsonSchema;
+export declare function integer(): import("../index.js").JsonSchema<number>;

package/lib/types/fn/lazyRef.d.ts

@@ -1,5 +1,7 @@
-import type { Type } from "@tsed/core";
+import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * 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 lazyRef<T extends abstract new (...args: any) => any>(cb: () => T): JsonSchema<InstanceType<T>>;

package/lib/types/fn/number.d.ts

@@ -2,5 +2,7 @@
  * Declare a new number model.
  *
  * * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function number(): import("../index.js").JsonSchema;
+export declare function number(): import("../index.js").JsonSchema<number>;

package/lib/types/fn/object.d.ts

@@ -14,8 +14,7 @@ import { JsonSchema } from "../domain/JsonSchema.js";
  * ```
  *
  * @param properties - An object containing property definitions where each value is a JsonSchema
- * @returns {JsonSchema} A new object model with the specified properties
+ * @returns A new object model with the specified properties
+ * @schemaFunctional
  */
-export declare function object(properties?: {
-    [key: string]: JsonSchema;
-}): JsonSchema;
+export declare function object<P extends Record<string, JsonSchema<any>> = Record<string, JsonSchema<any>>>(properties?: P): JsonSchema<import("../index.js").PropsToShape<P>>;

package/lib/types/fn/oneOf.d.ts

@@ -1,4 +1,5 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
+import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
+import type { Infer } from "../domain/types.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
  *
@@ -7,4 +8,4 @@ import type { JsonSchema } from "../domain/JsonSchema.js";
  * @schemaFunctional
  * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
  */
-export declare function oneOf(...oneOf: Parameters<JsonSchema["oneOf"]>[0]): JsonSchema;
+export declare function oneOf<S extends Array<AnyJsonSchema | null>>(...oneOf: S): JsonSchema<Infer<S[number]>>;

package/lib/types/fn/string.d.ts

@@ -1,7 +1,8 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new string model.
  *
  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function string(): JsonSchema;
+export declare function string(): import("../index.js").JsonSchema<string>;

package/lib/types/fn/uri.d.ts

@@ -1,4 +1,3 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new string model with `format: uri`.
  *
@@ -6,4 +5,4 @@ import type { JsonSchema } from "../domain/JsonSchema.js";
  *
  * @schemaFunctional
  */
-export declare function uri(): JsonSchema;
+export declare function uri(): import("../index.js").JsonSchema<string>;

package/lib/types/fn/url.d.ts

@@ -1,7 +1,8 @@
-import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a new string model with `format: url`.
  *
  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
  */
-export declare function url(): JsonSchema;
+export declare function url(): import("../index.js").JsonSchema<string>;

package/lib/types/index.d.ts

@@ -134,6 +134,7 @@ export * from "./domain/JsonRequestBody.js";
 export * from "./domain/JsonResponse.js";
 export * from "./domain/JsonSchema.js";
 export * from "./domain/SpecTypes.js";
+export * from "./domain/types.js";
 export * from "./fn/allOf.js";
 export * from "./fn/any.js";
 export * from "./fn/anyOf.js";

package/lib/types/registries/enumRegistries.d.ts

@@ -1,2 +1,2 @@
 import { JsonSchema } from "../domain/JsonSchema.js";
-export declare const enumsRegistry: Map<any, JsonSchema>;
+export declare const enumsRegistry: Map<any, JsonSchema<import("json-schema").JSONSchema7Type>>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/schema",
   "description": "JsonSchema module for Ts.ED Framework",
   "type": "module",
-  "version": "8.17.2",
+  "version": "8.18.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -34,7 +34,7 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/openspec": "8.17.2",
+    "@tsed/openspec": "8.18.0",
     "change-case": "^5.4.4",
     "json-schema": "0.4.0",
     "picomatch": "4.0.2",
@@ -43,11 +43,11 @@
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
-    "@tsed/barrels": "8.17.2",
-    "@tsed/core": "8.17.2",
-    "@tsed/hooks": "8.17.2",
-    "@tsed/openspec": "8.17.2",
-    "@tsed/typescript": "8.17.2",
+    "@tsed/barrels": "8.18.0",
+    "@tsed/core": "8.18.0",
+    "@tsed/hooks": "8.18.0",
+    "@tsed/openspec": "8.18.0",
+    "@tsed/typescript": "8.18.0",
     "@types/fs-extra": "11.0.4",
     "@types/json-schema": "7.0.15",
     "@types/picomatch": "3.0.2",