@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/esm/Entity.d.ts

@@ -0,0 +1,186 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback } from "@itwin/core-common";
+import type { IModelDb } from "./IModelDb";
+import { Schema } from "./Schema";
+import { EntityClass, Property, SchemaItemKey } from "@itwin/ecschema-metadata";
+/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.
+ * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.
+ * @beta */
+export interface ECSqlRow {
+    [key: string]: any;
+}
+/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.
+ * @beta */
+export interface DeserializeEntityArgs {
+    /** Row to deserialize */
+    row: ECSqlRow;
+    /** The IModel that contains this Entity */
+    iModel: IModelDb;
+    /** The options used when loading */
+    options?: {
+        /** Options used when loading an element */
+        element?: ElementLoadOptions;
+    };
+}
+/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.
+ * @beta */
+export interface CustomHandledProperty {
+    /** The name of the property as it appears in the ECSqlRow */
+    readonly propertyName: string;
+    /** Where the property is defined */
+    readonly source: "Class" | "Computed";
+}
+/** Represents one of the fundamental building block in an [[IModelDb]]: 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;
+    /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].
+     * @public @preview
+     */
+    static get schemaItemKey(): SchemaItemKey;
+    private _metadata?;
+    /** 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;
+    protected constructor(props: EntityProps, iModel: IModelDb);
+    /** Invoke the constructor of the specified `Entity` subclass.
+     * @internal
+     */
+    static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity;
+    /** List of properties that are need to be custom handled during deserialization and serialization.
+     * These properties differ between the ECSql instance of an Entity and the Entity itself.
+     * @beta */
+    protected static readonly _customHandledProps: CustomHandledProperty[];
+    /** Get the list of properties that are custom handled by this class and its superclasses.
+     * @internal */
+    private static getCustomHandledProperties;
+    /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.
+     * @beta */
+    static deserialize(props: DeserializeEntityArgs): EntityProps;
+    /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.
+     * @beta */
+    static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow;
+    /** 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.
+     * @deprecated in 5.0. Please use `forEach` to get the metadata and iterate over the properties instead.
+     *
+     * @example
+     * ```typescript
+     * // Deprecated method
+     * entity.forEachProperty((name, propMetaData) => {
+     *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);
+     * });
+     *
+     * // New method
+     * entity.forEach((name, property) => {
+     *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
+     * });
+     * ```
+     */
+    forEachProperty(func: PropertyCallback, includeCustom?: boolean): void;
+    /**
+     * 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.
+     * @throws Error if metadata for the class cannot be retrieved.
+     *
+     * @example
+     * ```typescript
+     * entity.forEach((name, property) => {
+     *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
+     * });
+     * ```
+     */
+    forEach(func: PropertyHandler, 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;
+    /**
+     * Get the item key used by the ecschema-metadata package to identify this entity class
+     * @public @preview
+     */
+    get schemaItemKey(): SchemaItemKey;
+    /** query metadata for this entity class from the iModel's schema
+     * @throws [[IModelError]] if there is a problem querying the schema
+     * @returns The metadata for the current entity
+     * @public @preview
+     */
+    getMetaData(): Promise<EntityClass>;
+    /** @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 set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id
+     * stored on the entity, in its EC properties or json fields.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @see this.collectReferenceIds
+     * @beta
+     */
+    getReferenceIds(): 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, including json fields.
+     * 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 This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
+     * @see getReferenceIds
+     * @beta
+     */
+    protected collectReferenceIds(_referenceIds: EntityReferenceSet): void;
+}
+/** A callback function to process properties of an Entity
+ * @public @preview
+ */
+export type PropertyHandler = (name: string, property: Property) => 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/esm/Entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AAC7H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGhF;;WAEW;AACX,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED;WACW;AACX,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,GAAG,EAAE,QAAQ,CAAC;IACd,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,CAAC;IACjB,oCAAoC;IACpC,OAAO,CAAC,EAAE;QACR,2CAA2C;QAC3C,OAAO,CAAC,EAAE,kBAAkB,CAAC;KAC9B,CAAA;CACF;AAED;WACW;AACX,MAAM,WAAW,qBAAqB;IACpC,6DAA6D;IAC7D,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;CACvC;AAED;;;;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;;OAEG;IACH,WAAkB,aAAa,IAAI,aAAa,CAG/C;IAED,OAAO,CAAC,SAAS,CAAC,CAAc;IAEhC;;;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;IAGtB,SAAS,aAAa,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAQ1D;;OAEG;WACW,WAAW,CAAC,QAAQ,EAAE,OAAO,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM;IAIhG;;eAEW;IACX,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,CAIpE;IAEF;mBACe;IACf,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAYzC;eACW;WACG,WAAW,CAAC,KAAK,EAAE,qBAAqB,GAAG,WAAW;IAyBpE;eACW;WACG,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,GAAG,QAAQ;IAcxE;;OAEG;IACI,MAAM,IAAI,WAAW;IAU5B;;;;;;;;;;;;;;;;;;OAkBG;IAEI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAK5E;;;;;;;;;;;;;OAaG;IACI,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,GAAE,OAAc;IAWnE,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IACvE;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,CAAqC;IAE9E;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAahD,gBAAgB;IAChB,WAAkB,mBAAmB,IAAI,MAAM,EAAE,CAAe;IAEhE;;;;;OAKG;WACW,EAAE,CAAC,UAAU,EAAE,OAAO,MAAM,GAAG,OAAO;IAKpD;;;OAGG;IACH,WAAkB,gBAAgB,YAAoB;IAEtD;;;;;OAKG;IACI,eAAe,IAAI,kBAAkB;IAM5C;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;CAGvE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/lib/esm/Entity.js

