@itwin/core-backend 5.1.0-dev.9 → 5.1.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,sDAAuD;AACvD,oDAA6H;AAG7H,gEAAgF;AAChF,gDAA+C;AAgC/C;;;;GAIG;AACH,MAAa,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,iCAAa,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,mBAAI,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,mBAAS,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,mBAAI,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,+BAAW,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,+BAAW,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,gCAAkB,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;;AArQH,wBAsQC","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"]}
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,oDAA6H;AAG7H,gEAA4G;AAC5G,gDAA+C;AAgC/C;;;;GAIG;AACH,MAAa,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,iCAAa,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,sCAAsC;IAC5B,SAAS,CAAmC;IAEtD;;;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,mBAAI,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,mBAAS,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,mBAAI,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,IAAI,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE/F,IAAI,+BAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnF,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;gBAChD,IAAI,aAAa,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,+BAA+B,CAAC;oBACnF,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,qDAAqD,CAAC,CAAC;QACtH,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,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,2BAAO,CAAC,CAAC;QAC3F,IAAI,+BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,eAAe;QACpB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,EAAE,2BAAO,CAAC,CAAC;QACzF,IAAI,+BAAW,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,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,gCAAkB,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;;AAxRH,wBAyRC","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 } from \"@itwin/core-bentley\";\r\nimport { ElementLoadOptions, EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport type { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\nimport { ECClass, EntityClass, Property, RelationshipClass, SchemaItemKey } from \"@itwin/ecschema-metadata\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n/** Represents a row returned by an ECSql query. The row is returned as a map of property names to values.\r\n * ECSqlRow has same schema as declared in ECSchema for the class and similar to if ECSQL SELECT * FROM <schema>:<class> were executed.\r\n * @beta */\r\nexport interface ECSqlRow {\r\n  [key: string]: any\r\n}\r\n\r\n/** Set of properties that are used to deserialize an [[EntityProps]] from an ECSqlRow.\r\n * @beta */\r\nexport interface DeserializeEntityArgs {\r\n  /** Row to deserialize */\r\n  row: ECSqlRow;\r\n  /** The IModel that contains this Entity */\r\n  iModel: IModelDb;\r\n  /** The options used when loading */\r\n  options?: {\r\n    /** Options used when loading an element */\r\n    element?: ElementLoadOptions;\r\n  }\r\n}\r\n\r\n/** A property of an [[Entity]] that needs to be custom handled during deserialization and serialization.\r\n * @beta */\r\nexport interface CustomHandledProperty {\r\n  /** The name of the property as it appears in the ECSqlRow */\r\n  readonly propertyName: string;\r\n  /** Where the property is defined */\r\n  readonly source: \"Class\" | \"Computed\";\r\n}\r\n\r\n/** Represents one of the fundamental building block in an [[IModelDb]]: 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 @preview\r\n */\r\nexport class Entity {\r\n  /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n   * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n   */\r\n  public readonly isInstanceOfEntity = true as const;\r\n  /** The Schema that defines this class. */\r\n  public static schema: typeof Schema; // TODO: Schema key on the static level, but it requires a version which may differ between imodels\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  /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].\r\n   * @public @preview\r\n   */\r\n  public static get schemaItemKey(): SchemaItemKey {\r\n    // We cannot cache this here because the className gets overridden in subclasses\r\n    return new SchemaItemKey(this.className, this.schema.schemaKey);\r\n  }\r\n\r\n  /** Cached Metadata for the ECClass */\r\n  protected _metadata?: EntityClass | RelationshipClass;\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\r\n  protected 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    // eslint-disable-next-line @typescript-eslint/no-deprecated\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  /** Invoke the constructor of the specified `Entity` subclass.\r\n   * @internal\r\n   */\r\n  public static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity {\r\n    return new subclass(props, iModel);\r\n  }\r\n\r\n  /** List of properties that are need to be custom handled during deserialization and serialization.\r\n   * These properties differ between the ECSql instance of an Entity and the Entity itself.\r\n   * @beta */\r\n  protected static readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"id\", source: \"Class\" },\r\n    { propertyName: \"className\", source: \"Class\" },\r\n    { propertyName: \"jsonProperties\", source: \"Class\" }\r\n  ];\r\n\r\n  /** Get the list of properties that are custom handled by this class and its superclasses.\r\n   * @internal */\r\n  private static getCustomHandledProperties(): readonly CustomHandledProperty[] {\r\n    if (this.name === \"Entity\") {\r\n      return this._customHandledProps;\r\n    }\r\n\r\n    const superClass = Object.getPrototypeOf(this) as typeof Entity;\r\n    return [\r\n      ...superClass.getCustomHandledProperties(),\r\n      ...this._customHandledProps,\r\n    ];\r\n  }\r\n\r\n  /** Converts an ECSqlRow of an Entity to an EntityProps. This is used to deserialize an Entity from the database.\r\n   * @beta */\r\n  public static deserialize(props: DeserializeEntityArgs): EntityProps {\r\n    const enProps: EntityProps = {\r\n      classFullName: props.row.classFullName,\r\n      id: props.row.id,\r\n    }\r\n\r\n    // Handles cases where id64 ints are stored in the jsonProperties and converts them to hex before parsing as a json object in js\r\n    if (props.row.jsonProperties) {\r\n      enProps.jsonProperties = JSON.parse(props.iModel[_nativeDb].patchJsonProperties(props.row.jsonProperties));\r\n    }\r\n    // Auto handles all properties that are not in the 'customHandledProperties' list\r\n    const customHandledProperties = this.getCustomHandledProperties();\r\n    Object.keys(props.row)\r\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\r\n      .forEach((propertyName) => (enProps as ECSqlRow)[propertyName] = props.row[propertyName]\r\n      );\r\n    // Handles custom relClassNames to use '.' instead of ':'\r\n    Object.keys(enProps).forEach((propertyName) => {\r\n      if ((enProps as ECSqlRow)[propertyName].relClassName !== undefined && propertyName !== \"modeledElement\" && propertyName !== \"parentModel\") {\r\n        (enProps as ECSqlRow)[propertyName].relClassName = (enProps as ECSqlRow)[propertyName].relClassName.replace(':', '.');\r\n      }\r\n    });\r\n    return enProps;\r\n  }\r\n\r\n  /** Converts an EntityProps to an ECSqlRow. This is used to serialize an Entity to prepare to write it to the database.\r\n   * @beta */\r\n  public static serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow {\r\n    const inst: ECSqlRow = {\r\n      classFullName: props.classFullName,\r\n      id: props.id,\r\n    }\r\n\r\n    const customHandledProperties = this.getCustomHandledProperties();\r\n    Object.keys(props)\r\n      .filter((propertyName) => customHandledProperties.find((val) => val.propertyName === propertyName) === undefined)\r\n      .forEach((propertyName) => inst[propertyName] = (props as ECSqlRow)[propertyName]\r\n      );\r\n    return inst;\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    // eslint-disable-next-line @typescript-eslint/no-deprecated\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   * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `forEach` to get the metadata and iterate over the properties instead.\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * // Deprecated method\r\n   * entity.forEachProperty((name, propMetaData) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);\r\n   * });\r\n   *\r\n   * // New method\r\n   * entity.forEach((name, property) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\r\n   * });\r\n   * ```\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.iModel.forEachMetaData(this.classFullName, true, func, includeCustom);\r\n  }\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   * @throws Error if metadata for the class cannot be retrieved.\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * entity.forEach((name, property) => {\r\n   *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);\r\n   * });\r\n   * ```\r\n   */\r\n  public forEach(func: PropertyHandler, includeCustom: boolean = true) {\r\n    const item = this._metadata ?? this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey);\r\n\r\n    if (EntityClass.isEntityClass(item) || RelationshipClass.isRelationshipClass(item)) {\r\n      for (const property of item.getPropertiesSync()) {\r\n        if (includeCustom || !property.customAttributes?.has(`BisCore.CustomHandledProperty`))\r\n          func(property.name, property);\r\n      }\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}. Class is not an EntityClass or RelationshipClass.`);\r\n    }\r\n  }\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   * Get the item key used by the ecschema-metadata package to identify this entity class\r\n   * @public @preview\r\n   */\r\n  public get schemaItemKey(): SchemaItemKey { return this._ctor.schemaItemKey; }\r\n\r\n  /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.\r\n   * @throws [[IModelError]] if there is a problem querying the schema\r\n   * @returns The metadata for the current entity\r\n   * @public @preview\r\n   */\r\n  public async getMetaData(): Promise<EntityClass | RelationshipClass> {\r\n    if (this._metadata) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const ecClass = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ECClass);\r\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\r\n      this._metadata = ecClass;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public getMetaDataSync(): EntityClass | RelationshipClass {\r\n    if (this._metadata) {\r\n      return this._metadata;\r\n    }\r\n\r\n    const ecClass = this.iModel.schemaContext.getSchemaItemSync(this.schemaItemKey, ECClass);\r\n    if (EntityClass.isEntityClass(ecClass) || RelationshipClass.isRelationshipClass(ecClass)) {\r\n      this._metadata = ecClass;\r\n      return this._metadata;\r\n    } else {\r\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\r\n    }\r\n  }\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 {\r\n    // inline of @itwin/core-bentley's isSubclassOf due to protected constructor.\r\n    return this === otherClass || this.prototype instanceof otherClass;\r\n  }\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  /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id\r\n   * stored on the entity, in its EC properties or json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @see this.collectReferenceIds\r\n   * @beta\r\n   */\r\n  public getReferenceIds(): EntityReferenceSet {\r\n    const referenceIds = new EntityReferenceSet();\r\n    this.collectReferenceIds(referenceIds);\r\n    return referenceIds;\r\n  }\r\n\r\n  /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n   * A *reference* is any entity referenced by this entity's EC Data, including json fields.\r\n   * This is important for cloning operations but can be useful in other situations as well.\r\n   * @param _referenceIds The Id64Set to populate with reference Ids.\r\n   * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n   * @see getReferenceIds\r\n   * @beta\r\n   */\r\n  protected collectReferenceIds(_referenceIds: EntityReferenceSet): void {\r\n    return; // no references by default\r\n  }\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @public @preview\r\n */\r\nexport type PropertyHandler = (name: string, property: Property) => void;\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 @preview\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T }; // eslint-disable-line @typescript-eslint/no-unsafe-function-type\r\n"]}

