@itwin/core-backend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/Entity.d.ts

@@ -1,107 +1,107 @@
-/** @packageDocumentation
- * @module Schema
- */
-import { Id64String } from "@itwin/core-bentley";
-import { EntityProps, EntityReferenceSet, PropertyCallback } from "@itwin/core-common";
-import { IModelDb } from "./IModelDb";
-import { Schema } from "./Schema";
-/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].
- * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
- * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
- * @public
- */
-export declare class Entity {
-    /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
-     * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
-     */
-    readonly isInstanceOfEntity: true;
-    /** The Schema that defines this class. */
-    static schema: typeof Schema;
-    private get _ctor();
-    /** The name of the BIS class associated with this class.
-     * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
-     * Failure to do so will ordinarily result in an error when the class is registered, since there may only
-     * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
-     */
-    static get className(): string;
-    /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
-     * This property makes such code slightly less tedious to read and write.
-     * @internal
-     */
-    get asAny(): any;
-    /** The name of the BIS Schema that defines this class */
-    get schemaName(): string;
-    /** The name of the BIS class associated with this class. */
-    get className(): string;
-    /** The [[IModelDb]] that contains this Entity */
-    iModel: IModelDb;
-    /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */
-    id: Id64String;
-    /** @internal */
-    constructor(props: EntityProps, iModel: IModelDb);
-    /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
-     * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
-     */
-    toJSON(): EntityProps;
-    /** Call a function for each property of this Entity.
-     * @param func The callback to be invoked on each property
-     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
-     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
-     */
-    forEachProperty(func: PropertyCallback, includeCustom?: boolean): void;
-    /** Get the full BIS class name of this Entity in the form "schema:class" */
-    static get classFullName(): string;
-    /** Get the full BIS class name of this Entity in the form "schema:class". */
-    get classFullName(): string;
-    /** @internal */
-    static get protectedOperations(): string[];
-    /** return whether this Entity class is a subclass of another Entity class
-     * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
-     * inheritance, you can use [ECClass.is]($ecschema-metadata)
-     * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
-     * typescript's restriction on the `this` type in static methods
-     */
-    static is(otherClass: typeof Entity): boolean;
-    /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
-     * ClassRegistry overrides this when generating a class
-     * @internal
-     */
-    static get isGeneratedClass(): boolean;
-    /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet
-     *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).
-     * @see collectReferenceIds
-     * @beta
-     */
-    getReferenceIds(): Set<Id64String>;
-    /** This is the intended and future behavior of [[getReferenceIds]].
-     * In the next breaking change it will replace getReferenceIds, and is already used by the transformer
-     * @internal
-     */
-    getReferenceConcreteIds(): EntityReferenceSet;
-    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
-     * A *reference* is any entity referenced by this entity's EC Data
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @param _referenceIds The Id64Set to populate with reference Ids.
-     * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,
-     *       which does not accept plain Id64s, see EntityReferenceSet.
-     * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
-     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
-     * @see getReferenceIds
-     * @beta
-     */
-    protected collectReferenceIds(referenceIds: Set<Id64String>): void;
-    /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.
-     * In the next breaking change it will replace getReferenceIds
-     * @internal
-     */
-    protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void;
-}
-/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.
- * @public
- */
-export declare type EntityClassType<T> = Function & {
-    prototype: T;
-};
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { EntityProps, EntityReferenceSet, PropertyCallback } from "@itwin/core-common";
+import { IModelDb } from "./IModelDb";
+import { Schema } from "./Schema";
+/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].
+ * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
+ * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
+ * @public
+ */
+export declare class Entity {
+    /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
+     * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
+     */
+    readonly isInstanceOfEntity: true;
+    /** The Schema that defines this class. */
+    static schema: typeof Schema;
+    private get _ctor();
+    /** The name of the BIS class associated with this class.
+     * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
+     * Failure to do so will ordinarily result in an error when the class is registered, since there may only
+     * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
+     */
+    static get className(): string;
+    /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
+     * This property makes such code slightly less tedious to read and write.
+     * @internal
+     */
+    get asAny(): any;
+    /** The name of the BIS Schema that defines this class */
+    get schemaName(): string;
+    /** The name of the BIS class associated with this class. */
+    get className(): string;
+    /** The [[IModelDb]] that contains this Entity */
+    iModel: IModelDb;
+    /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */
+    id: Id64String;
+    /** @internal */
+    constructor(props: EntityProps, iModel: IModelDb);
+    /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
+     * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
+     */
+    toJSON(): EntityProps;
+    /** Call a function for each property of this Entity.
+     * @param func The callback to be invoked on each property
+     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
+     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
+     */
+    forEachProperty(func: PropertyCallback, includeCustom?: boolean): void;
+    /** Get the full BIS class name of this Entity in the form "schema:class" */
+    static get classFullName(): string;
+    /** Get the full BIS class name of this Entity in the form "schema:class". */
+    get classFullName(): string;
+    /** @internal */
+    static get protectedOperations(): string[];
+    /** return whether this Entity class is a subclass of another Entity class
+     * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
+     * inheritance, you can use [ECClass.is]($ecschema-metadata)
+     * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
+     * typescript's restriction on the `this` type in static methods
+     */
+    static is(otherClass: typeof Entity): boolean;
+    /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
+     * ClassRegistry overrides this when generating a class
+     * @internal
+     */
+    static get isGeneratedClass(): boolean;
+    /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet
+     *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).
+     * @see collectReferenceIds
+     * @beta
+     */
+    getReferenceIds(): Set<Id64String>;
+    /** This is the intended and future behavior of [[getReferenceIds]].
+     * In the next breaking change it will replace getReferenceIds, and is already used by the transformer
+     * @internal
+     */
+    getReferenceConcreteIds(): EntityReferenceSet;
+    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
+     * A *reference* is any entity referenced by this entity's EC Data
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @param _referenceIds The Id64Set to populate with reference Ids.
+     * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,
+     *       which does not accept plain Id64s, see EntityReferenceSet.
+     * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
+     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
+     * @see getReferenceIds
+     * @beta
+     */
+    protected collectReferenceIds(referenceIds: Set<Id64String>): void;
+    /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.
+     * In the next breaking change it will replace getReferenceIds
+     * @internal
+     */
+    protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void;
+}
+/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.
+ * @public
+ */
+export type EntityClassType<T> = Function & {
+    prototype: T;
+};
 //# sourceMappingURL=Entity.d.ts.map

