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

package/lib/cjs/decorators/operations/in.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.In = void 0;
+const core_1 = require("@tsed/core");
+const domain_1 = require("../../domain");
+/**
+ * Add a input parameter.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application to decorate parameters. Use @@BodyParams@@, @@PathParams@@, etc... instead.
+ * But you can use this decorator on Method, to add extra in parameters like Authorization header.
+ *
+ * ```typescript
+ * @Controller("/")
+ * class MyController {
+ *    @Get("/")
+ *    @In("header").Type(String).Name("Authorization").Required()
+ *    method() {
+ *    }
+ *  }
+ * ```
+ * :::
+ *
+ * @param inType
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @operation
+ */
+function In(inType) {
+    const jsonParameter = new domain_1.JsonParameter();
+    const schema = {};
+    const decorator = (target, propertyKey, index) => {
+        const store = domain_1.JsonEntityStore.from(target, propertyKey, index);
+        switch (store.decoratorType) {
+            case core_1.DecoratorTypes.PARAM:
+                store.parameter.in(inType);
+                break;
+            case core_1.DecoratorTypes.METHOD:
+                jsonParameter.in(inType);
+                store.operation.addParameter(-1, jsonParameter);
+                jsonParameter.schema(domain_1.JsonSchema.from(schema));
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                (0, core_1.decorateMethodsOf)(target, decorator);
+                break;
+            default:
+                throw new core_1.UnsupportedDecoratorType(In, [target, propertyKey, index]);
+        }
+    };
+    decorator.Type = (type) => {
+        schema.type = type;
+        return decorator;
+    };
+    decorator.Name = (name) => {
+        jsonParameter.name(name);
+        return decorator;
+    };
+    decorator.Description = (description) => {
+        jsonParameter.description(description);
+        return decorator;
+    };
+    decorator.Required = (required = true) => {
+        jsonParameter.required(required);
+        return decorator;
+    };
+    decorator.Pattern = (pattern) => {
+        return decorator.Schema({ pattern: pattern.toString() });
+    };
+    decorator.Schema = (_schema) => {
+        Object.assign(schema, _schema);
+        return decorator;
+    };
+    return decorator;
+}
+exports.In = In;
+//# sourceMappingURL=in.js.map

