@tsed/schema 8.11.1 → 8.12.0-rc.1

package/src/hooks/alterRequiredGroups.ts

@@ -1,12 +0,0 @@
-import type {JsonSchema} from "../domain/JsonSchema.js";
-import type {JsonSchemaOptions} from "../interfaces/JsonSchemaOptions.js";
-/**
- * @ignore
- */
-export function alterRequiredGroups(required: string[], schema: JsonSchema, options: JsonSchemaOptions): string[] {
-  if (options.groups !== false) {
-    return schema?.$hooks?.alter("requiredGroups", required, [options.groups]);
-  }
-
-  return required;
-}

package/src/index.ts

@@ -1,202 +0,0 @@
-/**
- * @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/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";
-export * from "./components/open-spec/discriminatorMappingMapper.js";
-export * from "./components/open-spec/enumsMapper.js";
-export * from "./components/open-spec/generate.js";
-export * from "./components/open-spec/nullableMapper.js";
-export * from "./components/open-spec/operationInFilesMapper.js";
-export * from "./components/open-spec/operationInParameterMapper.js";
-export * from "./components/open-spec/operationInParametersMapper.js";
-export * from "./components/open-spec/operationInQueryMapper.js";
-export * from "./components/open-spec/operationMapper.js";
-export * from "./components/open-spec/operationMediaMapper.js";
-export * from "./components/open-spec/operationRequestBodyMapper.js";
-export * from "./components/open-spec/operationResponseMapper.js";
-export * from "./components/open-spec/pathsMapper.js";
-export * from "./constants/httpStatusMessages.js";
-export * from "./constants/jsonSchemaProperties.js";
-export * from "./constants/OperationVerbs.js";
-export * from "./decorators/class/children.js";
-export * from "./decorators/class/discriminatorValue.js";
-export * from "./decorators/collections/collectionContains.js";
-export * from "./decorators/collections/collectionOf.js";
-export * from "./decorators/collections/maxItems.js";
-export * from "./decorators/collections/maxProperties.js";
-export * from "./decorators/collections/minItems.js";
-export * from "./decorators/collections/minProperties.js";
-export * from "./decorators/collections/uniqueItems.js";
-export * from "./decorators/common/additionalProperties.js";
-export * from "./decorators/common/allOf.js";
-export * from "./decorators/common/allow.js";
-export * from "./decorators/common/any.js";
-export * from "./decorators/common/anyOf.js";
-export * from "./decorators/common/const.js";
-export * from "./decorators/common/customKey.js";
-export * from "./decorators/common/default.js";
-export * from "./decorators/common/defaultMsg.js";
-export * from "./decorators/common/description.js";
-export * from "./decorators/common/discriminatorKey.js";
-export * from "./decorators/common/enum.js";
-export * from "./decorators/common/errorMsg.js";
-export * from "./decorators/common/example.js";
-export * from "./decorators/common/examples.js";
-export * from "./decorators/common/exclusiveMaximum.js";
-export * from "./decorators/common/exclusiveMinimum.js";
-export * from "./decorators/common/format.js";
-export * from "./decorators/common/forwardGroups.js";
-export * from "./decorators/common/groups.js";
-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";
-export * from "./decorators/common/minLength.js";
-export * from "./decorators/common/multipleOf.js";
-export * from "./decorators/common/name.js";
-export * from "./decorators/common/nullable.js";
-export * from "./decorators/common/oneOf.js";
-export * from "./decorators/common/optional.js";
-export * from "./decorators/common/pattern.js";
-export * from "./decorators/common/property.js";
-export * from "./decorators/common/readOnly.js";
-export * from "./decorators/common/recordOf.js";
-export * from "./decorators/common/required.js";
-export * from "./decorators/common/requiredGroups.js";
-export * from "./decorators/common/schema.js";
-export * from "./decorators/common/title.js";
-export * from "./decorators/common/typeError.js";
-export * from "./decorators/common/writeOnly.js";
-export * from "./decorators/config/jsonEntityComponent.js";
-export * from "./decorators/generics/genericOf.js";
-export * from "./decorators/generics/generics.js";
-export * from "./decorators/operations/acceptMime.js";
-export * from "./decorators/operations/consumes.js";
-export * from "./decorators/operations/contentType.js";
-export * from "./decorators/operations/deprecated.js";
-export * from "./decorators/operations/header.js";
-export * from "./decorators/operations/in.js";
-export * from "./decorators/operations/inFile.js";
-export * from "./decorators/operations/location.js";
-export * from "./decorators/operations/operation.js";
-export * from "./decorators/operations/operationId.js";
-export * from "./decorators/operations/operationPath.js";
-export * from "./decorators/operations/partial.js";
-export * from "./decorators/operations/path.js";
-export * from "./decorators/operations/produces.js";
-export * from "./decorators/operations/publish.js";
-export * from "./decorators/operations/redirect.js";
-export * from "./decorators/operations/returns.js";
-export * from "./decorators/operations/route.js";
-export * from "./decorators/operations/security.js";
-export * from "./decorators/operations/status.js";
-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/DecoratorContext.js";
-export * from "./domain/JsonAliasMap.js";
-export * from "./domain/JsonClassStore.js";
-export * from "./domain/JsonDiscriminator.js";
-export * from "./domain/JsonEntityStore.js";
-export * from "./domain/JsonFormatTypes.js";
-export * from "./domain/JsonLazyRef.js";
-export * from "./domain/JsonMap.js";
-export * from "./domain/JsonMedia.js";
-export * from "./domain/JsonMethodStore.js";
-export * from "./domain/JsonOperation.js";
-export * from "./domain/JsonOperationPathsMap.js";
-export * from "./domain/JsonOperationRoute.js";
-export * from "./domain/JsonParameter.js";
-export * from "./domain/JsonParameterStore.js";
-export * from "./domain/JsonParameterTypes.js";
-export * from "./domain/JsonPropertyStore.js";
-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";
-export * from "./interfaces/IgnoreCallback.js";
-export * from "./interfaces/JsonHookContext.js";
-export * from "./interfaces/JsonOpenSpec.js";
-export * from "./interfaces/JsonSchemaOptions.js";
-export * from "./registries/enumRegistries.js";
-export * from "./registries/JsonSchemaMapperContainer.js";
-export * from "./utils/buildPath.js";
-export * from "./utils/concatParameters.js";
-export * from "./utils/concatPath.js";
-export * from "./utils/defineStatusModel.js";
-export * from "./utils/generateSpec.js";
-export * from "./utils/generics.js";
-export * from "./utils/getComputedType.js";
-export * from "./utils/getInheritedStores.js";
-export * from "./utils/getJsonEntityStore.js";
-export * from "./utils/getJsonPathParameters.js";
-export * from "./utils/getJsonSchema.js";
-export * from "./utils/getJsonType.js";
-export * from "./utils/getOperationsRoutes.js";
-export * from "./utils/getOperationsStores.js";
-export * from "./utils/getPropertiesStores.js";
-export * from "./utils/getSpec.js";
-export * from "./utils/getSpecType.js";
-export * from "./utils/isSuccessStatus.js";
-export * from "./utils/mapHeaders.js";
-export * from "./utils/mapOpenSpec.js";
-export * from "./utils/mapOpenSpec2.js";
-export * from "./utils/mapOpenSpec3.js";
-export * from "./utils/mapOpenSpecInfo.js";
-export * from "./utils/mapOperationOptions.js";
-export * from "./utils/matchGroups.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";
-export * from "./utils/withErrorMsg.js";

package/src/interfaces/IgnoreCallback.ts

@@ -1,5 +0,0 @@
-import {JsonHookContext} from "./JsonHookContext.js";
-
-export interface IgnoreCallback {
-  (value: boolean, ctx: JsonHookContext): boolean;
-}

package/src/interfaces/JsonHookContext.ts

@@ -1,18 +0,0 @@
-declare global {
-  namespace TsED {
-    interface JsonHookContext {}
-  }
-}
-
-export interface JsonHookContext extends TsED.JsonHookContext {
-  /**
-   * The current instance used by serializer function
-   */
-  self: any;
-  /**
-   *
-   */
-  groups?: string[] | false;
-
-  [key: string]: any;
-}

