@tsed/schema 8.0.7 → 8.2.0

package/lib/esm/utils/from.js

@@ -1,256 +0,0 @@
-import { isClass } from "@tsed/core";
-import { JsonEntityStore } from "../domain/JsonEntityStore.js";
-import { JsonFormatTypes } from "../domain/JsonFormatTypes.js";
-import { JsonLazyRef } from "../domain/JsonLazyRef.js";
-import { JsonSchema } from "../domain/JsonSchema.js";
-import { enumsRegistry } from "../registries/enumRegistries.js";
-import { getJsonEntityStore } from "./getJsonEntityStore.js";
-/**
- * Create a new model from the given type.
- *
- * ```typescript
- * from(String)
- * ```
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function from(type = Object) {
-    if (isClass(type)) {
-        const { schema } = getJsonEntityStore(type);
-        schema.properties = function properties(obj) {
-            Object.entries(obj).forEach(([propertyKey, propSchema]) => {
-                getJsonEntityStore(type.prototype, propertyKey).schema.assign(propSchema);
-            });
-            return this;
-        };
-        return schema;
-    }
-    return JsonSchema.from({ type });
-}
-/**
- * Declare a new number model.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function number() {
-    return from(Number);
-}
-/**
- * Declare a new integer model.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function integer() {
-    return from(Number).integer();
-}
-/**
- * Declare a new string model.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function string() {
-    return from(String);
-}
-/**
- * Declare a new boolean model.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function boolean() {
-    return from(Boolean);
-}
-/**
- * Declare a new string model with `format: date`.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function date() {
-    return from(Date).format(JsonFormatTypes.DATE);
-}
-/**
- * Declare a new string model with `format: datetime`.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function datetime() {
-    return from(Date).format(JsonFormatTypes.DATE_TIME);
-}
-/**
- * Declare a new string model with `format: time`.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function time() {
-    return from(Date).format(JsonFormatTypes.TIME);
-}
-/**
- * Declare a new string model with `format: email`.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function email() {
-    return from(String).format(JsonFormatTypes.EMAIL);
-}
-/**
- * Declare a new string model with `format: uri`.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function uri() {
-    return from(String).format(JsonFormatTypes.URI);
-}
-/**
- * Declare a new string model with `format: url`.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function url() {
-    return from(String).format(JsonFormatTypes.URL);
-}
-/**
- * Declare a new object model with `additionalProperties: true`.
- *
- * ```json
- * {
- *   "type": "array"
- * }
- * ```
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function array() {
-    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() {
-    return from(Map).unknown(true);
-}
-/**
- * Declare a new array model with `uniqueItems: true`.
- *
- * ```json
- * {
- *   "type": "array",
- *   "uniqueItems": true
- * }
- * ```
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function set() {
-    return from(Array).uniqueItems(true);
-}
-/**
- * Declare a new object model.
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function object(properties = {}) {
-    return from(Object).properties(properties);
-}
-/**
- * Declare a model with any type (By default: `integer`, `number`, `string`, `boolean`, `array`, `object`, `null`)
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @schemaFunctional
- */
-export function any(...types) {
-    return from().any(...types);
-}
-/**
- * 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 function anyOf(...anyOf) {
-    return from().anyOf(anyOf);
-}
-/**
- * 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) {
-    return from().oneOf(oneOf);
-}
-/**
- * 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 function allOf(...allOf) {
-    return from().allOf(allOf);
-}
-/**
- * Declare a sub schema which will be resolved later. Use this function when you have a circular reference between two schemes.
- *
- * @schemaFunctional
- */
-export function lazyRef(cb) {
-    try {
-        // solve issue with a self referenced model
-        if (cb()) {
-            // type is already accessible
-            return JsonEntityStore.from(cb()).schema;
-        }
-    }
-    catch (er) { }
-    return new JsonLazyRef(cb);
-}
-export function enums(e) {
-    const schema = string().enum(e);
-    enumsRegistry.set(e, schema);
-    return schema;
-}
-//# sourceMappingURL=from.js.map

package/lib/esm/utils/from.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"from.js","sourceRoot":"","sources":["../../../src/utils/from.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAO,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,MAAM,UAAU,IAAI,CAAC,OAAkB,MAAM;IAC3C,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAClB,MAAM,EAAC,MAAM,EAAC,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAE1C,MAAM,CAAC,UAAU,GAAG,SAAS,UAAU,CAAC,GAAgC;YACtE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,EAAE;gBACxD,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM;IACpB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM;IACpB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI;IAClB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI;IAClB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,aAA0C,EAAE;IACjE,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,GAAG,KAAY;IACjC,OAAO,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAC,GAAG,KAAY;IACnC,OAAO,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAC,GAAG,KAAY;IACnC,OAAO,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAC,GAAG,KAAY;IACnC,OAAO,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,EAAmB;IACzC,IAAI,CAAC;QACH,2CAA2C;QAC3C,IAAI,EAAE,EAAE,EAAE,CAAC;YACT,6BAA6B;YAC7B,OAAO,eAAe,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,MAAa,CAAC;QAClD,CAAC;IACH,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC,CAAA,CAAC;IAEf,OAAO,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;AAC7B,CAAC;AACD,MAAM,UAAU,KAAK,CAAC,CAAsB;IAC1C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAE7B,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,190 +0,0 @@
-import { Type } from "@tsed/core";
-import { JsonSchema } from "../domain/JsonSchema.js";
-/**
- * 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;
-export declare function enums(e: Record<string, any>): JsonSchema;