@@ -0,0 +1,244 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { Id64 } from "@itwin/core-bentley";
+import { EntityReferenceSet } from "@itwin/core-common";
+import { EntityClass, SchemaItemKey } from "@itwin/ecschema-metadata";
+import { _nativeDb } from "./internal/Symbols";
+/** Represents one of the fundamental building block in an [[IModelDb]]: 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 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]].
+     */
+    isInstanceOfEntity = true;
+    /** The Schema that defines this class. */
+    static schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels
+    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"; }
+    /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].
+     * @public @preview
+     */
+    static get schemaItemKey() {
+        // We cannot cache this here because the className gets overridden in subclasses
+        return new SchemaItemKey(this.className, this.schema.schemaKey);
+    }
+    _metadata;
+    /** 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; }
+    /** The [[IModelDb]] that contains this Entity */
+    iModel;
+    /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */
+    id;
+    constructor(props, iModel) {
+        this.iModel = iModel;
+        this.id = Id64.fromJSON(props.id);
+        // copy all auto-handled properties from input to the object being constructed
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        this.forEachProperty((propName, meta) => this[propName] = meta.createProperty(props[propName]), false);
+    }
+    /** Invoke the constructor of the specified `Entity` subclass.
+     * @internal
+     */
+    static instantiate(subclass, props, iModel) {
+        return new subclass(props, iModel);
+    }
+    /** List of properties that are need to be custom handled during deserialization and serialization.
+     * These properties differ between the ECSql instance of an Entity and the Entity itself.
+     * @beta */
+    static _customHandledProps = [
+        { propertyName: "id", source: "Class" },
+        { propertyName: "className", source: "Class" },
+        { propertyName: "jsonProperties", source: "Class" }
+    ];
+    /** Get the list of properties that are custom handled by this class and its superclasses.
+     * @internal */
+    static getCustomHandledProperties() {
+        if (this.name === "Entity") {
+            return this._customHandledProps;
+        }
+        const superClass = Object.getPrototypeOf(this);
+        return [
+            ...superClass.getCustomHandledProperties(),
+            ...this._customHandledProps,
+        ];
+    }
+    /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.
+     * @beta */
+    static deserialize(props) {
+        const enProps = {
+            classFullName: props.row.classFullName,
+            id: props.row.id,
+        };
+        // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js
+        if (props.row.jsonProperties) {
+            enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));
+        }
+        // Auto handles all properties that are not in the 'customHandledProperties' list
+        const customHandledProperties = this.getCustomHandledProperties();
+        Object.keys(props.row)
+            .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)
+            .forEach((propertyName) => enProps[propertyName] = props.row[propertyName]);
+        // Handles custom relClassNames to use '.' instead of ':'
+        Object.keys(enProps).forEach((propertyName) => {
+            if (enProps[propertyName].relClassName !== undefined && propertyName !== "modeledElement" && propertyName !== "parentModel") {
+                enProps[propertyName].relClassName = enProps[propertyName].relClassName.replace(':', '.');
+            }
+        });
+        return enProps;
+    }
+    /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.
+     * @beta */
+    static serialize(props, _iModel) {
+        const inst = {
+            classFullName: props.classFullName,
+            id: props.id,
+        };
+        const customHandledProperties = this.getCustomHandledProperties();
+        Object.keys(props)
+            .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)
+            .forEach((propertyName) => inst[propertyName] = props[propertyName]);
+        return inst;
+    }
+    /** 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 (Id64.isValid(this.id))
+            val.id = this.id;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        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.
+     * @deprecated in 5.0. Please use `forEach` to get the metadata and iterate over the properties instead.
+     *
+     * @example
+     * ```typescript
+     * // Deprecated method
+     * entity.forEachProperty((name, propMetaData) => {
+     *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);
+     * });
+     *
+     * // New method
+     * entity.forEach((name, property) => {
+     *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
+     * });
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    forEachProperty(func, includeCustom = true) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);
+    }
+    /**
+     * 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.
+     * @throws Error if metadata for the class cannot be retrieved.
+     *
+     * @example
+     * ```typescript
+     * entity.forEach((name, property) => {
+     *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
+     * });
+     * ```
+     */
+    forEach(func, includeCustom = true) {
+        const metaData = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, EntityClass);
+        if (!metaData)
+            throw new Error(`Cannot get metadata for ${this.classFullName}`);
+        for (const property of metaData.getPropertiesSync()) {
+            if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))
+                func(property.name, property);
+        }
+    }
+    /** 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; }
+    /**
+     * Get the item key used by the ecschema-metadata package to identify this entity class
+     * @public @preview
+     */
+    get schemaItemKey() { return this._ctor.schemaItemKey; }
+    /** query metadata for this entity class from the iModel's schema
+     * @throws [[IModelError]] if there is a problem querying the schema
+     * @returns The metadata for the current entity
+     * @public @preview
+     */
+    async getMetaData() {
+        if (!this._metadata) {
+            this._metadata = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, EntityClass);
+        }
+        if (!this._metadata) {
+            throw new Error(`Cannot get metadata for ${this.classFullName}`);
+        }
+        return this._metadata;
+    }
+    /** @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) {
+        // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.
+        return this === otherClass || this.prototype instanceof 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; }
+    /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id
+     * stored on the entity, in its EC properties or json fields.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @see this.collectReferenceIds
+     * @beta
+     */
+    getReferenceIds() {
+        const referenceIds = new EntityReferenceSet();
+        this.collectReferenceIds(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, including json fields.
+     * 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 This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
+     * @see getReferenceIds
+     * @beta
+     */
+    collectReferenceIds(_referenceIds) {
+        return; // no references by default
+    }
+}
+//# sourceMappingURL=Entity.js.map

package/lib/esm/Entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAmC,kBAAkB,EAAsC,MAAM,oBAAoB,CAAC;AAG7H,OAAO,EAAE,WAAW,EAAY,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAgC/C;;;;GAIG;AACH,MAAM,OAAO,MAAM;IACjB;;OAEG;IACa,kBAAkB,GAAG,IAAa,CAAC;IACnD,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAgB,CAAC,mGAAmG;IAExI,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACI,MAAM,KAAK,aAAa;QAC7B,gFAAgF;QAChF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAEO,SAAS,CAAe;IAEhC;;;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;IAE/D,iDAAiD;IAC1C,MAAM,CAAW;IAExB,kGAAkG;IAC3F,EAAE,CAAa;IAGtB,YAAsB,KAAkB,EAAE,MAAgB;QACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,4DAA4D;QAC5D,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,CAAC,WAAW,CAAC,QAAuB,EAAE,KAAkB,EAAE,MAAgB;QACrF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;eAEW;IACD,MAAM,CAAU,mBAAmB,GAA4B;QACvE,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QACvC,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE;QAC9C,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE;KACpD,CAAC;IAEF;mBACe;IACP,MAAM,CAAC,0BAA0B;QACvC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAkB,CAAC;QAChE,OAAO;YACL,GAAG,UAAU,CAAC,0BAA0B,EAAE;YAC1C,GAAG,IAAI,CAAC,mBAAmB;SAC5B,CAAC;IACJ,CAAC;IAED;eACW;IACJ,MAAM,CAAC,WAAW,CAAC,KAA4B;QACpD,MAAM,OAAO,GAAgB;YAC3B,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,aAAa;YACtC,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE;SACjB,CAAA;QAED,gIAAgI;QAChI,IAAI,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAC7B,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,iFAAiF;QACjF,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;aACnB,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,KAAK,YAAY,CAAC,KAAK,SAAS,CAAC;aAChH,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAE,OAAoB,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CACvF,CAAC;QACJ,yDAAyD;QACzD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC5C,IAAK,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,gBAAgB,IAAI,YAAY,KAAK,aAAa,EAAE,CAAC;gBACzI,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,GAAI,OAAoB,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACxH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;eACW;IACJ,MAAM,CAAC,SAAS,CAAC,KAAkB,EAAE,OAAiB;QAC3D,MAAM,IAAI,GAAa;YACrB,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,EAAE,EAAE,KAAK,CAAC,EAAE;SACb,CAAA;QAED,MAAM,uBAAuB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACf,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,KAAK,YAAY,CAAC,KAAK,SAAS,CAAC;aAChH,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAI,KAAkB,CAAC,YAAY,CAAC,CAChF,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,4DAA4D;QAC5D,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;;;;;;;;;;;;;;;;;;OAkBG;IACH,4DAA4D;IACrD,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI;QAC1E,4DAA4D;QAC5D,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,OAAO,CAAC,IAAqB,EAAE,gBAAyB,IAAI;QACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QAC9F,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAEnE,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,iBAAiB,EAAE,EAAE,CAAC;YACpD,IAAI,aAAa,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,+BAA+B,CAAC;gBACnF,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,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;IACvE;;;OAGG;IACH,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9E;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QAClG,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB;QACxC,6EAA6E;QAC7E,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,SAAS,YAAY,UAAU,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD;;;;;OAKG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACvC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACO,mBAAmB,CAAC,aAAiC;QAC7D,OAAO,CAAC,2BAA2B;IACrC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\nimport type { IModelDb } from \"./IModelDb\";\nimport { Schema } from \"./Schema\";\nimport { EntityClass, Property, SchemaItemKey } from \"@itwin/ecschema-metadata\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.\n * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.\n * @beta */\nexport interface ECSqlRow {\n  [key: string]: any\n}\n\n/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.\n * @beta */\nexport interface DeserializeEntityArgs {\n  /** Row to deserialize */\n  row: ECSqlRow;\n  /** The IModel that contains this Entity */\n  iModel: IModelDb;\n  /** The options used when loading */\n  options?: {\n    /** Options used when loading an element */\n    element?: ElementLoadOptions;\n  }\n}\n\n/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.\n * @beta */\nexport interface CustomHandledProperty {\n  /** The name of the property as it appears in the ECSqlRow */\n  readonly propertyName: string;\n  /** Where the property is defined */\n  readonly source: \"Class\" | \"Computed\";\n}\n\n/** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\n * @public\n */\nexport class Entity {\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\n   */\n  public readonly isInstanceOfEntity = true as const;\n  /** The Schema that defines this class. */\n  public static schema: typeof Schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels\n\n  private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\n\n  /** The name of the BIS class associated with this class.\n   * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\n   * Failure to do so will ordinarily result in an error when the class is registered, since there may only\n   * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\n   */\n  public static get className(): string { return \"Entity\"; }\n\n  /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].\n   * @public @preview\n   */\n  public static get schemaItemKey(): SchemaItemKey {\n    // We cannot cache this here because the className gets overridden in subclasses\n    return new SchemaItemKey(this.className, this.schema.schemaKey);\n  }\n\n  private _metadata?: EntityClass;\n\n  /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\n   * This property makes such code slightly less tedious to read and write.\n   * @internal\n   */\n  public get asAny(): any { return this; }\n\n  /** The name of the BIS Schema that defines this class */\n  public get schemaName(): string { return this._ctor.schema.schemaName; }\n\n  /** The name of the BIS class associated with this class. */\n  public get className(): string { return this._ctor.className; }\n\n  /** The [[IModelDb]] that contains this Entity */\n  public iModel: IModelDb;\n\n  /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\n  public id: Id64String;\n\n\n  protected constructor(props: EntityProps, iModel: IModelDb) {\n    this.iModel = iModel;\n    this.id = Id64.fromJSON(props.id);\n    // copy all auto-handled properties from input to the object being constructed\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\n  }\n\n  /** Invoke the constructor of the specified `Entity` subclass.\n   * @internal\n   */\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\n    return new subclass(props, iModel);\n  }\n\n  /** List of properties that are need to be custom handled during deserialization and serialization.\n   * These properties differ between the ECSql instance of an Entity and the Entity itself.\n   * @beta */\n  protected static readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"id\", source: \"Class\" },\n    { propertyName: \"className\", source: \"Class\" },\n    { propertyName: \"jsonProperties\", source: \"Class\" }\n  ];\n\n  /** Get the list of properties that are custom handled by this class and its superclasses.\n   * @internal */\n  private static getCustomHandledProperties(): readonly CustomHandledProperty[] {\n    if (this.name === \"Entity\") {\n      return this._customHandledProps;\n    }\n\n    const superClass = Object.getPrototypeOf(this) as typeof Entity;\n    return [\n      ...superClass.getCustomHandledProperties(),\n      ...this._customHandledProps,\n    ];\n  }\n\n  /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.\n   * @beta */\n  public static deserialize(props: DeserializeEntityArgs): EntityProps {\n    const enProps: EntityProps = {\n      classFullName: props.row.classFullName,\n      id: props.row.id,\n    }\n\n    // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js\n    if (props.row.jsonProperties) {\n      enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));\n    }\n    // Auto handles all properties that are not in the 'customHandledProperties' list\n    const customHandledProperties = this.getCustomHandledProperties();\n    Object.keys(props.row)\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\n      .forEach((propertyName) => (enProps as ECSqlRow)[propertyName] = props.row[propertyName]\n      );\n    // Handles custom relClassNames to use '.' instead of ':'\n    Object.keys(enProps).forEach((propertyName) => {\n      if ((enProps as ECSqlRow)[propertyName].relClassName !== undefined && propertyName !== \"modeledElement\" && propertyName !== \"parentModel\") {\n        (enProps as ECSqlRow)[propertyName].relClassName = (enProps as ECSqlRow)[propertyName].relClassName.replace(':', '.');\n      }\n    });\n    return enProps;\n  }\n\n  /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.\n   * @beta */\n  public static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow {\n    const inst: ECSqlRow = {\n      classFullName: props.classFullName,\n      id: props.id,\n    }\n\n    const customHandledProperties = this.getCustomHandledProperties();\n    Object.keys(props)\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\n      .forEach((propertyName) => inst[propertyName] = (props as ECSqlRow)[propertyName]\n      );\n    return inst;\n  }\n\n  /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\n   * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\n   */\n  public toJSON(): EntityProps {\n    const val: any = {};\n    val.classFullName = this.classFullName;\n    if (Id64.isValid(this.id))\n      val.id = this.id;\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\n    return val;\n  }\n\n  /** Call a function for each property of this Entity.\n   * @param func The callback to be invoked on each property\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\n   * @deprecated in 5.0. Please use `forEach` to get the metadata and iterate over the properties instead.\n   *\n   * @example\n   * ```typescript\n   * // Deprecated method\n   * entity.forEachProperty((name, propMetaData) => {\n   *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\n   * });\n   *\n   * // New method\n   * entity.forEach((name, property) => {\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\n   * });\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\n  }\n\n  /**\n   * Call a function for each property of this Entity.\n   * @param func The callback to be invoked on each property.\n   * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n   * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\n   * @throws Error if metadata for the class cannot be retrieved.\n   *\n   * @example\n   * ```typescript\n   * entity.forEach((name, property) => {\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\n   * });\n   * ```\n   */\n  public forEach(func: PropertyHandler, includeCustom: boolean = true) {\n    const metaData = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, EntityClass);\n    if (!metaData)\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n\n    for (const property of metaData.getPropertiesSync()) {\n      if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))\n        func(property.name, property);\n    }\n  }\n\n  /** Get the full BIS class name of this Entity in the form \"schema:class\" */\n  public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\n\n  /** Get the full BIS class name of this Entity in the form \"schema:class\". */\n  public get classFullName(): string { return this._ctor.classFullName; }\n  /**\n   * Get the item key used by the ecschema-metadata package to identify this entity class\n   * @public @preview\n   */\n  public get schemaItemKey(): SchemaItemKey { return this._ctor.schemaItemKey; }\n\n  /** query metadata for this entity class from the iModel's schema\n   * @throws [[IModelError]] if there is a problem querying the schema\n   * @returns The metadata for the current entity\n   * @public @preview\n   */\n  public async getMetaData(): Promise<EntityClass> {\n    if (!this._metadata) {\n      this._metadata = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, EntityClass);\n    }\n\n    if (!this._metadata) {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n\n    return this._metadata;\n  }\n\n\n  /** @internal */\n  public static get protectedOperations(): string[] { return []; }\n\n  /** return whether this Entity class is a subclass of another Entity class\n   * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\n   * inheritance, you can use [ECClass.is]($ecschema-metadata)\n   * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\n   * typescript's restriction on the `this` type in static methods\n   */\n  public static is(otherClass: typeof Entity): boolean {\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\n    return this === otherClass || this.prototype instanceof otherClass;\n  }\n\n  /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\n   * ClassRegistry overrides this when generating a class\n   * @internal\n   */\n  public static get isGeneratedClass() { return false; }\n\n  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\n   * stored on the entity, in its EC properties or json fields.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @see this.collectReferenceIds\n   * @beta\n   */\n  public getReferenceIds(): EntityReferenceSet {\n    const referenceIds = new EntityReferenceSet();\n    this.collectReferenceIds(referenceIds);\n    return referenceIds;\n  }\n\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @param _referenceIds The Id64Set to populate with reference Ids.\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\n   * @see getReferenceIds\n   * @beta\n   */\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\n    return; // no references by default\n  }\n}\n\n/** A callback function to process properties of an Entity\n * @public @preview\n */\nexport type PropertyHandler = (name: string, property: Property) => void;\n\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\n * @public\n */\nexport type EntityClassType<T> = Function & { prototype: T }; // eslint-disable-line @typescript-eslint/no-unsafe-function-type\n"]}