package/src/interfaces/JsonOpenSpec.ts

@@ -1,7 +0,0 @@
-import {OS3Header} from "@tsed/openspec";
-
-export interface JsonHeader extends OS3Header {}
-
-export interface JsonHeaders {
-  [key: string]: number | string | (JsonHeader & {type?: string; value?: string | number});
-}

package/src/interfaces/JsonSchemaOptions.ts

@@ -1,35 +0,0 @@
-import {SpecTypes} from "../domain/SpecTypes.js";
-
-export interface JsonSchemaOptions {
-  /**
-   * Map properties with the alias name. By default, false
-   */
-  useAlias?: boolean;
-  /**
-   * Reference to components Object.
-   */
-  components?: Record<string, any>;
-  /**
-   * Define Spec types level
-   */
-  specType?: SpecTypes;
-  /**
-   * Define a groups restriction to generate the JsonSchema.
-   * Set false to disable groups.
-   */
-  groups?: string[] | false;
-  /**
-   * Set the postfix groups name for generated model and ref.
-   */
-  groupsName?: string;
-  /**
-   * Generate custom keys when SpecType is JSON.
-   */
-  customKeys?: boolean;
-  /**
-   * Inline enums when enum instead of using $ref.
-   */
-  inlineEnums?: boolean;
-
-  [key: string]: any;
-}

