@tsed/schema 8.4.4 → 8.4.5

package/lib/esm/decorators/operations/operationPath.js

@@ -6,7 +6,7 @@ import { JsonEntityFn } from "../common/jsonEntityFn.js";
  * ::: warning
  * Don't use decorator with Ts.ED application.
  *
- * Use theses decorators instead:
+ * Use these decorators instead:
  *
  * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
  *

package/lib/esm/decorators/operations/tags.js

@@ -11,7 +11,7 @@ function mapTags(tags) {
     });
 }
 /**
- * Add tags metadata on the decorated element.
+ * Add metadata tags to the decorated element (class or method).
  *
  * ## Examples
  * ### On method
@@ -23,6 +23,15 @@ function mapTags(tags) {
  *  get() {}
  * }
  * ```
+ * ### On Class
+ *
+ * ```typescript
+ * @Controller("/")
+ * @Tags("api")
+ * class MyController {
+ *  get() {}
+ * }
+ * ```
  *
  * @param tags
  * @decorator

package/lib/esm/decorators/operations/tags.js.map

@@ -1 +1 @@
-{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../../../src/decorators/operations/tags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAE,cAAc,EAAE,wBAAwB,EAAC,MAAM,YAAY,CAAC;AAGvF,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAEvD,SAAS,OAAO,CAAC,IAA8B;IAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO;gBACL,IAAI,EAAE,GAAG;aACV,CAAC;QACJ,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,IAAI,CAAC,GAAG,IAA8B;IACpD,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,QAAQ,KAAK,CAAC,aAAa,EAAE,CAAC;YAC5B,KAAK,cAAc,CAAC,MAAM;gBACxB,KAAK,CAAC,SAAU,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,cAAc,CAAC,KAAK;gBACvB,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;gBAC1C,MAAM;YAER;gBACE,MAAM,IAAI,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../../../src/decorators/operations/tags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAE,cAAc,EAAE,wBAAwB,EAAC,MAAM,YAAY,CAAC;AAGvF,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAEvD,SAAS,OAAO,CAAC,IAA8B;IAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO;gBACL,IAAI,EAAE,GAAG;aACV,CAAC;QACJ,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,IAAI,CAAC,GAAG,IAA8B;IACpD,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,QAAQ,KAAK,CAAC,aAAa,EAAE,CAAC;YAC5B,KAAK,cAAc,CAAC,MAAM;gBACxB,KAAK,CAAC,SAAU,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,cAAc,CAAC,KAAK;gBACvB,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;gBAC1C,MAAM;YAER;gBACE,MAAM,IAAI,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/lib/types/decorators/generics/generics.d.ts

@@ -11,4 +11,4 @@
  * @input
  * @generics
  */
-export declare function Generics(...generics: string[]): (target: any) => void;
+export declare function Generics(...generics: string[]): ClassDecorator;

package/lib/types/decorators/operations/acceptMime.d.ts

@@ -16,4 +16,4 @@
  * @operation
  * @response
  */
-export declare function AcceptMime(...mimes: string[]): Function;
+export declare function AcceptMime(...mimes: string[]): ClassDecorator & MethodDecorator;

package/lib/types/decorators/operations/consumes.d.ts

@@ -16,4 +16,4 @@
  * @classDecorator
  * @operation
  */
-export declare function Consumes(...consumes: string[]): (...args: any[]) => any;
+export declare function Consumes(...consumes: string[]): ClassDecorator & MethodDecorator;

package/lib/types/decorators/operations/header.d.ts

@@ -46,4 +46,4 @@ import { JsonHeader, JsonHeaders } from "../../interfaces/JsonOpenSpec.js";
  * @operation
  * @response
  */
-export declare function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader): Function;
+export declare function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader): import("./returns.js").ReturnsChainedDecorators;

package/lib/types/decorators/operations/operationId.d.ts

@@ -7,4 +7,4 @@
  * @schema
  * @operation
  */
-export declare function OperationId(operationId: string): (...args: any[]) => any;
+export declare function OperationId(operationId: string): MethodDecorator;

package/lib/types/decorators/operations/operationPath.d.ts

@@ -5,7 +5,7 @@ import { OperationVerbs } from "../../constants/OperationVerbs.js";
  * ::: warning
  * Don't use decorator with Ts.ED application.
  *