package/lib/cjs/EntityReferences.js.map

@@ -1 +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,CAkEhC;AAlED,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,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,mBAAI,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,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,+FAA+F;IAC/F,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,EAlEgB,gBAAgB,gCAAhB,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"]}
+{"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,CAkEhC;AAlED,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,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,mBAAI,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,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,+FAA+F;IAC/F,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,EAlEgB,gBAAgB,gCAAhB,gBAAgB,QAkEhC","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 { ConcreteEntityTypes, ElementAspectProps, ElementProps, EntityReference, ModelProps } from \"@itwin/core-common\";\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport type { Entity } from \"./Entity\";\r\nimport { Model } from \"./Model\";\r\nimport { Element } from \"./Element\";\r\nimport { ElementAspect } from \"./ElementAspect\";\r\nimport { Relationship, RelationshipProps } from \"./Relationship\";\r\nimport * as assert from \"assert\";\r\n\r\n/** Concrete classes that can be created, with the notable exception of CodeSpecs since it is does not derive from Entity\r\n * other entity classes. In the future if there is a need\r\n * to manage them this way, it can be added\r\n * @alpha\r\n */\r\nexport type ConcreteEntity = Element | Model | ElementAspect | Relationship;\r\n\r\n/** Props for a [[ConcreteEntity]]\r\n * @alpha\r\n */\r\nexport type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;\r\n\r\n/**\r\n * Utilities for the [EntityReference]($common) type which is a kind of strings\r\n * @alpha\r\n */\r\nexport namespace EntityReferences {\r\n  export function isModel(id: EntityReference) {\r\n    return id[0] === ConcreteEntityTypes.Model;\r\n  }\r\n  export function isElement(id: EntityReference) {\r\n    return id[0] === ConcreteEntityTypes.Element;\r\n  }\r\n  export function isElementAspect(id: EntityReference) {\r\n    return id[0] === ConcreteEntityTypes.ElementAspect;\r\n  }\r\n  export function isRelationship(id: EntityReference) {\r\n    return id[0] === ConcreteEntityTypes.Relationship;\r\n  }\r\n  export function toId64(id: EntityReference) {\r\n    return id.slice(1);\r\n  }\r\n\r\n  /** split a concrete entity id into its type and raw id */\r\n  export function split(id: EntityReference): [ConcreteEntityTypes, Id64String] {\r\n    return [id[0] as ConcreteEntityTypes, id.slice(1)];\r\n  }\r\n\r\n  /** used by the transformer to figure out where to check for the existence in a db of a concrete element id\r\n   * @internal\r\n   */\r\n  export function isValid(id: EntityReference): boolean {\r\n    return Id64.isValid(toId64(id));\r\n  }\r\n\r\n  /** create the invalid id for a concrete entity type\r\n   * @internal\r\n   */\r\n  export function makeInvalid(type: ConcreteEntityTypes): EntityReference {\r\n    return `${type}${Id64.invalid}`;\r\n  }\r\n\r\n  /** create an EntityReference given an entity */\r\n  export function from(entity: ConcreteEntity): EntityReference {\r\n    const type = typeFromClass(entity.constructor as typeof Entity);\r\n    return `${type}${entity.id}`;\r\n  }\r\n\r\n  /** create an EntityReference given an id and a JavaScript class */\r\n  export function fromClass(id: Id64String, entityClass: typeof Entity): EntityReference {\r\n    const type = typeFromClass(entityClass);\r\n    return `${type}${id}`;\r\n  }\r\n\r\n  /** Create an EntityReference quickly from an exact reference type and id */\r\n  export function fromEntityType(id: Id64String, type: ConcreteEntityTypes): EntityReference {\r\n    return `${type}${id}`;\r\n  }\r\n\r\n  /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */\r\n  export function typeFromClass(entityClass: typeof Entity): ConcreteEntityTypes {\r\n    if (entityClass.is(Element))\r\n      return ConcreteEntityTypes.Element;\r\n    else if (entityClass.is(ElementAspect))\r\n      return ConcreteEntityTypes.ElementAspect;\r\n    else if (entityClass.is(Model))\r\n      return ConcreteEntityTypes.Model;\r\n    else if (entityClass.is(Relationship))\r\n      return ConcreteEntityTypes.Relationship;\r\n    else\r\n      assert(false, \"unknown or abstract entity type passed to EntityReferences.from\");\r\n  }\r\n}\r\n"]}