package/lib/cjs/Entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,SAAgB,kBAAkB,EAAE,IAAI,CAAQ;IAChD,0CAA0C;IAC1C,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO,KAAK,KAAK,GAA+D;IAEhF;;;;OAIG;IACH,WAAkB,SAAS,IAAI,MAAM,CAAqB;IAE1D;;;OAGG;IACH,IAAW,KAAK,IAAI,GAAG,CAAiB;IAExC,yDAAyD;IACzD,IAAW,UAAU,IAAI,MAAM,CAAyC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAiC;IAE/D,iDAAiD;IAC1C,MAAM,EAAE,QAAQ,CAAC;IAExB,kGAAkG;IAC3F,EAAE,EAAE,UAAU,CAAC;IAEtB,gBAAgB;gBACJ,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAOhD;;OAEG;IACI,MAAM,IAAI,WAAW;IAS5B;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAE5E,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IAEvE,gBAAgB;IAChB,WAAkB,mBAAmB,IAAI,MAAM,EAAE,CAAe;IAEhE;;;;;OAKG;WACW,EAAE,CAAC,UAAU,EAAE,OAAO,MAAM,GAAG,OAAO;IAEpD;;;OAGG;IACH,WAAkB,gBAAgB,YAAoB;IAGtD;;;;;;OAMG;IACI,eAAe,IAAI,GAAG,CAAC,UAAU,CAAC;IAMzC;;;OAGG;IACI,uBAAuB,IAAI,kBAAkB;IAMpD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,mBAAmB,CAAC,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI;IAYlE;;;OAGG;IACH,SAAS,CAAC,2BAA2B,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;CAG/E;AAED;;GAEG;AACH,oBAAY,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,SAAgB,kBAAkB,OAAiB;IACnD,0CAA0C;IAC1C,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO,KAAK,KAAK,GAA+D;IAEhF;;;;OAIG;IACH,WAAkB,SAAS,IAAI,MAAM,CAAqB;IAE1D;;;OAGG;IACH,IAAW,KAAK,IAAI,GAAG,CAAiB;IAExC,yDAAyD;IACzD,IAAW,UAAU,IAAI,MAAM,CAAyC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAiC;IAE/D,iDAAiD;IAC1C,MAAM,EAAE,QAAQ,CAAC;IAExB,kGAAkG;IAC3F,EAAE,EAAE,UAAU,CAAC;IAEtB,gBAAgB;gBACJ,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAOhD;;OAEG;IACI,MAAM,IAAI,WAAW;IAS5B;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAE5E,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IAEvE,gBAAgB;IAChB,WAAkB,mBAAmB,IAAI,MAAM,EAAE,CAAe;IAEhE;;;;;OAKG;WACW,EAAE,CAAC,UAAU,EAAE,OAAO,MAAM,GAAG,OAAO;IAEpD;;;OAGG;IACH,WAAkB,gBAAgB,YAAoB;IAGtD;;;;;;OAMG;IACI,eAAe,IAAI,GAAG,CAAC,UAAU,CAAC;IAMzC;;;OAGG;IACI,uBAAuB,IAAI,kBAAkB;IAMpD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,mBAAmB,CAAC,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI;IAYlE;;;OAGG;IACH,SAAS,CAAC,2BAA2B,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;CAG/E;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/lib/cjs/Entity.js

