@tsed/platform-response-filter 6.87.2 → 6.90.0

package/lib/index.modern.js

@@ -1,226 +0,0 @@
-import { registerProvider, Injectable, Configuration, InjectorService, Inject, Constant } from '@tsed/di';
-import { __decorate, __param, __metadata } from 'tslib';
-import { isObject, isSerializable } from '@tsed/core';
-import { renderView } from '@tsed/platform-views';
-import { serialize, deserialize } from '@tsed/json-mapper';
-
-/**
- * @ignore
- */
-// tslint:disable-next-line:variable-name
-const ResponseFiltersContainer = new Map();
-/**
- * @ignore
- */
-
-function registerResponseFilter(type, token) {
-  ResponseFiltersContainer.set(type, token);
-}
-
-/**
- * Register a response filter service.
- * @param contentTypes
- * @decorator
- */
-
-function ResponseFilter(...contentTypes) {
-  return target => {
-    contentTypes.forEach(contentType => {
-      registerResponseFilter(contentType, target);
-    });
-    registerProvider({
-      provide: target,
-      useClass: target
-    });
-  };
-}
-
-function _extends() {
-  _extends = Object.assign || function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
-    }
-
-    return target;
-  };
-
-  return _extends.apply(this, arguments);
-}
-
-const ANY_CONTENT_TYPE = "*/*";
-/**
- * @ignore
- */
-
-function getContentType(data, ctx) {
-  const {
-    endpoint,
-    response
-  } = ctx;
-  const {
-    operation
-  } = endpoint;
-  const contentType = response.getContentType() || operation.getContentTypeOf(response.statusCode) || "";
-
-  if (contentType && contentType !== ANY_CONTENT_TYPE) {
-    if (contentType === "application/json") {
-      if (isObject(data)) {
-        return contentType;
-      }
-    } else {
-      return contentType;
-    }
-  }
-
-  if (typeof data === "string" && endpoint.view) {
-    return "text/html";
-  }
-}
-
-/**
- * @deprecated Since 2021-10-03. Use serialize/deserialize functions from @tsed/json-mapper instead
- */
-
-let ConverterService = class ConverterService {
-  constructor(injectorService, configuration) {
-    this.injectorService = injectorService;
-    this._additionalProperties = configuration.get("converter.additionalProperties");
-  }
-  /**
-   * Convert instance to plainObject.
-   *
-   * @param obj
-   * @param options
-   */
-
-
-  serialize(obj, options = {}) {
-    return serialize(obj, _extends({
-      useAlias: true,
-      additionalProperties: this._additionalProperties === "accept"
-    }, options));
-  }
-  /**
-   * Convert a plainObject to targetType.
-   *
-   * ### Options
-   *
-   * - `ignoreCallback`: callback called for each object which will be deserialized. The callback can return a boolean to avoid the default converter behavior.
-   * - `checkRequiredValue`: Disable the required check condition.
-   *
-   * @param obj Object source that will be deserialized
-   * @param options Mapping options
-   * @returns {any}
-   */
-
-
-  deserialize(obj, options = {}) {
-    return deserialize(obj, _extends({
-      useAlias: true,
-      additionalProperties: this._additionalProperties === "accept"
-    }, options));
-  }
-
-};
-ConverterService = __decorate([Injectable(), __param(1, Configuration()), __metadata("design:paramtypes", [InjectorService, Object])], ConverterService);
-
-/**
- * @platform
- */
-
-let PlatformResponseFilter = class PlatformResponseFilter {
-  constructor() {
-    this.types = new Map();
-  }
-
-  get contentTypes() {
-    return [...this.types.keys()];
-  }
-
-  $onInit() {
-    ResponseFiltersContainer.forEach((token, type) => {
-      if (this.responseFilters.includes(token)) {
-        this.types.set(type, this.injector.get(token));
-      }
-    });
-  }
-
-  getBestContentType(data, ctx) {
-    const contentType = getContentType(data, ctx);
-
-    if (ctx.request.get("Accept")) {
-      const bestContentType = ctx.request.accepts([contentType].concat(this.contentTypes).filter(Boolean));
-
-      if (bestContentType) {
-        return [].concat(bestContentType).filter(type => type !== "*/*")[0];
-      }
-    }
-
-    return contentType;
-  }
-  /**
-   * Call filters to transform data
-   * @param data
-   * @param ctx
-   */
-
-
-  async transform(data, ctx) {
-    const {
-      response
-    } = ctx;
-    const bestContentType = this.getBestContentType(data, ctx);
-    bestContentType && response.contentType(bestContentType);
-
-    if (this.types.has(bestContentType)) {
-      return this.types.get(bestContentType).transform(data, ctx);
-    }
-
-    if (this.types.has(ANY_CONTENT_TYPE)) {
-      return this.types.get(ANY_CONTENT_TYPE).transform(data, ctx);
-    }
-
-    return data;
-  }
-  /**
-   * Serialize data before calling filters
-   * @param data
-   * @param ctx
-   */
-
-
-  async serialize(data, ctx) {
-    const {
-      response,
-      endpoint
-    } = ctx;
-
-    if (endpoint) {
-      if (endpoint.view) {
-        data = await renderView(data, ctx);
-      } else if (isSerializable(data)) {
-        data = this.injector.get(ConverterService).serialize(data, _extends({}, endpoint.getResponseOptions(response.statusCode), {
-          endpoint: true
-        }));
-      }
-    }
-
-    return data;
-  }
-
-};
-
-__decorate([Inject(), __metadata("design:type", InjectorService)], PlatformResponseFilter.prototype, "injector", void 0);
-
-__decorate([Constant("responseFilters", []), __metadata("design:type", Array)], PlatformResponseFilter.prototype, "responseFilters", void 0);
-
-PlatformResponseFilter = __decorate([Injectable()], PlatformResponseFilter);
-
-export { ANY_CONTENT_TYPE, ConverterService, PlatformResponseFilter, ResponseFilter, ResponseFiltersContainer, getContentType, registerResponseFilter };
-//# sourceMappingURL=index.modern.js.map

package/lib/index.modern.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.modern.js","sources":["../src/domain/ResponseFiltersContainer.ts","../src/decorators/responseFilter.ts","../src/utils/getContentType.ts","../src/services/ConverterService.ts","../src/services/PlatformResponseFilter.ts"],"sourcesContent":["import {Type} from \"@tsed/core\";\nimport {ResponseFilterMethods} from \"../interfaces/ResponseFilterMethods\";\n/**\n * @ignore\n */\nexport type ResponseFilterKey = \"*/*\" | \"application/json\" | \"text/html\" | \"plain/text\" | string;\n/**\n * @ignore\n */\n// tslint:disable-next-line:variable-name\nexport const ResponseFiltersContainer = new Map<ResponseFilterKey, Type<ResponseFilterMethods>>();\n/**\n * @ignore\n */\nexport function registerResponseFilter(type: ResponseFilterKey, token: Type<ResponseFilterMethods>) {\n  ResponseFiltersContainer.set(type, token);\n}\n","import {Type} from \"@tsed/core\";\nimport {registerProvider} from \"@tsed/di\";\nimport {registerResponseFilter, ResponseFilterKey} from \"../domain/ResponseFiltersContainer\";\n\n/**\n * Register a response filter service.\n * @param contentTypes\n * @decorator\n */\nexport function ResponseFilter(...contentTypes: ResponseFilterKey[]): ClassDecorator {\n  return <T = any>(target: T): void | T => {\n    contentTypes.forEach((contentType) => {\n      registerResponseFilter(contentType, target as any);\n    });\n    registerProvider({\n      provide: target,\n      useClass: (target as unknown) as Type<any>\n    });\n  };\n}\n","import {isObject} from \"@tsed/core\";\nimport type {BaseContext} from \"@tsed/di\";\nexport const ANY_CONTENT_TYPE = \"*/*\";\n/**\n * @ignore\n */\nexport function getContentType(data: any, ctx: BaseContext) {\n  const {endpoint, response} = ctx;\n  const {operation} = endpoint;\n\n  const contentType = response.getContentType() || operation.getContentTypeOf(response.statusCode) || \"\";\n\n  if (contentType && contentType !== ANY_CONTENT_TYPE) {\n    if (contentType === \"application/json\") {\n      if (isObject(data)) {\n        return contentType;\n      }\n    } else {\n      return contentType;\n    }\n  }\n\n  if (typeof data === \"string\" && endpoint.view) {\n    return \"text/html\";\n  }\n}\n","import {Configuration, Injectable, InjectorService} from \"@tsed/di\";\nimport {deserialize, JsonDeserializerOptions, JsonSerializerOptions, serialize} from \"@tsed/json-mapper\";\n\n/**\n * @deprecated Since 2021-10-03. Use serialize/deserialize functions from @tsed/json-mapper instead\n */\n@Injectable()\nexport class ConverterService {\n  private readonly _additionalProperties: string;\n\n  constructor(private injectorService: InjectorService, @Configuration() configuration: Configuration) {\n    this._additionalProperties = configuration.get<string>(\"converter.additionalProperties\");\n  }\n\n  /**\n   * Convert instance to plainObject.\n   *\n   * @param obj\n   * @param options\n   */\n  serialize(obj: any, options: JsonSerializerOptions = {}): any {\n    return serialize(obj, {\n      useAlias: true,\n      additionalProperties: this._additionalProperties === \"accept\",\n      ...options\n    });\n  }\n\n  /**\n   * Convert a plainObject to targetType.\n   *\n   * ### Options\n   *\n   * - `ignoreCallback`: callback called for each object which will be deserialized. The callback can return a boolean to avoid the default converter behavior.\n   * - `checkRequiredValue`: Disable the required check condition.\n   *\n   * @param obj Object source that will be deserialized\n   * @param options Mapping options\n   * @returns {any}\n   */\n  deserialize(obj: any, options: JsonDeserializerOptions = {}): any {\n    return deserialize(obj, {\n      useAlias: true,\n      additionalProperties: this._additionalProperties === \"accept\",\n      ...options\n    });\n  }\n}\n","import {isSerializable, Type} from \"@tsed/core\";\nimport {BaseContext, Constant, Inject, Injectable, InjectorService} from \"@tsed/di\";\nimport {renderView} from \"@tsed/platform-views\";\nimport {ResponseFilterKey, ResponseFiltersContainer} from \"../domain/ResponseFiltersContainer\";\nimport {ResponseFilterMethods} from \"../interfaces/ResponseFilterMethods\";\nimport {ANY_CONTENT_TYPE, getContentType} from \"../utils/getContentType\";\nimport {ConverterService} from \"./ConverterService\";\n\n/**\n * @platform\n */\n@Injectable()\nexport class PlatformResponseFilter {\n  types: Map<ResponseFilterKey, ResponseFilterMethods> = new Map();\n\n  @Inject()\n  injector: InjectorService;\n\n  @Constant(\"responseFilters\", [])\n  protected responseFilters: Type<ResponseFilterMethods>[];\n\n  get contentTypes(): ResponseFilterKey[] {\n    return [...this.types.keys()];\n  }\n\n  $onInit() {\n    ResponseFiltersContainer.forEach((token, type) => {\n      if (this.responseFilters.includes(token)) {\n        this.types.set(type, this.injector.get(token)!);\n      }\n    });\n  }\n\n  getBestContentType(data: any, ctx: BaseContext) {\n    const contentType = getContentType(data, ctx);\n\n    if (ctx.request.get(\"Accept\")) {\n      const bestContentType = ctx.request.accepts([contentType].concat(this.contentTypes).filter(Boolean));\n\n      if (bestContentType) {\n        return [].concat(bestContentType as any).filter((type) => type !== \"*/*\")[0];\n      }\n    }\n\n    return contentType;\n  }\n  /**\n   * Call filters to transform data\n   * @param data\n   * @param ctx\n   */\n  async transform(data: unknown, ctx: BaseContext) {\n    const {response} = ctx;\n    const bestContentType = this.getBestContentType(data, ctx);\n\n    bestContentType && response.contentType(bestContentType);\n\n    if (this.types.has(bestContentType)) {\n      return this.types.get(bestContentType)!.transform(data, ctx);\n    }\n\n    if (this.types.has(ANY_CONTENT_TYPE)) {\n      return this.types.get(ANY_CONTENT_TYPE)!.transform(data, ctx);\n    }\n\n    return data;\n  }\n  /**\n   * Serialize data before calling filters\n   * @param data\n   * @param ctx\n   */\n  async serialize(data: unknown, ctx: BaseContext) {\n    const {response, endpoint} = ctx;\n\n    if (endpoint) {\n      if (endpoint.view) {\n        data = await renderView(data, ctx);\n      } else if (isSerializable(data)) {\n        data = this.injector.get<ConverterService>(ConverterService)!.serialize(data, {\n          ...endpoint.getResponseOptions(response.statusCode),\n          endpoint: true\n        });\n      }\n    }\n\n    return data;\n  }\n}\n"],"names":["ResponseFiltersContainer","Map","registerResponseFilter","type","token","set","ResponseFilter","contentTypes","target","forEach","contentType","registerProvider","provide","useClass","ANY_CONTENT_TYPE","getContentType","data","ctx","endpoint","response","operation","getContentTypeOf","statusCode","isObject","view","ConverterService","constructor","injectorService","configuration","_additionalProperties","get","serialize","obj","options","useAlias","additionalProperties","deserialize","Injectable","__param","Configuration","InjectorService","PlatformResponseFilter","types","keys","$onInit","responseFilters","includes","injector","getBestContentType","request","bestContentType","accepts","concat","filter","Boolean","transform","has","renderView","isSerializable","getResponseOptions","__decorate","Inject","Constant"],"mappings":";;;;;;AAMA;;;AAGA;MACaA,wBAAwB,GAAG,IAAIC,GAAJ;AACxC;;;;SAGgBC,uBAAuBC,MAAyBC;AAC9DJ,EAAAA,wBAAwB,CAACK,GAAzB,CAA6BF,IAA7B,EAAmCC,KAAnC;AACD;;ACZD;;;;;;SAKgBE,eAAe,GAAGC;AAChC,SAAiBC,MAAV;AACLD,IAAAA,YAAY,CAACE,OAAb,CAAsBC,WAAD;AACnBR,MAAAA,sBAAsB,CAACQ,WAAD,EAAcF,MAAd,CAAtB;AACD,KAFD;AAGAG,IAAAA,gBAAgB,CAAC;AACfC,MAAAA,OAAO,EAAEJ,MADM;AAEfK,MAAAA,QAAQ,EAAGL;AAFI,KAAD,CAAhB;AAID,GARD;AASD;;;;;;;;;;;;;;;;;;;;MCjBYM,gBAAgB,GAAG;AAChC;;;;SAGgBC,eAAeC,MAAWC;AACxC,QAAM;AAACC,IAAAA,QAAD;AAAWC,IAAAA;AAAX,MAAuBF,GAA7B;AACA,QAAM;AAACG,IAAAA;AAAD,MAAcF,QAApB;AAEA,QAAMR,WAAW,GAAGS,QAAQ,CAACJ,cAAT,MAA6BK,SAAS,CAACC,gBAAV,CAA2BF,QAAQ,CAACG,UAApC,CAA7B,IAAgF,EAApG;;AAEA,MAAIZ,WAAW,IAAIA,WAAW,KAAKI,gBAAnC,EAAqD;AACnD,QAAIJ,WAAW,KAAK,kBAApB,EAAwC;AACtC,UAAIa,QAAQ,CAACP,IAAD,CAAZ,EAAoB;AAClB,eAAON,WAAP;AACD;AACF,KAJD,MAIO;AACL,aAAOA,WAAP;AACD;AACF;;AAED,MAAI,OAAOM,IAAP,KAAgB,QAAhB,IAA4BE,QAAQ,CAACM,IAAzC,EAA+C;AAC7C,WAAO,WAAP;AACD;AACF;;ACtBD;;;;IAIaC,gBAAgB,GAA7B,MAAaA,gBAAb;AAGEC,EAAAA,YAAoBC,iBAAmDC;AAAnD,wBAAA,GAAAD,eAAA;AAClB,SAAKE,qBAAL,GAA6BD,aAAa,CAACE,GAAd,CAA0B,gCAA1B,CAA7B;AACD;AAED;;;;;;;;AAMAC,EAAAA,SAAS,CAACC,GAAD,EAAWC,UAAiC,EAA5C;AACP,WAAOF,SAAS,CAACC,GAAD;AACdE,MAAAA,QAAQ,EAAE,IADI;AAEdC,MAAAA,oBAAoB,EAAE,KAAKN,qBAAL,KAA+B;AAFvC,OAGXI,OAHW,EAAhB;AAKD;AAED;;;;;;;;;;;;;;AAYAG,EAAAA,WAAW,CAACJ,GAAD,EAAWC,UAAmC,EAA9C;AACT,WAAOG,WAAW,CAACJ,GAAD;AAChBE,MAAAA,QAAQ,EAAE,IADM;AAEhBC,MAAAA,oBAAoB,EAAE,KAAKN,qBAAL,KAA+B;AAFrC,OAGbI,OAHa,EAAlB;AAKD;;;AAvCUR,gBAAgB,eAD5BY,UAAU,IAI8CC,WAAAC,aAAa,sCAA/BC,4BAH1Bf,iBAAA;;ACCb;;;;IAIagB,sBAAsB,GAAnC,MAAaA,sBAAb;AAAAf,EAAAA;AACE,cAAA,GAAuD,IAAIzB,GAAJ,EAAvD;AA2ED;;AAnEiB,MAAZM,YAAY;AACd,WAAO,CAAC,GAAG,KAAKmC,KAAL,CAAWC,IAAX,EAAJ,CAAP;AACD;;AAEDC,EAAAA,OAAO;AACL5C,IAAAA,wBAAwB,CAACS,OAAzB,CAAiC,CAACL,KAAD,EAAQD,IAAR;AAC/B,UAAI,KAAK0C,eAAL,CAAqBC,QAArB,CAA8B1C,KAA9B,CAAJ,EAA0C;AACxC,aAAKsC,KAAL,CAAWrC,GAAX,CAAeF,IAAf,EAAqB,KAAK4C,QAAL,CAAcjB,GAAd,CAAkB1B,KAAlB,CAArB;AACD;AACF,KAJD;AAKD;;AAED4C,EAAAA,kBAAkB,CAAChC,IAAD,EAAYC,GAAZ;AAChB,UAAMP,WAAW,GAAGK,cAAc,CAACC,IAAD,EAAOC,GAAP,CAAlC;;AAEA,QAAIA,GAAG,CAACgC,OAAJ,CAAYnB,GAAZ,CAAgB,QAAhB,CAAJ,EAA+B;AAC7B,YAAMoB,eAAe,GAAGjC,GAAG,CAACgC,OAAJ,CAAYE,OAAZ,CAAoB,CAACzC,WAAD,EAAc0C,MAAd,CAAqB,KAAK7C,YAA1B,EAAwC8C,MAAxC,CAA+CC,OAA/C,CAApB,CAAxB;;AAEA,UAAIJ,eAAJ,EAAqB;AACnB,eAAO,GAAGE,MAAH,CAAUF,eAAV,EAAkCG,MAAlC,CAA0ClD,IAAD,IAAUA,IAAI,KAAK,KAA5D,EAAmE,CAAnE,CAAP;AACD;AACF;;AAED,WAAOO,WAAP;AACD;AACD;;;;;;;AAKe,QAAT6C,SAAS,CAACvC,IAAD,EAAgBC,GAAhB;AACb,UAAM;AAACE,MAAAA;AAAD,QAAaF,GAAnB;AACA,UAAMiC,eAAe,GAAG,KAAKF,kBAAL,CAAwBhC,IAAxB,EAA8BC,GAA9B,CAAxB;AAEAiC,IAAAA,eAAe,IAAI/B,QAAQ,CAACT,WAAT,CAAqBwC,eAArB,CAAnB;;AAEA,QAAI,KAAKR,KAAL,CAAWc,GAAX,CAAeN,eAAf,CAAJ,EAAqC;AACnC,aAAO,KAAKR,KAAL,CAAWZ,GAAX,CAAeoB,eAAf,EAAiCK,SAAjC,CAA2CvC,IAA3C,EAAiDC,GAAjD,CAAP;AACD;;AAED,QAAI,KAAKyB,KAAL,CAAWc,GAAX,CAAe1C,gBAAf,CAAJ,EAAsC;AACpC,aAAO,KAAK4B,KAAL,CAAWZ,GAAX,CAAehB,gBAAf,EAAkCyC,SAAlC,CAA4CvC,IAA5C,EAAkDC,GAAlD,CAAP;AACD;;AAED,WAAOD,IAAP;AACD;AACD;;;;;;;AAKe,QAATe,SAAS,CAACf,IAAD,EAAgBC,GAAhB;AACb,UAAM;AAACE,MAAAA,QAAD;AAAWD,MAAAA;AAAX,QAAuBD,GAA7B;;AAEA,QAAIC,QAAJ,EAAc;AACZ,UAAIA,QAAQ,CAACM,IAAb,EAAmB;AACjBR,QAAAA,IAAI,GAAG,MAAMyC,UAAU,CAACzC,IAAD,EAAOC,GAAP,CAAvB;AACD,OAFD,MAEO,IAAIyC,cAAc,CAAC1C,IAAD,CAAlB,EAA0B;AAC/BA,QAAAA,IAAI,GAAG,KAAK+B,QAAL,CAAcjB,GAAd,CAAoCL,gBAApC,EAAuDM,SAAvD,CAAiEf,IAAjE,eACFE,QAAQ,CAACyC,kBAAT,CAA4BxC,QAAQ,CAACG,UAArC,CADE;AAELJ,UAAAA,QAAQ,EAAE;AAFL,WAAP;AAID;AACF;;AAED,WAAOF,IAAP;AACD;;;;AAvED4C,YADCC,MAAM,8BACGrB,wEAAV;;AAGAoB,YADCE,QAAQ,CAAC,iBAAD,EAAoB,EAApB,kGACT;;AAPWrB,sBAAsB,eADlCJ,UAAU,KACEI,uBAAA;;;;"}