@tsed/schema 7.0.0-alpha.2 → 7.0.0-beta.11

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

@@ -0,0 +1,30 @@
+import { Type } from "@tsed/core";
+import { OpenSpec3 } from "@tsed/openspec";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
+export declare type JsonTokenOptions = ({
+    token: Type<any>;
+} & Partial<SpecSerializerOptions>)[];
+export interface SpecSerializerOptions extends JsonSchemaOptions {
+    /**
+     * Paths
+     */
+    paths?: any;
+    /**
+     * Root path. This paths will be added to all generated paths Object.
+     */
+    rootPath?: string;
+    /**
+     * A function to generate the operationId.
+     */
+    operationIdFormatter?: (name: string, propertyKey: string, path: string) => string;
+    /**
+     * A pattern to generate the operationId.
+     */
+    operationIdPattern?: string;
+}
+/**
+ * Return the swagger or open spec for the given class.
+ * @param model
+ * @param options
+ */
+export declare function getSpec(model: Type<any> | JsonTokenOptions, options?: SpecSerializerOptions): Partial<OpenSpec3>;

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

@@ -0,0 +1,12 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+import { SpecTypes } from "../domain/SpecTypes";
+/**
+ * @ignore
+ * @param version
+ */
+export declare function getSpecType(version: string): SpecTypes.SWAGGER | SpecTypes.OPENAPI;
+/**
+ * @ignore
+ * @param spec
+ */
+export declare function getSpecTypeFromSpec(spec: Partial<OpenSpec2 | OpenSpec3>): SpecTypes.SWAGGER | SpecTypes.OPENAPI;

package/lib/{utils → types/utils}/mapNullableType.d.ts