package/src/registries/JsonSchemaMapperContainer.ts

@@ -1,52 +0,0 @@
-import {SpecTypes} from "../domain/SpecTypes.js";
-
-/**
- * @ignore
- */
-export interface JsonSchemaMapper {
-  (...args: any[]): any;
-}
-
-/**
- * @ignore
- */
-const JsonSchemaMappersContainer: Map<string, JsonSchemaMapper> = new Map();
-
-/**
- * @ignore
- */
-export function registerJsonSchemaMapper(type: string, mapper: JsonSchemaMapper, spec?: SpecTypes) {
-  return JsonSchemaMappersContainer.set(spec ? `${spec}:${type}` : type, mapper);
-}
-
-/**
- * @ignore
- */
-export function getJsonSchemaMapper(type: string, options: any): JsonSchemaMapper {
-  const mapper = JsonSchemaMappersContainer.get(`${options?.specType}:${type}`)! || JsonSchemaMappersContainer.get(type)!;
-
-  if (mapper) {
-    return mapper;
-  }
-
-  // istanbul ignore next
-  throw new Error(`JsonSchema ${type} mapper doesn't exists`);
-}
-
-/**
- * @ignore
- */
-export function execMapper(type: string, args: any[], options: any, parent?: any): any {
-  return getJsonSchemaMapper(type, options)(...args, options, parent);
-}
-
-export function hasMapper(type: string) {
-  return JsonSchemaMappersContainer.has(type);
-}
-
-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/registries/enumRegistries.ts

@@ -1,3 +0,0 @@
-import {JsonSchema} from "../domain/JsonSchema.js";
-
-export const enumsRegistry = new Map<any, JsonSchema>();

package/src/utils/__snapshots__/generateSpec.spec.ts.snap

@@ -1,109 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`generateSpec() > OS 3.0.1 > should generate spec with sorted paths 1`] = `
-{
-  "info": {
-    "title": "Api documentation",
-    "version": "1.0.0",
-  },
-  "openapi": "3.0.1",
-  "paths": {
-    "/rest/controller1": {
-      "get": {
-        "operationId": "controller1Method",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "Success",
-          },
-        },
-        "tags": [
-          "Controller1",
-        ],
-      },
-    },
-    "/rest/controller1/test": {
-      "post": {
-        "operationId": "controller1Method5",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "Success",
-          },
-        },
-        "tags": [
-          "Controller1",
-        ],
-      },
-    },
-    "/rest/controller1/{id}": {
-      "get": {
-        "operationId": "controller1MethodById",
-        "parameters": [
-          {
-            "in": "path",
-            "name": "id",
-            "required": true,
-            "schema": {
-              "type": "string",
-            },
-          },
-        ],
-        "responses": {
-          "200": {
-            "description": "Success",
-          },
-        },
-        "tags": [
-          "Controller1",
-        ],
-      },
-    },
-    "/rest/controller2": {
-      "get": {
-        "operationId": "controller2Method",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "Success",
-          },
-        },
-        "tags": [
-          "Controller2",
-        ],
-      },
-    },
-    "/rest/controller2/{id}": {
-      "get": {
-        "operationId": "controller2MethodById",
-        "parameters": [
-          {
-            "in": "path",
-            "name": "id",
-            "required": true,
-            "schema": {
-              "type": "string",
-            },
-          },
-        ],
-        "responses": {
-          "200": {
-            "description": "Success",
-          },
-        },
-        "tags": [
-          "Controller2",
-        ],
-      },
-    },
-  },
-  "tags": [
-    {
-      "name": "Controller2",
-    },
-    {
-      "name": "Controller1",
-    },
-  ],
-}
-`;

