typeorm 0.3.29-dev.cc07c90 → 1.0.0-beta.1

package/browser/metadata/EntityListenerMetadata.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../browser/src/metadata/EntityListenerMetadata.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,OAAO,sBAAsB;IA+B/B,wEAAwE;IACxE,cAAc;IACd,wEAAwE;IAExE,YAAY,OAIX;QACG,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAA;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAA;QAC7C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA;IACjC,CAAC;IAED,wEAAwE;IACxE,iBAAiB;IACjB,wEAAwE;IAExE;;OAEG;IACH,SAAS,CAAC,MAAqB;QAC3B,2DAA2D;QAC3D,OAAO,CACH,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,oIAAoI;YACzL,CAAC,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,UAAU;gBAC7C,MAAM,CAAC,WAAW,CAAC,SAAS;oBACxB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CACtC,CAAA,CAAC,yDAAyD;IAC/D,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAqB;QACzB,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,0BAA0B;YAC1B,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAE9C,4CAA4C;YAC5C,IAAI,CAAC,YAAY;gBACb,MAAM,IAAI,KAAK,CACX,2BAA2B,IAAI,CAAC,YAAY,+BAA+B,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CACzG,CAAA;YAEL,+CAA+C;YAC/C,IAAI,OAAO,YAAY,KAAK,UAAU;gBAClC,MAAM,IAAI,KAAK,CACX,2BAA2B,IAAI,CAAC,YAAY,gBACxC,MAAM,CAAC,WAAW,CAAC,IACvB,iCAAiC,OAAO,YAAY,IAAI,CAC3D,CAAA;YAEL,oCAAoC;YACpC,OAAO,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACpC,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,wBAAwB,CACzB,MAAM,EACN,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAChD,CAAA;IACL,CAAC;IAED,wEAAwE;IACxE,oBAAoB;IACpB,wEAAwE;IAExE;;OAEG;IACO,wBAAwB,CAC9B,MAAqB,EACrB,aAAuB;QAEvB,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,EAAE,CAAA;QAC1C,IAAI,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAAE,OAAM;QAElD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,QAAuB,EAAE,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAChC,CAAA;YACL,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAA;YAC7C,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,IAAI,MAAM,CAAC,YAAY,CAAC;gBACpB,IAAI,CAAC,wBAAwB,CACzB,MAAM,CAAC,YAAY,CAAC,EACpB,aAAa,CAChB,CAAA;QACT,CAAC;IACL,CAAC;CACJ","file":"EntityListenerMetadata.js","sourcesContent":["import { EventListenerType } from \"./types/EventListenerTypes\"\nimport { EntityListenerMetadataArgs } from \"../metadata-args/EntityListenerMetadataArgs\"\nimport { ObjectLiteral } from \"../common/ObjectLiteral\"\nimport { EntityMetadata } from \"./EntityMetadata\"\nimport { EmbeddedMetadata } from \"./EmbeddedMetadata\"\n\n/**\n * This metadata contains all information about entity's listeners.\n */\nexport class EntityListenerMetadata {\n    // ---------------------------------------------------------------------\n    // Properties\n    // ---------------------------------------------------------------------\n\n    /**\n     * Entity metadata of the listener.\n     */\n    entityMetadata: EntityMetadata\n\n    /**\n     * Embedded metadata of the listener, in the case if listener is in embedded.\n     */\n    embeddedMetadata?: EmbeddedMetadata\n\n    /**\n     * Target class to which metadata is applied.\n     * This can be different then entityMetadata.target in the case if listener is in the embedded.\n     */\n    target: Function | string\n\n    /**\n     * Target's property name to which this metadata is applied.\n     */\n    propertyName: string\n\n    /**\n     * The type of the listener.\n     */\n    type: EventListenerType\n\n    // ---------------------------------------------------------------------\n    // Constructor\n    // ---------------------------------------------------------------------\n\n    constructor(options: {\n        entityMetadata: EntityMetadata\n        embeddedMetadata?: EmbeddedMetadata\n        args: EntityListenerMetadataArgs\n    }) {\n        this.entityMetadata = options.entityMetadata\n        this.embeddedMetadata = options.embeddedMetadata\n        this.target = options.args.target\n        this.propertyName = options.args.propertyName\n        this.type = options.args.type\n    }\n\n    // ---------------------------------------------------------------------\n    // Public Methods\n    // ---------------------------------------------------------------------\n\n    /**\n     * Checks if entity listener is allowed to be executed on the given entity.\n     */\n    isAllowed(entity: ObjectLiteral) {\n        // todo: create in entity metadata method like isInherited?\n        return (\n            this.entityMetadata.target === entity.constructor || // todo: .constructor won't work for entity schemas, but there are no entity listeners in schemas since there are no objects, right?\n            (typeof this.entityMetadata.target === \"function\" &&\n                entity.constructor.prototype instanceof\n                    this.entityMetadata.target)\n        ) // todo: also need to implement entity schema inheritance\n    }\n\n    /**\n     * Executes listener method of the given entity.\n     */\n    execute(entity: ObjectLiteral) {\n        // Check if the Embedded Metadata does not exist\n        if (!this.embeddedMetadata) {\n            // Get the Entity's Method\n            const entityMethod = entity[this.propertyName]\n\n            // Check if the Entity Method does not exist\n            if (!entityMethod)\n                throw new Error(\n                    `Entity listener method \"${this.propertyName}\" does not exist in entity \"${entity.constructor.name}\".`,\n                )\n\n            // Check if the Entity Method is not a function\n            if (typeof entityMethod !== \"function\")\n                throw new Error(\n                    `Entity listener method \"${this.propertyName}\" in entity \"${\n                        entity.constructor.name\n                    }\" must be a function but got \"${typeof entityMethod}\".`,\n                )\n\n            // Call and return the Entity Method\n            return entityMethod.call(entity)\n        }\n\n        // Call the Embedded Method\n        this.callEntityEmbeddedMethod(\n            entity,\n            this.embeddedMetadata.propertyPath.split(\".\"),\n        )\n    }\n\n    // ---------------------------------------------------------------------\n    // Protected Methods\n    // ---------------------------------------------------------------------\n\n    /**\n     * Calls embedded entity listener method no matter how nested it is.\n     */\n    protected callEntityEmbeddedMethod(\n        entity: ObjectLiteral,\n        propertyPaths: string[],\n    ): void {\n        const propertyPath = propertyPaths.shift()\n        if (!propertyPath || !entity[propertyPath]) return\n\n        if (propertyPaths.length === 0) {\n            if (Array.isArray(entity[propertyPath])) {\n                entity[propertyPath].map((embedded: ObjectLiteral) =>\n                    embedded[this.propertyName](),\n                )\n            } else {\n                entity[propertyPath][this.propertyName]()\n            }\n        } else {\n            if (entity[propertyPath])\n                this.callEntityEmbeddedMethod(\n                    entity[propertyPath],\n                    propertyPaths,\n                )\n        }\n    }\n}\n"],"sourceRoot":".."}
+{"version":3,"file":"EntityListenerMetadata.js","sourceRoot":"../build/browser/src/","sources":["metadata/EntityListenerMetadata.ts"],"names":[],"mappings":";;;AAMA;;GAEG;AACH,MAAa,sBAAsB;IA+B/B,wEAAwE;IACxE,cAAc;IACd,wEAAwE;IAExE,YAAY,OAIX;QACG,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAA;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAA;QAC7C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA;IACjC,CAAC;IAED,wEAAwE;IACxE,iBAAiB;IACjB,wEAAwE;IAExE;;;OAGG;IACH,SAAS,CAAC,MAAqB;QAC3B,2DAA2D;QAC3D,OAAO,CACH,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,oIAAoI;YACzL,CAAC,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,UAAU;gBAC7C,MAAM,CAAC,WAAW,CAAC,SAAS;oBACxB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CACtC,CAAA,CAAC,yDAAyD;IAC/D,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,MAAqB;QACzB,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,0BAA0B;YAC1B,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAE9C,4CAA4C;YAC5C,IAAI,CAAC,YAAY;gBACb,MAAM,IAAI,KAAK,CACX,2BAA2B,IAAI,CAAC,YAAY,+BAA+B,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CACzG,CAAA;YAEL,+CAA+C;YAC/C,IAAI,OAAO,YAAY,KAAK,UAAU;gBAClC,MAAM,IAAI,KAAK,CACX,2BAA2B,IAAI,CAAC,YAAY,gBACxC,MAAM,CAAC,WAAW,CAAC,IACvB,iCAAiC,OAAO,YAAY,IAAI,CAC3D,CAAA;YAEL,oCAAoC;YACpC,OAAO,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACpC,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,wBAAwB,CACzB,MAAM,EACN,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAChD,CAAA;IACL,CAAC;IAED,wEAAwE;IACxE,oBAAoB;IACpB,wEAAwE;IAExE;;;;OAIG;IACO,wBAAwB,CAC9B,MAAqB,EACrB,aAAuB;QAEvB,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,EAAE,CAAA;QAC1C,IAAI,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAAE,OAAM;QAElD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,QAAuB,EAAE,EAAE,CACjD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAChC,CAAA;YACL,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAA;YAC7C,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,IAAI,MAAM,CAAC,YAAY,CAAC;gBACpB,IAAI,CAAC,wBAAwB,CACzB,MAAM,CAAC,YAAY,CAAC,EACpB,aAAa,CAChB,CAAA;QACT,CAAC;IACL,CAAC;CACJ;AApID,wDAoIC","sourcesContent":["import type { EventListenerType } from \"./types/EventListenerTypes\"\nimport type { EntityListenerMetadataArgs } from \"../metadata-args/EntityListenerMetadataArgs\"\nimport type { ObjectLiteral } from \"../common/ObjectLiteral\"\nimport type { EntityMetadata } from \"./EntityMetadata\"\nimport type { EmbeddedMetadata } from \"./EmbeddedMetadata\"\n\n/**\n * This metadata contains all information about entity's listeners.\n */\nexport class EntityListenerMetadata {\n    // ---------------------------------------------------------------------\n    // Properties\n    // ---------------------------------------------------------------------\n\n    /**\n     * Entity metadata of the listener.\n     */\n    entityMetadata: EntityMetadata\n\n    /**\n     * Embedded metadata of the listener, in the case if listener is in embedded.\n     */\n    embeddedMetadata?: EmbeddedMetadata\n\n    /**\n     * Target class to which metadata is applied.\n     * This can be different then entityMetadata.target in the case if listener is in the embedded.\n     */\n    target: Function | string\n\n    /**\n     * Target's property name to which this metadata is applied.\n     */\n    propertyName: string\n\n    /**\n     * The type of the listener.\n     */\n    type: EventListenerType\n\n    // ---------------------------------------------------------------------\n    // Constructor\n    // ---------------------------------------------------------------------\n\n    constructor(options: {\n        entityMetadata: EntityMetadata\n        embeddedMetadata?: EmbeddedMetadata\n        args: EntityListenerMetadataArgs\n    }) {\n        this.entityMetadata = options.entityMetadata\n        this.embeddedMetadata = options.embeddedMetadata\n        this.target = options.args.target\n        this.propertyName = options.args.propertyName\n        this.type = options.args.type\n    }\n\n    // ---------------------------------------------------------------------\n    // Public Methods\n    // ---------------------------------------------------------------------\n\n    /**\n     * Checks if entity listener is allowed to be executed on the given entity.\n     * @param entity\n     */\n    isAllowed(entity: ObjectLiteral) {\n        // todo: create in entity metadata method like isInherited?\n        return (\n            this.entityMetadata.target === entity.constructor || // todo: .constructor won't work for entity schemas, but there are no entity listeners in schemas since there are no objects, right?\n            (typeof this.entityMetadata.target === \"function\" &&\n                entity.constructor.prototype instanceof\n                    this.entityMetadata.target)\n        ) // todo: also need to implement entity schema inheritance\n    }\n\n    /**\n     * Executes listener method of the given entity.\n     * @param entity\n     */\n    execute(entity: ObjectLiteral) {\n        // Check if the Embedded Metadata does not exist\n        if (!this.embeddedMetadata) {\n            // Get the Entity's Method\n            const entityMethod = entity[this.propertyName]\n\n            // Check if the Entity Method does not exist\n            if (!entityMethod)\n                throw new Error(\n                    `Entity listener method \"${this.propertyName}\" does not exist in entity \"${entity.constructor.name}\".`,\n                )\n\n            // Check if the Entity Method is not a function\n            if (typeof entityMethod !== \"function\")\n                throw new Error(\n                    `Entity listener method \"${this.propertyName}\" in entity \"${\n                        entity.constructor.name\n                    }\" must be a function but got \"${typeof entityMethod}\".`,\n                )\n\n            // Call and return the Entity Method\n            return entityMethod.call(entity)\n        }\n\n        // Call the Embedded Method\n        this.callEntityEmbeddedMethod(\n            entity,\n            this.embeddedMetadata.propertyPath.split(\".\"),\n        )\n    }\n\n    // ---------------------------------------------------------------------\n    // Protected Methods\n    // ---------------------------------------------------------------------\n\n    /**\n     * Calls embedded entity listener method no matter how nested it is.\n     * @param entity\n     * @param propertyPaths\n     */\n    protected callEntityEmbeddedMethod(\n        entity: ObjectLiteral,\n        propertyPaths: string[],\n    ): void {\n        const propertyPath = propertyPaths.shift()\n        if (!propertyPath || !entity[propertyPath]) return\n\n        if (propertyPaths.length === 0) {\n            if (Array.isArray(entity[propertyPath])) {\n                entity[propertyPath].map((embedded: ObjectLiteral) =>\n                    embedded[this.propertyName](),\n                )\n            } else {\n                entity[propertyPath][this.propertyName]()\n            }\n        } else {\n            if (entity[propertyPath])\n                this.callEntityEmbeddedMethod(\n                    entity[propertyPath],\n                    propertyPaths,\n                )\n        }\n    }\n}\n"]}