package/lib/esm/EntityReferences.d.ts

@@ -0,0 +1,50 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { ConcreteEntityTypes, ElementAspectProps, ElementProps, EntityReference, ModelProps } from "@itwin/core-common";
+import { Id64String } from "@itwin/core-bentley";
+import type { Entity } from "./Entity";
+import { Model } from "./Model";
+import { Element } from "./Element";
+import { ElementAspect } from "./ElementAspect";
+import { Relationship, RelationshipProps } from "./Relationship";
+/** Concrete classes that can be created, with the notable exception of CodeSpecs since it is does not derive from Entity
+ * other entity classes. In the future if there is a need
+ * to manage them this way, it can be added
+ * @alpha
+ */
+export type ConcreteEntity = Element | Model | ElementAspect | Relationship;
+/** Props for a [[ConcreteEntity]]
+ * @alpha
+ */
+export type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;
+/**
+ * Utilities for the [EntityReference]($common) type which is a kind of strings
+ * @alpha
+ */
+export declare namespace EntityReferences {
+    function isModel(id: EntityReference): boolean;
+    function isElement(id: EntityReference): boolean;
+    function isElementAspect(id: EntityReference): boolean;
+    function isRelationship(id: EntityReference): boolean;
+    function toId64(id: EntityReference): string;
+    /** split a concrete entity id into its type and raw id */
+    function split(id: EntityReference): [ConcreteEntityTypes, Id64String];
+    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
+     * @internal
+     */
+    function isValid(id: EntityReference): boolean;
+    /** create the invalid id for a concrete entity type
+     * @internal
+     */
+    function makeInvalid(type: ConcreteEntityTypes): EntityReference;
+    /** create an EntityReference given an entity */
+    function from(entity: ConcreteEntity): EntityReference;
+    /** create an EntityReference given an id and a JavaScript class */
+    function fromClass(id: Id64String, entityClass: typeof Entity): EntityReference;
+    /** Create an EntityReference quickly from an exact reference type and id */
+    function fromEntityType(id: Id64String, type: ConcreteEntityTypes): EntityReference;
+    /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */
+    function typeFromClass(entityClass: typeof Entity): ConcreteEntityTypes;
+}
+//# sourceMappingURL=EntityReferences.d.ts.map

