@tsed/schema 8.1.0 → 8.3.0

package/src/fn/anyOf.ts

@@ -0,0 +1,13 @@
+import type {AnyJsonSchema, JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * 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
+ */
+export function anyOf(...anyOf: AnyJsonSchema[]): JsonSchema {
+  return from().anyOf(anyOf);
+}

package/src/fn/boolean.ts

@@ -0,0 +1,11 @@
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new boolean model.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ */
+export function boolean(): JsonSchema {
+  return from(Boolean);
+}

package/src/fn/collection.ts

@@ -0,0 +1,53 @@
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new object model with `additionalProperties: true`.
+ *
+ * ```json
+ * {
+ *   "type": "array"
+ * }
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export function array(): JsonSchema {
+  return from(Array);
+}
+
+/**
+ * Declare a new object model with `additionalProperties: true`.
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "additionalProperties": true
+ * }
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export function map(): JsonSchema {
+  return from(Map).unknown(true);
+}
+
+/**
+ * Declare a new array model with `uniqueItems: true`.
+ *
+ * ```json
+ * {
+ *   "type": "array",
+ *   "uniqueItems": true
+ * }
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ */
+export function set(): JsonSchema {
+  return from(Array).uniqueItems(true);
+}

package/src/fn/date.ts

@@ -0,0 +1,30 @@
+import {JsonFormatTypes} from "../domain/JsonFormatTypes.js";
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new string model with `format: date`.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ */
+export function date(): JsonSchema {
+  return from(Date).format(JsonFormatTypes.DATE);
+}
+
+/**
+ * Declare a new string model with `format: datetime`.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ */
+export function datetime(): JsonSchema {
+  return from(Date).format(JsonFormatTypes.DATE_TIME);
+}
+
+/**
+ * Declare a new string model with `format: time`.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ */
+export function time(): JsonSchema {
+  return from(Date).format(JsonFormatTypes.TIME);
+}

package/src/fn/email.ts

@@ -0,0 +1,19 @@
+import {JsonFormatTypes} from "../domain/JsonFormatTypes.js";
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new string model with `format: email`.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * ### Example
+ *
+ * ```typescript
+ * const schema = email();
+ * // Results in: { type: "string", format: "email" }
+ * ```
+ */
+export function email(): JsonSchema {
+  return from(String).format(JsonFormatTypes.EMAIL);
+}

package/src/fn/enums.ts

@@ -0,0 +1,9 @@
+import {enumsRegistry} from "../registries/enumRegistries.js";
+import {string} from "./string.js";
+
+export function enums(e: Record<string, any>) {
+  const schema = string().enum(e);
+  enumsRegistry.set(e, schema);
+
+  return schema;
+}

package/src/{utils → fn}/from.spec.ts

@@ -1,28 +1,19 @@
 import "../index.js";
 
-import {CollectionOf} from "../decorators/collections/collectionOf.js";
-import {Property} from "../decorators/common/property.js";
-import {
-  allOf,
-  any,
-  anyOf,
-  array,
-  boolean,
-  date,
-  datetime,
-  email,
-  from,
-  integer,
-  lazyRef,
-  map,
-  number,
-  object,
-  set,
-  string,
-  time,
-  uri,
-  url
-} from "./from.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 {date, datetime, time} from "./date.js";
+import {email} from "./email.js";
+import {from} from "./from.js";
+import {integer} from "./integer.js";
+import {number} from "./number.js";
+import {object} from "./object.js";
+import {string} from "./string.js";
+import {uri} from "./uri.js";
+import {url} from "./url.js";
 
 describe("from", () => {
   it("should declare a model", () => {
@@ -180,64 +171,4 @@ describe("from", () => {
       type: "object"
     });
   });
-  it("should declare a lazyRef", () => {
-    const schema1 = object({
-      owners: array().items(lazyRef(() => Owner))
-    });
-
-    class Post {
-      @Property()
-      id: string;
-
-      @Property(() => Owner)
-      owner: typeof Owner;
-    }
-
-    class Owner {
-      @Property()
-      id: string;
-
-      @CollectionOf(() => Post)
-      posts: Post[];
-    }
-
-    expect(schema1.toJSON()).toEqual({
-      definitions: {
-        Owner: {
-          properties: {
-            id: {
-              type: "string"
-            },
-            posts: {
-              items: {
-                $ref: "#/definitions/Post"
-              },
-              type: "array"
-            }
-          },
-          type: "object"
-        },
-        Post: {
-          properties: {
-            id: {
-              type: "string"
-            },
-            owner: {
-              $ref: "#/definitions/Owner"
-            }
-          },
-          type: "object"
-        }
-      },
-      properties: {
-        owners: {
-          items: {
-            $ref: "#/definitions/Owner"
-          },
-          type: "array"
-        }
-      },
-      type: "object"
-    });
-  });
 });

package/src/fn/from.ts

@@ -0,0 +1,33 @@
+import {isClass, Type} from "@tsed/core";
+
+import {JsonSchema} from "../domain/JsonSchema.js";
+import {getJsonEntityStore} from "../utils/getJsonEntityStore.js";
+
+/**
+ * Create a new model from the given type.
+ *
+ * ```typescript
+ * from(String)
+ * ```
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export function from(type: Type<any> = Object) {
+  if (isClass(type)) {
+    const {schema} = getJsonEntityStore(type);
+
+    schema.properties = function properties(obj: {[key: string]: JsonSchema}) {
+      Object.entries(obj).forEach(([propertyKey, propSchema]) => {
+        getJsonEntityStore(type.prototype, propertyKey).schema.assign(propSchema);
+      });
+
+      return this;
+    };
+
+    return schema;
+  }
+
+  return JsonSchema.from({type});
+}

package/src/fn/integer.ts

@@ -0,0 +1,13 @@
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+/**
+ * Declare a new integer model.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * @returns {JsonSchema} A schema configured for integer values
+ * @function
+ */
+export function integer(): JsonSchema {
+  return from(Number).integer();
+}

package/src/fn/layzRef.spec.ts

@@ -0,0 +1,70 @@
+import "../index.js";
+
+import {CollectionOf} from "../decorators/collections/collectionOf.js";
+import {Property} from "../decorators/common/property.js";
+import {array} from "./collection.js";
+import {lazyRef} from "./lazyRef.js";
+import {object} from "./object.js";
+
+describe("lazyRef", () => {
+  it("should declare a lazyRef", () => {
+    const schema1 = object({
+      owners: array().items(lazyRef(() => Owner))
+    });
+
+    class Post {
+      @Property()
+      id: string;
+
+      @Property(() => Owner)
+      owner: typeof Owner;
+    }
+
+    class Owner {
+      @Property()
+      id: string;
+
+      @CollectionOf(() => Post)
+      posts: Post[];
+    }
+
+    expect(schema1.toJSON()).toEqual({
+      definitions: {
+        Owner: {
+          properties: {
+            id: {
+              type: "string"
+            },
+            posts: {
+              items: {
+                $ref: "#/definitions/Post"
+              },
+              type: "array"
+            }
+          },
+          type: "object"
+        },
+        Post: {
+          properties: {
+            id: {
+              type: "string"
+            },
+            owner: {
+              $ref: "#/definitions/Owner"
+            }
+          },
+          type: "object"
+        }
+      },
+      properties: {
+        owners: {
+          items: {
+            $ref: "#/definitions/Owner"
+          },
+          type: "array"
+        }
+      },
+      type: "object"
+    });
+  });
+});

package/src/fn/lazyRef.ts

@@ -0,0 +1,19 @@
+import type {Type} from "@tsed/core";
+
+import {JsonEntityStore} from "../domain/JsonEntityStore.js";
+import {JsonLazyRef} from "../domain/JsonLazyRef.js";
+
+/**
+ * Declare a sub schema which will be resolved later. Use this function when you have a circular reference between two schemes.
+ */
+export function lazyRef(cb: () => Type<any>) {
+  try {
+    // solve issue with a self referenced model
+    if (cb()) {
+      // type is already accessible
+      return JsonEntityStore.from(cb()).schema as any;
+    }
+  } catch (er) {}
+
+  return new JsonLazyRef(cb);
+}

package/src/fn/number.ts

@@ -0,0 +1,10 @@
+import {from} from "./from.js";
+
+/**
+ * Declare a new number model.
+ *
+ * * See @@JsonSchema@@ to discover available methods.
+ */
+export function number() {
+  return from(Number);
+}

package/src/fn/object.ts

@@ -0,0 +1,23 @@
+import {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new object model.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ *
+ * ### Example
+ *
+ * ```typescript
+ * const userSchema = object({
+ *   name: string(),
+ *   age: number()
+ * });
+ * ```
+ *
+ * @param properties - An object containing property definitions where each value is a JsonSchema
+ * @returns {JsonSchema} A new object model with the specified properties
+ */
+export function object(properties: {[key: string]: JsonSchema} = {}): JsonSchema {
+  return from(Object).properties(properties);
+}

package/src/fn/oneOf.ts

@@ -0,0 +1,14 @@
+import type {AnyJsonSchema, JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * 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 function oneOf(...oneOf: AnyJsonSchema[]): JsonSchema {
+  return from().oneOf(oneOf);
+}

package/src/fn/string.ts

@@ -0,0 +1,11 @@
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new string model.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ */
+export function string(): JsonSchema {
+  return from(String);
+}

package/src/fn/uri.ts

@@ -0,0 +1,14 @@
+import {JsonFormatTypes} from "../domain/JsonFormatTypes.js";
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new string model with `format: uri`.
+ *
+ *  * See @@JsonSchema@@ to discover available methods.
+ *
+ * @schemaFunctional
+ */
+export function uri(): JsonSchema {
+  return from(String).format(JsonFormatTypes.URI);
+}

package/src/fn/url.ts

@@ -0,0 +1,12 @@
+import {JsonFormatTypes} from "../domain/JsonFormatTypes.js";
+import type {JsonSchema} from "../domain/JsonSchema.js";
+import {from} from "./from.js";
+
+/**
+ * Declare a new string model with `format: url`.
+ *
+ * See @@JsonSchema@@ to discover available methods.
+ */
+export function url(): JsonSchema {
+  return from(String).format(JsonFormatTypes.URL);
+}

package/src/index.ts

@@ -71,6 +71,7 @@ export * from "./decorators/common/hidden.js";
 export * from "./decorators/common/ignore.js";
 export * from "./decorators/common/integer.js";
 export * from "./decorators/common/jsonEntityFn.js";
+export * from "./decorators/common/labelledAs.js";
 export * from "./decorators/common/maximum.js";
 export * from "./decorators/common/maxLength.js";
 export * from "./decorators/common/minimum.js";
@@ -138,6 +139,23 @@ export * from "./domain/JsonRequestBody.js";
 export * from "./domain/JsonResponse.js";
 export * from "./domain/JsonSchema.js";
 export * from "./domain/SpecTypes.js";
+export * from "./fn/allOf.js";
+export * from "./fn/any.js";
+export * from "./fn/anyOf.js";
+export * from "./fn/boolean.js";
+export * from "./fn/collection.js";
+export * from "./fn/date.js";
+export * from "./fn/email.js";
+export * from "./fn/enums.js";
+export * from "./fn/from.js";
+export * from "./fn/integer.js";
+export * from "./fn/lazyRef.js";
+export * from "./fn/number.js";
+export * from "./fn/object.js";
+export * from "./fn/oneOf.js";
+export * from "./fn/string.js";
+export * from "./fn/uri.js";
+export * from "./fn/url.js";
 export * from "./hooks/alterIgnore.js";
 export * from "./hooks/alterOneOf.js";
 export * from "./hooks/alterRequiredGroups.js";
@@ -151,7 +169,6 @@ export * from "./utils/buildPath.js";
 export * from "./utils/concatParameters.js";
 export * from "./utils/concatPath.js";
 export * from "./utils/defineStatusModel.js";
-export * from "./utils/from.js";
 export * from "./utils/generateSpec.js";
 export * from "./utils/generics.js";
 export * from "./utils/getComputedType.js";

package/src/registries/JsonSchemaMapperContainer.ts

@@ -44,7 +44,7 @@ export function hasMapper(type: string) {
   return JsonSchemaMappersContainer.has(type);
 }
 
-export function oneOfMapper(types: string[], options: any): string {
+export function execOneOfMapper(types: string[], options: any): string {
   return (
     types.find((type) => JsonSchemaMappersContainer.has(`${options?.specType}:${type}`)) ||
     types.find((type) => JsonSchemaMappersContainer.has(type))!

package/src/utils/ref.ts

@@ -4,7 +4,6 @@ import {pascalCase} from "change-case";
 import type {JsonSchema} from "../domain/JsonSchema.js";
 import {SpecTypes} from "../domain/SpecTypes.js";
 import {JsonSchemaOptions} from "../interfaces/JsonSchemaOptions.js";
-import {anyOf} from "./from.js";
 
 /**
  * ignore