@@ -1,3 +1,3 @@
 import type { JsonSchema } from "../domain/JsonSchema";
 import type { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
-export declare function mapNullableType(obj: any, schema: JsonSchema, options: JsonSchemaOptions): any;
+export declare function mapNullableType(obj: any, schema: JsonSchema | null, options: JsonSchemaOptions): any;

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

@@ -0,0 +1,10 @@
+import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param spec
+ * @param fileSpec
+ * @param version
+ * @param acceptMimes
+ * @param specVersion
+ */
+export declare function mapOpenSpec(spec: any, { fileSpec, acceptMimes, specVersion, version }: any): Partial<OpenSpec2 | OpenSpec3>;

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

@@ -0,0 +1,9 @@
+import { OpenSpec2 } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ * @param acceptMimes
+ */
+export declare function mapOpenSpec2(spec: Partial<OpenSpec2>, { version, specVersion, acceptMimes }: any): Partial<OpenSpec2>;

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

@@ -0,0 +1,8 @@
+import { OpenSpec3 } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param spec
+ * @param version
+ * @param specVersion
+ */
+export declare function mapOpenSpec3(spec: any, { specVersion }: any): Partial<OpenSpec3>;

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

@@ -0,0 +1,6 @@
+import { OpenSpecInfo } from "@tsed/openspec";
+/**
+ * @ignore
+ * @param info
+ */
+export declare function mapOpenSpecInfo(info: Partial<OpenSpecInfo>): OpenSpecInfo;

package/lib/{utils → types/utils}/mapRouteOptions.d.ts

@@ -1,5 +1,5 @@
 export declare function mapRouteOptions(args: any[]): {
     path: undefined;
     method: undefined;
-    handlers: any[];
+    use: any[];
 };

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

@@ -0,0 +1,14 @@
+import type { JsonSchema } from "../domain/JsonSchema";
+import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
+/**
+ * @ignore
+ */
+export declare function createRefName(name: string, options: JsonSchemaOptions): string;
+/**
+ * @ignore
+ */
+export declare function createRef(name: string, schema: JsonSchema, options: JsonSchemaOptions): any;
+/**
+ * @ignore
+ */
+export declare function toRef(value: JsonSchema, schema: any, options: JsonSchemaOptions): any;

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

@@ -0,0 +1,5 @@
+export declare const serializeEnum: (enumValue: any) => any;
+export declare function serializeEnumValues(enumValues: any[]): {
+    values: any[];
+    types: any;
+};

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

@@ -0,0 +1,25 @@
+import { OpenSpec2, OpenSpec3, OS3Operation } from "@tsed/openspec";
+export declare function transformSecurity(securitySchemes: any): {};
+export declare function transformInformation(server: any): {
+    host: string | undefined;
+    basePath: string;
+    schemes: string[] | undefined;
+};
+export declare class Converter {
+    private spec;
+    constructor(spec: Partial<OpenSpec3>);
+    convertInfos(): {};
+    resolveReference(base: any, obj: any, shouldClone: boolean): any;
+    convert(): any;
+    convertOperations(paths: any, spec: any): any;
+    convertOperationParameters(operation: OS3Operation): void;
+    convertParameters(obj: any): void;
+    copySchemaProperties(obj: any, props: any[]): void;
+    copySchemaXProperties(obj: Record<string, any>): void;
+    convertResponses(operation: Record<string, any>): void;
+    convertSchema(def: any, operationDirection?: any): void;
+    convertSchemas(): void;
+    convertDiscriminatorMapping(mapping: any): void;
+    convertSecurityDefinitions(): void;
+}
+export declare function transformToOS2(spec: any): Partial<OpenSpec2>;

package/package.json

@@ -1,14 +1,25 @@
 {
   "name": "@tsed/schema",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0-beta.11",
   "description": "JsonSchema module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
-  "main": "./lib/index.js",
-  "typings": "./lib/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "default": "./lib/index.modern.js"
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "yarn clean && yarn barrels && yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\"",
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2"
   },
   "keywords": [
     "TypeScript",
@@ -20,35 +31,43 @@
     "classes",
     "tsed"
   ],
-  "scripts": {
-    "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json"
-  },
   "dependencies": {
-    "@tsed/core": "7.0.0-alpha.2",
-    "@tsed/openspec": "7.0.0-alpha.2",
-    "change-case": "4.1.2",
-    "micromatch": "4.0.2",
-    "tslib": "2.2.0"
+    "@tsed/openspec": "7.0.0-beta.11",
+    "camel-case": "4.1.2",
+    "fs-extra": "^10.0.1",
+    "json-schema": "0.4.0",
+    "micromatch": "4.0.5",
+    "pascal-case": "3.1.2",
+    "statuses": ">=2.0.1",
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@apidevtools/swagger-parser": "10.0.2",
-    "@types/fs-extra": "9.0.6",
-    "@types/json-schema": "7.0.7",
-    "@types/micromatch": "4.0.1",
-    "fs-extra": "9.0.1"
+    "@apidevtools/swagger-parser": "10.0.3",
+    "@tsed/core": "7.0.0-beta.11",
+    "@tsed/openspec": "7.0.0-beta.11",
+    "@types/fs-extra": "9.0.13",
+    "@types/json-schema": "7.0.11",
+    "@types/micromatch": "4.0.2",
+    "@types/statuses": "2.0.0",
+    "api-spec-converter": "2.12.0"
   },
   "peerDependencies": {
-    "@tsed/core": "^7.0.0-alpha.2",
-    "@tsed/openspec": "^7.0.0-alpha.2"
+    "@tsed/core": "^7.0.0-beta.11",
+    "@tsed/openspec": "^7.0.0-beta.11"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/openspec": {
+      "optional": false
+    },
+    "@tsed/core": {
+      "optional": false
+    }
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/alpha/packages/specs/schema",
+  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/specs/schema",
   "author": "Romain Lenzotti",
-  "license": "MIT",
-  "publishConfig": {
-    "tag": "alpha"
-  }
+  "license": "MIT"
 }

package/readme.md