package/lib/esm/EntityReferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityReferences.d.ts","sourceRoot":"","sources":["../../src/EntityReferences.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACxH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGjE;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,KAAK,GAAG,aAAa,GAAG,YAAY,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAErG;;;GAGG;AACH,yBAAiB,gBAAgB,CAAC;IAChC,SAAgB,OAAO,CAAC,EAAE,EAAE,eAAe,WAE1C;IACD,SAAgB,SAAS,CAAC,EAAE,EAAE,eAAe,WAE5C;IACD,SAAgB,eAAe,CAAC,EAAE,EAAE,eAAe,WAElD;IACD,SAAgB,cAAc,CAAC,EAAE,EAAE,eAAe,WAEjD;IACD,SAAgB,MAAM,CAAC,EAAE,EAAE,eAAe,UAEzC;IAED,0DAA0D;IAC1D,SAAgB,KAAK,CAAC,EAAE,EAAE,eAAe,GAAG,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAE5E;IAED;;OAEG;IACH,SAAgB,OAAO,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAEpD;IAED;;OAEG;IACH,SAAgB,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAEtE;IAED,gDAAgD;IAChD,SAAgB,IAAI,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAG5D;IAED,mEAAmE;IACnE,SAAgB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,MAAM,GAAG,eAAe,CAGrF;IAED,4EAA4E;IAC5E,SAAgB,cAAc,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAEzF;IAED,+FAA+F;IAC/F,SAAgB,aAAa,CAAC,WAAW,EAAE,OAAO,MAAM,GAAG,mBAAmB,CAW7E;CACF"}

