@tsed/schema 6.70.0 → 6.71.1

package/lib/index.modern.js

@@ -1,5 +1,5 @@
 import { constantCase, pascalCase, camelCase } from 'change-case';
-import { Store, decoratorTypeOf, nameOf, isFunction, cleanObject, isPromise, isClass, isSymbol, isPrimitiveOrPrimitiveClass, isClassObject, isDate, isCollection, classOf, isArrowFn, primitiveOf, isArray, Hooks, uniq, isObject, uniqBy, deepMerge, toMap, Entity, DecoratorTypes, descriptorOf, Metadata, isPrimitiveClass, ancestorsOf, mergeReducerBuilder, UnsupportedDecoratorType, decorateMethodsOf, isString, isPlainObject, useDecorators, StoreSet } from '@tsed/core';
+import { Store, decoratorTypeOf, nameOf, isFunction, cleanObject, isPromise, isClass, isSymbol, isPrimitiveOrPrimitiveClass, isClassObject, isDate, isCollection, classOf, isArrowFn, primitiveOf, isArray, Hooks, uniq, isObject, uniqBy, deepMerge, toMap, Entity, DecoratorTypes, descriptorOf, Metadata, isPrimitiveClass, ancestorsOf, mergeReducerBuilder, UnsupportedDecoratorType, decorateMethodsOf, isString, isPlainObject, isNumber, useDecorators, StoreSet } from '@tsed/core';
 import micromatch from 'micromatch';
 
 const HTTP_STATUS_MESSAGES = {
@@ -74,6 +74,9 @@ const HTTP_STATUS_MESSAGES = {
 function getStatusConstant(status) {
   return constantCase(HTTP_STATUS_MESSAGES[status]);
 }
+function getStatusMessage(status) {
+  return HTTP_STATUS_MESSAGES[status];
+}
 
 function _extends() {
   _extends = Object.assign || function (target) {
@@ -108,6 +111,20 @@ function _objectWithoutPropertiesLoose(source, excluded) {
   return target;
 }
 
+var id = 0;
+
+function _classPrivateFieldLooseKey(name) {
+  return "__private_" + id++ + "_" + name;
+}
+
+function _classPrivateFieldLooseBase(receiver, privateKey) {
+  if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) {
+    throw new TypeError("attempted to use private field on non-instance");
+  }
+
+  return receiver;
+}
+
 /**
  * @ignore
  */
@@ -327,6 +344,7 @@ function anyMapper(input, options = {}) {
 registerJsonSchemaMapper("any", anyMapper);
 
 const isSuccessStatus = code => Number(code) && 200 <= Number(code) && Number(code) < 300;
+const isRedirectionStatus = code => Number(code) && 300 <= Number(code) && Number(code) < 400;
 
 class JsonMap extends Map {
   constructor(obj = {}) {
@@ -1471,13 +1489,27 @@ class JsonSchema extends Map {
 }
 
 const _excluded$6 = ["schema", "in"];
+
+var _status = /*#__PURE__*/_classPrivateFieldLooseKey("status");
+
+var _redirection = /*#__PURE__*/_classPrivateFieldLooseKey("redirection");
+
 class JsonOperation extends JsonMap {
   constructor(obj = {}) {
     super(_extends({
       parameters: [],
       responses: new JsonMap()
     }, obj));
+    Object.defineProperty(this, _status, {
+      writable: true,
+      value: void 0
+    });
+    Object.defineProperty(this, _redirection, {
+      writable: true,
+      value: void 0
+    });
     this.operationPaths = new Map();
+    _classPrivateFieldLooseBase(this, _redirection)[_redirection] = false;
   }
 
   get response() {
@@ -1485,7 +1517,7 @@ class JsonOperation extends JsonMap {
   }
 
   get status() {
-    return this._status;
+    return _classPrivateFieldLooseBase(this, _status)[_status];
   }
 
   tags(tags) {
@@ -1514,15 +1546,32 @@ class JsonOperation extends JsonMap {
   }
 
   defaultStatus(status) {
-    this._status = status;
+    _classPrivateFieldLooseBase(this, _status)[_status] = status;
+    return this;
   }
 
   getStatus() {
-    return this._status || 200;
+    return _classPrivateFieldLooseBase(this, _status)[_status] || 200;
+  }
+
+  setRedirection(status = 302) {
+    _classPrivateFieldLooseBase(this, _redirection)[_redirection] = true;
+    _classPrivateFieldLooseBase(this, _status)[_status] = status;
+    return this;
+  }
+
+  isRedirection(status) {
+    if (_classPrivateFieldLooseBase(this, _redirection)[_redirection]) {
+      if (status) {
+        return isRedirectionStatus(status);
+      }
+    }
+
+    return _classPrivateFieldLooseBase(this, _redirection)[_redirection];
   }
 
   addResponse(statusCode, response) {
-    if (isSuccessStatus(statusCode) && !this._status) {
+    if ((isSuccessStatus(statusCode) || isRedirectionStatus(statusCode)) && !_classPrivateFieldLooseBase(this, _status)[_status]) {
       const res = this.getResponseOf(200);
       this.getResponses().set(statusCode.toString(), res).delete("200");
       this.defaultStatus(Number(statusCode));
@@ -4287,17 +4336,9 @@ class ReturnDecoratorContext extends DecoratorContext {
     model
   }) {
     super();
-    this.methods = ["contentType", "description", "examples", "type", "status", "of", "nested", "header", "headers", "schema", "title", "groups"];
-    this.set("status", status);
-    this.set("model", model);
-
-    if (status && HTTP_STATUS_MESSAGES[status]) {
-      this.set("description", HTTP_STATUS_MESSAGES[status]);
-
-      if (!model) {
-        this.model(getStatusModel(+status));
-      }
-    }
+    this.methods = ["contentType", "description", "examples", "type", "status", "of", "nested", "header", "headers", "schema", "title", "groups", "location"];
+    this.model(model);
+    this.status(status);
   }
 
   type(model) {
@@ -4305,12 +4346,21 @@ class ReturnDecoratorContext extends DecoratorContext {
   }
 
   model(model) {
-    this.set("model", model);
+    model && this.set("model", model);
     return this;
   }
 
   status(status) {
     this.set("status", status);
+
+    if (status && HTTP_STATUS_MESSAGES[status] && !this.get("description")) {
+      this.set("description", HTTP_STATUS_MESSAGES[status]);
+
+      if (!this.get("model")) {
+        this.model(getStatusModel(+status));
+      }
+    }
+
     return this;
   }
 
@@ -4325,6 +4375,15 @@ class ReturnDecoratorContext extends DecoratorContext {
     });
   }
 
+  location(path, meta = {}) {
+    this.headers({
+      Location: _extends({}, meta, {
+        value: path
+      })
+    });
+    return this;
+  }
+
   groups(...groups) {
     this.set("groups", groups);
     return this;
@@ -4424,6 +4483,8 @@ class ReturnDecoratorContext extends DecoratorContext {
       default:
         throw new UnsupportedDecoratorType(Returns, args);
     }
+
+    this.clear();
   }
 
   map() {
@@ -5112,6 +5173,61 @@ function Partial() {
   return Groups("partial");
 }
 
+function Redirect(...args) {
+  const {
+    status,
+    url,
+    meta
+  } = args.reduce((options, value) => {
+    if (isNumber(value)) {
+      options.status = value;
+      return options;
+    }
+
+    if (isString(value)) {
+      options.url = value;
+      return options;
+    }
+
+    options.meta = value;
+    return options;
+  }, {
+    status: 302,
+    url: "",
+    meta: {}
+  });
+  return useDecorators(Returns(status).Location(url, meta), JsonEntityFn(entity => {
+    var _entity$operation;
+
+    (_entity$operation = entity.operation) == null ? void 0 : _entity$operation.setRedirection(status);
+  }));
+}
+
+/**
+ * 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 Returns().Location(location, meta);
+}
+
 /**
  * Accept unknown properties on the deserialized model.
  *
@@ -7375,5 +7491,5 @@ function JsonEntityComponent(type) {
   };
 }
 
-export { AdditionalProperties, AllOf, Allow, Any, AnyOf, ArrayOf, CollectionContains, CollectionOf, Const, Consumes, ContentType, CustomKey, CustomKeys, DateFormat, DateTime, Default, Deprecated, Description, Email, Enum, Example, ExclusiveMaximum, ExclusiveMinimum, For, Format, ForwardGroups, GenericOf, Generics, Groups, HTTP_STATUS_MESSAGES, Header, Hidden, Ignore, In, Integer, JSON_TYPES, JsonEntityComponent, JsonEntityFn, JsonEntityStore, JsonFormatTypes, JsonLazyRef, JsonMap, JsonMedia, JsonOperation, JsonParameter, JsonParameterTypes, JsonRequestBody, JsonResponse, JsonSchema, MapOf, Max, MaxItems, MaxLength, MaxProperties, Maximum, Min, MinItems, MinLength, MinProperties, Minimum, MultipleOf, Name, Nullable, OneOf, OperationId, OperationMethods, OperationPath, Optional, Partial, Path, Pattern, Produces, Property, ReadOnly, Required, RequiredGroups, Returns, Schema, Security, SpecTypes, Status, Summary, Tags, TimeFormat, Title, UniqueItems, Uri, Url, WriteOnly, allOf, alterIgnore, any, anyOf, array, boolean, date, datetime, defineStatusModel, email, formatParameterType, from, getGenericsMap, getJsonSchema, getJsonType, getOperationsStores, getProperties, getPropertiesStores, getSpec, getStatusConstant, getStatusModel, integer, isParameterType, isSuccessStatus, lazyRef, map, mapGenericsOptions, mapHeaders, mergeSpec, number, object, oneOf, parameters, popGenerics, schemesReducer, security, set, string, tagsReducer, time, uri, url };
+export { AdditionalProperties, AllOf, Allow, Any, AnyOf, ArrayOf, CollectionContains, CollectionOf, Const, Consumes, ContentType, CustomKey, CustomKeys, DateFormat, DateTime, Default, Deprecated, Description, Email, Enum, Example, ExclusiveMaximum, ExclusiveMinimum, For, Format, ForwardGroups, GenericOf, Generics, Groups, HTTP_STATUS_MESSAGES, Header, Hidden, Ignore, In, Integer, JSON_TYPES, JsonEntityComponent, JsonEntityFn, JsonEntityStore, JsonFormatTypes, JsonLazyRef, JsonMap, JsonMedia, JsonOperation, JsonParameter, JsonParameterTypes, JsonRequestBody, JsonResponse, JsonSchema, Location, MapOf, Max, MaxItems, MaxLength, MaxProperties, Maximum, Min, MinItems, MinLength, MinProperties, Minimum, MultipleOf, Name, Nullable, OneOf, OperationId, OperationMethods, OperationPath, Optional, Partial, Path, Pattern, Produces, Property, ReadOnly, Redirect, Required, RequiredGroups, Returns, Schema, Security, SpecTypes, Status, Summary, Tags, TimeFormat, Title, UniqueItems, Uri, Url, WriteOnly, allOf, alterIgnore, any, anyOf, array, boolean, date, datetime, defineStatusModel, email, formatParameterType, from, getGenericsMap, getJsonSchema, getJsonType, getOperationsStores, getProperties, getPropertiesStores, getSpec, getStatusConstant, getStatusMessage, getStatusModel, integer, isParameterType, isRedirectionStatus, isSuccessStatus, lazyRef, map, mapGenericsOptions, mapHeaders, mergeSpec, number, object, oneOf, parameters, popGenerics, schemesReducer, security, set, string, tagsReducer, time, uri, url };
 //# sourceMappingURL=index.modern.js.map