package/browser/metadata/EntityMetadata.d.ts

@@ -1,32 +1,37 @@
-import { QueryRunner, SelectQueryBuilder } from "..";
-import { ObjectLiteral } from "../common/ObjectLiteral";
-import { DataSource } from "../data-source/DataSource";
-import { OrderByCondition } from "../find-options/OrderByCondition";
-import { TableMetadataArgs } from "../metadata-args/TableMetadataArgs";
-import { TreeMetadataArgs } from "../metadata-args/TreeMetadataArgs";
-import { CheckMetadata } from "./CheckMetadata";
-import { ColumnMetadata } from "./ColumnMetadata";
-import { EmbeddedMetadata } from "./EmbeddedMetadata";
-import { EntityListenerMetadata } from "./EntityListenerMetadata";
-import { ExclusionMetadata } from "./ExclusionMetadata";
-import { ForeignKeyMetadata } from "./ForeignKeyMetadata";
-import { IndexMetadata } from "./IndexMetadata";
-import { RelationCountMetadata } from "./RelationCountMetadata";
-import { RelationIdMetadata } from "./RelationIdMetadata";
-import { RelationMetadata } from "./RelationMetadata";
-import { TableType } from "./types/TableTypes";
-import { TreeType } from "./types/TreeTypes";
-import { UniqueMetadata } from "./UniqueMetadata";
-import { ClosureTreeOptions } from "./types/ClosureTreeOptions";
+import type { ObjectLiteral } from "../common/ObjectLiteral";
+import type { DataSource } from "../data-source/DataSource";
+import type { OrderByCondition } from "../find-options/OrderByCondition";
+import type { TableMetadataArgs } from "../metadata-args/TableMetadataArgs";
+import type { TreeMetadataArgs } from "../metadata-args/TreeMetadataArgs";
+import type { CheckMetadata } from "./CheckMetadata";
+import type { ColumnMetadata } from "./ColumnMetadata";
+import type { EmbeddedMetadata } from "./EmbeddedMetadata";
+import type { EntityListenerMetadata } from "./EntityListenerMetadata";
+import type { ExclusionMetadata } from "./ExclusionMetadata";
+import type { ForeignKeyMetadata } from "./ForeignKeyMetadata";
+import type { IndexMetadata } from "./IndexMetadata";
+import type { RelationIdMetadata } from "./RelationIdMetadata";
+import type { RelationMetadata } from "./RelationMetadata";
+import type { TableType } from "./types/TableTypes";
+import type { TreeType } from "./types/TreeTypes";
+import type { UniqueMetadata } from "./UniqueMetadata";
+import type { ClosureTreeOptions } from "./types/ClosureTreeOptions";
+import type { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
+import type { QueryRunner } from "../query-runner/QueryRunner";
 /**
  * Contains all entity metadata.
  */
 export declare class EntityMetadata {
     readonly "@instanceof": symbol;
     /**
-     * Connection where this entity metadata is created.
+     * DataSource where this entity metadata is created.
      */
-    connection: DataSource;
+    dataSource: DataSource;
+    /**
+     * DataSource where this entity metadata is created.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection(): DataSource;
     /**
      * Metadata arguments used to build this entity metadata.
      */
@@ -77,7 +82,7 @@ export declare class EntityMetadata {
      * View's expression.
      * Used in views
      */
-    expression?: string | ((connection: DataSource) => SelectQueryBuilder<any>);
+    expression?: string | ((dataSource: DataSource) => SelectQueryBuilder<any>);
     /**
      * View's dependencies.
      * Used in views
@@ -315,10 +320,6 @@ export declare class EntityMetadata {
      * Entity's relation id metadatas.
      */
     relationIds: RelationIdMetadata[];
-    /**
-     * Entity's relation id metadatas.
-     */
-    relationCounts: RelationCountMetadata[];
     /**
      * Entity's foreign key metadatas.
      */
@@ -420,7 +421,7 @@ export declare class EntityMetadata {
      */
     comment?: string;
     constructor(options: {
-        connection: DataSource;
+        dataSource: DataSource;
         inheritanceTree?: Function[];
         inheritancePattern?: "STI";
         tableTree?: TreeMetadataArgs;
@@ -429,6 +430,10 @@ export declare class EntityMetadata {
     });
     /**
      * Creates a new entity.
+     * @param queryRunner
+     * @param options
+     * @param options.fromDeserializer
+     * @param options.pojo
      */
     create(queryRunner?: QueryRunner, options?: {
         fromDeserializer?: boolean;
@@ -436,11 +441,13 @@ export declare class EntityMetadata {
     }): any;
     /**
      * Checks if given entity has an id.
+     * @param entity
      */
     hasId(entity: ObjectLiteral): boolean;
     /**
      * Checks if given entity / object contains ALL primary keys entity must have.
      * Returns true if it contains all of them, false if at least one of them is not defined.
+     * @param entity
      */
     hasAllPrimaryKeys(entity: ObjectLiteral): boolean;
     /**
@@ -448,6 +455,7 @@ export declare class EntityMetadata {
      * If given id is an object then it means its already id map.
      * If given id isn't an object then it means its a value of the id column
      * and it creates a new id map with this value and name of the primary column.
+     * @param id
      */
     ensureEntityIdMap(id: any): ObjectLiteral;
     /**
@@ -455,6 +463,7 @@ export declare class EntityMetadata {
      * For example, for Post{ id: 1, title: "hello" } where id is primary it will return { id: 1 }
      * For multiple primary keys it returns multiple keys in object.
      * For primary keys inside embeds it returns complex object literal with keys in them.
+     * @param entity
      */
     getEntityIdMap(entity: ObjectLiteral | undefined): ObjectLiteral | undefined;
     /**
@@ -462,88 +471,103 @@ export declare class EntityMetadata {
      * If entity has multiple primary keys (ids) then it will return just regular id map, like what getEntityIdMap returns.
      * But if entity has a single primary key then it will return just value of the id column of the entity, just value.
      * This is called mixed id map.
+     * @param entity
      */
     getEntityIdMixedMap(entity: ObjectLiteral | undefined): ObjectLiteral | undefined;
     /**
      * Compares two different entities by their ids.
      * Returns true if they match, false otherwise.
+     * @param firstEntity
+     * @param secondEntity
      */
     compareEntities(firstEntity: ObjectLiteral, secondEntity: ObjectLiteral): boolean;
     /**
      * Finds column with a given property name.
+     * @param propertyName
      */
     findColumnWithPropertyName(propertyName: string): ColumnMetadata | undefined;
     /**
      * Finds column with a given database name.
+     * @param databaseName
      */
     findColumnWithDatabaseName(databaseName: string): ColumnMetadata | undefined;
     /**
      * Checks if there is a column or relationship with a given property path.
+     * @param propertyPath
      */
     hasColumnWithPropertyPath(propertyPath: string): boolean;
     /**
      * Finds column with a given property path.
+     * @param propertyPath
      */
     findColumnWithPropertyPath(propertyPath: string): ColumnMetadata | undefined;
     /**
      * Finds column with a given property path.
      * Does not search in relation unlike findColumnWithPropertyPath.
+     * @param propertyPath
      */
     findColumnWithPropertyPathStrict(propertyPath: string): ColumnMetadata | undefined;
     /**
      * Finds columns with a given property path.
      * Property path can match a relation, and relations can contain multiple columns.
+     * @param propertyPath
      */
     findColumnsWithPropertyPath(propertyPath: string): ColumnMetadata[];
     /**
      * Checks if there is a relation with the given property path.
+     * @param propertyPath
      */
     hasRelationWithPropertyPath(propertyPath: string): boolean;
     /**
      * Finds relation with the given property path.
+     * @param propertyPath
      */
     findRelationWithPropertyPath(propertyPath: string): RelationMetadata | undefined;
     /**
      * Checks if there is an embedded with a given property path.
+     * @param propertyPath
      */
     hasEmbeddedWithPropertyPath(propertyPath: string): boolean;
     /**
      * Finds embedded with a given property path.
+     * @param propertyPath
      */
     findEmbeddedWithPropertyPath(propertyPath: string): EmbeddedMetadata | undefined;
     /**
      * Returns an array of databaseNames mapped from provided propertyPaths
+     * @param propertyPaths
      */
     mapPropertyPathsToColumns(propertyPaths: string[]): ColumnMetadata[];
     /**
      * Iterates through entity and finds and extracts all values from relations in the entity.
      * If relation value is an array its being flattened.
+     * @param entity
+     * @param relations
      */
     extractRelationValuesFromEntity(entity: ObjectLiteral, relations: RelationMetadata[]): [RelationMetadata, any, EntityMetadata][];
     /**
      * In the case of SingleTableInheritance, find the correct metadata
      * for a given value.
-     *
      * @param value The value to find the metadata for.
      * @returns The found metadata for the entity or the base metadata if no matching metadata
      *          was found in the whole inheritance tree.
      */
     findInheritanceMetadata(value: any): EntityMetadata;
     private static getInverseEntityMetadata;
-    /**
-     * Creates a property paths for a given entity.
-     *
-     * @deprecated
-     */
-    static createPropertyPath(metadata: EntityMetadata, entity: ObjectLiteral, prefix?: string): string[];
     /**
      * Finds difference between two entity id maps.
      * Returns items that exist in the first array and absent in the second array.
+     * @param firstIdMaps
+     * @param secondIdMaps
      */
     static difference(firstIdMaps: ObjectLiteral[], secondIdMaps: ObjectLiteral[]): ObjectLiteral[];
     /**
      * Creates value map from the given values and columns.
      * Examples of usages are primary columns map and join columns map.
+     * @param entity
+     * @param columns
+     * @param options
+     * @param options.skipNulls
      */
     static getValueMap(entity: ObjectLiteral, columns: ColumnMetadata[], options?: {
         skipNulls?: boolean;
@@ -551,6 +575,7 @@ export declare class EntityMetadata {
     build(): void;
     /**
      * Registers a new column in the entity and recomputes all depend properties.
+     * @param column
      */
     registerColumn(column: ColumnMetadata): void;
     /**

package/browser/metadata/EntityMetadata.js

@@ -1,12 +1,22 @@
-import { CannotCreateEntityIdMapError } from "../error/CannotCreateEntityIdMapError";
-import { OrmUtils } from "../util/OrmUtils";
-import { EntityPropertyNotFoundError } from "../error/EntityPropertyNotFoundError";
-import { ObjectUtils } from "../util/ObjectUtils";
-import { shorten } from "../util/StringUtils";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityMetadata = void 0;
+const CannotCreateEntityIdMapError_1 = require("../error/CannotCreateEntityIdMapError");
+const OrmUtils_1 = require("../util/OrmUtils");
+const EntityPropertyNotFoundError_1 = require("../error/EntityPropertyNotFoundError");
+const ObjectUtils_1 = require("../util/ObjectUtils");
+const StringUtils_1 = require("../util/StringUtils");
 /**
  * Contains all entity metadata.
  */
-export class EntityMetadata {
+class EntityMetadata {
+    /**
+     * DataSource where this entity metadata is created.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection() {
+        return this.dataSource;
+    }
     // ---------------------------------------------------------------------
     // Constructor
     // ---------------------------------------------------------------------
@@ -149,10 +159,6 @@ export class EntityMetadata {
          * Entity's relation id metadatas.
          */
         this.relationIds = [];
-        /**
-         * Entity's relation id metadatas.
-         */
-        this.relationCounts = [];
         /**
          * Entity's foreign key metadatas.
          */
@@ -241,7 +247,7 @@ export class EntityMetadata {
          * Listener metadatas with "AFTER RECOVER" type.
          */
         this.afterRecoverListeners = [];
-        this.connection = options.connection;
+        this.dataSource = options.dataSource;
         this.inheritanceTree = options.inheritanceTree || [];
         this.inheritancePattern = options.inheritancePattern;
         this.treeType = options.tableTree ? options.tableTree.type : undefined;
@@ -261,6 +267,10 @@ export class EntityMetadata {
     // -------------------------------------------------------------------------
     /**
      * Creates a new entity.
+     * @param queryRunner
+     * @param options
+     * @param options.fromDeserializer
+     * @param options.pojo
      */
     create(queryRunner, options) {
         const pojo = options && options.pojo === true ? true : false;
@@ -279,14 +289,15 @@ export class EntityMetadata {
             ret = {};
         }
         // add "typename" property
-        if (this.connection.options.typename) {
-            ret[this.connection.options.typename] = this.targetName;
+        if (this.dataSource.options.typename) {
+            ret[this.dataSource.options.typename] = this.targetName;
         }
-        this.lazyRelations.forEach((relation) => this.connection.relationLoader.enableLazyLoad(relation, ret, queryRunner));
+        this.lazyRelations.forEach((relation) => this.dataSource.relationLoader.enableLazyLoad(relation, ret, queryRunner));
         return ret;
     }
     /**
      * Checks if given entity has an id.
+     * @param entity
      */
     hasId(entity) {
         if (!entity)
@@ -299,6 +310,7 @@ export class EntityMetadata {
     /**
      * Checks if given entity / object contains ALL primary keys entity must have.
      * Returns true if it contains all of them, false if at least one of them is not defined.
+     * @param entity
      */
     hasAllPrimaryKeys(entity) {
         return this.primaryColumns.every((primaryColumn) => {
@@ -311,12 +323,13 @@ export class EntityMetadata {
      * If given id is an object then it means its already id map.
      * If given id isn't an object then it means its a value of the id column
      * and it creates a new id map with this value and name of the primary column.
+     * @param id
      */
     ensureEntityIdMap(id) {
-        if (ObjectUtils.isObject(id))
+        if (ObjectUtils_1.ObjectUtils.isObject(id))
             return id;
         if (this.hasMultiplePrimaryKeys)
-            throw new CannotCreateEntityIdMapError(this, id);
+            throw new CannotCreateEntityIdMapError_1.CannotCreateEntityIdMapError(this, id);
         return this.primaryColumns[0].createValueMap(id);
     }
     /**
@@ -324,6 +337,7 @@ export class EntityMetadata {
      * For example, for Post{ id: 1, title: "hello" } where id is primary it will return { id: 1 }
      * For multiple primary keys it returns multiple keys in object.
      * For primary keys inside embeds it returns complex object literal with keys in them.
+     * @param entity
      */
     getEntityIdMap(entity) {
         if (!entity)
@@ -337,6 +351,7 @@ export class EntityMetadata {
      * If entity has multiple primary keys (ids) then it will return just regular id map, like what getEntityIdMap returns.
      * But if entity has a single primary key then it will return just value of the id column of the entity, just value.
      * This is called mixed id map.
+     * @param entity
      */
     getEntityIdMixedMap(entity) {
         if (!entity)
@@ -353,6 +368,8 @@ export class EntityMetadata {
     /**
      * Compares two different entities by their ids.
      * Returns true if they match, false otherwise.
+     * @param firstEntity
+     * @param secondEntity
      */
     compareEntities(firstEntity, secondEntity) {
         const firstEntityIdMap = this.getEntityIdMap(firstEntity);
@@ -361,22 +378,25 @@ export class EntityMetadata {
         const secondEntityIdMap = this.getEntityIdMap(secondEntity);
         if (!secondEntityIdMap)
             return false;
-        return OrmUtils.compareIds(firstEntityIdMap, secondEntityIdMap);
+        return OrmUtils_1.OrmUtils.compareIds(firstEntityIdMap, secondEntityIdMap);
     }
     /**
      * Finds column with a given property name.
+     * @param propertyName
      */
     findColumnWithPropertyName(propertyName) {
         return this.columns.find((column) => column.propertyName === propertyName);
     }
     /**
      * Finds column with a given database name.
+     * @param databaseName
      */
     findColumnWithDatabaseName(databaseName) {
         return this.columns.find((column) => column.databaseName === databaseName);
     }
     /**
      * Checks if there is a column or relationship with a given property path.
+     * @param propertyPath
      */
     hasColumnWithPropertyPath(propertyPath) {
         const hasColumn = this.columns.some((column) => column.propertyPath === propertyPath);
@@ -384,6 +404,7 @@ export class EntityMetadata {
     }
     /**
      * Finds column with a given property path.
+     * @param propertyPath
      */
     findColumnWithPropertyPath(propertyPath) {
         const column = this.columns.find((column) => column.propertyPath === propertyPath);
@@ -399,6 +420,7 @@ export class EntityMetadata {
     /**
      * Finds column with a given property path.
      * Does not search in relation unlike findColumnWithPropertyPath.
+     * @param propertyPath
      */
     findColumnWithPropertyPathStrict(propertyPath) {
         return this.columns.find((column) => column.propertyPath === propertyPath);
@@ -406,6 +428,7 @@ export class EntityMetadata {
     /**
      * Finds columns with a given property path.
      * Property path can match a relation, and relations can contain multiple columns.
+     * @param propertyPath
      */
     findColumnsWithPropertyPath(propertyPath) {
         const column = this.columns.find((column) => column.propertyPath === propertyPath);
@@ -420,36 +443,41 @@ export class EntityMetadata {
     }
     /**
      * Checks if there is a relation with the given property path.
+     * @param propertyPath
      */
     hasRelationWithPropertyPath(propertyPath) {
         return this.relations.some((relation) => relation.propertyPath === propertyPath);
     }
     /**
      * Finds relation with the given property path.
+     * @param propertyPath
      */
     findRelationWithPropertyPath(propertyPath) {
         return this.relations.find((relation) => relation.propertyPath === propertyPath);
     }
     /**
      * Checks if there is an embedded with a given property path.
+     * @param propertyPath
      */
     hasEmbeddedWithPropertyPath(propertyPath) {
         return this.allEmbeddeds.some((embedded) => embedded.propertyPath === propertyPath);
     }
     /**
      * Finds embedded with a given property path.
+     * @param propertyPath
      */
     findEmbeddedWithPropertyPath(propertyPath) {
         return this.allEmbeddeds.find((embedded) => embedded.propertyPath === propertyPath);
     }
     /**
      * Returns an array of databaseNames mapped from provided propertyPaths
+     * @param propertyPaths
      */
     mapPropertyPathsToColumns(propertyPaths) {
         return propertyPaths.map((propertyPath) => {
             const column = this.findColumnWithPropertyPath(propertyPath);
             if (column == null) {
-                throw new EntityPropertyNotFoundError(propertyPath, this);
+                throw new EntityPropertyNotFoundError_1.EntityPropertyNotFoundError(propertyPath, this);
             }
             return column;
         });
@@ -457,6 +485,8 @@ export class EntityMetadata {
     /**
      * Iterates through entity and finds and extracts all values from relations in the entity.
      * If relation value is an array its being flattened.
+     * @param entity
+     * @param relations
      */
     extractRelationValuesFromEntity(entity, relations) {
         const relationsAndValues = [];
@@ -482,7 +512,6 @@ export class EntityMetadata {
     /**
      * In the case of SingleTableInheritance, find the correct metadata
      * for a given value.
-     *
      * @param value The value to find the metadata for.
      * @returns The found metadata for the entity or the base metadata if no matching metadata
      *          was found in the whole inheritance tree.
@@ -514,40 +543,24 @@ export class EntityMetadata {
     // -------------------------------------------------------------------------
     // Public Static Methods
     // -------------------------------------------------------------------------
-    /**
-     * Creates a property paths for a given entity.
-     *
-     * @deprecated
-     */
-    static createPropertyPath(metadata, entity, prefix = "") {
-        const paths = [];
-        Object.keys(entity).forEach((key) => {
-            // check for function is needed in the cases when createPropertyPath used on values contain a function as a value
-            // example: .update().set({ name: () => `SUBSTR('', 1, 2)` })
-            const parentPath = prefix ? prefix + "." + key : key;
-            if (metadata.hasEmbeddedWithPropertyPath(parentPath)) {
-                const subPaths = this.createPropertyPath(metadata, entity[key], parentPath);
-                paths.push(...subPaths);
-            }
-            else {
-                const path = prefix ? prefix + "." + key : key;
-                paths.push(path);
-            }
-        });
-        return paths;
-    }
     /**
      * Finds difference between two entity id maps.
      * Returns items that exist in the first array and absent in the second array.
+     * @param firstIdMaps
+     * @param secondIdMaps
      */
     static difference(firstIdMaps, secondIdMaps) {
         return firstIdMaps.filter((firstIdMap) => {
-            return !secondIdMaps.find((secondIdMap) => OrmUtils.compareIds(firstIdMap, secondIdMap));
+            return !secondIdMaps.find((secondIdMap) => OrmUtils_1.OrmUtils.compareIds(firstIdMap, secondIdMap));
         });
     }
     /**
      * Creates value map from the given values and columns.
      * Examples of usages are primary columns map and join columns map.
+     * @param entity
+     * @param columns
+     * @param options
+     * @param options.skipNulls
      */
     static getValueMap(entity, columns, options) {
         return columns.reduce((map, column) => {
@@ -555,16 +568,16 @@ export class EntityMetadata {
             // make sure that none of the values of the columns are not missing
             if (map === undefined || value === null || value === undefined)
                 return undefined;
-            return OrmUtils.mergeDeep(map, value);
+            return OrmUtils_1.OrmUtils.mergeDeep(map, value);
         }, {});
     }
     // ---------------------------------------------------------------------
     // Public Builder Methods
     // ---------------------------------------------------------------------
     build() {
-        const namingStrategy = this.connection.namingStrategy;
-        const entityPrefix = this.connection.options.entityPrefix;
-        const entitySkipConstructor = this.connection.options.entitySkipConstructor;
+        const namingStrategy = this.dataSource.namingStrategy;
+        const entityPrefix = this.dataSource.options.entityPrefix;
+        const entitySkipConstructor = this.dataSource.options.entitySkipConstructor;
         this.engine = this.tableMetadataArgs.engine;
         this.database =
             this.tableMetadataArgs.type === "entity-child" &&
@@ -578,8 +591,8 @@ export class EntityMetadata {
             this.parentEntityMetadata) {
             this.schema = this.parentEntityMetadata.schema;
         }
-        else if (this.connection.options?.hasOwnProperty("schema")) {
-            this.schema = this.connection.options.schema;
+        else if (this.dataSource.options?.hasOwnProperty("schema")) {
+            this.schema = this.dataSource.options.schema;
         }
         this.givenTableName =
             this.tableMetadataArgs.type === "entity-child" &&
@@ -603,14 +616,14 @@ export class EntityMetadata {
         else {
             this.tableNameWithoutPrefix = namingStrategy.tableName(this.targetName, this.givenTableName);
             if (this.tableMetadataArgs.type === "junction" &&
-                this.connection.driver.maxAliasLength &&
-                this.connection.driver.maxAliasLength > 0 &&
+                this.dataSource.driver.maxAliasLength &&
+                this.dataSource.driver.maxAliasLength > 0 &&
                 this.tableNameWithoutPrefix.length >
-                    this.connection.driver.maxAliasLength) {
+                    this.dataSource.driver.maxAliasLength) {
                 // note: we are not using DriverUtils.buildAlias here because we would like to avoid
                 // hashed table names. However, current algorithm also isn't perfect, but we cannot
                 // change it, since it's a big breaking change. Planned to 0.4.0
-                this.tableNameWithoutPrefix = shorten(this.tableNameWithoutPrefix, { separator: "_", segmentLength: 3 });
+                this.tableNameWithoutPrefix = (0, StringUtils_1.shorten)(this.tableNameWithoutPrefix, { separator: "_", segmentLength: 3 });
             }
         }
         this.tableName = entityPrefix
@@ -621,7 +634,7 @@ export class EntityMetadata {
         this.expression = this.tableMetadataArgs.expression;
         this.withoutRowid =
             this.tableMetadataArgs.withoutRowid === true ? true : false;
-        this.tablePath = this.connection.driver.buildTableName(this.tableName, this.schema, this.database);
+        this.tablePath = this.dataSource.driver.buildTableName(this.tableName, this.schema, this.database);
         this.orderBy =
             typeof this.tableMetadataArgs.orderBy === "function"
                 ? this.tableMetadataArgs.orderBy(this.propertiesMap)
@@ -638,6 +651,7 @@ export class EntityMetadata {
     }
     /**
      * Registers a new column in the entity and recomputes all depend properties.
+     * @param column
      */
     registerColumn(column) {
         if (this.ownColumns.indexOf(column) !== -1)
@@ -662,8 +676,8 @@ export class EntityMetadata {
      */
     createPropertiesMap() {
         const map = {};
-        this.columns.forEach((column) => OrmUtils.mergeDeep(map, column.createValueMap(column.propertyPath)));
-        this.relations.forEach((relation) => OrmUtils.mergeDeep(map, relation.createValueMap(relation.propertyPath)));
+        this.columns.forEach((column) => OrmUtils_1.OrmUtils.mergeDeep(map, column.createValueMap(column.propertyPath)));
+        this.relations.forEach((relation) => OrmUtils_1.OrmUtils.mergeDeep(map, relation.createValueMap(relation.propertyPath)));
         return map;
     }
     /**
@@ -684,5 +698,5 @@ export class EntityMetadata {
         });
     }
 }
-
-//# sourceMappingURL=EntityMetadata.js.map
+exports.EntityMetadata = EntityMetadata;
+//# sourceMappingURL=EntityMetadata.js.map