package/lib/esm/EntityReferences.js

@@ -0,0 +1,92 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { ConcreteEntityTypes } from "@itwin/core-common";
+import { Id64 } from "@itwin/core-bentley";
+import { Model } from "./Model";
+import { Element } from "./Element";
+import { ElementAspect } from "./ElementAspect";
+import { Relationship } from "./Relationship";
+import * as assert from "assert";
+/**
+ * Utilities for the [EntityReference]($common) type which is a kind of strings
+ * @alpha
+ */
+export var EntityReferences;
+(function (EntityReferences) {
+    function isModel(id) {
+        return id[0] === ConcreteEntityTypes.Model;
+    }
+    EntityReferences.isModel = isModel;
+    function isElement(id) {
+        return id[0] === ConcreteEntityTypes.Element;
+    }
+    EntityReferences.isElement = isElement;
+    function isElementAspect(id) {
+        return id[0] === ConcreteEntityTypes.ElementAspect;
+    }
+    EntityReferences.isElementAspect = isElementAspect;
+    function isRelationship(id) {
+        return id[0] === ConcreteEntityTypes.Relationship;
+    }
+    EntityReferences.isRelationship = isRelationship;
+    function toId64(id) {
+        return id.slice(1);
+    }
+    EntityReferences.toId64 = toId64;
+    /** split a concrete entity id into its type and raw id */
+    function split(id) {
+        return [id[0], id.slice(1)];
+    }
+    EntityReferences.split = split;
+    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
+     * @internal
+     */
+    function isValid(id) {
+        return Id64.isValid(toId64(id));
+    }
+    EntityReferences.isValid = isValid;
+    /** create the invalid id for a concrete entity type
+     * @internal
+     */
+    function makeInvalid(type) {
+        return `${type}${Id64.invalid}`;
+    }
+    EntityReferences.makeInvalid = makeInvalid;
+    /** create an EntityReference given an entity */
+    function from(entity) {
+        const type = typeFromClass(entity.constructor);
+        return `${type}${entity.id}`;
+    }
+    EntityReferences.from = from;
+    /** create an EntityReference given an id and a JavaScript class */
+    function fromClass(id, entityClass) {
+        const type = typeFromClass(entityClass);
+        return `${type}${id}`;
+    }
+    EntityReferences.fromClass = fromClass;
+    /** Create an EntityReference quickly from an exact reference type and id */
+    function fromEntityType(id, type) {
+        return `${type}${id}`;
+    }
+    EntityReferences.fromEntityType = fromEntityType;
+    /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */
+    function typeFromClass(entityClass) {
+        if (entityClass.is(Element))
+            return ConcreteEntityTypes.Element;
+        else if (entityClass.is(ElementAspect))
+            return ConcreteEntityTypes.ElementAspect;
+        else if (entityClass.is(Model))
+            return ConcreteEntityTypes.Model;
+        else if (entityClass.is(Relationship))
+            return ConcreteEntityTypes.Relationship;
+        else
+            assert(false, "unknown or abstract entity type passed to EntityReferences.from");
+    }
+    EntityReferences.typeFromClass = typeFromClass;
+})(EntityReferences || (EntityReferences = {}));
+//# sourceMappingURL=EntityReferences.js.map

