????
Your IP : 3.16.139.36
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ColumnMetadata = void 0;
const OrmUtils_1 = require("../util/OrmUtils");
const ApplyValueTransformers_1 = require("../util/ApplyValueTransformers");
const ObjectUtils_1 = require("../util/ObjectUtils");
const InstanceChecker_1 = require("../util/InstanceChecker");
/**
* This metadata contains all information about entity's column.
*/
class ColumnMetadata {
// ---------------------------------------------------------------------
// Constructor
// ---------------------------------------------------------------------
constructor(options) {
this["@instanceof"] = Symbol.for("ColumnMetadata");
/**
* Type's length in the database.
*/
this.length = "";
/**
* Indicates if this column is a primary key.
*/
this.isPrimary = false;
/**
* Indicates if this column is generated (auto increment or generated other way).
*/
this.isGenerated = false;
/**
* Indicates if column can contain nulls or not.
*/
this.isNullable = false;
/**
* Indicates if column is selected by query builder or not.
*/
this.isSelect = true;
/**
* Indicates if column is inserted by default or not.
*/
this.isInsert = true;
/**
* Indicates if column allows updates or not.
*/
this.isUpdate = true;
/**
* Puts ZEROFILL attribute on to numeric column. Works only for MySQL.
* If you specify ZEROFILL for a numeric column, MySQL automatically adds the UNSIGNED attribute to the column
*/
this.zerofill = false;
/**
* Puts UNSIGNED attribute on to numeric column. Works only for MySQL.
*/
this.unsigned = false;
/**
* Indicates if this column is an array.
*/
this.isArray = false;
/**
* Indicates if column is virtual. Virtual columns are not mapped to the entity.
*/
this.isVirtual = false;
/**
* Indicates if column is a virtual property. Virtual properties are not mapped to the entity.
* This property is used in tandem the virtual column decorator.
* @See https://typeorm.io/decorator-reference#virtualcolumn for more details.
*/
this.isVirtualProperty = false;
/**
* Indicates if column is discriminator. Discriminator columns are not mapped to the entity.
*/
this.isDiscriminator = false;
/**
* Indicates if column is tree-level column. Tree-level columns are used in closure entities.
*/
this.isTreeLevel = false;
/**
* Indicates if this column contains an entity creation date.
*/
this.isCreateDate = false;
/**
* Indicates if this column contains an entity update date.
*/
this.isUpdateDate = false;
/**
* Indicates if this column contains an entity delete date.
*/
this.isDeleteDate = false;
/**
* Indicates if this column contains an entity version.
*/
this.isVersion = false;
/**
* Indicates if this column contains an object id.
*/
this.isObjectId = false;
/**
* Indicates if this column is nested set's left column.
* Used only in tree entities with nested-set type.
*/
this.isNestedSetLeft = false;
/**
* Indicates if this column is nested set's right column.
* Used only in tree entities with nested-set type.
*/
this.isNestedSetRight = false;
/**
* Indicates if this column is materialized path's path column.
* Used only in tree entities with materialized path type.
*/
this.isMaterializedPath = false;
this.entityMetadata = options.entityMetadata;
this.embeddedMetadata = options.embeddedMetadata;
this.referencedColumn = options.referencedColumn;
if (options.args.target)
this.target = options.args.target;
if (options.args.propertyName)
this.propertyName = options.args.propertyName;
if (options.args.options.name)
this.givenDatabaseName = options.args.options.name;
if (options.args.options.type)
this.type = options.args.options.type;
if (options.args.options.length)
this.length = options.args.options.length
? options.args.options.length.toString()
: "";
if (options.args.options.width)
this.width = options.args.options.width;
if (options.args.options.charset)
this.charset = options.args.options.charset;
if (options.args.options.collation)
this.collation = options.args.options.collation;
if (options.args.options.primary)
this.isPrimary = options.args.options.primary;
if (options.args.options.default === null)
// to make sure default: null is the same as nullable: true
this.isNullable = true;
if (options.args.options.nullable !== undefined)
this.isNullable = options.args.options.nullable;
if (options.args.options.select !== undefined)
this.isSelect = options.args.options.select;
if (options.args.options.insert !== undefined)
this.isInsert = options.args.options.insert;
if (options.args.options.update !== undefined)
this.isUpdate = options.args.options.update;
if (options.args.options.readonly !== undefined)
this.isUpdate = !options.args.options.readonly;
if (options.args.options.comment)
this.comment = options.args.options.comment;
if (options.args.options.default !== undefined)
this.default = options.args.options.default;
if (options.args.options.onUpdate)
this.onUpdate = options.args.options.onUpdate;
if (options.args.options.generatedIdentity)
this.generatedIdentity = options.args.options.generatedIdentity;
if (options.args.options.scale !== null &&
options.args.options.scale !== undefined)
this.scale = options.args.options.scale;
if (options.args.options.zerofill) {
this.zerofill = options.args.options.zerofill;
this.unsigned = true; // if you specify ZEROFILL for a numeric column, MySQL automatically adds the UNSIGNED attribute to the column
}
if (options.args.options.unsigned)
this.unsigned = options.args.options.unsigned;
if (options.args.options.precision !== null)
this.precision = options.args.options.precision;
if (options.args.options.enum) {
if (ObjectUtils_1.ObjectUtils.isObject(options.args.options.enum) &&
!Array.isArray(options.args.options.enum)) {
this.enum = Object.keys(options.args.options.enum)
// remove numeric keys - typescript numeric enum types generate them
// From the documentation: “declaration merging” means that the compiler merges two separate declarations
// declared with the same name into a single definition. This concept is often used to merge enum with namespace
// where in namespace we define e.g. utility methods for creating enum. This is well known in other languages
// like Java (enum methods). Here in case if enum have function, we need to remove it from metadata, otherwise
// generated SQL statements contains string representation of that function which leads into syntax error
// at database side.
.filter((key) => isNaN(+key) &&
typeof options.args.options.enum[key] !== "function")
.map((key) => options.args.options.enum[key]);
}
else {
this.enum = options.args.options.enum;
}
}
if (options.args.options.enumName) {
this.enumName = options.args.options.enumName;
}
if (options.args.options.primaryKeyConstraintName) {
this.primaryKeyConstraintName =
options.args.options.primaryKeyConstraintName;
}
if (options.args.options.foreignKeyConstraintName) {
this.foreignKeyConstraintName =
options.args.options.foreignKeyConstraintName;
}
if (options.args.options.asExpression) {
this.asExpression = options.args.options.asExpression;
this.generatedType = options.args.options.generatedType
? options.args.options.generatedType
: "VIRTUAL";
}
if (options.args.options.hstoreType)
this.hstoreType = options.args.options.hstoreType;
if (options.args.options.array)
this.isArray = options.args.options.array;
if (options.args.mode) {
this.isVirtualProperty = options.args.mode === "virtual-property";
this.isVirtual = options.args.mode === "virtual";
this.isTreeLevel = options.args.mode === "treeLevel";
this.isCreateDate = options.args.mode === "createDate";
this.isUpdateDate = options.args.mode === "updateDate";
this.isDeleteDate = options.args.mode === "deleteDate";
this.isVersion = options.args.mode === "version";
this.isObjectId = options.args.mode === "objectId";
}
if (this.isVirtualProperty) {
this.isInsert = false;
this.isUpdate = false;
}
if (options.args.options.transformer)
this.transformer = options.args.options.transformer;
if (options.args.options.spatialFeatureType)
this.spatialFeatureType = options.args.options.spatialFeatureType;
if (options.args.options.srid !== undefined)
this.srid = options.args.options.srid;
if (options.args.options.query)
this.query = options.args.options.query;
if (this.isTreeLevel)
this.type = options.connection.driver.mappedDataTypes.treeLevel;
if (this.isCreateDate) {
if (!this.type)
this.type = options.connection.driver.mappedDataTypes.createDate;
if (!this.default)
this.default = () => options.connection.driver.mappedDataTypes.createDateDefault;
// skip precision if it was explicitly set to "null" in column options. Otherwise use default precision if it exist.
if (this.precision === undefined &&
options.args.options.precision === undefined &&
options.connection.driver.mappedDataTypes.createDatePrecision)
this.precision =
options.connection.driver.mappedDataTypes.createDatePrecision;
}
if (this.isUpdateDate) {
if (!this.type)
this.type = options.connection.driver.mappedDataTypes.updateDate;
if (!this.default)
this.default = () => options.connection.driver.mappedDataTypes.updateDateDefault;
if (!this.onUpdate)
this.onUpdate =
options.connection.driver.mappedDataTypes.updateDateDefault;
// skip precision if it was explicitly set to "null" in column options. Otherwise use default precision if it exist.
if (this.precision === undefined &&
options.args.options.precision === undefined &&
options.connection.driver.mappedDataTypes.updateDatePrecision)
this.precision =
options.connection.driver.mappedDataTypes.updateDatePrecision;
}
if (this.isDeleteDate) {
if (!this.type)
this.type = options.connection.driver.mappedDataTypes.deleteDate;
if (!this.isNullable)
this.isNullable =
options.connection.driver.mappedDataTypes.deleteDateNullable;
// skip precision if it was explicitly set to "null" in column options. Otherwise use default precision if it exist.
if (this.precision === undefined &&
options.args.options.precision === undefined &&
options.connection.driver.mappedDataTypes.deleteDatePrecision)
this.precision =
options.connection.driver.mappedDataTypes.deleteDatePrecision;
}
if (this.isVersion)
this.type = options.connection.driver.mappedDataTypes.version;
if (options.closureType)
this.closureType = options.closureType;
if (options.nestedSetLeft)
this.isNestedSetLeft = options.nestedSetLeft;
if (options.nestedSetRight)
this.isNestedSetRight = options.nestedSetRight;
if (options.materializedPath)
this.isMaterializedPath = options.materializedPath;
}
// ---------------------------------------------------------------------
// Public Methods
// ---------------------------------------------------------------------
/**
* Creates entity id map from the given entity ids array.
*/
createValueMap(value, useDatabaseName = false) {
// extract column value from embeds of entity if column is in embedded
if (this.embeddedMetadata) {
// example: post[data][information][counters].id where "data", "information" and "counters" are embeddeds
// we need to get value of "id" column from the post real entity object and return it in a
// { data: { information: { counters: { id: ... } } } } format
// first step - we extract all parent properties of the entity relative to this column, e.g. [data, information, counters]
const propertyNames = [...this.embeddedMetadata.parentPropertyNames];
// now need to access post[data][information][counters] to get column value from the counters
// and on each step we need to create complex literal object, e.g. first { data },
// then { data: { information } }, then { data: { information: { counters } } },
// then { data: { information: { counters: [this.propertyName]: entity[data][information][counters][this.propertyName] } } }
// this recursive function helps doing that
const extractEmbeddedColumnValue = (propertyNames, map) => {
const propertyName = propertyNames.shift();
if (propertyName) {
map[propertyName] = {};
extractEmbeddedColumnValue(propertyNames, map[propertyName]);
return map;
}
// this is bugfix for #720 when increment number is bigint we need to make sure its a string
if ((this.generationStrategy === "increment" ||
this.generationStrategy === "rowid") &&
this.type === "bigint" &&
value !== null)
value = String(value);
map[useDatabaseName ? this.databaseName : this.propertyName] =
value;
return map;
};
return extractEmbeddedColumnValue(propertyNames, {});
}
else {
// no embeds - no problems. Simply return column property name and its value of the entity
// this is bugfix for #720 when increment number is bigint we need to make sure its a string
if ((this.generationStrategy === "increment" ||
this.generationStrategy === "rowid") &&
this.type === "bigint" &&
value !== null)
value = String(value);
return {
[useDatabaseName ? this.databaseName : this.propertyName]: value,
};
}
}
/**
* Extracts column value and returns its column name with this value in a literal object.
* If column is in embedded (or recursive embedded) it returns complex literal object.
*
* Examples what this method can return depend if this column is in embeds.
* { id: 1 } or { title: "hello" }, { counters: { code: 1 } }, { data: { information: { counters: { code: 1 } } } }
*/
getEntityValueMap(entity, options) {
const returnNulls = false; // options && options.skipNulls === false ? false : true; // todo: remove if current will not bring problems, uncomment if it will.
// extract column value from embeds of entity if column is in embedded
if (this.embeddedMetadata) {
// example: post[data][information][counters].id where "data", "information" and "counters" are embeddeds
// we need to get value of "id" column from the post real entity object and return it in a
// { data: { information: { counters: { id: ... } } } } format
// first step - we extract all parent properties of the entity relative to this column, e.g. [data, information, counters]
const propertyNames = [...this.embeddedMetadata.parentPropertyNames];
const isEmbeddedArray = this.embeddedMetadata.isArray;
// now need to access post[data][information][counters] to get column value from the counters
// and on each step we need to create complex literal object, e.g. first { data },
// then { data: { information } }, then { data: { information: { counters } } },
// then { data: { information: { counters: [this.propertyName]: entity[data][information][counters][this.propertyName] } } }
// this recursive function helps doing that
const extractEmbeddedColumnValue = (propertyNames, value) => {
if (value === undefined) {
return {};
}
const propertyName = propertyNames.shift();
if (propertyName) {
const submap = extractEmbeddedColumnValue(propertyNames, value[propertyName]);
if (Object.keys(submap).length > 0) {
return { [propertyName]: submap };
}
return {};
}
if (isEmbeddedArray && Array.isArray(value)) {
return value.map((v) => ({
[this.propertyName]: v[this.propertyName],
}));
}
if (value[this.propertyName] !== undefined &&
(returnNulls === false || value[this.propertyName] !== null)) {
return { [this.propertyName]: value[this.propertyName] };
}
return {};
};
const map = extractEmbeddedColumnValue(propertyNames, entity);
return Object.keys(map).length > 0 ? map : undefined;
}
else {
// no embeds - no problems. Simply return column property name and its value of the entity
/**
* Object.getOwnPropertyDescriptor checks if the relation is lazy, in which case value is a Promise
* DO NOT use `entity[
this.relationMetadata.propertyName] instanceof Promise`, which will invoke property getter and make unwanted DB request
* refer: https://github.com/typeorm/typeorm/pull/8676#issuecomment-1049906331
*/
if (this.relationMetadata &&
!Object.getOwnPropertyDescriptor(entity, this.relationMetadata.propertyName)?.get &&
entity[this.relationMetadata.propertyName] &&
ObjectUtils_1.ObjectUtils.isObject(entity[this.relationMetadata.propertyName])) {
const map = this.relationMetadata.joinColumns.reduce((map, joinColumn) => {
const value = joinColumn.referencedColumn.getEntityValueMap(entity[this.relationMetadata.propertyName]);
if (value === undefined)
return map;
return OrmUtils_1.OrmUtils.mergeDeep(map, value);
}, {});
if (Object.keys(map).length > 0)
return { [this.propertyName]: map };
return undefined;
}
else {
if (entity[this.propertyName] !== undefined &&
(returnNulls === false ||
entity[this.propertyName] !== null))
return { [this.propertyName]: entity[this.propertyName] };
return undefined;
}
}
}
/**
* Extracts column value from the given entity.
* If column is in embedded (or recursive embedded) it extracts its value from there.
*/
getEntityValue(entity, transform = false) {
if (entity === undefined || entity === null)
return undefined;
// extract column value from embeddeds of entity if column is in embedded
let value = undefined;
if (this.embeddedMetadata) {
// example: post[data][information][counters].id where "data", "information" and "counters" are embeddeds
// we need to get value of "id" column from the post real entity object
// first step - we extract all parent properties of the entity relative to this column, e.g. [data, information, counters]
const propertyNames = [...this.embeddedMetadata.parentPropertyNames];
const isEmbeddedArray = this.embeddedMetadata.isArray;
// next we need to access post[data][information][counters][this.propertyName] to get column value from the counters
// this recursive function takes array of generated property names and gets the post[data][information][counters] embed
const extractEmbeddedColumnValue = (propertyNames, value) => {
const propertyName = propertyNames.shift();
return propertyName && value
? extractEmbeddedColumnValue(propertyNames, value[propertyName])
: value;
};
// once we get nested embed object we get its column, e.g. post[data][information][counters][this.propertyName]
const embeddedObject = extractEmbeddedColumnValue(propertyNames, entity);
if (embeddedObject) {
if (this.relationMetadata && this.referencedColumn) {
const relatedEntity = this.relationMetadata.getEntityValue(embeddedObject);
if (relatedEntity &&
ObjectUtils_1.ObjectUtils.isObject(relatedEntity) &&
!InstanceChecker_1.InstanceChecker.isFindOperator(relatedEntity) &&
!Buffer.isBuffer(relatedEntity)) {
value =
this.referencedColumn.getEntityValue(relatedEntity);
}
else if (embeddedObject[this.propertyName] &&
ObjectUtils_1.ObjectUtils.isObject(embeddedObject[this.propertyName]) &&
!InstanceChecker_1.InstanceChecker.isFindOperator(embeddedObject[this.propertyName]) &&
!Buffer.isBuffer(embeddedObject[this.propertyName]) &&
!(embeddedObject[this.propertyName] instanceof Date)) {
value = this.referencedColumn.getEntityValue(embeddedObject[this.propertyName]);
}
else {
value = embeddedObject[this.propertyName];
}
}
else if (this.referencedColumn) {
value = this.referencedColumn.getEntityValue(embeddedObject[this.propertyName]);
}
else if (isEmbeddedArray && Array.isArray(embeddedObject)) {
value = embeddedObject.map((o) => o[this.propertyName]);
}
else {
value = embeddedObject[this.propertyName];
}
}
}
else {
// no embeds - no problems. Simply return column name by property name of the entity
if (this.relationMetadata && this.referencedColumn) {
const relatedEntity = this.relationMetadata.getEntityValue(entity);
if (relatedEntity &&
ObjectUtils_1.ObjectUtils.isObject(relatedEntity) &&
!InstanceChecker_1.InstanceChecker.isFindOperator(relatedEntity) &&
!(typeof relatedEntity === "function") &&
!Buffer.isBuffer(relatedEntity)) {
value = this.referencedColumn.getEntityValue(relatedEntity);
}
else if (entity[this.propertyName] &&
ObjectUtils_1.ObjectUtils.isObject(entity[this.propertyName]) &&
!InstanceChecker_1.InstanceChecker.isFindOperator(entity[this.propertyName]) &&
!(typeof entity[this.propertyName] === "function") &&
!Buffer.isBuffer(entity[this.propertyName]) &&
!(entity[this.propertyName] instanceof Date)) {
value = this.referencedColumn.getEntityValue(entity[this.propertyName]);
}
else {
value = entity[this.propertyName];
}
}
else if (this.referencedColumn) {
value = this.referencedColumn.getEntityValue(entity[this.propertyName]);
}
else {
value = entity[this.propertyName];
}
}
if (transform && this.transformer)
value = ApplyValueTransformers_1.ApplyValueTransformers.transformTo(this.transformer, value);
return value;
}
/**
* Sets given entity's column value.
* Using of this method helps to set entity relation's value of the lazy and non-lazy relations.
*/
setEntityValue(entity, value) {
if (this.embeddedMetadata) {
// first step - we extract all parent properties of the entity relative to this column, e.g. [data, information, counters]
const extractEmbeddedColumnValue = (embeddedMetadatas, map) => {
// if (!object[embeddedMetadata.propertyName])
// object[embeddedMetadata.propertyName] = embeddedMetadata.create();
const embeddedMetadata = embeddedMetadatas.shift();
if (embeddedMetadata) {
if (!map[embeddedMetadata.propertyName])
map[embeddedMetadata.propertyName] =
embeddedMetadata.create();
extractEmbeddedColumnValue(embeddedMetadatas, map[embeddedMetadata.propertyName]);
return map;
}
map[this.propertyName] = value;
return map;
};
return extractEmbeddedColumnValue([...this.embeddedMetadata.embeddedMetadataTree], entity);
}
else {
// we write a deep object in this entity only if the column is virtual
// because if its not virtual it means the user defined a real column for this relation
// also we don't do it if column is inside a junction table
if (!this.entityMetadata.isJunction &&
this.isVirtual &&
this.referencedColumn &&
this.referencedColumn.propertyName !== this.propertyName) {
if (!(this.propertyName in entity)) {
entity[this.propertyName] = {};
}
entity[this.propertyName][this.referencedColumn.propertyName] =
value;
}
else {
entity[this.propertyName] = value;
}
}
}
/**
* Compares given entity's column value with a given value.
*/
compareEntityValue(entity, valueToCompareWith) {
const columnValue = this.getEntityValue(entity);
if (ObjectUtils_1.ObjectUtils.isObject(columnValue)) {
return columnValue.equals(valueToCompareWith);
}
return columnValue === valueToCompareWith;
}
// ---------------------------------------------------------------------
// Builder Methods
// ---------------------------------------------------------------------
build(connection) {
this.propertyPath = this.buildPropertyPath();
this.propertyAliasName = this.propertyPath.replace(".", "_");
this.databaseName = this.buildDatabaseName(connection);
this.databasePath = this.buildDatabasePath();
this.databaseNameWithoutPrefixes = connection.namingStrategy.columnName(this.propertyName, this.givenDatabaseName, []);
return this;
}
buildPropertyPath() {
let path = "";
if (this.embeddedMetadata &&
this.embeddedMetadata.parentPropertyNames.length)
path = this.embeddedMetadata.parentPropertyNames.join(".") + ".";
path += this.propertyName;
// we add reference column to property path only if this column is virtual
// because if its not virtual it means user defined a real column for this relation
// also we don't do it if column is inside a junction table
if (!this.entityMetadata.isJunction &&
this.isVirtual &&
this.referencedColumn &&
this.referencedColumn.propertyName !== this.propertyName)
path += "." + this.referencedColumn.propertyName;
return path;
}
buildDatabasePath() {
let path = "";
if (this.embeddedMetadata &&
this.embeddedMetadata.parentPropertyNames.length)
path = this.embeddedMetadata.parentPropertyNames.join(".") + ".";
path += this.databaseName;
// we add reference column to property path only if this column is virtual
// because if its not virtual it means user defined a real column for this relation
// also we don't do it if column is inside a junction table
if (!this.entityMetadata.isJunction &&
this.isVirtual &&
this.referencedColumn &&
this.referencedColumn.databaseName !== this.databaseName)
path += "." + this.referencedColumn.databaseName;
return path;
}
buildDatabaseName(connection) {
let propertyNames = this.embeddedMetadata
? this.embeddedMetadata.parentPrefixes
: [];
if (connection.driver.options.type === "mongodb")
// we don't need to include embedded name for the mongodb column names
propertyNames = [];
return connection.namingStrategy.columnName(this.propertyName, this.givenDatabaseName, propertyNames);
}
}
exports.ColumnMetadata = ColumnMetadata;
//# sourceMappingURL=ColumnMetadata.js.map