@itwin/core-backend 3.4.0 → 3.4.1

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;AAErE,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;CACvD;AApFD,wBAoFC","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, 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\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;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":["/*---------------------------------------------------------------------------------------------\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, isSubclassOf } from \"@itwin/core-bentley\";\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\nimport { IModelDb } from \"./IModelDb\";\nimport { Schema } from \"./Schema\";\n\n/** Represents an entity in an [[IModelDb]] such 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 = true;\n  /** The Schema that defines this class. */\n  public static schema: typeof Schema;\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  /** 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  /** @internal */\n  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    this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\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    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   */\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) { IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }\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  /** @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 { return isSubclassOf(this, otherClass); }\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  // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds\n  /** Get the Ids of this element's *references*. A *reference* is an element that this element references.\n   * This is important for cloning operations but can be useful in other situations as well.\n   * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet\n   *       which does not iterate plain Id64s, see [EntityReferenceSet]($backend).\n   * @see collectReferenceIds\n   * @internal\n   */\n  public getReferenceIds(): Set<Id64String> {\n    const referenceIds = new Set<Id64String>();\n    this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation\n    return referenceIds;\n  }\n\n  /** This is the intended and future behavior of [[getReferenceIds]].\n   * In the next breaking change it will replace getReferenceIds, and is already used by the transformer\n   * @internal\n   */\n  public getReferenceConcreteIds(): EntityReferenceSet {\n    const referenceIds = new EntityReferenceSet();\n    this.collectReferenceConcreteIds(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\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 In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,\n   *       which does not accept plain Id64s, see EntityReferenceSet.\n   * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\n   * @see getReferenceIds\n   * @internal\n   */\n  protected collectReferenceIds(referenceIds: Set<Id64String>): void {\n    const concreteEntityIds = this.getReferenceConcreteIds();\n    for (const entity of concreteEntityIds) {\n      // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention\n      const EntityReferences = (require(\"./EntityReferences\") as typeof import(\"./EntityReferences\")).EntityReferences;\n      // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else\n      if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {\n        referenceIds.add(EntityReferences.toId64(entity));\n      }\n    }\n  }\n\n  /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.\n   * In the next breaking change it will replace getReferenceIds\n   * @internal\n   */\n  protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void {\n    return; // no references by default\n  }\n}\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 };\n"]}

package/lib/cjs/EntityReferences.d.ts

@@ -0,0 +1,46 @@
+/** @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
+ * @internal
+ */
+export declare type ConcreteEntity = Element | Model | ElementAspect | Relationship;
+/** Props for a [[ConcreteEntity]]
+ * @internal
+ */
+export declare type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;
+/**
+ * Utilities for the [EntityReference]($common) type which is a kind of strings
+ * @internal
+ */
+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 */
+    function isValid(id: EntityReference): boolean;
+    /** create the invalid id for a concrete entity type */
+    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;
+    /** 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/cjs/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,oBAAY,cAAc,GAAG,OAAO,GAAG,KAAK,GAAG,aAAa,GAAG,YAAY,CAAC;AAE5E;;GAEG;AACH,oBAAY,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,CAG5E;IAED,8GAA8G;IAC9G,SAAgB,OAAO,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAEpD;IAED,uDAAuD;IACvD,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,qFAAqF;IACrF,SAAgB,aAAa,CAAC,WAAW,EAAE,OAAO,MAAM,GAAG,mBAAmB,CAW7E;CACF"}

package/lib/cjs/EntityReferences.js

@@ -0,0 +1,92 @@
+"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.EntityReferences = void 0;
+const core_common_1 = require("@itwin/core-common");
+const core_bentley_1 = require("@itwin/core-bentley");
+const Model_1 = require("./Model");
+const Element_1 = require("./Element");
+const ElementAspect_1 = require("./ElementAspect");
+const Relationship_1 = require("./Relationship");
+const assert = require("assert");
+/**
+ * Utilities for the [EntityReference]($common) type which is a kind of strings
+ * @internal
+ */
+var EntityReferences;
+(function (EntityReferences) {
+    function isModel(id) {
+        return id[0] === core_common_1.ConcreteEntityTypes.Model;
+    }
+    EntityReferences.isModel = isModel;
+    function isElement(id) {
+        return id[0] === core_common_1.ConcreteEntityTypes.Element;
+    }
+    EntityReferences.isElement = isElement;
+    function isElementAspect(id) {
+        return id[0] === core_common_1.ConcreteEntityTypes.ElementAspect;
+    }
+    EntityReferences.isElementAspect = isElementAspect;
+    function isRelationship(id) {
+        return id[0] === core_common_1.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) {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        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 */
+    function isValid(id) {
+        return core_bentley_1.Id64.isValid(toId64(id));
+    }
+    EntityReferences.isValid = isValid;
+    /** create the invalid id for a concrete entity type */
+    function makeInvalid(type) {
+        return `${type}${core_bentley_1.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;
+    /** the argument entityClass be concrete (i.e. not the Entity abstract base class) */
+    function typeFromClass(entityClass) {
+        if (entityClass.is(Element_1.Element))
+            return core_common_1.ConcreteEntityTypes.Element;
+        else if (entityClass.is(ElementAspect_1.ElementAspect))
+            return core_common_1.ConcreteEntityTypes.ElementAspect;
+        else if (entityClass.is(Model_1.Model))
+            return core_common_1.ConcreteEntityTypes.Model;
+        else if (entityClass.is(Relationship_1.Relationship))
+            return core_common_1.ConcreteEntityTypes.Relationship;
+        else
+            assert(false, "unknown or abstract entity type passed to EntityReferences.from");
+    }
+    EntityReferences.typeFromClass = typeFromClass;
+})(EntityReferences = exports.EntityReferences || (exports.EntityReferences = {}));
+//# sourceMappingURL=EntityReferences.js.map

package/lib/cjs/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,oDAAwH;AACxH,sDAAuD;AAEvD,mCAAgC;AAChC,uCAAoC;AACpC,mDAAgD;AAChD,iDAAiE;AACjE,iCAAiC;AAcjC;;;GAGG;AACH,IAAiB,gBAAgB,CA+DhC;AA/DD,WAAiB,gBAAgB;IAC/B,SAAgB,OAAO,CAAC,EAAmB;QACzC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,iCAAmB,CAAC,KAAK,CAAC;IAC7C,CAAC;IAFe,wBAAO,UAEtB,CAAA;IACD,SAAgB,SAAS,CAAC,EAAmB;QAC3C,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,iCAAmB,CAAC,OAAO,CAAC;IAC/C,CAAC;IAFe,0BAAS,YAExB,CAAA;IACD,SAAgB,eAAe,CAAC,EAAmB;QACjD,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,iCAAmB,CAAC,aAAa,CAAC;IACrD,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IACD,SAAgB,cAAc,CAAC,EAAmB;QAChD,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,iCAAmB,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,4EAA4E;QAC5E,OAAO,CAAC,EAAE,CAAC,CAAC,CAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAHe,sBAAK,QAGpB,CAAA;IAED,8GAA8G;IAC9G,SAAgB,OAAO,CAAC,EAAmB;QACzC,OAAO,mBAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,uDAAuD;IACvD,SAAgB,WAAW,CAAC,IAAyB;QACnD,OAAO,GAAG,IAAI,GAAG,mBAAI,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,qFAAqF;IACrF,SAAgB,aAAa,CAAC,WAA0B;QACtD,IAAI,WAAW,CAAC,EAAE,CAAC,iBAAO,CAAC;YACzB,OAAO,iCAAmB,CAAC,OAAO,CAAC;aAChC,IAAI,WAAW,CAAC,EAAE,CAAC,6BAAa,CAAC;YACpC,OAAO,iCAAmB,CAAC,aAAa,CAAC;aACtC,IAAI,WAAW,CAAC,EAAE,CAAC,aAAK,CAAC;YAC5B,OAAO,iCAAmB,CAAC,KAAK,CAAC;aAC9B,IAAI,WAAW,CAAC,EAAE,CAAC,2BAAY,CAAC;YACnC,OAAO,iCAAmB,CAAC,YAAY,CAAC;;YAExC,MAAM,CAAC,KAAK,EAAE,iEAAiE,CAAC,CAAC;IACrF,CAAC;IAXe,8BAAa,gBAW5B,CAAA;AACH,CAAC,EA/DgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QA+DhC","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 * @internal\n */\nexport type ConcreteEntity = Element | Model | ElementAspect | Relationship;\n\n/** Props for a [[ConcreteEntity]]\n * @internal\n */\nexport type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;\n\n/**\n * Utilities for the [EntityReference]($common) type which is a kind of strings\n * @internal\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    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\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  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  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  /** 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"]}