package/lib/cjs/ExportGraphics.d.ts

@@ -49,7 +49,7 @@ export interface ExportGraphicsMesh {
     normals: Float32Array;
     /** Parameters (uvs) for this mesh, laid out in the pattern XYXY */
     params: Float32Array;
-    /** If true, clients should assume both sides of the mesh are visible and not cull backfaces. */
+    /** If true, clients should assume both sides of the mesh are visible and not cull back faces. */
     isTwoSided: boolean;
 }
 /** Info provided to ExportGraphicsFunction about graphics.
@@ -273,18 +273,19 @@ export declare class ExportGraphicsMeshVisitor extends PolyfaceData implements P
     private _nextFacetIndex;
     private _numWrap;
     private _polyface;
-    private constructor();
+    protected constructor(facets: ExportGraphicsMesh, numWrap: number);
     /** Create a visitor for iterating the facets of `polyface`, with indicated number of points to be added to each facet to produce closed point arrays
      * Typical wrap counts are:
-     * * 0 -- leave the point arrays with "missing final edge"
+     * * 0 -- leave the point arrays with "missing final edge" (default)
      * * 1 -- add point 0 as closure point
      * * 2 -- add points 0 and 1 as closure and wrap point.  This is useful when vertex visit requires two adjacent vectors, e.g. for cross products.
      */