- * Use theses decorators instead:
+ * Use these decorators instead:
  *
  * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
  *

package/lib/types/decorators/operations/path.d.ts

@@ -12,4 +12,4 @@
  * @classDecorator
  * @operation
  */
-export declare function Path(path: string): (...args: any[]) => any;
+export declare function Path(path: string): ClassDecorator;

package/lib/types/decorators/operations/produces.d.ts

@@ -23,4 +23,4 @@
  * @operation
  * @response
  */
-export declare function Produces(...produces: string[]): (...args: any[]) => any;
+export declare function Produces(...produces: string[]): ClassDecorator & MethodDecorator;

package/lib/types/decorators/operations/redirect.d.ts

@@ -48,5 +48,5 @@ import { JsonHeader } from "../../interfaces/JsonOpenSpec.js";
  * @response
  * @headers
  */
-export declare function Redirect(url: string, meta?: JsonHeader): Function;
-export declare function Redirect(status: number, url: string, meta?: JsonHeader): Function;
+export declare function Redirect(url: string, meta?: JsonHeader): MethodDecorator;
+export declare function Redirect(status: number, url: string, meta?: JsonHeader): MethodDecorator;

package/lib/types/decorators/operations/security.d.ts

@@ -21,7 +21,7 @@ import { OpenSpecSecurity } from "@tsed/openspec";
  * @classDecorator
  * @operation
  */
-export declare function Security(name: string, ...scopes: string[]): Function;
+export declare function Security(name: string, ...scopes: string[]): ClassDecorator & MethodDecorator;
 /**
  * Add security metadata on the decorated method.
  *
@@ -53,4 +53,4 @@ export declare function Security(name: string, ...scopes: string[]): Function;
  * @classDecorator
  * @operation
  */
-export declare function Security(security: OpenSpecSecurity): Function;
+export declare function Security(security: OpenSpecSecurity): ClassDecorator & MethodDecorator;

package/lib/types/decorators/operations/summary.d.ts

@@ -17,4 +17,4 @@
  * @schema
  * @operation
  */
-export declare function Summary(summary: string): (...args: any[]) => any;
+export declare function Summary(summary: string): MethodDecorator;

package/lib/types/decorators/operations/tags.d.ts

@@ -1,6 +1,6 @@
 import { OpenSpecTag } from "@tsed/openspec";
 /**
- * Add tags metadata on the decorated element.
+ * Add metadata tags to the decorated element (class or method).
  *
  * ## Examples
  * ### On method
@@ -12,6 +12,15 @@ import { OpenSpecTag } from "@tsed/openspec";
  *  get() {}
  * }
  * ```
+ * ### On Class
+ *
+ * ```typescript
+ * @Controller("/")
+ * @Tags("api")
+ * class MyController {
+ *  get() {}
+ * }
+ * ```
  *
  * @param tags
  * @decorator
@@ -20,4 +29,4 @@ import { OpenSpecTag } from "@tsed/openspec";
  * @classDecorator
  * @operation
  */
-export declare function Tags(...tags: (string | OpenSpecTag)[]): (...args: any[]) => any;
+export declare function Tags(...tags: (string | OpenSpecTag)[]): ClassDecorator & MethodDecorator;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/schema",
   "description": "JsonSchema module for Ts.ED Framework",
   "type": "module",
-  "version": "8.4.4",
+  "version": "8.4.5",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -37,7 +37,7 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/openspec": "8.4.4",
+    "@tsed/openspec": "8.4.5",
     "change-case": "^5.4.4",
     "json-schema": "0.4.0",
     "picomatch": "2.3.1",
@@ -46,11 +46,11 @@
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
-    "@tsed/barrels": "8.4.4",
-    "@tsed/core": "8.4.4",
-    "@tsed/hooks": "8.4.4",
-    "@tsed/openspec": "8.4.4",
-    "@tsed/typescript": "8.4.4",
+    "@tsed/barrels": "8.4.5",
+    "@tsed/core": "8.4.5",
+    "@tsed/hooks": "8.4.5",
+    "@tsed/openspec": "8.4.5",
+    "@tsed/typescript": "8.4.5",
     "@types/fs-extra": "11.0.4",
     "@types/json-schema": "7.0.15",
     "@types/picomatch": "3.0.1",