package/src/utils/buildPath.ts

@@ -1,8 +0,0 @@
-/**
- * Return a sanitized path
- * @param path
- * @ignore
- */
-export function buildPath(path: string) {
-  return path.split("/").filter(Boolean).join("/");
-}

package/src/utils/concatParameters.ts

@@ -1,12 +0,0 @@
-/**
- * @ignore
- */
-export function concatParameters(parameters: any[], operation: any) {
-  return parameters
-    .map((param) => {
-      const f = operation.parameters.find((p: any) => p.in === param.in && p.name === param.name);
-
-      return f || param;
-    })
-    .concat(...operation.parameters.filter((param: any) => param.in !== "path"));
-}

package/src/utils/concatPath.spec.ts

@@ -1,23 +0,0 @@
-import {concatPath} from "./concatPath.js";
-
-describe("concatPath", () => {
-  it("should return path", () => {
-    expect(concatPath("/controllers/", "/path")).toEqual("/controllers/path");
-    expect(concatPath("/controllers", "/path")).toEqual("/controllers/path");
-    expect(concatPath("/controllers/", "path")).toEqual("/controllers/path");
-    expect(concatPath(undefined, "/path")).toEqual("/path");
-    expect(concatPath("/controllers/", undefined)).toEqual("/controllers");
-    expect(concatPath("/", "/:id")).toEqual("/:id");
-    expect(concatPath("/", "/")).toEqual("/");
-    expect(concatPath("/", undefined)).toEqual("/");
-    expect(concatPath(undefined, "/")).toEqual("/");
-    expect(concatPath("tests/", "/test")).toEqual("tests/test");
-  });
-  it("should concat regexp", () => {
-    expect(concatPath(/\/(.*)/, /\/test(.*)/).source).toEqual("\\/(.*)\\/test(.*)");
-    expect(concatPath(undefined, /\/test(.*)/).source).toEqual("\\/test(.*)");
-    expect(concatPath(/\/(.*)/, undefined).source).toEqual("\\/(.*)");
-    expect(concatPath(/\/(.*)/, "/test").source).toEqual("\\/(.*)\\/test");
-    expect(concatPath("/test", /\/test(.*)/).source).toEqual("\\/test\\/test(.*)");
-  });
-});

package/src/utils/concatPath.ts

@@ -1,24 +0,0 @@
-export function concatPath(basePath: string | undefined | RegExp, path: string | undefined | RegExp): any {
-  if (basePath instanceof RegExp || path instanceof RegExp) {
-    if (!basePath) {
-      return path;
-    }
-
-    if (!path) {
-      return basePath;
-    }
-
-    const r1 = basePath instanceof RegExp ? basePath : new RegExp(basePath, "gi");
-    const r2 = path instanceof RegExp ? path : new RegExp(path, "gi");
-
-    return new RegExp(r1.source + r2.source, (r1.global ? "g" : "") + (r1.ignoreCase ? "i" : "") + (r1.multiline ? "m" : ""));
-  }
-
-  if (basePath && path && basePath.endsWith("/") && path.startsWith("/")) {
-    path = path.slice(1);
-  }
-
-  const result = (basePath || "") + (path || "");
-
-  return result.endsWith("/") && result.length > 1 ? result.slice(0, -1) : result;
-}

package/src/utils/defineStatusModel.ts

@@ -1,11 +0,0 @@
-import {Type} from "@tsed/core";
-
-const statusesModel: Map<number, Type<any>> = new Map();
-
-export function defineStatusModel(status: number, model: Type<any>) {
-  statusesModel.set(status, model);
-}
-
-export function getStatusModel(status: number) {
-  return statusesModel.get(status);
-}