-    static create(polyface: ExportGraphicsMesh, numWrap: number): ExportGraphicsMeshVisitor;
-    /** Reset the iterator to start at the first facet of the polyface. */
+    static create(polyface: ExportGraphicsMesh, numWrap?: number): ExportGraphicsMeshVisitor;
+    /** Restart the visitor at the first facet. */
     reset(): void;
     /** Select a facet by simple index. */
     moveToReadIndex(facetIndex: number): boolean;
+    /** Load data for the next facet. */
     moveToNextFacet(): boolean;
     /** Set the number of vertices to replicate in visitor arrays. */
     setNumWrap(numWrap: number): void;
@@ -300,12 +301,12 @@ export declare class ExportGraphicsMeshVisitor extends PolyfaceData implements P
      * Use the artificial paramIndex, which matches pointIndex.
      */
     clientNormalIndex(i: number): number;
-    /** Return the color index of vertex i within the currently loaded facet */
+    /** Always returns -1 since we never have colors. */
     clientColorIndex(_i: number): number;
-    /** Return the aux data index of vertex i within the currently loaded facet */
+    /** Always returns -1 since we never have auxiliary data. */
     clientAuxIndex(_i: number): number;
     /** return the client polyface */
-    clientPolyface(): Polyface;
+    clientPolyface(): Polyface | undefined;
     /** clear the contents of all arrays.  Use this along with transferDataFrom methods to build up new facets */
     clearArrays(): void;
     /** transfer interpolated data from the other visitor.
@@ -314,5 +315,50 @@ export declare class ExportGraphicsMeshVisitor extends PolyfaceData implements P
     pushInterpolatedDataFrom(other: PolyfaceVisitor, index0: number, fraction: number, index1: number): void;
     /** transfer data from a specified index of the other visitor as new data in this visitor. */
     pushDataFrom(other: PolyfaceVisitor, index: number): void;
+    /** Return the number of facets this visitor is able to visit */
+    getVisitableFacetCount(): number;
+    /** Create a visitor for a subset of the facets visitable by the instance. */
+    createSubsetVisitor(facetIndices: number[], numWrap?: number): ExportGraphicsMeshSubsetVisitor;
+}
+/**
+ * An `ExportGraphicsMeshSubsetVisitor` is an `ExportGraphicsMeshVisitor` which only visits a subset of the facets.
+ * * The subset is defined by an array of facet indices provided when this visitor is created.
+ * * Input indices (e.g., for `moveToReadIndex`) are understood to be indices into the subset array.
+ * @public
+ */
+export declare class ExportGraphicsMeshSubsetVisitor extends ExportGraphicsMeshVisitor {
+    private _facetIndices;
+    private _currentSubsetIndex;
+    private _nextSubsetIndex;
+    private constructor();
+    private isValidSubsetIndex;
+    /**
+     * Create a visitor for iterating a subset of the facets of `polyface`.
+     * @param polyface reference to the client polyface, supplying facets
+     * @param facetIndices array of indices of facets in the client polyface to visit. This array is cloned.
+     * @param numWrap number of vertices replicated in the visitor arrays to facilitate simpler caller code. Default is zero.
+     */
+    static createSubsetVisitor(polyface: ExportGraphicsMesh, facetIndices: number[], numWrap?: number): ExportGraphicsMeshSubsetVisitor;
+    /**
+     * Advance the iterator to a particular facet in the subset of client polyface facets.
+     * @param subsetIndex index into the subset array, not to be confused with the client facet index.
+     * @return whether the iterator was successfully moved.
+     */
+    moveToReadIndex(subsetIndex: number): boolean;
+    /**
+     * Advance the iterator to the next facet in the subset of client polyface facets.
+     * @return whether the iterator was successfully moved.
+     */
+    moveToNextFacet(): boolean;
+    /** Restart the visitor at the first facet. */
+    reset(): void;
+    /**
+     * Return the client polyface facet index (aka "readIndex") for the given subset index.
+     * @param subsetIndex index into the subset array. Default is the subset index of the currently visited facet.
+     * @return valid client polyface facet index, or `undefined` if invalid subset index.
+     */
+    parentFacetIndex(subsetIndex?: number): number | undefined;
+    /** Return the number of facets this visitor is able to visit. */
+    getVisitableFacetCount(): number;
 }
 //# sourceMappingURL=ExportGraphics.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ExportGraphics.d.ts","sourceRoot":"","sources":["../../src/ExportGraphics.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,4EAA4E;IAC5E,OAAO,EAAE,UAAU,CAAC;IACpB,+DAA+D;IAC/D,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,OAAO,EAAE,UAAU,CAAC;IACpB,6DAA6D;IAC7D,MAAM,EAAE,YAAY,CAAC;IACrB,4DAA4D;IAC5D,OAAO,EAAE,YAAY,CAAC;IACtB,mEAAmE;IACnE,MAAM,EAAE,YAAY,CAAC;IACrB,gGAAgG;IAChG,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,MAAM,EAAE,UAAU,CAAC;IACnB,2FAA2F;IAC3F,cAAc,EAAE,UAAU,CAAC;IAC3B,yFAAyF;IACzF,YAAY,EAAE,qBAAqB,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oDAAoD;IACpD,cAAc,EAAE,SAAS,CAAC;IAC1B,mFAAmF;IACnF,UAAU,EAAE,sBAAsB,CAAC;IACnC,iEAAiE;IACjE,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC;IACpC,wEAAwE;IACxE,cAAc,EAAE,kBAAkB,CAAC;IACnC,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,SAAgB,wBAAwB,CAAC,GAAG,EAAE,qBAAqB,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAYxG;IAED;;;;OAIG;IACH,SAAgB,wBAAwB,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe,CA+BlF;CACF;AACD;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,YAAa,YAAW,eAAe;IACpF,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAqB;IAEtC,OAAO;IAUP;;;;;OAKG;WACW,MAAM,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,GAAG,yBAAyB;IAG9F,sEAAsE;IAC/D,KAAK,IAAI,IAAI;IAIpB,sCAAsC;IAC/B,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAqD5C,eAAe,IAAI,OAAO;IAGjC,iEAAiE;IAC1D,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAExC,qEAAqE;IAC9D,gBAAgB,IAAI,MAAM;IACjC,2EAA2E;IACpE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAC1C;;OAEG;IACI,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAC1C;;OAEG;IACI,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAC3C,2EAA2E;IACpE,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAC3C,8EAA8E;IACvE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAEzC,iCAAiC;IAC1B,cAAc,IAAI,QAAQ;IACjC,6GAA6G;IACtG,WAAW,IAAI,IAAI;IAS1B;;OAEG;IACI,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAO/G,6FAA6F;IACtF,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;CAUjE"}
+{"version":3,"file":"ExportGraphics.d.ts","sourceRoot":"","sources":["../../src/ExportGraphics.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,4EAA4E;IAC5E,OAAO,EAAE,UAAU,CAAC;IACpB,+DAA+D;IAC/D,MAAM,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,OAAO,EAAE,UAAU,CAAC;IACpB,6DAA6D;IAC7D,MAAM,EAAE,YAAY,CAAC;IACrB,4DAA4D;IAC5D,OAAO,EAAE,YAAY,CAAC;IACtB,mEAAmE;IACnE,MAAM,EAAE,YAAY,CAAC;IACrB,iGAAiG;IACjG,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,SAAS,EAAE,UAAU,CAAC;IACtB,kEAAkE;IAClE,WAAW,EAAE,UAAU,CAAC;IACxB,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,MAAM,EAAE,UAAU,CAAC;IACnB,2FAA2F;IAC3F,cAAc,EAAE,UAAU,CAAC;IAC3B,yFAAyF;IACzF,YAAY,EAAE,qBAAqB,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oDAAoD;IACpD,cAAc,EAAE,SAAS,CAAC;IAC1B,mFAAmF;IACnF,UAAU,EAAE,sBAAsB,CAAC;IACnC,iEAAiE;IACjE,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,kCAAkC;IAClC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAC;IACrB,uCAAuC;IACvC,aAAa,EAAE,aAAa,CAAC;IAC7B,sCAAsC;IACtC,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC;IACpC,wEAAwE;IACxE,cAAc,EAAE,kBAAkB,CAAC;IACnC,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,SAAgB,wBAAwB,CAAC,GAAG,EAAE,qBAAqB,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAYxG;IAED;;;;OAIG;IACH,SAAgB,wBAAwB,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe,CA+BlF;CACF;AACD;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,YAAa,YAAW,eAAe;IACpF,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAqB;IACtC,SAAS,aAAa,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM;IAQjE;;;;;OAKG;WACW,MAAM,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,GAAE,MAAU,GAAG,yBAAyB;IAGlG,8CAA8C;IACvC,KAAK,IAAI,IAAI;IAIpB,sCAAsC;IAC/B,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAoDnD,oCAAoC;IAC7B,eAAe,IAAI,OAAO;IAMjC,iEAAiE;IAC1D,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIxC,qEAAqE;IAC9D,gBAAgB,IAAI,MAAM;IAGjC,2EAA2E;IACpE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C;;OAEG;IACI,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C;;OAEG;IACI,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG3C,oDAAoD;IAC7C,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAG3C,4DAA4D;IACrD,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAGzC,iCAAiC;IAC1B,cAAc,IAAI,QAAQ,GAAG,SAAS;IAG7C,6GAA6G;IACtG,WAAW,IAAI,IAAI;IAS1B;;OAEG;IACI,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAO/G,6FAA6F;IACtF,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAQhE,gEAAgE;IACzD,sBAAsB,IAAI,MAAM;IAGvC,6EAA6E;IACtE,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GAAG,+BAA+B;CAGzG;AAED;;;;;GAKG;AACH,qBAAa,+BAAgC,SAAQ,yBAAyB;IAC5E,OAAO,CAAC,aAAa,CAAW;IAChC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO;IAOP,OAAO,CAAC,kBAAkB;IAG1B;;;;;OAKG;WACW,mBAAmB,CAC/B,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GACxE,+BAA+B;IAGlC;;;;OAIG;IACa,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAQ7D;;;OAGG;IACa,eAAe,IAAI,OAAO;IAM1C,8CAA8C;IAC9B,KAAK,IAAI,IAAI;IAM7B;;;;OAIG;IACI,gBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKjE,iEAAiE;IACjD,sBAAsB,IAAI,MAAM;CAGjD"}

package/lib/cjs/ExportGraphics.js

@@ -7,7 +7,7 @@
  * @module ExportGraphics
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExportGraphicsMeshVisitor = exports.ExportGraphics = void 0;
+exports.ExportGraphicsMeshSubsetVisitor = exports.ExportGraphicsMeshVisitor = exports.ExportGraphics = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_geometry_1 = require("@itwin/core-geometry");
 /** Provides utility functions for working with data generated by [IModelDb.exportGraphics]($core-backend)
@@ -79,105 +79,122 @@ class ExportGraphicsMeshVisitor extends core_geometry_1.PolyfaceData {
     _nextFacetIndex;
     _numWrap;
     _polyface;
-    // to be called from static factory method that validates the polyface ...
     constructor(facets, numWrap) {
         super(facets.normals.length > 0, facets.params.length > 0, false, facets.isTwoSided);
         this._polyface = facets;
         this._numWrap = numWrap;
         this._nextFacetIndex = 0;
         this._currentFacetIndex = -1;
-        this.twoSided = facets.isTwoSided;
         this.reset();
     }
     /** Create a visitor for iterating the facets of `polyface`, with indicated number of points to be added to each facet to produce closed point arrays
      * Typical wrap counts are:
-     * * 0 -- leave the point arrays with "missing final edge"
+     * * 0 -- leave the point arrays with "missing final edge" (default)
      * * 1 -- add point 0 as closure point
      * * 2 -- add points 0 and 1 as closure and wrap point.  This is useful when vertex visit requires two adjacent vectors, e.g. for cross products.
      */
-    static create(polyface, numWrap) {
+    static create(polyface, numWrap = 0) {
         return new ExportGraphicsMeshVisitor(polyface, numWrap);
     }
-    /** Reset the iterator to start at the first facet of the polyface. */
+    /** Restart the visitor at the first facet. */
     reset() {
         this.moveToReadIndex(0);
-        this._nextFacetIndex = 0; // so immediate moveToNextFacet stays here.
+        this._nextFacetIndex = 0; // so immediate moveToNextFacet stays here
     }
     /** Select a facet by simple index. */
     moveToReadIndex(facetIndex) {
         if (facetIndex < 0 || 2 + facetIndex * 3 >= this._polyface.indices.length)
             return false;
-        this._currentFacetIndex = facetIndex;
-        this._nextFacetIndex = facetIndex + 1;
-        this.point.length = 0;
-        const points = this.point;
-        points.length = 0;
-        this.pointIndex.length = 0;
-        this.point.length = 0;
-        this.edgeVisible.length = 0;
-        const sourcePoints = this._polyface.points;
-        const indices = this._polyface.indices;
-        const i0 = 3 * facetIndex;
-        for (let i = i0; i < i0 + 3; i++) {
-            const k = 3 * indices[i];
-            this.pointIndex.push(indices[i]);
-            this.point.pushXYZ(sourcePoints[k], sourcePoints[k + 1], sourcePoints[k + 2]);
-            this.edgeVisible.push(true);
-        }
-        for (let i = 0; i < this._numWrap; i++) {
-            this.point.pushFromGrowableXYZArray(this.point, i);
-        }
-        const sourceParams = this._polyface.params;
-        if (sourceParams.length > 0 && this.paramIndex && this.param) {
-            this.paramIndex.length = 0;
-            this.param.length = 0;
+        if (this._currentFacetIndex !== facetIndex || 3 + this._numWrap !== this.point.length) {
+            this._currentFacetIndex = facetIndex;
+            this.point.length = 0;
+            this.pointIndex.length = 0;
+            this.edgeVisible.length = 0;
+            const sourcePoints = this._polyface.points;
+            const indices = this._polyface.indices;
+            const i0 = 3 * facetIndex;
             for (let i = i0; i < i0 + 3; i++) {
-                const k = 2 * indices[i];
-                this.paramIndex.push(indices[i]);
-                this.param.pushXY(sourceParams[k], sourceParams[k + 1]);
+                const k = 3 * indices[i];
+                this.pointIndex.push(indices[i]);
+                this.point.pushXYZ(sourcePoints[k], sourcePoints[k + 1], sourcePoints[k + 2]);
+                this.edgeVisible.push(true);
             }
             for (let i = 0; i < this._numWrap; i++) {
-                this.param.pushFromGrowableXYArray(this.param, i);
+                this.point.pushFromGrowableXYZArray(this.point, i);
             }
-        }
-        const sourceNormals = this._polyface.normals;
-        if (sourceNormals.length > 0 && this.normalIndex && this.normal) {
-            this.normalIndex.length = 0;
-            this.normal.length = 0;
-            for (let i = i0; i < i0 + 3; i++) {
-                const k = 3 * indices[i];
-                this.normalIndex.push(indices[i]);
-                this.normal.pushXYZ(sourceNormals[k], sourceNormals[k + 1], sourceNormals[k + 2]);
+            const sourceParams = this._polyface.params;
+            if (sourceParams.length > 0 && this.paramIndex && this.param) {
+                this.paramIndex.length = 0;
+                this.param.length = 0;
+                for (let i = i0; i < i0 + 3; i++) {
+                    const k = 2 * indices[i];
+                    this.paramIndex.push(indices[i]);
+                    this.param.pushXY(sourceParams[k], sourceParams[k + 1]);
+                }
+                for (let i = 0; i < this._numWrap; i++) {
+                    this.param.pushFromGrowableXYArray(this.param, i);
+                }
             }
-            for (let i = 0; i < this._numWrap; i++) {
-                this.normal.pushFromGrowableXYZArray(this.normal, i);
+            const sourceNormals = this._polyface.normals;
+            if (sourceNormals.length > 0 && this.normalIndex && this.normal) {
+                this.normalIndex.length = 0;
+                this.normal.length = 0;
+                for (let i = i0; i < i0 + 3; i++) {
+                    const k = 3 * indices[i];
+                    this.normalIndex.push(indices[i]);
+                    this.normal.pushXYZ(sourceNormals[k], sourceNormals[k + 1], sourceNormals[k + 2]);
+                }
+                for (let i = 0; i < this._numWrap; i++) {
+                    this.normal.pushFromGrowableXYZArray(this.normal, i);
+                }
             }
         }
+        this._nextFacetIndex = facetIndex + 1;
         return true;
     }
+    /** Load data for the next facet. */
     moveToNextFacet() {
-        return this.moveToReadIndex(this._nextFacetIndex);
+        if (this._nextFacetIndex !== this._currentFacetIndex)
+            return this.moveToReadIndex(this._nextFacetIndex);
+        this._nextFacetIndex++;
+        return true;
     }
     /** Set the number of vertices to replicate in visitor arrays. */
-    setNumWrap(numWrap) { this._numWrap = numWrap; }
+    setNumWrap(numWrap) {
+        this._numWrap = numWrap;
+    }
     /** Return the index (in the client polyface) of the current facet */
-    currentReadIndex() { return this._currentFacetIndex; }
+    currentReadIndex() {
+        return this._currentFacetIndex;
+    }
     /** Return the point index of vertex i within the currently loaded facet */
-    clientPointIndex(i) { return this.pointIndex[i]; }
+    clientPointIndex(i) {
+        return this.pointIndex[i];
+    }
     /** Return the param index of vertex i within the currently loaded facet.
      * Use the artificial paramIndex, which matches pointIndex.
      */
-    clientParamIndex(i) { return this.paramIndex ? this.paramIndex[i] : -1; }
+    clientParamIndex(i) {
+        return this.paramIndex ? this.paramIndex[i] : -1;
+    }
     /** Return the normal index of vertex i within the currently loaded facet.
      * Use the artificial paramIndex, which matches pointIndex.
      */
-    clientNormalIndex(i) { return this.normalIndex ? this.normalIndex[i] : -1; }
-    /** Return the color index of vertex i within the currently loaded facet */
-    clientColorIndex(_i) { return 1; }
-    /** Return the aux data index of vertex i within the currently loaded facet */
-    clientAuxIndex(_i) { return -1; }
+    clientNormalIndex(i) {
+        return this.normalIndex ? this.normalIndex[i] : -1;
+    }
+    /** Always returns -1 since we never have colors. */
+    clientColorIndex(_i) {
+        return -1;
+    }
+    /** Always returns -1 since we never have auxiliary data. */
+    clientAuxIndex(_i) {
+        return -1;
+    }
     /** return the client polyface */
-    clientPolyface() { return undefined; }
+    clientPolyface() {
+        return undefined;
+    }
     /** clear the contents of all arrays.  Use this along with transferDataFrom methods to build up new facets */
     clearArrays() {
         if (this.point !== undefined)
@@ -201,13 +218,95 @@ class ExportGraphicsMeshVisitor extends core_geometry_1.PolyfaceData {
     /** transfer data from a specified index of the other visitor as new data in this visitor. */
     pushDataFrom(other, index) {
         this.point.pushFromGrowableXYZArray(other.point, index);
-        if (this.color && other.color && index < other.color.length)
-            this.color.push(other.color[index]);
         if (this.param && other.param && index < other.param.length)
             this.param.pushFromGrowableXYArray(other.param, index);
         if (this.normal && other.normal && index < other.normal.length)
             this.normal.pushFromGrowableXYZArray(other.normal, index);
+        // ignore color and aux -- they never exist.
+    }
+    /** Return the number of facets this visitor is able to visit */
+    getVisitableFacetCount() {
+        return Math.floor(this._polyface.indices.length / 3);
+    }
+    /** Create a visitor for a subset of the facets visitable by the instance. */
+    createSubsetVisitor(facetIndices, numWrap = 0) {
+        return ExportGraphicsMeshSubsetVisitor.createSubsetVisitor(this._polyface, facetIndices, numWrap);
     }
 }
 exports.ExportGraphicsMeshVisitor = ExportGraphicsMeshVisitor;
+/**
+ * An `ExportGraphicsMeshSubsetVisitor` is an `ExportGraphicsMeshVisitor` which only visits a subset of the facets.
+ * * The subset is defined by an array of facet indices provided when this visitor is created.
+ * * Input indices (e.g., for `moveToReadIndex`) are understood to be indices into the subset array.
+ * @public
+ */
+class ExportGraphicsMeshSubsetVisitor extends ExportGraphicsMeshVisitor {
+    _facetIndices;
+    _currentSubsetIndex; // index within _facetIndices
+    _nextSubsetIndex; // index within _facetIndices
+    constructor(polyface, facetIndices, numWrap) {
+        super(polyface, numWrap);
+        this._facetIndices = facetIndices.slice();
+        this._currentSubsetIndex = -1;
+        this._nextSubsetIndex = 0;
+        this.reset();
+    }
+    isValidSubsetIndex(index) {
+        return index >= 0 && index < this._facetIndices.length;
+    }
+    /**
+     * Create a visitor for iterating a subset of the facets of `polyface`.
+     * @param polyface reference to the client polyface, supplying facets
+     * @param facetIndices array of indices of facets in the client polyface to visit. This array is cloned.
+     * @param numWrap number of vertices replicated in the visitor arrays to facilitate simpler caller code. Default is zero.
+     */
+    static createSubsetVisitor(polyface, facetIndices, numWrap = 0) {
+        return new ExportGraphicsMeshSubsetVisitor(polyface, facetIndices, numWrap);
+    }
+    /**
+     * Advance the iterator to a particular facet in the subset of client polyface facets.
+     * @param subsetIndex index into the subset array, not to be confused with the client facet index.
+     * @return whether the iterator was successfully moved.
+     */
+    moveToReadIndex(subsetIndex) {
+        if (this.isValidSubsetIndex(subsetIndex)) {
+            this._currentSubsetIndex = subsetIndex;
+            this._nextSubsetIndex = subsetIndex + 1;
+            return super.moveToReadIndex(this._facetIndices[subsetIndex]);
+        }
+        return false;
+    }
+    /**
+     * Advance the iterator to the next facet in the subset of client polyface facets.
+     * @return whether the iterator was successfully moved.
+     */
+    moveToNextFacet() {
+        if (this._nextSubsetIndex !== this._currentSubsetIndex)
+            return this.moveToReadIndex(this._nextSubsetIndex);
+        this._nextSubsetIndex++;
+        return true;
+    }
+    /** Restart the visitor at the first facet. */
+    reset() {
+        if (this._facetIndices) { // avoid crash during super ctor when we aren't yet initialized
+            this.moveToReadIndex(0);
+            this._nextSubsetIndex = 0; // so immediate moveToNextFacet stays here
+        }
+    }
+    /**
+     * Return the client polyface facet index (aka "readIndex") for the given subset index.
+     * @param subsetIndex index into the subset array. Default is the subset index of the currently visited facet.
+     * @return valid client polyface facet index, or `undefined` if invalid subset index.
+     */
+    parentFacetIndex(subsetIndex) {
+        if (undefined === subsetIndex)
+            subsetIndex = this._currentSubsetIndex;
+        return this.isValidSubsetIndex(subsetIndex) ? this._facetIndices[subsetIndex] : undefined;
+    }
+    /** Return the number of facets this visitor is able to visit. */
+    getVisitableFacetCount() {
+        return this._facetIndices.length;
+    }
+}
+exports.ExportGraphicsMeshSubsetVisitor = ExportGraphicsMeshSubsetVisitor;
 //# sourceMappingURL=ExportGraphics.js.map