package/lib/esm/EntityReferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityReferences.js","sourceRoot":"","sources":["../../src/EntityReferences.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAiE,MAAM,oBAAoB,CAAC;AACxH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAqB,MAAM,gBAAgB,CAAC;AACjE,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAcjC;;;GAGG;AACH,MAAM,KAAW,gBAAgB,CAkEhC;AAlED,WAAiB,gBAAgB;IAC/B,SAAgB,OAAO,CAAC,EAAmB;QACzC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,KAAK,CAAC;IAC7C,CAAC;IAFe,wBAAO,UAEtB,CAAA;IACD,SAAgB,SAAS,CAAC,EAAmB;QAC3C,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,OAAO,CAAC;IAC/C,CAAC;IAFe,0BAAS,YAExB,CAAA;IACD,SAAgB,eAAe,CAAC,EAAmB;QACjD,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,aAAa,CAAC;IACrD,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IACD,SAAgB,cAAc,CAAC,EAAmB;QAChD,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,mBAAmB,CAAC,YAAY,CAAC;IACpD,CAAC;IAFe,+BAAc,iBAE7B,CAAA;IACD,SAAgB,MAAM,CAAC,EAAmB;QACxC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IAFe,uBAAM,SAErB,CAAA;IAED,0DAA0D;IAC1D,SAAgB,KAAK,CAAC,EAAmB;QACvC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAFe,sBAAK,QAEpB,CAAA;IAED;;OAEG;IACH,SAAgB,OAAO,CAAC,EAAmB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED;;OAEG;IACH,SAAgB,WAAW,CAAC,IAAyB;QACnD,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAClC,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,gDAAgD;IAChD,SAAgB,IAAI,CAAC,MAAsB;QACzC,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,WAA4B,CAAC,CAAC;QAChE,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,EAAE,EAAE,CAAC;IAC/B,CAAC;IAHe,qBAAI,OAGnB,CAAA;IAED,mEAAmE;IACnE,SAAgB,SAAS,CAAC,EAAc,EAAE,WAA0B;QAClE,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC;IACxB,CAAC;IAHe,0BAAS,YAGxB,CAAA;IAED,4EAA4E;IAC5E,SAAgB,cAAc,CAAC,EAAc,EAAE,IAAyB;QACtE,OAAO,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC;IACxB,CAAC;IAFe,+BAAc,iBAE7B,CAAA;IAED,+FAA+F;IAC/F,SAAgB,aAAa,CAAC,WAA0B;QACtD,IAAI,WAAW,CAAC,EAAE,CAAC,OAAO,CAAC;YACzB,OAAO,mBAAmB,CAAC,OAAO,CAAC;aAChC,IAAI,WAAW,CAAC,EAAE,CAAC,aAAa,CAAC;YACpC,OAAO,mBAAmB,CAAC,aAAa,CAAC;aACtC,IAAI,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC;YAC5B,OAAO,mBAAmB,CAAC,KAAK,CAAC;aAC9B,IAAI,WAAW,CAAC,EAAE,CAAC,YAAY,CAAC;YACnC,OAAO,mBAAmB,CAAC,YAAY,CAAC;;YAExC,MAAM,CAAC,KAAK,EAAE,iEAAiE,CAAC,CAAC;IACrF,CAAC;IAXe,8BAAa,gBAW5B,CAAA;AACH,CAAC,EAlEgB,gBAAgB,KAAhB,gBAAgB,QAkEhC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { ConcreteEntityTypes, ElementAspectProps, ElementProps, EntityReference, ModelProps } from \"@itwin/core-common\";\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\nimport type { Entity } from \"./Entity\";\nimport { Model } from \"./Model\";\nimport { Element } from \"./Element\";\nimport { ElementAspect } from \"./ElementAspect\";\nimport { Relationship, RelationshipProps } from \"./Relationship\";\nimport * as assert from \"assert\";\n\n/** Concrete classes that can be created, with the notable exception of CodeSpecs since it is does not derive from Entity\n * other entity classes. In the future if there is a need\n * to manage them this way, it can be added\n * @alpha\n */\nexport type ConcreteEntity = Element | Model | ElementAspect | Relationship;\n\n/** Props for a [[ConcreteEntity]]\n * @alpha\n */\nexport type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;\n\n/**\n * Utilities for the [EntityReference]($common) type which is a kind of strings\n * @alpha\n */\nexport namespace EntityReferences {\n  export function isModel(id: EntityReference) {\n    return id[0] === ConcreteEntityTypes.Model;\n  }\n  export function isElement(id: EntityReference) {\n    return id[0] === ConcreteEntityTypes.Element;\n  }\n  export function isElementAspect(id: EntityReference) {\n    return id[0] === ConcreteEntityTypes.ElementAspect;\n  }\n  export function isRelationship(id: EntityReference) {\n    return id[0] === ConcreteEntityTypes.Relationship;\n  }\n  export function toId64(id: EntityReference) {\n    return id.slice(1);\n  }\n\n  /** split a concrete entity id into its type and raw id */\n  export function split(id: EntityReference): [ConcreteEntityTypes, Id64String] {\n    return [id[0] as ConcreteEntityTypes, id.slice(1)];\n  }\n\n  /** used by the transformer to figure out where to check for the existence in a db of a concrete element id\n   * @internal\n   */\n  export function isValid(id: EntityReference): boolean {\n    return Id64.isValid(toId64(id));\n  }\n\n  /** create the invalid id for a concrete entity type\n   * @internal\n   */\n  export function makeInvalid(type: ConcreteEntityTypes): EntityReference {\n    return `${type}${Id64.invalid}`;\n  }\n\n  /** create an EntityReference given an entity */\n  export function from(entity: ConcreteEntity): EntityReference {\n    const type = typeFromClass(entity.constructor as typeof Entity);\n    return `${type}${entity.id}`;\n  }\n\n  /** create an EntityReference given an id and a JavaScript class */\n  export function fromClass(id: Id64String, entityClass: typeof Entity): EntityReference {\n    const type = typeFromClass(entityClass);\n    return `${type}${id}`;\n  }\n\n  /** Create an EntityReference quickly from an exact reference type and id */\n  export function fromEntityType(id: Id64String, type: ConcreteEntityTypes): EntityReference {\n    return `${type}${id}`;\n  }\n\n  /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */\n  export function typeFromClass(entityClass: typeof Entity): ConcreteEntityTypes {\n    if (entityClass.is(Element))\n      return ConcreteEntityTypes.Element;\n    else if (entityClass.is(ElementAspect))\n      return ConcreteEntityTypes.ElementAspect;\n    else if (entityClass.is(Model))\n      return ConcreteEntityTypes.Model;\n    else if (entityClass.is(Relationship))\n      return ConcreteEntityTypes.Relationship;\n    else\n      assert(false, \"unknown or abstract entity type passed to EntityReferences.from\");\n  }\n}\n"]}