@tsed/schema 8.11.1 → 8.12.0-rc.1

package/src/domain/SpecTypes.ts

@@ -1,6 +0,0 @@
-export enum SpecTypes {
-  JSON = "jsonschema",
-  SWAGGER = "swagger2",
-  OPENAPI = "openapi3",
-  ASYNCAPI = "asyncapi2"
-}

package/src/domain/__fixtures__/inspectOperationsPaths.ts

@@ -1,8 +0,0 @@
-import type {JsonMethodStore} from "../JsonMethodStore.js";
-
-export function inspectOperationsPaths(endpoint: JsonMethodStore) {
-  return [...endpoint.operationPaths.values()].map(({method, path}) => ({
-    method,
-    path
-  }));
-}

package/src/fn/allOf.ts

@@ -1,13 +0,0 @@
-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.26
- *
- *  * See @@JsonSchema@@ to discover available methods.
- *
- * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
- */
-export function allOf(...allOf: AnyJsonSchema[]): JsonSchema {
-  return from().allOf(allOf);
-}

package/src/fn/any.ts

@@ -1,11 +0,0 @@
-import type {AnyJsonSchema, JsonSchema} from "../domain/JsonSchema.js";
-import {from} from "./from.js";
-
-/**
- * Declare a model with any type (By default: `integer`, `number`, `string`, `boolean`, `array`, `object`, `null`)
- *
- * See @@JsonSchema@@ to discover available methods.
- */
-export function any(...types: AnyJsonSchema[]): JsonSchema {
-  return from().any(...types);
-}

package/src/fn/anyOf.ts

@@ -1,13 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,53 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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/fn/from.spec.ts

@@ -1,174 +0,0 @@
-import "../index.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", () => {
-    expect(from().toJSON()).toEqual({type: "object"});
-    expect(string().toJSON()).toEqual({type: "string"});
-    expect(number().toJSON()).toEqual({type: "number"});
-    expect(integer().toJSON()).toEqual({
-      multipleOf: 1,
-      type: "integer"
-    });
-    expect(boolean().toJSON()).toEqual({type: "boolean"});
-    expect(date().toJSON()).toEqual({
-      format: "date",
-      type: "string"
-    });
-    expect(datetime().toJSON()).toEqual({
-      format: "date-time",
-      type: "string"
-    });
-    expect(time().toJSON()).toEqual({
-      format: "time",
-      type: "string"
-    });
-    expect(email().toJSON()).toEqual({
-      format: "email",
-      type: "string"
-    });
-    expect(email().toJSON()).toEqual({
-      format: "email",
-      type: "string"
-    });
-    expect(uri().toJSON()).toEqual({
-      format: "uri",
-      type: "string"
-    });
-    expect(url().toJSON()).toEqual({
-      format: "url",
-      type: "string"
-    });
-    expect(set().toJSON()).toEqual({
-      type: "array",
-      uniqueItems: true
-    });
-    expect(map().toJSON()).toEqual({
-      additionalProperties: true,
-      type: "object"
-    });
-    expect(array().toJSON()).toEqual({type: "array"});
-    expect(any().toJSON()).toEqual({
-      anyOf: [
-        {
-          type: "null"
-        },
-        {
-          multipleOf: 1,
-          type: "integer"
-        },
-        {
-          type: "number"
-        },
-        {
-          type: "string"
-        },
-        {
-          type: "boolean"
-        },
-        {
-          type: "array"
-        },
-        {
-          type: "object"
-        }
-      ]
-    });
-
-    expect(anyOf(string(), number()).toJSON()).toEqual({
-      anyOf: [{type: "string"}, {type: "number"}]
-    });
-
-    expect(allOf(string(), number()).toJSON()).toEqual({
-      allOf: [{type: "string"}, {type: "number"}]
-    });
-  });
-  it("should create ref when use a label", () => {
-    const ErrorSchema = object({
-      name: string().required().description("The error name"),
-      message: string().required().description("An error message")
-    })
-      .label("GenericError")
-      .unknown();
-
-    const ExceptionSchema = object()
-      .allOf([ErrorSchema])
-      .properties({
-        name: string().required().description("The error name"),
-        message: string().required().description("An error message"),
-        status: number().required().description("The status code of the exception"),
-        errors: array().items(ErrorSchema).description("A list of related errors"),
-        stack: string().description("The stack trace (only in development mode)")
-      });
-
-    expect(ExceptionSchema.toJSON()).toEqual({
-      allOf: [
-        {
-          $ref: "#/definitions/GenericError"
-        }
-      ],
-      definitions: {
-        GenericError: {
-          additionalProperties: true,
-          properties: {
-            message: {
-              description: "An error message",
-              minLength: 1,
-              type: "string"
-            },
-            name: {
-              description: "The error name",
-              minLength: 1,
-              type: "string"
-            }
-          },
-          required: ["name", "message"],
-          type: "object"
-        }
-      },
-      properties: {
-        errors: {
-          description: "A list of related errors",
-          items: {
-            $ref: "#/definitions/GenericError"
-          },
-          type: "array"
-        },
-        message: {
-          description: "An error message",
-          minLength: 1,
-          type: "string"
-        },
-        name: {
-          description: "The error name",
-          minLength: 1,
-          type: "string"
-        },
-        stack: {
-          description: "The stack trace (only in development mode)",
-          type: "string"
-        },
-        status: {
-          description: "The status code of the exception",
-          type: "number"
-        }
-      },
-      required: ["name", "message", "status"],
-      type: "object"
-    });
-  });
-});