@@ -44,6 +44,7 @@ npm install --save @tsed/schema
 ```
 
 ## Contributors
+
 Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html)
 
 <a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>

package/tsconfig.compile.esm.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
+}

package/lib/components/index.d.ts

@@ -1,9 +0,0 @@
-export * from "./anyMapper";
-export * from "./classMapper";
-export * from "./genericsMapper";
-export * from "./inheritedClassMapper";
-export * from "./itemMapper";
-export * from "./lazyRefMapper";
-export * from "./mapMapper";
-export * from "./objectMapper";
-export * from "./schemaMapper";

package/lib/components/lazyRefMapper.d.ts

@@ -1,19 +0,0 @@
-import { JsonLazyRef } from "../domain/JsonLazyRef";
-import { JsonSchemaOptions } from "../interfaces/JsonSchemaOptions";
-export declare function lazyRefMapper(input: JsonLazyRef, options: JsonSchemaOptions): {
-    $ref: string;
-} | {
-    nullable: boolean;
-    allOf: {
-        $ref: string;
-    }[];
-    oneOf?: undefined;
-} | {
-    oneOf: ({
-        $ref: string;
-    } | {
-        type: string;
-    })[];
-    nullable?: undefined;
-    allOf?: undefined;
-};

package/lib/constants/httpStatusMessages.d.ts

@@ -1,5 +0,0 @@
-export declare const HTTP_STATUS_MESSAGES: {
-    [key: string]: string;
-};
-export declare function getStatusConstant(status: number): string;
-export declare function getStatusMessage(status: number): string;

package/lib/decorators/index.d.ts

@@ -1,65 +0,0 @@
-export * from "./collections/collectionContains";
-export * from "./collections/collectionOf";
-export * from "./collections/maxItems";
-export * from "./collections/minItems";
-export * from "./collections/uniqueItems";
-export * from "./collections/maxProperties";
-export * from "./collections/minProperties";
-export * from "./generics/generics";
-export * from "./generics/genericOf";
-export * from "./operations/deprecated";
-export * from "./operations/consumes";
-export * from "./operations/contentType";
-export * from "./operations/in";
-export * from "./operations/operationId";
-export * from "./operations/operationPath";
-export * from "./operations/path";
-export * from "./operations/produces";
-export * from "./operations/returns";
-export * from "./operations/status";
-export * from "./operations/header";
-export * from "./operations/security";
-export * from "./operations/tags";
-export * from "./operations/summary";
-export * from "./operations/partial";
-export * from "./operations/redirect";
-export * from "./operations/location";
-export * from "./operations/route";
-export * from "./common/additionalProperties";
-export * from "./common/allow";
-export * from "./common/any";
-export * from "./common/integer";
-export * from "./common/const";
-export * from "./common/default";
-export * from "./common/description";
-export * from "./common/example";
-export * from "./common/enum";
-export * from "./common/exclusiveMaximum";
-export * from "./common/exclusiveMinimum";
-export * from "./common/format";
-export * from "./common/forwardGroups";
-export * from "./common/groups";
-export * from "./common/pattern";
-export * from "./common/ignore";
-export * from "./common/maximum";
-export * from "./common/maxLength";
-export * from "./common/minimum";
-export * from "./common/minLength";
-export * from "./common/multipleOf";
-export * from "./common/name";
-export * from "./common/required";
-export * from "./common/requiredGroups";
-export * from "./common/property";
-export * from "./common/hidden";
-export * from "./common/title";
-export * from "./common/schema";
-export * from "./common/oneOf";
-export * from "./common/allOf";
-export * from "./common/anyOf";
-export * from "./common/jsonEntityFn";
-export * from "./common/optional";
-export * from "./common/writeOnly";
-export * from "./common/readOnly";
-export * from "./common/customKey";
-export * from "./common/nullable";
-export * from "./config/jsonEntityComponent";

package/lib/domain/JsonEntityStore.d.ts

@@ -1,94 +0,0 @@
-import { Entity, EntityOptions, Store, Type } from "@tsed/core";
-import { JsonOperation } from "./JsonOperation";
-import { JsonParameter } from "./JsonParameter";
-import { JsonSchema } from "./JsonSchema";
-export interface JsonEntityStoreOptions extends EntityOptions {
-    [key: string]: any;
-}
-export declare class JsonEntityStore extends Entity implements JsonEntityStoreOptions {
-    readonly store: Store;
-    readonly isStore = true;
-    /**
-     * List of children JsonEntityStore (properties or methods or params)
-     */
-    readonly children: Map<string | number, JsonEntityStore>;
-    /**
-     * Path used to generate open spec.
-     */
-    path: string;
-    constructor(options: JsonEntityStoreOptions);
-    /**
-     * Ref to JsonSchema
-     */
-    protected _schema: JsonSchema;
-    /**
-     * Return the JsonSchema
-     */
-    get schema(): JsonSchema;
-    [key: string]: any;
-    /**
-     * Ref to JsonOperation when the decorated object is a method.
-     */
-    protected _operation: JsonOperation;
-    /**
-     * Return the JsonOperation
-     */
-    get operation(): JsonOperation | undefined;
-    /**
-     * Ref to JsonParameter when the decorated object is a parameter.
-     */
-    protected _parameter: JsonParameter;
-    /**
-     * Return the JsonParameter
-     */
-    get parameter(): JsonParameter | undefined;
-    get nestedGenerics(): Type<any>[][];
-    set nestedGenerics(nestedGenerics: Type<any>[][]);
-    /**
-     *
-     * @returns {Type<any>}
-     */
-    get type(): Type<any> | any;
-    /**
-     * Get original type without transformation
-     * @param value
-     */
-    set type(value: Type<any> | any);
-    /**
-     * Return the itemSchema computed type. if the type is a function used for recursive model, the function will be called to
-     * get the right type.
-     */
-    get computedType(): any;
-    get itemSchema(): JsonSchema;
-    get parentSchema(): JsonSchema;
-    get parent(): JsonEntityStore;
-    /**
-     * Return the required state.
-     * @returns {boolean}
-     */
-    get required(): boolean;
-    /**
-     * Change the state of the required data.
-     * @param value
-     */
-    set required(value: boolean);
-    get allowedRequiredValues(): any[];
-    /**
-     *
-     * @param args
-     */
-    static from<T extends JsonEntityStore = JsonEntityStore>(...args: any[]): NonNullable<T>;
-    static fromMethod(target: any, propertyKey: string | symbol): JsonEntityStore;
-    getResponseOptions(status: number, contentType?: string): undefined | any;
-    /**
-     * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
-     * @param value
-     * @returns {boolean}
-     */
-    isRequired(value: any): boolean;
-    protected build(): void;
-    protected createProperty(): any;
-    protected createOperation(): JsonOperation;
-    protected createParameter(): JsonParameter;
-    static get(target: Type<any>, propertyKey: string | symbol, descriptor?: any): JsonEntityStore;
-}

package/lib/domain/index.d.ts

@@ -1,11 +0,0 @@
-export * from "./JsonMap";
-export * from "./JsonOperation";
-export * from "./JsonParameter";
-export * from "./JsonRequestBody";
-export * from "./JsonResponse";
-export * from "./JsonSchema";
-export * from "./JsonFormatTypes";
-export * from "./SpecTypes";
-export * from "./JsonEntityStore";
-export * from "./JsonParameterTypes";
-export * from "./JsonLazyRef";

package/lib/index.d.ts

@@ -1,17 +0,0 @@
-export * from "./constants/httpStatusMessages";
-export * from "./constants/httpMethods";
-export * from "./utils/getJsonSchema";
-export * from "./utils/getJsonType";
-export * from "./utils/getPropertiesStores";
-export * from "./utils/getOperationsStores";
-export * from "./utils/getSpec";
-export * from "./utils/mergeSpec";
-export * from "./utils/generics";
-export * from "./utils/mapHeaders";
-export * from "./utils/isSuccessStatus";
-export * from "./utils/from";
-export * from "./utils/defineStatusModel";
-export * from "./domain";
-export * from "./hooks/alterIgnore";
-export * from "./interfaces";
-export * from "./decorators";