@tsed/schema 6.96.2 → 6.98.0

package/lib/types/domain/JsonParameterStore.d.ts

@@ -1,14 +1,30 @@
 import { Type } from "@tsed/core";
-import { JsonEntityStore } from "./JsonEntityStore";
+import { JsonEntityStore, JsonEntityStoreOptions } from "./JsonEntityStore";
 import type { JsonMethodStore } from "./JsonMethodStore";
 import { JsonParameter } from "./JsonParameter";
 import { JsonSchema } from "./JsonSchema";
+export interface JsonParameterStoreOptions extends JsonEntityStoreOptions {
+    dataPath?: string;
+    paramType?: string;
+    expression?: string;
+}
+export interface PipeMethods<T = any, R = any> {
+    transform(value: T, metadata: JsonParameterStore): R;
+}
 export declare class JsonParameterStore extends JsonEntityStore {
+    paramType: string;
+    expression: string;
+    dataPath: string;
+    /**
+     * Define pipes can be called by the framework to transform input parameter
+     */
+    pipes: Type<PipeMethods>[];
     /**
      * Ref to JsonParameter when the decorated object is a parameter.
      */
     readonly parameter: JsonParameter;
     readonly parent: JsonMethodStore;
+    constructor(options: JsonParameterStoreOptions);
     get nestedGenerics(): Type<any>[][];
     set nestedGenerics(nestedGenerics: Type<any>[][]);
     /**
@@ -19,6 +35,7 @@ export declare class JsonParameterStore extends JsonEntityStore {
     set required(value: boolean);
     get allowedRequiredValues(): any[];
     static getParams<T extends JsonParameterStore = JsonParameterStore>(target: Type<any>, propertyKey: string | symbol): T[];
+    static get(target: Type<any>, propertyKey: string | symbol, index: number): JsonParameterStore;
     /**
      * Check precondition between value, required and allowedRequiredValues to know if the entity is required.
      * @param value
@@ -28,3 +45,8 @@ export declare class JsonParameterStore extends JsonEntityStore {
     protected getSchema(type: any): JsonSchema;
     protected build(): void;
 }
+/**
+ * @alias JsonParameterStore
+ */
+export declare type ParamMetadata = JsonParameterStore;
+export declare const ParamMetadata: typeof JsonParameterStore;

package/lib/types/domain/JsonPropertyStore.d.ts

@@ -1,3 +1,4 @@
+import { Type } from "@tsed/core";
 import { JsonEntityStore } from "./JsonEntityStore";
 import type { JsonClassStore } from "./JsonClassStore";
 export declare class JsonPropertyStore extends JsonEntityStore {
@@ -20,4 +21,10 @@ export declare class JsonPropertyStore extends JsonEntityStore {
      */
     isRequired(value: any): boolean;
     protected build(): void;
+    static get(target: Type<any>, propertyKey: string | symbol): JsonPropertyStore;
 }
+/**
+ * @alias JsonPropertyStore
+ */
+export declare type PropertyMetadata = JsonPropertyStore;
+export declare const PropertyMetadata: typeof JsonPropertyStore;

package/lib/types/domain/JsonSchema.d.ts

@@ -14,29 +14,19 @@ export interface JsonSchemaObject extends JSONSchema6, Record<string, any> {
 }
 export declare type AnyJsonSchema = Partial<JsonSchemaObject> | JsonSchema | JsonLazyRef | any;
 export declare class JsonSchema extends Map<string, any> implements NestedGenerics {
+    #private;
     readonly isJsonSchema = true;
     readonly $hooks: Hooks;
     readonly $required: Set<string>;
     readonly $allow: any[];
     $selfRequired: boolean;
     $forwardGroups: boolean;
-    protected _nullable: boolean;
-    protected _genericLabels: string[];
-    protected _nestedGenerics: Type<any>[][];
-    protected _alias: AliasMap;
-    protected _itemSchema: JsonSchema;
-    protected _target: Type<any>;
-    protected _isGeneric: boolean;
-    protected _isCollection: boolean;
-    protected _ref: boolean;
     constructor(obj?: JsonSchema | Partial<JsonSchemaObject>);
     get alias(): AliasMap;
     get nestedGenerics(): any[];
     set nestedGenerics(value: any[]);
     get genericLabels(): string[];
     set genericLabels(value: string[]);
-    get nullable(): boolean;
-    set nullable(value: boolean);
     get isClass(): boolean;
     /**
      * Current schema is a collection
@@ -53,7 +43,11 @@ export declare class JsonSchema extends Map<string, any> implements NestedGeneri
     get genericType(): string;
     get class(): any;
     get canRef(): boolean;
+    get isNullable(): boolean;
+    get isReadOnly(): any;
+    get isWriteOnly(): any;
     static from(obj?: Partial<JsonSchemaObject>): JsonSchema;
+    nullable(value: boolean): void;
     itemSchema(obj?: AnyJsonSchema): JsonSchema;
     getAliasOf(property: AliasType): AliasType | undefined;
     addAlias(property: AliasType, alias: AliasType): this;

package/lib/types/domain/SpecTypes.d.ts

@@ -1,5 +1,8 @@
 export declare enum SpecTypes {
     JSON = "jsonschema",
+    /**
+     * @deprecated
+     */
     SWAGGER = "swagger2",
     OPENAPI = "openapi3"
 }

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

@@ -1,8 +1,8 @@
 import { Type } from "@tsed/core";
+import { JsonMethodStore } from "../domain/JsonMethodStore";
 import { JsonOperationRoute } from "../domain/JsonOperationRoute";
-import { JsonEntityStore } from "../domain/JsonEntityStore";
 export interface GetOperationsRoutesOptions {
     withChildren?: boolean;
     basePath?: string;
 }
-export declare function getOperationsRoutes<Entity extends JsonEntityStore = JsonEntityStore>(token: Type<any> | any, options?: GetOperationsRoutesOptions): JsonOperationRoute<Entity>[];
+export declare function getOperationsRoutes<Entity extends JsonMethodStore = JsonMethodStore>(token: Type<any> | any, options?: GetOperationsRoutesOptions): JsonOperationRoute<Entity>[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/schema",
-  "version": "6.96.2",
+  "version": "6.98.0",
   "description": "JsonSchema module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
@@ -16,7 +16,7 @@
     "build": "yarn run build:esm && yarn run build:cjs",
     "build:cjs": "tsc --build tsconfig.compile.json",
     "build:esm": "tsc --build tsconfig.compile.esm.json",
-    "test": "cross-env NODE_ENV=test nyc mocha"
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2"
   },
   "keywords": [
     "TypeScript",
@@ -29,8 +29,8 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/core": "6.96.2",
-    "@tsed/openspec": "6.96.2",
+    "@tsed/core": "6.98.0",
+    "@tsed/openspec": "6.98.0",
     "camel-case": "4.1.2",
     "json-schema": "0.4.0",
     "micromatch": "4.0.2",
@@ -45,8 +45,8 @@
     "fs-extra": "9.0.1"
   },
   "peerDependencies": {
-    "@tsed/core": "^6.96.2",
-    "@tsed/openspec": "^6.96.2"
+    "@tsed/core": "^6.98.0",
+    "@tsed/openspec": "^6.98.0"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {

package/.mocharc.js

@@ -1,5 +0,0 @@
-module.exports = {
-  ...require('@tsed/mocha-config')(),
-  spec: ["{src,test}/**/*.spec.ts"],
-  exclude: [],
-};

package/.nycrc

@@ -1,27 +0,0 @@
-{
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "**/*.d.ts",
-    "node_modules",
-    "**/interfaces/**",
-    "**/index.ts",
-    "**/*.spec.ts"
-  ],
-  "extension": [
-    ".ts"
-  ],
-  "require": [],
-  "reporter": [
-    "text-summary",
-    "html",
-    "lcov",
-    "json"
-  ],
-  "check-coverage": true,
-  "statements": 99.67,
-  "branches": 91.32,
-  "functions": 99.51,
-  "lines": 99.81
-}

package/lib/cjs/utils/isJsonClass.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isJsonClass = void 0;
-const core_1 = require("@tsed/core");
-/**
- * @ignore
- */
-function isJsonClass(type) {
-    return (0, core_1.isClass)(type) && ![Map, Array, Set, Object, Date, Boolean, Number, String].includes(this._target);
-}
-exports.isJsonClass = isJsonClass;
-//# sourceMappingURL=isJsonClass.js.map

package/lib/cjs/utils/isJsonClass.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isJsonClass.js","sourceRoot":"","sources":["../../../src/utils/isJsonClass.ts"],"names":[],"mappings":";;;AAAA,qCAAmC;AAEnC;;GAEG;AACH,SAAgB,WAAW,CAAC,IAAS;IACnC,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAc,CAAC,CAAC;AAClH,CAAC;AAFD,kCAEC","sourcesContent":["import {isClass} from \"@tsed/core\";\n\n/**\n * @ignore\n */\nexport function isJsonClass(type: any) {\n  return isClass(type) && ![Map, Array, Set, Object, Date, Boolean, Number, String].includes(this._target as any);\n}\n"]}

package/lib/esm/utils/isJsonClass.js

@@ -1,8 +0,0 @@
-import { isClass } from "@tsed/core";
-/**
- * @ignore
- */
-export function isJsonClass(type) {
-    return isClass(type) && ![Map, Array, Set, Object, Date, Boolean, Number, String].includes(this._target);
-}
-//# sourceMappingURL=isJsonClass.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"isJsonClass.js","sourceRoot":"","sources":["../../../src/utils/isJsonClass.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAS;IACnC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAc,CAAC,CAAC;AAClH,CAAC","sourcesContent":["import {isClass} from \"@tsed/core\";\n\n/**\n * @ignore\n */\nexport function isJsonClass(type: any) {\n  return isClass(type) && ![Map, Array, Set, Object, Date, Boolean, Number, String].includes(this._target as any);\n}\n"]}

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

@@ -1,4 +0,0 @@
-/**
- * @ignore
- */
-export declare function isJsonClass(type: any): boolean;