package/lib/cjs/decorators/operations/in.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"in.js","sourceRoot":"","sources":["../../../../src/decorators/operations/in.ts"],"names":[],"mappings":";;;AAAA,qCAA6F;AAC7F,yCAA+H;AA+C/H;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,EAAE,CAAC,MAAmC;IACpD,MAAM,aAAa,GAAG,IAAI,sBAAa,EAAE,CAAC;IAC1C,MAAM,MAAM,GAAQ,EAAE,CAAC;IAEvB,MAAM,SAAS,GAAG,CAAC,MAAW,EAAE,WAA6B,EAAE,KAAmC,EAAE,EAAE;QACpG,MAAM,KAAK,GAAG,wBAAe,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QAE/D,QAAQ,KAAK,CAAC,aAAa,EAAE;YAC3B,KAAK,qBAAc,CAAC,KAAK;gBACtB,KAA4B,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;gBACnD,MAAM;YACR,KAAK,qBAAc,CAAC,MAAM;gBACxB,aAAa,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;gBACxB,KAAyB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;gBAErE,aAAa,CAAC,MAAM,CAAC,mBAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC9C,MAAM;YAER,KAAK,qBAAc,CAAC,KAAK;gBACvB,IAAA,wBAAiB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBACrC,MAAM;YAER;gBACE,MAAM,IAAI,+BAAwB,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;SACxE;IACH,CAAC,CAAC;IAEF,SAAS,CAAC,IAAI,GAAG,CAAC,IAAe,EAAE,EAAE;QACnC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAEnB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,SAAS,CAAC,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE;QAChC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,SAAS,CAAC,WAAW,GAAG,CAAC,WAAmB,EAAE,EAAE;QAC9C,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAEvC,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,SAAS,CAAC,QAAQ,GAAG,CAAC,WAAoB,IAAI,EAAE,EAAE;QAChD,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEjC,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,SAAS,CAAC,OAAO,GAAG,CAAC,OAAwB,EAAE,EAAE;QAC/C,OAAO,SAAS,CAAC,MAAM,CAAC,EAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAC,CAAC,CAAC;IACzD,CAAC,CAAC;IAEF,SAAS,CAAC,MAAM,GAAG,CAAC,OAAY,EAAE,EAAE;QAClC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/B,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AA9DD,gBA8DC","sourcesContent":["import {decorateMethodsOf, DecoratorTypes, Type, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityStore, JsonMethodStore, JsonParameter, JsonParameterStore, JsonSchema, JsonSchemaObject} from \"../../domain\";\nimport {JsonParameterTypes} from \"../../domain/JsonParameterTypes\";\n\nexport interface InChainedDecorators {\n  <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;\n\n  (target: Object, propertyKey: string | symbol, parameterIndex: number): void;\n\n  (target: Function): void;\n\n  /**\n   * Type of this in parameter\n   * @param type\n   */\n  Type(type: Type<any>): this;\n\n  /**\n   *\n   * @param name\n   */\n  Name(name: string): this;\n\n  /**\n   *\n   * @param description\n   */\n  Description(description: string): this;\n\n  /**\n   *\n   * @param required\n   */\n  Required(required?: boolean): this;\n\n  /**\n   * Add pattern constraint. Only available for OPENAPI.\n   * @param pattern\n   */\n  Pattern(pattern: string | RegExp): this;\n\n  /**\n   * Add custom schema.\n   * @param schema\n   */\n  Schema(schema: Partial<JsonSchemaObject>): this;\n}\n\n/**\n * Add a input parameter.\n *\n * ::: warning\n * Don't use decorator with Ts.ED application to decorate parameters. Use @@BodyParams@@, @@PathParams@@, etc... instead.\n * But you can use this decorator on Method, to add extra in parameters like Authorization header.\n *\n * ```typescript\n * @Controller(\"/\")\n * class MyController {\n *    @Get(\"/\")\n *    @In(\"header\").Type(String).Name(\"Authorization\").Required()\n *    method() {\n *    }\n *  }\n * ```\n * :::\n *\n * @param inType\n * @decorator\n * @swagger\n * @schema\n * @input\n * @operation\n */\nexport function In(inType: JsonParameterTypes | string): InChainedDecorators {\n  const jsonParameter = new JsonParameter();\n  const schema: any = {};\n\n  const decorator = (target: any, propertyKey?: string | symbol, index?: PropertyDescriptor | number) => {\n    const store = JsonEntityStore.from(target, propertyKey, index);\n\n    switch (store.decoratorType) {\n      case DecoratorTypes.PARAM:\n        (store as JsonParameterStore).parameter.in(inType);\n        break;\n      case DecoratorTypes.METHOD:\n        jsonParameter.in(inType);\n        (store as JsonMethodStore).operation.addParameter(-1, jsonParameter);\n\n        jsonParameter.schema(JsonSchema.from(schema));\n        break;\n\n      case DecoratorTypes.CLASS:\n        decorateMethodsOf(target, decorator);\n        break;\n\n      default:\n        throw new UnsupportedDecoratorType(In, [target, propertyKey, index]);\n    }\n  };\n\n  decorator.Type = (type: Type<any>) => {\n    schema.type = type;\n\n    return decorator;\n  };\n\n  decorator.Name = (name: string) => {\n    jsonParameter.name(name);\n\n    return decorator;\n  };\n\n  decorator.Description = (description: string) => {\n    jsonParameter.description(description);\n\n    return decorator;\n  };\n\n  decorator.Required = (required: boolean = true) => {\n    jsonParameter.required(required);\n\n    return decorator;\n  };\n\n  decorator.Pattern = (pattern: string | RegExp) => {\n    return decorator.Schema({pattern: pattern.toString()});\n  };\n\n  decorator.Schema = (_schema: any) => {\n    Object.assign(schema, _schema);\n\n    return decorator;\n  };\n\n  return decorator;\n}\n"]}