package/src/fn/from.ts

@@ -1,33 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,70 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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/hooks/alterIgnore.ts

@@ -1,25 +0,0 @@
-import {isBoolean} from "@tsed/core";
-import type {Hooks} from "@tsed/hooks";
-
-/**
- * @ignore
- * @param schema
- * @param options
- */
-export function alterIgnore(schema: {$hooks: Hooks; $ignore: boolean | Function}, options: any) {
-  if (isBoolean(schema.$ignore) && schema.$ignore) {
-    return true;
-  }
-
-  let result = schema?.$hooks?.alter("ignore", false, [options]);
-
-  if (result) {
-    return result;
-  }
-
-  if (options.groups !== false) {
-    return schema?.$hooks?.alter("groups", false, [options.groups]);
-  }
-
-  return result;
-}

package/src/hooks/alterOneOf.ts

@@ -1,67 +0,0 @@
-import {isArray, isBoolean, isNumber, isObject, isString} from "@tsed/core";
-import type {JSONSchema6} from "json-schema";
-import {filter} from "rxjs";
-
-import {
-  ARRAY_PROPERTIES,
-  BOOLEAN_PROPERTIES,
-  COMMON_PROPERTIES,
-  MANY_OF_PROPERTIES,
-  NUMBER_PROPERTIES,
-  OBJECT_PROPERTIES,
-  STRING_PROPERTIES
-} from "../constants/jsonSchemaProperties.js";
-import type {JsonSchema} from "../domain/JsonSchema.js";
-import type {JsonSchemaOptions} from "../interfaces/JsonSchemaOptions.js";
-
-function findManyOf(obj: any) {
-  return MANY_OF_PROPERTIES.find((keyword) => obj[keyword]);
-}
-
-const RULES: {[index: string]: {properties: string[]; is: (value: any) => boolean}} = {
-  string: {properties: STRING_PROPERTIES, is: isString},
-  number: {properties: NUMBER_PROPERTIES, is: isNumber},
-  boolean: {properties: BOOLEAN_PROPERTIES, is: isBoolean},
-  array: {properties: ARRAY_PROPERTIES, is: () => false},
-  object: {properties: OBJECT_PROPERTIES, is: () => false}
-};
-
-function pickProperties(type: string, obj: JSONSchema6 & Record<string, never>, item: Record<string, never>) {
-  const rule = RULES[type];
-
-  rule?.properties.concat(COMMON_PROPERTIES).forEach((keyword) => {
-    if (obj[keyword] !== undefined) {
-      if (COMMON_PROPERTIES.includes(keyword)) {
-        item[keyword] = (obj[keyword] as never[]).filter(rule.is) as never;
-      } else {
-        item[keyword] = obj[keyword] as never;
-        delete obj[keyword];
-      }
-    }
-  });
-}
-
-export function alterOneOf(obj: any, schema: JsonSchema, options: JsonSchemaOptions) {
-  const kind = findManyOf(obj);
-
-  if (kind) {
-    obj[kind].forEach((item: {type: string} & Record<string, never>) => {
-      pickProperties(item.type as string, obj, item);
-    });
-
-    MANY_OF_PROPERTIES.forEach((keyword) => {
-      if (obj[keyword] && options.groups !== false && schema.$hooks.has(keyword)) {
-        obj = {...obj, [keyword]: schema.$hooks.alter(keyword, obj[keyword], [options.groups])};
-      }
-    });
-
-    delete obj.const;
-    delete obj.enum;
-
-    if (!(obj.items || obj.properties)) {
-      delete obj.type;
-    }
-  }
-
-  return obj;
-}