@@ -1,135 +1,135 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Schema
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Entity = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const IModelDb_1 = require("./IModelDb");
-/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].
- * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
- * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
- * @public
- */
-class Entity {
-    /** @internal */
-    constructor(props, iModel) {
-        /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
-         * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
-         */
-        this.isInstanceOfEntity = true;
-        this.iModel = iModel;
-        this.id = core_bentley_1.Id64.fromJSON(props.id);
-        // copy all auto-handled properties from input to the object being constructed
-        this.forEachProperty((propName, meta) => this[propName] = meta.createProperty(props[propName]), false);
-    }
-    get _ctor() { return this.constructor; }
-    /** The name of the BIS class associated with this class.
-     * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
-     * Failure to do so will ordinarily result in an error when the class is registered, since there may only
-     * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
-     */
-    static get className() { return "Entity"; }
-    /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
-     * This property makes such code slightly less tedious to read and write.
-     * @internal
-     */
-    get asAny() { return this; }
-    /** The name of the BIS Schema that defines this class */
-    get schemaName() { return this._ctor.schema.schemaName; }
-    /** The name of the BIS class associated with this class. */
-    get className() { return this._ctor.className; }
-    /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
-     * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
-     */
-    toJSON() {
-        const val = {};
-        val.classFullName = this.classFullName;
-        if (core_bentley_1.Id64.isValid(this.id))
-            val.id = this.id;
-        this.forEachProperty((propName) => val[propName] = this[propName], false);
-        return val;
-    }
-    /** Call a function for each property of this Entity.
-     * @param func The callback to be invoked on each property
-     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
-     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
-     */
-    forEachProperty(func, includeCustom = true) { IModelDb_1.IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }
-    /** Get the full BIS class name of this Entity in the form "schema:class" */
-    static get classFullName() { return `${this.schema.schemaName}:${this.className}`; }
-    /** Get the full BIS class name of this Entity in the form "schema:class". */
-    get classFullName() { return this._ctor.classFullName; }
-    /** @internal */
-    static get protectedOperations() { return []; }
-    /** return whether this Entity class is a subclass of another Entity class
-     * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
-     * inheritance, you can use [ECClass.is]($ecschema-metadata)
-     * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
-     * typescript's restriction on the `this` type in static methods
-     */
-    static is(otherClass) { return (0, core_bentley_1.isSubclassOf)(this, otherClass); }
-    /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
-     * ClassRegistry overrides this when generating a class
-     * @internal
-     */
-    static get isGeneratedClass() { return false; }
-    // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds
-    /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet
-     *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).
-     * @see collectReferenceIds
-     * @beta
-     */
-    getReferenceIds() {
-        const referenceIds = new Set();
-        this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation
-        return referenceIds;
-    }
-    /** This is the intended and future behavior of [[getReferenceIds]].
-     * In the next breaking change it will replace getReferenceIds, and is already used by the transformer
-     * @internal
-     */
-    getReferenceConcreteIds() {
-        const referenceIds = new core_common_1.EntityReferenceSet();
-        this.collectReferenceConcreteIds(referenceIds);
-        return referenceIds;
-    }
-    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
-     * A *reference* is any entity referenced by this entity's EC Data
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @param _referenceIds The Id64Set to populate with reference Ids.
-     * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,
-     *       which does not accept plain Id64s, see EntityReferenceSet.
-     * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
-     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
-     * @see getReferenceIds
-     * @beta
-     */
-    collectReferenceIds(referenceIds) {
-        const concreteEntityIds = this.getReferenceConcreteIds();
-        for (const entity of concreteEntityIds) {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention
-            const EntityReferences = require("./EntityReferences").EntityReferences;
-            // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else
-            if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {
-                referenceIds.add(EntityReferences.toId64(entity));
-            }
-        }
-    }
-    /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.
-     * In the next breaking change it will replace getReferenceIds
-     * @internal
-     */
-    collectReferenceConcreteIds(_referenceIds) {
-        return; // no references by default
-    }
-}
-exports.Entity = Entity;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entity = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const IModelDb_1 = require("./IModelDb");
+/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].
+ * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
+ * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
+ * @public
+ */
+class Entity {
+    get _ctor() { return this.constructor; }
+    /** The name of the BIS class associated with this class.
+     * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
+     * Failure to do so will ordinarily result in an error when the class is registered, since there may only
+     * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
+     */
+    static get className() { return "Entity"; }
+    /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
+     * This property makes such code slightly less tedious to read and write.
+     * @internal
+     */
+    get asAny() { return this; }
+    /** The name of the BIS Schema that defines this class */
+    get schemaName() { return this._ctor.schema.schemaName; }
+    /** The name of the BIS class associated with this class. */
+    get className() { return this._ctor.className; }
+    /** @internal */
+    constructor(props, iModel) {
+        /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
+         * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
+         */
+        this.isInstanceOfEntity = true;
+        this.iModel = iModel;
+        this.id = core_bentley_1.Id64.fromJSON(props.id);
+        // copy all auto-handled properties from input to the object being constructed
+        this.forEachProperty((propName, meta) => this[propName] = meta.createProperty(props[propName]), false);
+    }
+    /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
+     * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
+     */
+    toJSON() {
+        const val = {};
+        val.classFullName = this.classFullName;
+        if (core_bentley_1.Id64.isValid(this.id))
+            val.id = this.id;
+        this.forEachProperty((propName) => val[propName] = this[propName], false);
+        return val;
+    }
+    /** Call a function for each property of this Entity.
+     * @param func The callback to be invoked on each property
+     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
+     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
+     */
+    forEachProperty(func, includeCustom = true) { IModelDb_1.IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }
+    /** Get the full BIS class name of this Entity in the form "schema:class" */
+    static get classFullName() { return `${this.schema.schemaName}:${this.className}`; }
+    /** Get the full BIS class name of this Entity in the form "schema:class". */
+    get classFullName() { return this._ctor.classFullName; }
+    /** @internal */
+    static get protectedOperations() { return []; }
+    /** return whether this Entity class is a subclass of another Entity class
+     * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
+     * inheritance, you can use [ECClass.is]($ecschema-metadata)
+     * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
+     * typescript's restriction on the `this` type in static methods
+     */
+    static is(otherClass) { return (0, core_bentley_1.isSubclassOf)(this, otherClass); }
+    /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
+     * ClassRegistry overrides this when generating a class
+     * @internal
+     */
+    static get isGeneratedClass() { return false; }
+    // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds
+    /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet
+     *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).
+     * @see collectReferenceIds
+     * @beta
+     */
+    getReferenceIds() {
+        const referenceIds = new Set();
+        this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation
+        return referenceIds;
+    }
+    /** This is the intended and future behavior of [[getReferenceIds]].
+     * In the next breaking change it will replace getReferenceIds, and is already used by the transformer
+     * @internal
+     */
+    getReferenceConcreteIds() {
+        const referenceIds = new core_common_1.EntityReferenceSet();
+        this.collectReferenceConcreteIds(referenceIds);
+        return referenceIds;
+    }
+    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
+     * A *reference* is any entity referenced by this entity's EC Data
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @param _referenceIds The Id64Set to populate with reference Ids.
+     * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,
+     *       which does not accept plain Id64s, see EntityReferenceSet.
+     * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
+     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
+     * @see getReferenceIds
+     * @beta
+     */
+    collectReferenceIds(referenceIds) {
+        const concreteEntityIds = this.getReferenceConcreteIds();
+        for (const entity of concreteEntityIds) {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention
+            const EntityReferences = require("./EntityReferences").EntityReferences;
+            // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else
+            if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {
+                referenceIds.add(EntityReferences.toId64(entity));
+            }
+        }
+    }
+    /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.
+     * In the next breaking change it will replace getReferenceIds
+     * @internal
+     */
+    collectReferenceConcreteIds(_referenceIds) {
+        return; // no references by default
+    }
+}
+exports.Entity = Entity;
 //# sourceMappingURL=Entity.js.map