package/lib/cjs/decorators/operations/inFile.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InFile = void 0;
+const core_1 = require("@tsed/core");
+const in_1 = require("./in");
+const JsonParameterTypes_1 = require("../../domain/JsonParameterTypes");
+const returns_1 = require("./returns");
+const name_1 = require("../common/name");
+const consumes_1 = require("./consumes");
+/**
+ * Add a input file parameter.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application to decorate parameters. Use @@BodyParams@@, @@PathParams@@, etc... instead.
+ * But you can use this decorator on Method, to add extra in parameters like Authorization header.
+ *
+ * ```typescript
+ * @Controller("/")
+ * class MyController {
+ *    @Post("/")
+ *    method(@InFile("file1") file: any) {
+ *    }
+ *  }
+ * ```
+ * :::
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @operation
+ * @param name
+ */
+function InFile(name) {
+    return (...args) => {
+        const [target, propertyKey, index] = args;
+        const multiple = core_1.Metadata.getParamTypes(target, propertyKey)[index] === Array;
+        name = (typeof name === "object" ? undefined : name);
+        const expression = [name, !multiple && "0"].filter(Boolean).join(".");
+        const decorators = (0, core_1.useDecorators)((0, in_1.In)(JsonParameterTypes_1.JsonParameterTypes.FILES), (0, name_1.Name)(expression), (0, core_1.useMethodDecorators)((0, returns_1.Returns)(400).Description(`<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1`), (0, consumes_1.Consumes)("multipart/form-data")));
+        decorators(...args);
+    };
+}
+exports.InFile = InFile;
+//# sourceMappingURL=inFile.js.map

package/lib/cjs/decorators/operations/inFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inFile.js","sourceRoot":"","sources":["../../../../src/decorators/operations/inFile.ts"],"names":[],"mappings":";;;AAAA,qCAA6F;AAC7F,6BAAwB;AACxB,wEAAmE;AACnE,uCAAkC;AAClC,yCAAoC;AACpC,yCAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,MAAM,CAAC,IAAY;IACjC,OAAO,CAAC,GAAG,IAAyB,EAAQ,EAAE;QAC5C,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC;QAC1C,MAAM,QAAQ,GAAG,eAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,KAAe,CAAC,KAAK,KAAK,CAAC;QAExF,IAAI,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAE,CAAC;QAEtD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEtE,MAAM,UAAU,GAAG,IAAA,oBAAa,EAC9B,IAAA,OAAE,EAAC,uCAAkB,CAAC,KAAK,CAAC,EAC5B,IAAA,WAAI,EAAC,UAAU,CAAC,EAChB,IAAA,0BAAmB,EACjB,IAAA,iBAAO,EAAC,GAAG,CAAC,CAAC,WAAW,CACtB,+KAA+K,CAChL,EACD,IAAA,mBAAQ,EAAC,qBAAqB,CAAC,CAChC,CACF,CAAC;QAEF,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC;AAtBD,wBAsBC","sourcesContent":["import {DecoratorParameters, Metadata, useDecorators, useMethodDecorators} from \"@tsed/core\";\nimport {In} from \"./in\";\nimport {JsonParameterTypes} from \"../../domain/JsonParameterTypes\";\nimport {Returns} from \"./returns\";\nimport {Name} from \"../common/name\";\nimport {Consumes} from \"./consumes\";\n\n/**\n * Add a input file parameter.\n *\n * ::: warning\n * Don't use decorator with Ts.ED application to decorate parameters. Use @@BodyParams@@, @@PathParams@@, etc... instead.\n * But you can use this decorator on Method, to add extra in parameters like Authorization header.\n *\n * ```typescript\n * @Controller(\"/\")\n * class MyController {\n *    @Post(\"/\")\n *    method(@InFile(\"file1\") file: any) {\n *    }\n *  }\n * ```\n * :::\n *\n * @decorator\n * @swagger\n * @schema\n * @input\n * @operation\n * @param name\n */\nexport function InFile(name: string): ParameterDecorator {\n  return (...args: DecoratorParameters): void => {\n    const [target, propertyKey, index] = args;\n    const multiple = Metadata.getParamTypes(target, propertyKey)[index as number] === Array;\n\n    name = (typeof name === \"object\" ? undefined : name)!;\n\n    const expression = [name, !multiple && \"0\"].filter(Boolean).join(\".\");\n\n    const decorators = useDecorators(\n      In(JsonParameterTypes.FILES),\n      Name(expression),\n      useMethodDecorators(\n        Returns(400).Description(\n          `<File too long | Too many parts | Too many files | Field name too long | Field value too long | Too many fields | Unexpected field>  [fieldName] Example: File too long file1`\n        ),\n        Consumes(\"multipart/form-data\")\n      )\n    );\n\n    decorators(...args);\n  };\n}\n"]}

package/lib/cjs/decorators/operations/location.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Location = void 0;
+const returns_1 = require("./returns");
+/**
+ * Sets the response Location HTTP header to the specified path parameter.
+ *
+ * ```typescript
+ *  @Location('/foo/bar', {description: 'Location to the next step'})
+ *  @Location('http://example.com')
+ *  @Location('back')
+ *  private myMethod() {
+ *
+ *  }
+ * ```
+ *
+ * A path value of “back” has a special meaning, it refers to the URL specified in the `Referer` header of the request. If the `Referer` header was not specified, it refers to “/”.
+ *
+ * @param location
+ * @param meta
+ * @returns {Function}
+ * @decorator
+ * @operation
+ */
+function Location(location, meta) {
+    return (0, returns_1.Returns)().Location(location, meta);
+}
+exports.Location = Location;
+//# sourceMappingURL=location.js.map

package/lib/cjs/decorators/operations/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../../src/decorators/operations/location.ts"],"names":[],"mappings":";;;AACA,uCAAkC;AAElC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,QAAQ,CAAC,QAAgB,EAAE,IAAiB;IAC1D,OAAO,IAAA,iBAAO,GAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC5C,CAAC;AAFD,4BAEC","sourcesContent":["import {JsonHeader} from \"../../interfaces/JsonOpenSpec\";\nimport {Returns} from \"./returns\";\n\n/**\n * Sets the response Location HTTP header to the specified path parameter.\n *\n * ```typescript\n *  @Location('/foo/bar', {description: 'Location to the next step'})\n *  @Location('http://example.com')\n *  @Location('back')\n *  private myMethod() {\n *\n *  }\n * ```\n *\n * A path value of “back” has a special meaning, it refers to the URL specified in the `Referer` header of the request. If the `Referer` header was not specified, it refers to “/”.\n *\n * @param location\n * @param meta\n * @returns {Function}\n * @decorator\n * @operation\n */\nexport function Location(location: string, meta?: JsonHeader) {\n  return Returns().Location(location, meta);\n}\n"]}

package/lib/cjs/decorators/operations/operationId.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationId = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Set a swagger operationId explicitly.
+ *
+ * @param operationId
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+function OperationId(operationId) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        if (store.decoratorType !== core_1.DecoratorTypes.METHOD) {
+            throw new core_1.UnsupportedDecoratorType(OperationId, args);
+        }
+        store.operation.operationId(operationId);
+    });
+}
+exports.OperationId = OperationId;
+//# sourceMappingURL=operationId.js.map

package/lib/cjs/decorators/operations/operationId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operationId.js","sourceRoot":"","sources":["../../../../src/decorators/operations/operationId.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,yDAAoD;AAEpD;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,WAAmB;IAC7C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,MAAM,EAAE;YACjD,MAAM,IAAI,+BAAwB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;SACvD;QAED,KAAK,CAAC,SAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;AARD,kCAQC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Set a swagger operationId explicitly.\n *\n * @param operationId\n * @decorator\n * @swagger\n * @schema\n * @operation\n */\nexport function OperationId(operationId: string) {\n  return JsonEntityFn((store, args) => {\n    if (store.decoratorType !== DecoratorTypes.METHOD) {\n      throw new UnsupportedDecoratorType(OperationId, args);\n    }\n\n    store.operation!.operationId(operationId);\n  });\n}\n"]}

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationPath = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Declare new Operation with his path and http method.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application.
+ *
+ * Use theses decorators instead:
+ *
+ * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
+ *
+ * :::
+ *
+ * @param method
+ * @param path
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+function OperationPath(method, path = "/") {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        if (store.decoratorType !== core_1.DecoratorTypes.METHOD) {
+            throw new core_1.UnsupportedDecoratorType(OperationPath, args);
+        }
+        store.operation.addOperationPath(method.toUpperCase(), path);
+    });
+}
+exports.OperationPath = OperationPath;
+//# sourceMappingURL=operationPath.js.map

package/lib/cjs/decorators/operations/operationPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operationPath.js","sourceRoot":"","sources":["../../../../src/decorators/operations/operationPath.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,yDAAoD;AAGpD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,aAAa,CAAC,MAAiC,EAAE,OAAwB,GAAG;IAC1F,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,MAAM,EAAE;YACjD,MAAM,IAAI,+BAAwB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;SACzD;QAED,KAAK,CAAC,SAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC;AARD,sCAQC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\nimport {OperationMethods} from \"../../constants/httpMethods\";\n\n/**\n * Declare new Operation with his path and http method.\n *\n * ::: warning\n * Don't use decorator with Ts.ED application.\n *\n * Use theses decorators instead:\n *\n * <ApiList query=\"status.includes('decorator') && status.includes('httpMethod')\" />\n *\n * :::\n *\n * @param method\n * @param path\n * @decorator\n * @swagger\n * @schema\n * @operation\n */\nexport function OperationPath(method: OperationMethods | string, path: string | RegExp = \"/\") {\n  return JsonEntityFn((store, args) => {\n    if (store.decoratorType !== DecoratorTypes.METHOD) {\n      throw new UnsupportedDecoratorType(OperationPath, args);\n    }\n\n    store.operation!.addOperationPath(method.toUpperCase(), path);\n  });\n}\n"]}