@@ -63,9 +63,9 @@
     "webpack": "^5.75.0"
   },
   "peerDependencies": {
-    "@tsed/core": ">=8.4.4",
-    "@tsed/hooks": ">=8.4.4",
-    "@tsed/openspec": ">=8.4.4"
+    "@tsed/core": ">=8.4.5",
+    "@tsed/hooks": ">=8.4.5",
+    "@tsed/openspec": ">=8.4.5"
   },
   "peerDependenciesMeta": {
     "@tsed/core": {

package/src/decorators/generics/generics.ts

@@ -13,7 +13,7 @@ import {JsonEntityStore} from "../../domain/JsonEntityStore.js";
  * @input
  * @generics
  */
-export function Generics(...generics: string[]) {
+export function Generics(...generics: string[]): ClassDecorator {
   return (target: any) => {
     const storedSchema = JsonEntityStore.from(target);
 

package/src/decorators/operations/acceptMime.ts

@@ -20,6 +20,6 @@ import {Produces} from "./produces.js";
  * @operation
  * @response
  */
-export function AcceptMime(...mimes: string[]): Function {
+export function AcceptMime(...mimes: string[]): ClassDecorator & MethodDecorator {
   return useDecorators(Produces(...mimes), StoreSet("acceptMimes", mimes));
 }

package/src/decorators/operations/consumes.spec.ts

@@ -79,6 +79,7 @@ describe("Consumes", () => {
 
     let actualError: any;
     try {
+      // @ts-ignore
       Consumes("text/json")(Test.prototype, "test", 0);
     } catch (er) {
       actualError = er;

package/src/decorators/operations/consumes.ts

@@ -20,7 +20,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * @classDecorator
  * @operation
  */
-export function Consumes(...consumes: string[]) {
+export function Consumes(...consumes: string[]): ClassDecorator & MethodDecorator {
   return JsonEntityFn((store, args) => {
     switch (store.decoratorType) {
       case DecoratorTypes.METHOD:

package/src/decorators/operations/header.ts

@@ -50,7 +50,7 @@ import {Returns} from "./returns.js";
  * @operation
  * @response
  */
-export function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader): Function {
+export function Header(headers: string | number | JsonHeaders, value?: string | number | JsonHeader) {
   if (value !== undefined) {
     headers = {[headers as string]: value};
   }

package/src/decorators/operations/operationId.spec.ts

@@ -33,6 +33,7 @@ describe("OperationId", () => {
   it("should throw error for unsupported usage", () => {
     let actualError: any;
     try {
+      // @ts-ignore
       OperationId("id")(class Test {});
     } catch (er) {
       actualError = er;

package/src/decorators/operations/operationId.ts

@@ -11,7 +11,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * @schema
  * @operation
  */
-export function OperationId(operationId: string) {
+export function OperationId(operationId: string): MethodDecorator {
   return JsonEntityFn((store, args) => {
     if (store.decoratorType !== DecoratorTypes.METHOD) {
       throw new UnsupportedDecoratorType(OperationId, args);

package/src/decorators/operations/operationPath.ts

@@ -9,7 +9,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * ::: warning
  * Don't use decorator with Ts.ED application.
  *
- * Use theses decorators instead:
+ * Use these decorators instead:
  *
  * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
  *

package/src/decorators/operations/path.spec.ts

@@ -37,6 +37,7 @@ describe("Path", () => {
 
     let actualError: any;
     try {
+      // @ts-ignore
       Path("/")(Test.prototype, "test", 0);
     } catch (er) {
       actualError = er;

package/src/decorators/operations/path.ts

@@ -16,7 +16,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * @classDecorator
  * @operation
  */
-export function Path(path: string) {
+export function Path(path: string): ClassDecorator {
   return JsonEntityFn((store, args) => {
     if (store.decoratorType !== DecoratorTypes.CLASS) {
       throw new UnsupportedDecoratorType(Path, args);

package/src/decorators/operations/produces.spec.ts

@@ -79,6 +79,7 @@ describe("Produces", () => {
 
     let actualError: any;
     try {
+      // @ts-ignore
       Produces("text/json")(Test.prototype, "test", 0);
     } catch (er) {
       actualError = er;

package/src/decorators/operations/produces.ts

@@ -27,7 +27,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * @operation
  * @response
  */
-export function Produces(...produces: string[]) {
+export function Produces(...produces: string[]): ClassDecorator & MethodDecorator {
   return JsonEntityFn((store, args) => {
     switch (store.decoratorType) {
       case DecoratorTypes.METHOD:

package/src/decorators/operations/redirect.ts

@@ -53,9 +53,9 @@ import {Returns} from "./returns.js";
  * @response
  * @headers
  */
-export function Redirect(url: string, meta?: JsonHeader): Function;
-export function Redirect(status: number, url: string, meta?: JsonHeader): Function;
-export function Redirect(...args: any[]): Function {
+export function Redirect(url: string, meta?: JsonHeader): MethodDecorator;
+export function Redirect(status: number, url: string, meta?: JsonHeader): MethodDecorator;
+export function Redirect(...args: any[]): MethodDecorator {
   const {status, url, meta} = args.reduce(
     (options: any, value: any) => {
       if (isNumber(value)) {

package/src/decorators/operations/security.spec.ts

@@ -152,6 +152,7 @@ describe("Security", () => {
 
     let actualError: any;
     try {
+      // @ts-ignore
       Security("POST", "/")(Test.prototype, "test", 0);
     } catch (er) {
       actualError = er;

package/src/decorators/operations/security.ts

@@ -25,7 +25,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * @classDecorator
  * @operation
  */
-export function Security(name: string, ...scopes: string[]): Function;
+export function Security(name: string, ...scopes: string[]): ClassDecorator & MethodDecorator;
 /**
  * Add security metadata on the decorated method.
  *
@@ -57,8 +57,8 @@ export function Security(name: string, ...scopes: string[]): Function;
  * @classDecorator
  * @operation
  */
-export function Security(security: OpenSpecSecurity): Function;
-export function Security(nameOrSecurity: string | OpenSpecSecurity, ...scopes: string[]): Function {
+export function Security(security: OpenSpecSecurity): ClassDecorator & MethodDecorator;
+export function Security(nameOrSecurity: string | OpenSpecSecurity, ...scopes: string[]): ClassDecorator & MethodDecorator {
   return JsonEntityFn((store, args) => {
     switch (store.decoratorType) {
       case DecoratorTypes.METHOD:

package/src/decorators/operations/summary.spec.ts

@@ -35,6 +35,7 @@ describe("Summary", () => {
   it("should throw error for unsupported usage", () => {
     let actualError: any;
     try {
+      // @ts-ignore
       Summary("summary")(class Test {});
     } catch (er) {
       actualError = er;

package/src/decorators/operations/summary.ts

@@ -21,7 +21,7 @@ import {JsonEntityFn} from "../common/jsonEntityFn.js";
  * @schema
  * @operation
  */
-export function Summary(summary: string) {
+export function Summary(summary: string): MethodDecorator {
   return JsonEntityFn((store, args) => {
     if (store.decoratorType !== DecoratorTypes.METHOD) {
       throw new UnsupportedDecoratorType(Summary, args);

package/src/decorators/operations/tags.spec.ts

@@ -103,6 +103,7 @@ describe("Tags", () => {
 
     let actualError: any;
     try {
+      // @ts-ignore
       Tags("tags")(Test.prototype, "test", 0);
     } catch (er) {
       actualError = er;

package/src/decorators/operations/tags.ts

@@ -16,7 +16,7 @@ function mapTags(tags: (string | OpenSpecTag)[]) {
 }
 
 /**
- * Add tags metadata on the decorated element.
+ * Add metadata tags to the decorated element (class or method).
  *
  * ## Examples
  * ### On method
@@ -28,6 +28,15 @@ function mapTags(tags: (string | OpenSpecTag)[]) {
  *  get() {}
  * }
  * ```
+ * ### On Class
+ *
+ * ```typescript
+ * @Controller("/")
+ * @Tags("api")
+ * class MyController {
+ *  get() {}
+ * }
+ * ```
  *
  * @param tags
  * @decorator
@@ -36,7 +45,7 @@ function mapTags(tags: (string | OpenSpecTag)[]) {
  * @classDecorator
  * @operation
  */
-export function Tags(...tags: (string | OpenSpecTag)[]) {
+export function Tags(...tags: (string | OpenSpecTag)[]): ClassDecorator & MethodDecorator {
   return JsonEntityFn((store, args) => {
     switch (store.decoratorType) {
       case DecoratorTypes.METHOD: