123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499 |
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
- if (ar || !(i in from)) {
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
- ar[i] = from[i];
- }
- }
- return to.concat(ar || Array.prototype.slice.call(from));
- };
- import { defaultMetadataStorage } from './storage';
- import { TransformationType } from './enums';
- import { getGlobal, isPromise } from './utils';
- function instantiateArrayType(arrayType) {
- var array = new arrayType();
- if (!(array instanceof Set) && !('push' in array)) {
- return [];
- }
- return array;
- }
- var TransformOperationExecutor = /** @class */ (function () {
- // -------------------------------------------------------------------------
- // Constructor
- // -------------------------------------------------------------------------
- function TransformOperationExecutor(transformationType, options) {
- this.transformationType = transformationType;
- this.options = options;
- // -------------------------------------------------------------------------
- // Private Properties
- // -------------------------------------------------------------------------
- this.recursionStack = new Set();
- }
- // -------------------------------------------------------------------------
- // Public Methods
- // -------------------------------------------------------------------------
- TransformOperationExecutor.prototype.transform = function (source, value, targetType, arrayType, isMap, level) {
- var _this = this;
- if (level === void 0) { level = 0; }
- if (Array.isArray(value) || value instanceof Set) {
- var newValue_1 = arrayType && this.transformationType === TransformationType.PLAIN_TO_CLASS
- ? instantiateArrayType(arrayType)
- : [];
- value.forEach(function (subValue, index) {
- var subSource = source ? source[index] : undefined;
- if (!_this.options.enableCircularCheck || !_this.isCircular(subValue)) {
- var realTargetType = void 0;
- if (typeof targetType !== 'function' &&
- targetType &&
- targetType.options &&
- targetType.options.discriminator &&
- targetType.options.discriminator.property &&
- targetType.options.discriminator.subTypes) {
- if (_this.transformationType === TransformationType.PLAIN_TO_CLASS) {
- realTargetType = targetType.options.discriminator.subTypes.find(function (subType) {
- return subType.name === subValue[targetType.options.discriminator.property];
- });
- var options = { newObject: newValue_1, object: subValue, property: undefined };
- var newType = targetType.typeFunction(options);
- realTargetType === undefined ? (realTargetType = newType) : (realTargetType = realTargetType.value);
- if (!targetType.options.keepDiscriminatorProperty)
- delete subValue[targetType.options.discriminator.property];
- }
- if (_this.transformationType === TransformationType.CLASS_TO_CLASS) {
- realTargetType = subValue.constructor;
- }
- if (_this.transformationType === TransformationType.CLASS_TO_PLAIN) {
- subValue[targetType.options.discriminator.property] = targetType.options.discriminator.subTypes.find(function (subType) { return subType.value === subValue.constructor; }).name;
- }
- }
- else {
- realTargetType = targetType;
- }
- var value_1 = _this.transform(subSource, subValue, realTargetType, undefined, subValue instanceof Map, level + 1);
- if (newValue_1 instanceof Set) {
- newValue_1.add(value_1);
- }
- else {
- newValue_1.push(value_1);
- }
- }
- else if (_this.transformationType === TransformationType.CLASS_TO_CLASS) {
- if (newValue_1 instanceof Set) {
- newValue_1.add(subValue);
- }
- else {
- newValue_1.push(subValue);
- }
- }
- });
- return newValue_1;
- }
- else if (targetType === String && !isMap) {
- if (value === null || value === undefined)
- return value;
- return String(value);
- }
- else if (targetType === Number && !isMap) {
- if (value === null || value === undefined)
- return value;
- return Number(value);
- }
- else if (targetType === Boolean && !isMap) {
- if (value === null || value === undefined)
- return value;
- return Boolean(value);
- }
- else if ((targetType === Date || value instanceof Date) && !isMap) {
- if (value instanceof Date) {
- return new Date(value.valueOf());
- }
- if (value === null || value === undefined)
- return value;
- return new Date(value);
- }
- else if (!!getGlobal().Buffer && (targetType === Buffer || value instanceof Buffer) && !isMap) {
- if (value === null || value === undefined)
- return value;
- return Buffer.from(value);
- }
- else if (isPromise(value) && !isMap) {
- return new Promise(function (resolve, reject) {
- value.then(function (data) { return resolve(_this.transform(undefined, data, targetType, undefined, undefined, level + 1)); }, reject);
- });
- }
- else if (!isMap && value !== null && typeof value === 'object' && typeof value.then === 'function') {
- // Note: We should not enter this, as promise has been handled above
- // This option simply returns the Promise preventing a JS error from happening and should be an inaccessible path.
- return value; // skip promise transformation
- }
- else if (typeof value === 'object' && value !== null) {
- // try to guess the type
- if (!targetType && value.constructor !== Object /* && TransformationType === TransformationType.CLASS_TO_PLAIN*/)
- if (!Array.isArray(value) && value.constructor === Array) {
- // Somebody attempts to convert special Array like object to Array, eg:
- // const evilObject = { '100000000': '100000000', __proto__: [] };
- // This could be used to cause Denial-of-service attack so we don't allow it.
- // See prevent-array-bomb.spec.ts for more details.
- }
- else {
- // We are good we can use the built-in constructor
- targetType = value.constructor;
- }
- if (!targetType && source)
- targetType = source.constructor;
- if (this.options.enableCircularCheck) {
- // add transformed type to prevent circular references
- this.recursionStack.add(value);
- }
- var keys = this.getKeys(targetType, value, isMap);
- var newValue = source ? source : {};
- if (!source &&
- (this.transformationType === TransformationType.PLAIN_TO_CLASS ||
- this.transformationType === TransformationType.CLASS_TO_CLASS)) {
- if (isMap) {
- newValue = new Map();
- }
- else if (targetType) {
- newValue = new targetType();
- }
- else {
- newValue = {};
- }
- }
- var _loop_1 = function (key) {
- if (key === '__proto__' || key === 'constructor') {
- return "continue";
- }
- var valueKey = key;
- var newValueKey = key, propertyName = key;
- if (!this_1.options.ignoreDecorators && targetType) {
- if (this_1.transformationType === TransformationType.PLAIN_TO_CLASS) {
- var exposeMetadata = defaultMetadataStorage.findExposeMetadataByCustomName(targetType, key);
- if (exposeMetadata) {
- propertyName = exposeMetadata.propertyName;
- newValueKey = exposeMetadata.propertyName;
- }
- }
- else if (this_1.transformationType === TransformationType.CLASS_TO_PLAIN ||
- this_1.transformationType === TransformationType.CLASS_TO_CLASS) {
- var exposeMetadata = defaultMetadataStorage.findExposeMetadata(targetType, key);
- if (exposeMetadata && exposeMetadata.options && exposeMetadata.options.name) {
- newValueKey = exposeMetadata.options.name;
- }
- }
- }
- // get a subvalue
- var subValue = undefined;
- if (this_1.transformationType === TransformationType.PLAIN_TO_CLASS) {
- /**
- * This section is added for the following report:
- * https://github.com/typestack/class-transformer/issues/596
- *
- * We should not call functions or constructors when transforming to class.
- */
- subValue = value[valueKey];
- }
- else {
- if (value instanceof Map) {
- subValue = value.get(valueKey);
- }
- else if (value[valueKey] instanceof Function) {
- subValue = value[valueKey]();
- }
- else {
- subValue = value[valueKey];
- }
- }
- // determine a type
- var type = undefined, isSubValueMap = subValue instanceof Map;
- if (targetType && isMap) {
- type = targetType;
- }
- else if (targetType) {
- var metadata_1 = defaultMetadataStorage.findTypeMetadata(targetType, propertyName);
- if (metadata_1) {
- var options = { newObject: newValue, object: value, property: propertyName };
- var newType = metadata_1.typeFunction ? metadata_1.typeFunction(options) : metadata_1.reflectedType;
- if (metadata_1.options &&
- metadata_1.options.discriminator &&
- metadata_1.options.discriminator.property &&
- metadata_1.options.discriminator.subTypes) {
- if (!(value[valueKey] instanceof Array)) {
- if (this_1.transformationType === TransformationType.PLAIN_TO_CLASS) {
- type = metadata_1.options.discriminator.subTypes.find(function (subType) {
- if (subValue && subValue instanceof Object && metadata_1.options.discriminator.property in subValue) {
- return subType.name === subValue[metadata_1.options.discriminator.property];
- }
- });
- type === undefined ? (type = newType) : (type = type.value);
- if (!metadata_1.options.keepDiscriminatorProperty) {
- if (subValue && subValue instanceof Object && metadata_1.options.discriminator.property in subValue) {
- delete subValue[metadata_1.options.discriminator.property];
- }
- }
- }
- if (this_1.transformationType === TransformationType.CLASS_TO_CLASS) {
- type = subValue.constructor;
- }
- if (this_1.transformationType === TransformationType.CLASS_TO_PLAIN) {
- if (subValue) {
- subValue[metadata_1.options.discriminator.property] = metadata_1.options.discriminator.subTypes.find(function (subType) { return subType.value === subValue.constructor; }).name;
- }
- }
- }
- else {
- type = metadata_1;
- }
- }
- else {
- type = newType;
- }
- isSubValueMap = isSubValueMap || metadata_1.reflectedType === Map;
- }
- else if (this_1.options.targetMaps) {
- // try to find a type in target maps
- this_1.options.targetMaps
- .filter(function (map) { return map.target === targetType && !!map.properties[propertyName]; })
- .forEach(function (map) { return (type = map.properties[propertyName]); });
- }
- else if (this_1.options.enableImplicitConversion &&
- this_1.transformationType === TransformationType.PLAIN_TO_CLASS) {
- // if we have no registererd type via the @Type() decorator then we check if we have any
- // type declarations in reflect-metadata (type declaration is emited only if some decorator is added to the property.)
- var reflectedType = Reflect.getMetadata('design:type', targetType.prototype, propertyName);
- if (reflectedType) {
- type = reflectedType;
- }
- }
- }
- // if value is an array try to get its custom array type
- var arrayType_1 = Array.isArray(value[valueKey])
- ? this_1.getReflectedType(targetType, propertyName)
- : undefined;
- // const subValueKey = TransformationType === TransformationType.PLAIN_TO_CLASS && newKeyName ? newKeyName : key;
- var subSource = source ? source[valueKey] : undefined;
- // if its deserialization then type if required
- // if we uncomment this types like string[] will not work
- // if (this.transformationType === TransformationType.PLAIN_TO_CLASS && !type && subValue instanceof Object && !(subValue instanceof Date))
- // throw new Error(`Cannot determine type for ${(targetType as any).name }.${propertyName}, did you forget to specify a @Type?`);
- // if newValue is a source object that has method that match newKeyName then skip it
- if (newValue.constructor.prototype) {
- var descriptor = Object.getOwnPropertyDescriptor(newValue.constructor.prototype, newValueKey);
- if ((this_1.transformationType === TransformationType.PLAIN_TO_CLASS ||
- this_1.transformationType === TransformationType.CLASS_TO_CLASS) &&
- // eslint-disable-next-line @typescript-eslint/unbound-method
- ((descriptor && !descriptor.set) || newValue[newValueKey] instanceof Function))
- return "continue";
- }
- if (!this_1.options.enableCircularCheck || !this_1.isCircular(subValue)) {
- var transformKey = this_1.transformationType === TransformationType.PLAIN_TO_CLASS ? newValueKey : key;
- var finalValue = void 0;
- if (this_1.transformationType === TransformationType.CLASS_TO_PLAIN) {
- // Get original value
- finalValue = value[transformKey];
- // Apply custom transformation
- finalValue = this_1.applyCustomTransformations(finalValue, targetType, transformKey, value, this_1.transformationType);
- // If nothing change, it means no custom transformation was applied, so use the subValue.
- finalValue = value[transformKey] === finalValue ? subValue : finalValue;
- // Apply the default transformation
- finalValue = this_1.transform(subSource, finalValue, type, arrayType_1, isSubValueMap, level + 1);
- }
- else {
- if (subValue === undefined && this_1.options.exposeDefaultValues) {
- // Set default value if nothing provided
- finalValue = newValue[newValueKey];
- }
- else {
- finalValue = this_1.transform(subSource, subValue, type, arrayType_1, isSubValueMap, level + 1);
- finalValue = this_1.applyCustomTransformations(finalValue, targetType, transformKey, value, this_1.transformationType);
- }
- }
- if (finalValue !== undefined || this_1.options.exposeUnsetFields) {
- if (newValue instanceof Map) {
- newValue.set(newValueKey, finalValue);
- }
- else {
- newValue[newValueKey] = finalValue;
- }
- }
- }
- else if (this_1.transformationType === TransformationType.CLASS_TO_CLASS) {
- var finalValue = subValue;
- finalValue = this_1.applyCustomTransformations(finalValue, targetType, key, value, this_1.transformationType);
- if (finalValue !== undefined || this_1.options.exposeUnsetFields) {
- if (newValue instanceof Map) {
- newValue.set(newValueKey, finalValue);
- }
- else {
- newValue[newValueKey] = finalValue;
- }
- }
- }
- };
- var this_1 = this;
- // traverse over keys
- for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
- var key = keys_1[_i];
- _loop_1(key);
- }
- if (this.options.enableCircularCheck) {
- this.recursionStack.delete(value);
- }
- return newValue;
- }
- else {
- return value;
- }
- };
- TransformOperationExecutor.prototype.applyCustomTransformations = function (value, target, key, obj, transformationType) {
- var _this = this;
- var metadatas = defaultMetadataStorage.findTransformMetadatas(target, key, this.transformationType);
- // apply versioning options
- if (this.options.version !== undefined) {
- metadatas = metadatas.filter(function (metadata) {
- if (!metadata.options)
- return true;
- return _this.checkVersion(metadata.options.since, metadata.options.until);
- });
- }
- // apply grouping options
- if (this.options.groups && this.options.groups.length) {
- metadatas = metadatas.filter(function (metadata) {
- if (!metadata.options)
- return true;
- return _this.checkGroups(metadata.options.groups);
- });
- }
- else {
- metadatas = metadatas.filter(function (metadata) {
- return !metadata.options || !metadata.options.groups || !metadata.options.groups.length;
- });
- }
- metadatas.forEach(function (metadata) {
- value = metadata.transformFn({ value: value, key: key, obj: obj, type: transformationType, options: _this.options });
- });
- return value;
- };
- // preventing circular references
- TransformOperationExecutor.prototype.isCircular = function (object) {
- return this.recursionStack.has(object);
- };
- TransformOperationExecutor.prototype.getReflectedType = function (target, propertyName) {
- if (!target)
- return undefined;
- var meta = defaultMetadataStorage.findTypeMetadata(target, propertyName);
- return meta ? meta.reflectedType : undefined;
- };
- TransformOperationExecutor.prototype.getKeys = function (target, object, isMap) {
- var _this = this;
- // determine exclusion strategy
- var strategy = defaultMetadataStorage.getStrategy(target);
- if (strategy === 'none')
- strategy = this.options.strategy || 'exposeAll'; // exposeAll is default strategy
- // get all keys that need to expose
- var keys = [];
- if (strategy === 'exposeAll' || isMap) {
- if (object instanceof Map) {
- keys = Array.from(object.keys());
- }
- else {
- keys = Object.keys(object);
- }
- }
- if (isMap) {
- // expose & exclude do not apply for map keys only to fields
- return keys;
- }
- /**
- * If decorators are ignored but we don't want the extraneous values, then we use the
- * metadata to decide which property is needed, but doesn't apply the decorator effect.
- */
- if (this.options.ignoreDecorators && this.options.excludeExtraneousValues && target) {
- var exposedProperties = defaultMetadataStorage.getExposedProperties(target, this.transformationType);
- var excludedProperties = defaultMetadataStorage.getExcludedProperties(target, this.transformationType);
- keys = __spreadArray(__spreadArray([], exposedProperties, true), excludedProperties, true);
- }
- if (!this.options.ignoreDecorators && target) {
- // add all exposed to list of keys
- var exposedProperties = defaultMetadataStorage.getExposedProperties(target, this.transformationType);
- if (this.transformationType === TransformationType.PLAIN_TO_CLASS) {
- exposedProperties = exposedProperties.map(function (key) {
- var exposeMetadata = defaultMetadataStorage.findExposeMetadata(target, key);
- if (exposeMetadata && exposeMetadata.options && exposeMetadata.options.name) {
- return exposeMetadata.options.name;
- }
- return key;
- });
- }
- if (this.options.excludeExtraneousValues) {
- keys = exposedProperties;
- }
- else {
- keys = keys.concat(exposedProperties);
- }
- // exclude excluded properties
- var excludedProperties_1 = defaultMetadataStorage.getExcludedProperties(target, this.transformationType);
- if (excludedProperties_1.length > 0) {
- keys = keys.filter(function (key) {
- return !excludedProperties_1.includes(key);
- });
- }
- // apply versioning options
- if (this.options.version !== undefined) {
- keys = keys.filter(function (key) {
- var exposeMetadata = defaultMetadataStorage.findExposeMetadata(target, key);
- if (!exposeMetadata || !exposeMetadata.options)
- return true;
- return _this.checkVersion(exposeMetadata.options.since, exposeMetadata.options.until);
- });
- }
- // apply grouping options
- if (this.options.groups && this.options.groups.length) {
- keys = keys.filter(function (key) {
- var exposeMetadata = defaultMetadataStorage.findExposeMetadata(target, key);
- if (!exposeMetadata || !exposeMetadata.options)
- return true;
- return _this.checkGroups(exposeMetadata.options.groups);
- });
- }
- else {
- keys = keys.filter(function (key) {
- var exposeMetadata = defaultMetadataStorage.findExposeMetadata(target, key);
- return (!exposeMetadata ||
- !exposeMetadata.options ||
- !exposeMetadata.options.groups ||
- !exposeMetadata.options.groups.length);
- });
- }
- }
- // exclude prefixed properties
- if (this.options.excludePrefixes && this.options.excludePrefixes.length) {
- keys = keys.filter(function (key) {
- return _this.options.excludePrefixes.every(function (prefix) {
- return key.substr(0, prefix.length) !== prefix;
- });
- });
- }
- // make sure we have unique keys
- keys = keys.filter(function (key, index, self) {
- return self.indexOf(key) === index;
- });
- return keys;
- };
- TransformOperationExecutor.prototype.checkVersion = function (since, until) {
- var decision = true;
- if (decision && since)
- decision = this.options.version >= since;
- if (decision && until)
- decision = this.options.version < until;
- return decision;
- };
- TransformOperationExecutor.prototype.checkGroups = function (groups) {
- if (!groups)
- return true;
- return this.options.groups.some(function (optionGroup) { return groups.includes(optionGroup); });
- };
- return TransformOperationExecutor;
- }());
- export { TransformOperationExecutor };
- //# sourceMappingURL=TransformOperationExecutor.js.map
|