package/lib/cjs/decorators/operations/partial.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Partial = void 0;
+const groups_1 = require("../common/groups");
+/**
+ * Apply Partial group strategy on the input model
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Partial() {
+    return (0, groups_1.Groups)("partial");
+}
+exports.Partial = Partial;
+//# sourceMappingURL=partial.js.map

package/lib/cjs/decorators/operations/partial.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partial.js","sourceRoot":"","sources":["../../../../src/decorators/operations/partial.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AAExC;;;;;;;;GAQG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAA,eAAM,EAAC,SAAS,CAAQ,CAAC;AAClC,CAAC;AAFD,0BAEC","sourcesContent":["import {Groups} from \"../common/groups\";\n\n/**\n * Apply Partial group strategy on the input model\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Partial(): ParameterDecorator {\n  return Groups(\"partial\") as any;\n}\n"]}

package/lib/cjs/decorators/operations/path.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Path = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Set class path to expose all endpoints
+ *
+ * ::: warning
+ * Don't use this decorator to change the path if you develop your application with Ts.ED.
+ * :::
+ *
+ * @param path
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @operation
+ */
+function Path(path) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        if (store.decoratorType !== core_1.DecoratorTypes.CLASS) {
+            throw new core_1.UnsupportedDecoratorType(Path, args);
+        }
+        store.path = path;
+    });
+}
+exports.Path = Path;
+//# sourceMappingURL=path.js.map

package/lib/cjs/decorators/operations/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../../../src/decorators/operations/path.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,yDAAoD;AAEpD;;;;;;;;;;;;;GAaG;AACH,SAAgB,IAAI,CAAC,IAAY;IAC/B,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,KAAK,EAAE;YAChD,MAAM,IAAI,+BAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SAChD;QAED,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC;AARD,oBAQC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Set class path to expose all endpoints\n *\n * ::: warning\n * Don't use this decorator to change the path if you develop your application with Ts.ED.\n * :::\n *\n * @param path\n * @decorator\n * @swagger\n * @schema\n * @classDecorator\n * @operation\n */\nexport function Path(path: string) {\n  return JsonEntityFn((store, args) => {\n    if (store.decoratorType !== DecoratorTypes.CLASS) {\n      throw new UnsupportedDecoratorType(Path, args);\n    }\n\n    store.path = path;\n  });\n}\n"]}

package/lib/cjs/decorators/operations/produces.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Produces = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Add produces metadata on the decorated element.
+ *
+ * ## Examples
+ * ### On method
+ *
+ * ```typescript
+ * class Model {
+ *    @Produces("text/html")
+ *    id: string;
+ * }
+ * ```
+ *
+ * ::: warning
+ * For openspec v3 prefer `@Returns().ContentType()` usage (see @@Returns@@).
+ * :::
+ *
+ * @param produces
+ * @decorator
+ * @swagger
+ * @methodDecorator
+ * @classDecorator
+ * @operation
+ * @response
+ */
+function Produces(...produces) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        switch (store.decoratorType) {
+            case core_1.DecoratorTypes.METHOD:
+                store.operation.produces(produces);
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                (0, core_1.decorateMethodsOf)(args[0], Produces(...produces));
+                break;
+            default:
+                throw new core_1.UnsupportedDecoratorType(Produces, args);
+        }
+    });
+}
+exports.Produces = Produces;
+//# sourceMappingURL=produces.js.map

package/lib/cjs/decorators/operations/produces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"produces.js","sourceRoot":"","sources":["../../../../src/decorators/operations/produces.ts"],"names":[],"mappings":";;;AAAA,qCAAuF;AACvF,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,QAAQ,CAAC,GAAG,QAAkB;IAC5C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,QAAQ,KAAK,CAAC,aAAa,EAAE;YAC3B,KAAK,qBAAc,CAAC,MAAM;gBACxB,KAAK,CAAC,SAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,qBAAc,CAAC,KAAK;gBACvB,IAAA,wBAAiB,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;gBAClD,MAAM;YAER;gBACE,MAAM,IAAI,+BAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACtD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,4BAcC","sourcesContent":["import {decorateMethodsOf, DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Add produces metadata on the decorated element.\n *\n * ## Examples\n * ### On method\n *\n * ```typescript\n * class Model {\n *    @Produces(\"text/html\")\n *    id: string;\n * }\n * ```\n *\n * ::: warning\n * For openspec v3 prefer `@Returns().ContentType()` usage (see @@Returns@@).\n * :::\n *\n * @param produces\n * @decorator\n * @swagger\n * @methodDecorator\n * @classDecorator\n * @operation\n * @response\n */\nexport function Produces(...produces: string[]) {\n  return JsonEntityFn((store, args) => {\n    switch (store.decoratorType) {\n      case DecoratorTypes.METHOD:\n        store.operation!.produces(produces);\n        break;\n      case DecoratorTypes.CLASS:\n        decorateMethodsOf(args[0], Produces(...produces));\n        break;\n\n      default:\n        throw new UnsupportedDecoratorType(Produces, args);\n    }\n  });\n}\n"]}

package/lib/cjs/decorators/operations/redirect.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Redirect = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+const returns_1 = require("./returns");
+function Redirect(...args) {
+    const { status, url, meta } = args.reduce((options, value) => {
+        if ((0, core_1.isNumber)(value)) {
+            options.status = value;
+            return options;
+        }
+        if ((0, core_1.isString)(value)) {
+            options.url = value;
+            return options;
+        }
+        options.meta = value;
+        return options;
+    }, { status: 302, url: "", meta: {} });
+    return (0, core_1.useDecorators)((0, returns_1.Returns)(status).Location(url, meta), (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        var _a;
+        (_a = entity.operation) === null || _a === void 0 ? void 0 : _a.setRedirection(status);
+    }));
+}
+exports.Redirect = Redirect;
+//# sourceMappingURL=redirect.js.map

package/lib/cjs/decorators/operations/redirect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.js","sourceRoot":"","sources":["../../../../src/decorators/operations/redirect.ts"],"names":[],"mappings":";;;AAAA,qCAA6D;AAE7D,yDAAoD;AACpD,uCAAkC;AAqDlC,SAAgB,QAAQ,CAAC,GAAG,IAAW;IACrC,MAAM,EAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,MAAM,CACrC,CAAC,OAAY,EAAE,KAAU,EAAE,EAAE;QAC3B,IAAI,IAAA,eAAQ,EAAC,KAAK,CAAC,EAAE;YACnB,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;YACvB,OAAO,OAAO,CAAC;SAChB;QAED,IAAI,IAAA,eAAQ,EAAC,KAAK,CAAC,EAAE;YACnB,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC;YACpB,OAAO,OAAO,CAAC;SAChB;QAED,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;QACrB,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,EAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAC,CACjC,CAAC;IACF,OAAO,IAAA,oBAAa,EAClB,IAAA,iBAAO,EAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,EACnC,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,EAAE;;QACtB,MAAA,MAAM,CAAC,SAAS,0CAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAxBD,4BAwBC","sourcesContent":["import {isNumber, isString, useDecorators} from \"@tsed/core\";\nimport {JsonHeader} from \"../../interfaces/JsonOpenSpec\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\nimport {Returns} from \"./returns\";\n\n/**\n * Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an HTTP status code . If not specified, status defaults to “302 “Found”.\n *\n * ```typescript\n *  @Redirect('/foo/bar')\n *  @Redirect(301, 'http://example.com').Type(Model)\n *  private myMethod() {}\n * ```\n * Redirects can be a fully-qualified URL for redirecting to a different site:\n *\n * ```typescript\n *  @Redirect('http://google.com');\n *  private myMethod() {}\n * ```\n *\n * Redirects can be relative to the root of the host name. For example, if the application is on http://example.com/admin/post/new, the following would redirect to the URL http://example.com/admin:\n *\n * ```typescript\n *  @Redirect('/admin');\n * ```\n * Redirects can be relative to the current URL. For example, from http://example.com/blog/admin/ (notice the trailing slash), the following would redirect to the URL http://example.com/blog/admin/post/new.\n *\n * ```typescript\n *  @Redirect('post/new');\n * ```\n *\n * Redirecting to post/new from http://example.com/blog/admin (no trailing slash), will redirect to http://example.com/blog/post/new.\n *\n * If you found the above behavior confusing, think of path segments as directories (with trailing slashes) and files, it will start to make sense.\n *\n * Path-relative redirects are also possible. If you were on http://example.com/admin/post/new, the following would redirect to http//example.com/admin/post:\n *\n * ```typescript\n *  @Redirect('..');\n * ``\n *\n * A back redirection redirects the request back to the referer, defaulting to / when the referer is missing.\n *\n * ```typescript\n *  @Redirect('back');\n * ```\n *\n * @param url\n * @param meta\n * @decorator\n * @operation\n * @response\n * @headers\n */\nexport function Redirect(url: string, meta?: JsonHeader): Function;\nexport function Redirect(status: number, url: string, meta?: JsonHeader): Function;\nexport function Redirect(...args: any[]): Function {\n  const {status, url, meta} = args.reduce(\n    (options: any, value: any) => {\n      if (isNumber(value)) {\n        options.status = value;\n        return options;\n      }\n\n      if (isString(value)) {\n        options.url = value;\n        return options;\n      }\n\n      options.meta = value;\n      return options;\n    },\n    {status: 302, url: \"\", meta: {}}\n  );\n  return useDecorators(\n    Returns(status).Location(url, meta),\n    JsonEntityFn((entity) => {\n      entity.operation?.setRedirection(status);\n    })\n  );\n}\n"]}

package/lib/cjs/decorators/operations/returns.js

@@ -0,0 +1,252 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Returns = void 0;
+const core_1 = require("@tsed/core");
+const httpStatusMessages_1 = require("../../constants/httpStatusMessages");
+const DecoratorContext_1 = require("../../domain/DecoratorContext");
+const JsonEntityStore_1 = require("../../domain/JsonEntityStore");
+const JsonSchema_1 = require("../../domain/JsonSchema");
+const defineStatusModel_1 = require("../../utils/defineStatusModel");
+const from_1 = require("../../utils/from");
+const isSuccessStatus_1 = require("../../utils/isSuccessStatus");
+const mapHeaders_1 = require("../../utils/mapHeaders");
+/**
+ * @ignore
+ */
+function isEnum(type) {
+    return (0, core_1.isObject)(type) && !("toJSON" in type);
+}
+function mapGenerics(types) {
+    return types.map((type) => {
+        if (isEnum(type)) {
+            return (0, from_1.string)().enum(Object.values(type));
+        }
+        return type;
+    });
+}
+/**
+ * @ignore
+ */
+class ReturnDecoratorContext extends DecoratorContext_1.DecoratorContext {
+    constructor({ status, model }) {
+        super();
+        this.methods = [
+            "contentType",
+            "description",
+            "examples",
+            "type",
+            "status",
+            "of",
+            "oneOf",
+            "allOf",
+            "anyOf",
+            "nested",
+            "header",
+            "headers",
+            "schema",
+            "title",
+            "groups",
+            "location"
+        ];
+        this.model(model);
+        this.status(status);
+    }
+    type(model) {
+        return this.model(model);
+    }
+    model(model) {
+        model && this.set("model", model);
+        return this;
+    }
+    status(status) {
+        this.set("status", status);
+        if (status && (0, httpStatusMessages_1.getStatusMessage)(status) && !this.get("description")) {
+            this.set("description", (0, httpStatusMessages_1.getStatusMessage)(status));
+            if (!this.get("model")) {
+                this.model((0, defineStatusModel_1.getStatusModel)(+status));
+            }
+        }
+        return this;
+    }
+    headers(headers) {
+        this.set("headers", {
+            ...(this.get("headers") || {}),
+            ...(0, mapHeaders_1.mapHeaders)(headers)
+        });
+        return this;
+    }
+    header(key, value) {
+        return this.headers({ [key]: value });
+    }
+    location(path, meta = {}) {
+        this.headers({
+            Location: {
+                ...meta,
+                value: path
+            }
+        });
+        return this;
+    }
+    groups(...groups) {
+        this.set("groups", groups);
+        return this;
+    }
+    nested(...generics) {
+        const model = this.get("model");
+        this.checkPrimitive(model);
+        this.checkCollection(model);
+        this.addAction((ctx) => {
+            this.get("schema").nestedGenerics.push(mapGenerics(generics));
+        });
+        return this;
+    }
+    of(...types) {
+        const model = this.get("model");
+        this.checkPrimitive(model);
+        this.addAction(() => {
+            const schema = this.get("schema");
+            if ((0, core_1.isCollection)(model)) {
+                schema === null || schema === void 0 ? void 0 : schema.itemSchema({ type: types[0] });
+            }
+            else {
+                schema === null || schema === void 0 ? void 0 : schema.nestedGenerics.push(mapGenerics(types));
+            }
+        });
+        return this;
+    }
+    oneOf(...types) {
+        const model = this.get("model");
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.type(model);
+            schema.itemSchema({ oneOf: types.map((type) => ({ type })) });
+        });
+        return this;
+    }
+    allOf(...types) {
+        const model = this.get("model");
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.type(model);
+            schema.itemSchema({ allOf: types.map((type) => ({ type })) });
+        });
+        return this;
+    }
+    anyOf(...types) {
+        const model = this.get("model");
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.type(model);
+            schema.itemSchema({ anyOf: types.map((type) => ({ type })) });
+        });
+        return this;
+    }
+    schema(partial) {
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.assign(partial);
+        });
+        return this;
+    }
+    examples(examples) {
+        this.set("examples", (0, core_1.isString)(examples) ? [examples] : examples);
+        return this;
+    }
+    title(title) {
+        return this.schema({ title });
+    }
+    checkPrimitive(model) {
+        if ((0, core_1.isPrimitiveOrPrimitiveClass)(model)) {
+            throw new Error("Returns.Of cannot be used with the following primitive classes: String, Number, Boolean");
+        }
+    }
+    checkCollection(model) {
+        if ((0, core_1.isCollection)(model)) {
+            throw new Error("Returns.Nested cannot be used with the following classes: Map, Set, Array, String, Number, Boolean");
+        }
+    }
+    getContentType() {
+        const model = this.get("model");
+        let contentType = this.get("contentType");
+        if (model && !(0, core_1.isPlainObject)(model) && !(0, core_1.isPrimitiveOrPrimitiveClass)(model)) {
+            contentType = contentType || "application/json";
+        }
+        return contentType;
+    }
+    getStatus() {
+        return this.get("status") || "default";
+    }
+    onInit(args, decorator) {
+        const type = (0, core_1.decoratorTypeOf)(args);
+        switch (type) {
+            case core_1.DecoratorTypes.METHOD:
+                this.entity = JsonEntityStore_1.JsonEntityStore.from(...args);
+                if (this.entity.operation) {
+                    this.map();
+                }
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                this.decoratorType = core_1.DecoratorTypes.CLASS;
+                (0, core_1.decorateMethodsOf)(args[0], decorator);
+                break;
+        }
+    }
+    map() {
+        const model = this.get("model");
+        const { entity, decoratorType } = this;
+        const operation = this.entity.operation;
+        const currentStatus = this.getStatus();
+        const response = operation.ensureResponseOf(currentStatus);
+        const contentType = this.getContentType();
+        let { description = response.get("description") } = this.toObject();
+        if (description) {
+            description = decoratorType === core_1.DecoratorTypes.CLASS ? response.get("description") || description : description;
+            response.description(description);
+        }
+        const headers = this.getMergedKey("headers", response.get("headers"));
+        if (headers) {
+            response.headers(headers);
+        }
+        this.mapMedia(response);
+        if ((0, isSuccessStatus_1.isSuccessStatus)(this.get("status")) || currentStatus === "default") {
+            if (model) {
+                entity.type = model;
+            }
+        }
+        // additional info for OS2
+        contentType && operation.addProduce(contentType);
+        // run additional actions
+        return this.runActions();
+    }
+    mapMedia(response) {
+        const contentType = this.getContentType();
+        const model = this.get("model");
+        const media = response.getMedia(contentType || "*/*");
+        const schema = media.get("schema") || new JsonSchema_1.JsonSchema({ type: model });
+        if (model) {
+            if ((0, core_1.isArray)(model)) {
+                schema.oneOf(model.map((type) => ({ type })));
+            }
+            else {
+                schema.type(model);
+            }
+        }
+        this.set("schema", schema);
+        media.schema(schema);
+        media.groups = this.get("groups");
+        const examples = this.get("examples");
+        if (examples) {
+            media.examples(examples);
+        }
+        return media;
+    }
+}
+function Returns(status, model) {
+    const context = new ReturnDecoratorContext({
+        status,
+        model
+    });
+    return context.build();
+}
+exports.Returns = Returns;
+//# sourceMappingURL=returns.js.map