package/lib/cjs/Entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqE;AACrE,oDAAyG;AACzG,yCAAsC;AAGtC;;;;GAIG;AACH,MAAa,MAAM;IAmCjB,gBAAgB;IAChB,YAAY,KAAkB,EAAE,MAAgB;QAnChD;;WAEG;QACa,uBAAkB,GAAS,IAAI,CAAC;QAiC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,IAAsB,EAAE,EAAE,CAAE,IAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,cAAc,CAAE,KAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrJ,CAAC;IAjCD,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACH,IAAW,KAAK,KAAU,OAAO,IAAI,CAAC,CAAC,CAAC;IAExC,yDAAyD;IACzD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAgB/D;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAI,IAAY,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI,IAAI,mBAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAEvK,4EAA4E;IACrE,MAAM,KAAK,aAAa,KAAa,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAEvE,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB,IAAa,OAAO,IAAA,2BAAY,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/F;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD,uHAAuH;IACvH;;;;;;OAMG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,8CAA8C;QACtF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,uBAAuB;QAC5B,MAAM,YAAY,GAAG,IAAI,gCAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACO,mBAAmB,CAAC,YAA6B;QACzD,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACzD,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE;YACtC,oGAAoG;YACpG,MAAM,gBAAgB,GAAI,OAAO,CAAC,oBAAoB,CAAyC,CAAC,gBAAgB,CAAC;YACjH,8HAA8H;YAC9H,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC1E,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;aACnD;SACF;IACH,CAAC;IAED;;;OAGG;IACO,2BAA2B,CAAC,aAAiC;QACrE,OAAO,CAAC,2BAA2B;IACrC,CAAC;CACF;AA3ID,wBA2IC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { Id64, Id64String, isSubclassOf } from \"@itwin/core-bentley\";\r\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity: true = true;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema;\r\n\r\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n  /** The name of the BIS class associated with this class.\r\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n   */\r\n  public static get className(): string { return \"Entity\"; }\r\n\r\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n   * This property makes such code slightly less tedious to read and write.\r\n   * @internal\r\n   */\r\n  public get asAny(): any { return this; }\r\n\r\n  /** The name of the BIS Schema that defines this class */\r\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n  /** The name of the BIS class associated with this class. */\r\n  public get className(): string { return this._ctor.className; }\r\n\r\n  /** The [[IModelDb]] that contains this Entity */\r\n  public iModel: IModelDb;\r\n\r\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n  public id: Id64String;\r\n\r\n  /** @internal */\r\n  constructor(props: EntityProps, iModel: IModelDb) {\r\n    this.iModel = iModel;\r\n    this.id = Id64.fromJSON(props.id);\r\n    // copy all auto-handled properties from input to the object being constructed\r\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n  }\r\n\r\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n   */\r\n  public toJSON(): EntityProps {\r\n    const val: any = {};\r\n    val.classFullName = this.classFullName;\r\n    if (Id64.isValid(this.id))\r\n      val.id = this.id;\r\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n    return val;\r\n  }\r\n\r\n  /** Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   */\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) { IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n  public get classFullName(): string { return this._ctor.classFullName; }\r\n\r\n  /** @internal */\r\n  public static get protectedOperations(): string[] { return []; }\r\n\r\n  /** return whether this Entity class is a subclass of another Entity class\r\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n   * typescript's restriction on the `this` type in static methods\r\n   */\r\n  public static is(otherClass: typeof Entity): boolean { return isSubclassOf(this, otherClass); }\r\n\r\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n   * ClassRegistry overrides this when generating a class\r\n   * @internal\r\n   */\r\n  public static get isGeneratedClass() { return false; }\r\n\r\n  // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds\r\n  /** Get the Ids of this element's *references*. A *reference* is an element that this element references.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet\r\n   *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).\r\n   * @see collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): Set<Id64String> {\r\n    const referenceIds = new Set<Id64String>();\r\n    this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation\r\n    return referenceIds;\r\n  }\r\n\r\n  /** This is the intended and future behavior of [[getReferenceIds]].\r\n   * In the next breaking change it will replace getReferenceIds, and is already used by the transformer\r\n   * @internal\r\n   */\r\n  public getReferenceConcreteIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceConcreteIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,\r\n   *       which does not accept plain Id64s, see EntityReferenceSet.\r\n   * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(referenceIds: Set<Id64String>): void {\r\n    const concreteEntityIds = this.getReferenceConcreteIds();\r\n    for (const entity of concreteEntityIds) {\r\n      // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention\r\n      const EntityReferences = (require(\"./EntityReferences\") as typeof import(\"./EntityReferences\")).EntityReferences;\r\n      // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else\r\n      if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {\r\n        referenceIds.add(EntityReferences.toId64(entity));\r\n      }\r\n    }\r\n  }\r\n\r\n  /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.\r\n   * In the next breaking change it will replace getReferenceIds\r\n   * @internal\r\n   */\r\n  protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n}\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T };\r\n"]}
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqE;AACrE,oDAAyG;AACzG,yCAAsC;AAGtC;;;;GAIG;AACH,MAAa,MAAM;IAQjB,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACH,IAAW,KAAK,KAAU,OAAO,IAAI,CAAC,CAAC,CAAC;IAExC,yDAAyD;IACzD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAQ/D,gBAAgB;IAChB,YAAY,KAAkB,EAAE,MAAgB;QAnChD;;WAEG;QACa,uBAAkB,GAAG,IAAa,CAAC;QAiCjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,IAAsB,EAAE,EAAE,CAAE,IAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,cAAc,CAAE,KAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrJ,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAI,IAAY,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI,IAAI,mBAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAEvK,4EAA4E;IACrE,MAAM,KAAK,aAAa,KAAa,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAEvE,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB,IAAa,OAAO,IAAA,2BAAY,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/F;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD,uHAAuH;IACvH;;;;;;OAMG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,8CAA8C;QACtF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,uBAAuB;QAC5B,MAAM,YAAY,GAAG,IAAI,gCAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACO,mBAAmB,CAAC,YAA6B;QACzD,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACzD,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE;YACtC,oGAAoG;YACpG,MAAM,gBAAgB,GAAI,OAAO,CAAC,oBAAoB,CAAyC,CAAC,gBAAgB,CAAC;YACjH,8HAA8H;YAC9H,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC1E,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;aACnD;SACF;IACH,CAAC;IAED;;;OAGG;IACO,2BAA2B,CAAC,aAAiC;QACrE,OAAO,CAAC,2BAA2B;IACrC,CAAC;CACF;AA3ID,wBA2IC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport { Id64, Id64String, isSubclassOf } from \"@itwin/core-bentley\";\r\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity = true as const;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema;\r\n\r\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n  /** The name of the BIS class associated with this class.\r\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n   */\r\n  public static get className(): string { return \"Entity\"; }\r\n\r\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n   * This property makes such code slightly less tedious to read and write.\r\n   * @internal\r\n   */\r\n  public get asAny(): any { return this; }\r\n\r\n  /** The name of the BIS Schema that defines this class */\r\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n  /** The name of the BIS class associated with this class. */\r\n  public get className(): string { return this._ctor.className; }\r\n\r\n  /** The [[IModelDb]] that contains this Entity */\r\n  public iModel: IModelDb;\r\n\r\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n  public id: Id64String;\r\n\r\n  /** @internal */\r\n  constructor(props: EntityProps, iModel: IModelDb) {\r\n    this.iModel = iModel;\r\n    this.id = Id64.fromJSON(props.id);\r\n    // copy all auto-handled properties from input to the object being constructed\r\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n  }\r\n\r\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n   */\r\n  public toJSON(): EntityProps {\r\n    const val: any = {};\r\n    val.classFullName = this.classFullName;\r\n    if (Id64.isValid(this.id))\r\n      val.id = this.id;\r\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n    return val;\r\n  }\r\n\r\n  /** Call a function for each property of this Entity.\r\n   * @param func The callback to be invoked on each property\r\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n   */\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) { IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n  public get classFullName(): string { return this._ctor.classFullName; }\r\n\r\n  /** @internal */\r\n  public static get protectedOperations(): string[] { return []; }\r\n\r\n  /** return whether this Entity class is a subclass of another Entity class\r\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n   * typescript's restriction on the `this` type in static methods\r\n   */\r\n  public static is(otherClass: typeof Entity): boolean { return isSubclassOf(this, otherClass); }\r\n\r\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n   * ClassRegistry overrides this when generating a class\r\n   * @internal\r\n   */\r\n  public static get isGeneratedClass() { return false; }\r\n\r\n  // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds\r\n  /** Get the Ids of this element's *references*. A *reference* is an element that this element references.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet\r\n   *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).\r\n   * @see collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): Set<Id64String> {\r\n    const referenceIds = new Set<Id64String>();\r\n    this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation\r\n    return referenceIds;\r\n  }\r\n\r\n  /** This is the intended and future behavior of [[getReferenceIds]].\r\n   * In the next breaking change it will replace getReferenceIds, and is already used by the transformer\r\n   * @internal\r\n   */\r\n  public getReferenceConcreteIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceConcreteIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,\r\n   *       which does not accept plain Id64s, see EntityReferenceSet.\r\n   * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(referenceIds: Set<Id64String>): void {\r\n    const concreteEntityIds = this.getReferenceConcreteIds();\r\n    for (const entity of concreteEntityIds) {\r\n      // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention\r\n      const EntityReferences = (require(\"./EntityReferences\") as typeof import(\"./EntityReferences\")).EntityReferences;\r\n      // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else\r\n      if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {\r\n        referenceIds.add(EntityReferences.toId64(entity));\r\n      }\r\n    }\r\n  }\r\n\r\n  /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.\r\n   * In the next breaking change it will replace getReferenceIds\r\n   * @internal\r\n   */\r\n  protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n}\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T };\r\n"]}