@itwin/core-backend 5.1.0-dev.9 → 5.2.0-dev.1

package/lib/cjs/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAC9C,yCAAsC;AACtC,qEAAqE;AAGrE;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,mCAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,kDAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AApHH,kCAqHC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,2BAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,kBAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,mCAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAjEH,4BAkEC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,0CAyDC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAvDD,0CAuDC","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 iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * SubCategory custom HandledProps include 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"description\", source: \"Class\" },\n    { propertyName: \"properties\", source: \"Class\" },\n  ];\n\n  /**\n   * SubCategory deserializes 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\n    const elProps = super.deserialize(props) as SubCategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    if (props.row.properties !== '') {\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\n    } else {\n      elProps.appearance = undefined;\n    }\n    return elProps;\n  }\n\n  /**\n   * SubCategory serialize 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (props.description !== undefined) {\n      inst.description = props.description;\n    }\n    if (props.appearance !== undefined) {\n      inst.properties = JSON.stringify(props.appearance);\n    }\n    return inst;\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * Category custom HandledProps include 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"rank\", source: \"Class\" },\n    { propertyName: \"description\", source: \"Class\" },\n  ];\n\n  /**\n   * Category deserializes 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\n    const elProps = super.deserialize(props) as CategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    elProps.rank = JsonUtils.asInt(props.row.rank);\n    return elProps;\n  }\n\n  /**\n   * Category serialize 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (undefined !== props.description) {\n      inst.description = props.description;\n    }\n    inst.rank = props.rank;\n    return inst;\n  }\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkE;AAClE,oDAE4B;AAC5B,uCAA8C;AAC9C,yCAAsC;AACtC,qEAAqE;AAGrE;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,mCAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,kDAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AApHH,kCAqHC;AAED;;GAEG;AACH,MAAa,QAAS,SAAQ,2BAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,kBAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,wBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,wBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,mBAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,mCAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,mCAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAjEH,4BAkEC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,0CAyDC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,yBAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAvDD,0CAuDC","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 iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public @preview\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * SubCategory custom HandledProps include 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"description\", source: \"Class\" },\n    { propertyName: \"properties\", source: \"Class\" },\n  ];\n\n  /**\n   * SubCategory deserializes 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\n    const elProps = super.deserialize(props) as SubCategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    if (props.row.properties !== '') {\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\n    } else {\n      elProps.appearance = undefined;\n    }\n    return elProps;\n  }\n\n  /**\n   * SubCategory serialize 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (props.description !== undefined) {\n      inst.description = props.description;\n    }\n    if (props.appearance !== undefined) {\n      inst.properties = JSON.stringify(props.appearance);\n    }\n    return inst;\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public @preview\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * Category custom HandledProps include 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"rank\", source: \"Class\" },\n    { propertyName: \"description\", source: \"Class\" },\n  ];\n\n  /**\n   * Category deserializes 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\n    const elProps = super.deserialize(props) as CategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    elProps.rank = JsonUtils.asInt(props.row.rank);\n    return elProps;\n  }\n\n  /**\n   * Category serialize 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (undefined !== props.description) {\n      inst.description = props.description;\n    }\n    inst.rank = props.rank;\n    return inst;\n  }\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public @preview\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public @preview\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}

package/lib/cjs/ChangesetECAdaptor.d.ts

@@ -2,7 +2,7 @@
  * @module ECDb
  */
 import { Id64String } from "@itwin/core-bentley";
-import { SqliteChangeOp, SqliteChangesetReader, SqliteValueStage } from "./SqliteChangesetReader";
+import { AnyDb, SqliteChangeOp, SqliteChangesetReader, SqliteValueStage } from "./SqliteChangesetReader";
 /**
  * Record meta data for the change.
  * @beta
@@ -31,33 +31,96 @@ export interface ChangedECInstance {
     $meta?: ChangeMetaData;
     [key: string]: any;
 }
+/**
+ * Represents a cache for unifying EC changes.
+ * @beta
+ */
+export interface ECChangeUnifierCache extends Disposable {
+    /**
+     * Retrieves the value associated with the specified key from the cache.
+     * @param key - The key to retrieve the value for.
+     * @returns The value associated with the key, or undefined if the key is not found.
+     */
+    get(key: string): ChangedECInstance | undefined;
+    /**
+     * Sets the value associated with the specified key in the cache.
+     * @param key - The key to set the value for.
+     * @param value - The value to be associated with the key.
+     */
+    set(key: string, value: ChangedECInstance): void;
+    /**
+     * Returns an iterator for all the values in the cache.
+     * @returns An iterator for all the values in the cache.
+     */
+    all(): IterableIterator<ChangedECInstance>;
+    /**
+     * Returns the number of entries in the cache.
+     * @returns The number of entries in the cache.
+     */
+    count(): number;
+}
+/** @beta */
+export declare namespace ECChangeUnifierCache {
+    /**
+     * Creates and returns a new in-memory cache for EC change unification.
+     * @note This cache is fast but recommended for small to medium size changesets. As it store changes in memory using a hash map, it may run out of memory for larger changesets.
+     * @returns {ECChangeUnifierCache} An instance of cache that store changes in memory using a hash map.
+     */
+    function createInMemoryCache(): ECChangeUnifierCache;
+    /**
+     * Creates an ECChangeUnifierCache that is backed by a database.
+     * @note This cache is suitable for larger changesets and uses SQLite to store changes. It is slower than the in-memory cache but can handle larger datasets without running out of memory.
+     * @param db - The database instance to use for caching.
+     * @param bufferedReadInstanceSizeInBytes - The size in bytes for buffered read instances. Defaults to 10 MB.
+     * @returns An instance of ECChangeUnifierCache backed by SQLite temp db.
+     */
+    function createSqliteBackedCache(db: AnyDb, bufferedReadInstanceSizeInBytes?: number): ECChangeUnifierCache;
+}
 /**
  * Combine partial changed instance into single instance.
  * Partial changes is per table and a single instance can
  * span multiple tables.
  * @beta
  */
-export declare class PartialECChangeUnifier {
+export declare class PartialECChangeUnifier implements Disposable {
+    private _db;
     private _cache;
     private _readonly;
+    constructor(_db: AnyDb, _cache?: ECChangeUnifierCache);
+    /**
+     * Dispose the instance.
+     */
+    [Symbol.dispose](): void;
     /**
      * Get root class id for a given class
      * @param classId given class id
      * @param db use to find root class
      * @returns return root class id
      */
-    private static getRootClassId;
+    private getRootClassId;
+    /**
+     * Checks if the given `rhsClassId` is an instance of the `lhsClassId`.
+     * @param rhsClassId The ID of the right-hand side class.
+     * @param lhsClassId The ID of the left-hand side class.
+     * @returns `true` if `rhsClassId` is an instance of `lhsClassId`, `false` otherwise.
+     */
+    private instanceOf;
     /**
      * Combine partial instance with instance with same key if already exists.
      * @param rhs partial instance
      */
     private combine;
+    /**
+     * Returns the number of instances in the cache.
+     * @returns The number of instances in the cache.
+     */
+    getInstanceCount(): number;
     /**
      * Build key from EC change.
      * @param change EC change
      * @returns key created from EC change.
      */
-    private static buildKey;
+    private buildKey;
     /**
      * Append partial changes which will be combine using there instance key.
      * @note $meta property must be present on partial change as information
@@ -66,10 +129,6 @@ export declare class PartialECChangeUnifier {
      * @beta
      */
     appendFrom(adaptor: ChangesetECAdaptor): void;
-    /**
-     * Delete $meta from all the instances.
-     */
-    stripMetaData(): void;
     /**
      * Returns complete EC change instances.
      * @beta

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

@@ -1 +1 @@
-{"version":3,"file":"ChangesetECAdaptor.d.ts","sourceRoot":"","sources":["../../src/ChangesetECAdaptor.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAwB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAuB,cAAc,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAoVvH;;;KAGK;AACL,MAAM,WAAW,cAAc;IAC7B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,EAAE,EAAE,cAAc,CAAC;IACnB,mDAAmD;IACnD,KAAK,EAAE,gBAAgB,CAAC;IACxB,sFAAsF;IACtF,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,iEAAiE;IACjE,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC,YAAY,EAAE,UAAU,CAAC;IAEzB,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AA4BD;;;;;GAKG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAwC;IACtD,OAAO,CAAC,SAAS,CAAS;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAgC7B;;;OAGG;IACH,OAAO,CAAC,OAAO;IAkCf;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAYvB;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAiBpD;;OAEG;IACI,aAAa,IAAI,IAAI;IAQ5B;;;OAGG;IACH,IAAW,SAAS,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,CAAiC;CAC7F;AAED;;;;;;EAME;AACF,qBAAa,kBAAmB,YAAW,UAAU;aA4EhB,MAAM,EAAE,qBAAqB;aAAkB,eAAe;IA3EjG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,eAAe,CAAqB;IAC5C;;OAEG;IACH,SAAgB,UAAU;;;;MAIxB;IACF;;;OAGG;IACI,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACI,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAEnC;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB;IAKrD;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,kBAAkB;IAKvD;;;;;OAKG;IACI,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,kBAAkB;IAO7D,OAAO,CAAC,gBAAgB;IAUxB;;;;;OAKG;gBACgC,MAAM,EAAE,qBAAqB,EAAkB,eAAe,UAAQ;IAMzG;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAG/B;;OAEG;IACI,KAAK,IAAI,IAAI;IAGpB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAoBvB;;;;OAIG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM;IAGlC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAUxB,qCAAqC;IACrC,IAAW,EAAE,mBAA6B;IAC1C,0DAA0D;IAC1D,IAAW,UAAU,YAAqC;IAC1D,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IACxD,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IAExD;;;OAGG;IACI,IAAI,IAAI,OAAO;IA2GtB;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IAuBnC;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;CA6ClB"}
+{"version":3,"file":"ChangesetECAdaptor.d.ts","sourceRoot":"","sources":["../../src/ChangesetECAdaptor.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAA8B,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,KAAK,EAAgB,cAAc,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAuVvH;;;KAGK;AACL,MAAM,WAAW,cAAc;IAC7B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,EAAE,EAAE,cAAc,CAAC;IACnB,mDAAmD;IACnD,KAAK,EAAE,gBAAgB,CAAC;IACxB,sFAAsF;IACtF,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,iEAAiE;IACjE,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC,YAAY,EAAE,UAAU,CAAC;IAEzB,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AA6BD;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAEhD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEjD;;;OAGG;IACH,GAAG,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IAE3C;;;OAGG;IACH,KAAK,IAAI,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,yBAAiB,oBAAoB,CAAC;IACpC;;;;OAIG;IACH,SAAgB,mBAAmB,IAAI,oBAAoB,CAE1D;IAED;;;;;;OAMG;IACH,SAAgB,uBAAuB,CAAC,EAAE,EAAE,KAAK,EAAE,+BAA+B,SAAmB,GAAG,oBAAoB,CAE3H;CACF;AAuLD;;;;;GAKG;AACH,qBAAa,sBAAuB,YAAW,UAAU;IAEpC,OAAO,CAAC,GAAG;IAAS,OAAO,CAAC,MAAM;IADrD,OAAO,CAAC,SAAS,CAAS;gBACC,GAAG,EAAE,KAAK,EAAU,MAAM,GAAE,oBAAkD;IAEzG;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAI/B;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAiCtB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAUlB;;;OAGG;IACH,OAAO,CAAC,OAAO;IA8Bf;;;OAGG;IACI,gBAAgB,IAAI,MAAM;IAIjC;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAahB;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAmBpD;;;OAGG;IACH,IAAW,SAAS,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,CAE1D;CACF;AAED;;;;;;EAME;AACF,qBAAa,kBAAmB,YAAW,UAAU;aAgFhB,MAAM,EAAE,qBAAqB;aAAkB,eAAe;IA/EjG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,eAAe,CAAqB;IAC5C;;OAEG;IACH,SAAgB,UAAU;;;;MAIxB;IACF;;;OAGG;IACI,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACI,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAEnC;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB;IAMrD;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,kBAAkB;IAMvD;;;;;OAKG;IACI,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,kBAAkB;IAQ7D,OAAO,CAAC,gBAAgB;IAWxB;;;;;OAKG;gBACgC,MAAM,EAAE,qBAAqB,EAAkB,eAAe,UAAQ;IAOzG;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAI/B;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAYlC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAoBvB;;;;OAIG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM;IAIlC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAWxB,qCAAqC;IACrC,IAAW,EAAE,mBAA6B;IAC1C,0DAA0D;IAC1D,IAAW,UAAU,YAAqC;IAC1D,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IACxD,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IAExD;;;OAGG;IACI,IAAI,IAAI,OAAO;IA4GtB;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IAwBnC;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;CA6ClB"}

package/lib/cjs/ChangesetECAdaptor.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChangesetECAdaptor = exports.PartialECChangeUnifier = void 0;
+exports.ChangesetECAdaptor = exports.PartialECChangeUnifier = exports.ECChangeUnifierCache = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -9,6 +9,9 @@ exports.ChangesetECAdaptor = exports.PartialECChangeUnifier = void 0;
  * @module ECDb
  */
 const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const ECDb_1 = require("./ECDb");
+const Symbols_1 = require("./internal/Symbols");
 class ECDbMap {
     db;
     _cachedClassMaps = new Map();
@@ -321,6 +324,199 @@ var DateTime;
     }
     DateTime.fromJulianDay = fromJulianDay;
 })(DateTime || (DateTime = {}));
+/** @beta */
+var ECChangeUnifierCache;
+(function (ECChangeUnifierCache) {
+    /**
+     * Creates and returns a new in-memory cache for EC change unification.
+     * @note This cache is fast but recommended for small to medium size changesets. As it store changes in memory using a hash map, it may run out of memory for larger changesets.
+     * @returns {ECChangeUnifierCache} An instance of cache that store changes in memory using a hash map.
+     */
+    function createInMemoryCache() {
+        return new InMemoryInstanceCache();
+    }
+    ECChangeUnifierCache.createInMemoryCache = createInMemoryCache;
+    /**
+     * Creates an ECChangeUnifierCache that is backed by a database.
+     * @note This cache is suitable for larger changesets and uses SQLite to store changes. It is slower than the in-memory cache but can handle larger datasets without running out of memory.
+     * @param db - The database instance to use for caching.
+     * @param bufferedReadInstanceSizeInBytes - The size in bytes for buffered read instances. Defaults to 10 MB.
+     * @returns An instance of ECChangeUnifierCache backed by SQLite temp db.
+     */
+    function createSqliteBackedCache(db, bufferedReadInstanceSizeInBytes = 1024 * 1024 * 10) {
+        return new SqliteBackedInstanceCache(db, bufferedReadInstanceSizeInBytes);
+    }
+    ECChangeUnifierCache.createSqliteBackedCache = createSqliteBackedCache;
+})(ECChangeUnifierCache || (exports.ECChangeUnifierCache = ECChangeUnifierCache = {}));
+/**
+ * In-memory cache for storing changed EC instances.
+ */
+class InMemoryInstanceCache {
+    _cache = new Map();
+    /**
+     * Retrieves the changed EC instance associated with the specified key.
+     * @param key - The key used to retrieve the instance.
+     * @returns The changed EC instance, or undefined if not found.
+     */
+    get(key) {
+        return this._cache.get(key);
+    }
+    /**
+     * Sets the changed EC instance associated with the specified key.
+     * @param key - The key used to store the instance.
+     * @param value - The changed EC instance to be stored.
+     */
+    set(key, value) {
+        const meta = value.$meta;
+        // Remove undefined keys
+        if (meta) {
+            Object.keys(meta).forEach((k) => meta[k] === undefined && delete meta[k]);
+        }
+        this._cache.set(key, value);
+    }
+    /**
+     * Returns an iterator over all the changed EC instances in the cache.
+     * @returns An iterator over all the changed EC instances.
+     */
+    *all() {
+        for (const key of Array.from(this._cache.keys()).sort()) {
+            const instance = this._cache.get(key);
+            if (instance) {
+                yield instance;
+            }
+        }
+    }
+    /**
+     * Returns the number of changed EC instances in the cache.
+     * @returns The number of changed EC instances.
+     */
+    count() {
+        return this._cache.size;
+    }
+    /**
+     * Disposes the cache.
+     */
+    [Symbol.dispose]() {
+        // Implementation details
+    }
+}
+/**
+ * Represents a cache for unifying EC changes in a SQLite-backed instance cache.
+ */
+class SqliteBackedInstanceCache {
+    _db;
+    bufferedReadInstanceSizeInBytes;
+    _cacheTable = `[temp].[${core_bentley_1.Guid.createValue()}]`;
+    static defaultBufferSize = 1024 * 1024 * 10; // 10MB
+    /**
+     * Creates an instance of SqliteBackedInstanceCache.
+     * @param _db The underlying database connection.
+     * @param bufferedReadInstanceSizeInBytes The size of read instance buffer defaults to 10Mb.
+     * @throws Error if bufferedReadInstanceSizeInBytes is less than or equal to 0.
+     */
+    constructor(_db, bufferedReadInstanceSizeInBytes = SqliteBackedInstanceCache.defaultBufferSize) {
+        this._db = _db;
+        this.bufferedReadInstanceSizeInBytes = bufferedReadInstanceSizeInBytes;
+        if (bufferedReadInstanceSizeInBytes <= 0)
+            throw new Error("bufferedReadInstanceCount must be greater than 0");
+        this.createTempTable();
+    }
+    /**
+     * Creates a temporary table in the database for caching instances.
+     * @throws Error if unable to create the temporary table.
+     */
+    createTempTable() {
+        this._db.withSqliteStatement(`CREATE TABLE ${this._cacheTable} ([key] text primary key, [value] text)`, (stmt) => {
+            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== stmt.step())
+                throw new Error("unable to create temp table");
+        });
+    }
+    /**
+     * Drops the temporary table from the database.
+     * @throws Error if unable to drop the temporary table.
+     */
+    dropTempTable() {
+        this._db.saveChanges();
+        if (this._db instanceof ECDb_1.ECDb)
+            this._db.clearStatementCache();
+        else {
+            this._db.clearCaches();
+            this._db[Symbols_1._nativeDb].clearECDbCache();
+        }
+        this._db.withSqliteStatement(`DROP TABLE IF EXISTS ${this._cacheTable}`, (stmt) => {
+            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== stmt.step())
+                throw new Error("unable to drop temp table");
+        });
+    }
+    /**
+     * Retrieves the changed EC instance from the cache based on the specified key.
+     * @param key The key of the instance.
+     * @returns The changed EC instance if found, otherwise undefined.
+     */
+    get(key) {
+        return this._db.withPreparedSqliteStatement(`SELECT [value] FROM ${this._cacheTable} WHERE [key]=?`, (stmt) => {
+            stmt.bindString(1, key);
+            if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+                const out = JSON.parse(stmt.getValueString(0), core_common_1.Base64EncodedString.reviver);
+                return out;
+            }
+            return undefined;
+        });
+    }
+    /**
+     * Sets the changed EC instance in the cache with the specified key.
+     * @param key The key of the instance.
+     * @param value The changed EC instance to be set.
+     */
+    set(key, value) {
+        const shallowCopy = Object.assign({}, value);
+        this._db.withPreparedSqliteStatement(`INSERT INTO ${this._cacheTable} ([key], [value]) VALUES (?, ?) ON CONFLICT ([key]) DO UPDATE SET [value] = [excluded].[value]`, (stmt) => {
+            stmt.bindString(1, key);
+            stmt.bindString(2, JSON.stringify(shallowCopy, core_common_1.Base64EncodedString.replacer));
+            stmt.step();
+        });
+    }
+    /**
+     * Returns an iterator for all the changed EC instances in the cache.
+     * @returns An iterator for all the changed EC instances.
+     */
+    *all() {
+        const sql = `
+      SELECT JSON_GROUP_ARRAY (JSON([value]))
+      FROM   (SELECT
+                    [value],
+                    SUM (LENGTH ([value])) OVER (ORDER BY [key] ROWS UNBOUNDED PRECEDING) / ${this.bufferedReadInstanceSizeInBytes} AS [bucket]
+              FROM   ${this._cacheTable})
+      GROUP  BY [bucket]`;
+        const stmt = this._db.prepareSqliteStatement(sql);
+        while (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+            const instanceBucket = JSON.parse(stmt.getValueString(0), core_common_1.Base64EncodedString.reviver);
+            for (const value of instanceBucket) {
+                yield value;
+            }
+        }
+        stmt[Symbol.dispose]();
+    }
+    /**
+     * Returns the number of instances in the cache.
+     * @returns The number of instances in the cache.
+     */
+    count() {
+        return this._db.withPreparedSqliteStatement(`SELECT COUNT(*) FROM ${this._cacheTable}`, (stmt) => {
+            if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
+                return stmt.getValue(0).getInteger();
+            return 0;
+        });
+    }
+    /**
+     * Disposes the cache by dropping the temporary table.
+     */
+    [Symbol.dispose]() {
+        if (this._db.isOpen) {
+            this.dropTempTable();
+        }
+    }
+}
 /**
  * Combine partial changed instance into single instance.
  * Partial changes is per table and a single instance can
@@ -328,15 +524,26 @@ var DateTime;
  * @beta
  */
 class PartialECChangeUnifier {
-    _cache = new Map();
+    _db;
+    _cache;
     _readonly = false;
+    constructor(_db, _cache = new InMemoryInstanceCache()) {
+        this._db = _db;
+        this._cache = _cache;
+    }
+    /**
+     * Dispose the instance.
+     */
+    [Symbol.dispose]() {
+        this._cache[Symbol.dispose]();
+    }
     /**
      * Get root class id for a given class
      * @param classId given class id
      * @param db use to find root class
      * @returns return root class id
      */
-    static getRootClassId(classId, db) {
+    getRootClassId(classId) {
         const sql = `
       WITH
       [base_class]([classId], [baseClassId], [Level]) AS(
@@ -359,7 +566,7 @@ class PartialECChangeUnifier {
                     WHERE  [cc].[Name] = 'IsMixIn'
                             AND [ss].[Name] = 'CoreCustomAttributes'))
       ORDER BY [Level] DESC`;
-        return db.withSqliteStatement(sql, (stmt) => {
+        return this._db.withSqliteStatement(sql, (stmt) => {
             stmt.bindId(1, classId);
             if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW && !stmt.isValueNull(0)) {
                 return stmt.getValueString(0);
@@ -367,15 +574,30 @@ class PartialECChangeUnifier {
             return classId;
         });
     }
+    /**
+     * Checks if the given `rhsClassId` is an instance of the `lhsClassId`.
+     * @param rhsClassId The ID of the right-hand side class.
+     * @param lhsClassId The ID of the left-hand side class.
+     * @returns `true` if `rhsClassId` is an instance of `lhsClassId`, `false` otherwise.
+     */
+    instanceOf(rhsClassId, lhsClassId) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        return this._db.withPreparedStatement("SELECT ec_instanceof(?,?)", (stmt) => {
+            stmt.bindId(1, rhsClassId);
+            stmt.bindId(2, lhsClassId);
+            stmt.step();
+            return stmt.getValue(0).getInteger() === 1;
+        });
+    }
     /**
      * Combine partial instance with instance with same key if already exists.
      * @param rhs partial instance
      */
-    combine(rhs, db) {
+    combine(rhs) {
         if (!rhs.$meta) {
             throw new Error("PartialECChange being combine must have '$meta' property");
         }
-        const key = PartialECChangeUnifier.buildKey(rhs, db);
+        const key = this.buildKey(rhs);
         const lhs = this._cache.get(key);
         if (lhs) {
             const { $meta: _, ...restOfRhs } = rhs;
@@ -384,37 +606,39 @@ class PartialECChangeUnifier {
                 lhs.$meta.tables = [...rhs.$meta?.tables, ...lhs.$meta?.tables];
                 lhs.$meta.changeIndexes = [...rhs.$meta?.changeIndexes, ...lhs.$meta?.changeIndexes];
                 // we preserve child class name & id when merging instance.
-                if (rhs.$meta.fallbackClassId && lhs.$meta.fallbackClassId && db && rhs.$meta.fallbackClassId !== lhs.$meta.fallbackClassId) {
+                if (rhs.$meta.fallbackClassId && lhs.$meta.fallbackClassId && rhs.$meta.fallbackClassId !== lhs.$meta.fallbackClassId) {
                     const lhsClassId = lhs.$meta.fallbackClassId;
                     const rhsClassId = rhs.$meta.fallbackClassId;
-                    // eslint-disable-next-line @typescript-eslint/no-deprecated
-                    const isRhsIsSubClassOfLhs = db.withPreparedStatement("SELECT ec_instanceof(?,?)", (stmt) => {
-                        stmt.bindId(1, rhsClassId);
-                        stmt.bindId(2, lhsClassId);
-                        stmt.step();
-                        return stmt.getValue(0).getInteger() === 1;
-                    });
+                    const isRhsIsSubClassOfLhs = this.instanceOf(rhsClassId, lhsClassId);
                     if (isRhsIsSubClassOfLhs) {
                         lhs.$meta.fallbackClassId = rhs.$meta.fallbackClassId;
                         lhs.$meta.classFullName = rhs.$meta.classFullName;
                     }
                 }
             }
+            this._cache.set(key, lhs);
         }
         else {
             this._cache.set(key, rhs);
         }
     }
+    /**
+     * Returns the number of instances in the cache.
+     * @returns The number of instances in the cache.
+     */
+    getInstanceCount() {
+        return this._cache.count();
+    }
     /**
      * Build key from EC change.
      * @param change EC change
      * @returns key created from EC change.
      */
-    static buildKey(change, db) {
+    buildKey(change) {
         let classId = change.ECClassId;
         if (typeof classId === "undefined") {
-            if (db && change.$meta?.fallbackClassId) {
-                classId = this.getRootClassId(change.$meta.fallbackClassId, db);
+            if (change.$meta?.fallbackClassId) {
+                classId = this.getRootClassId(change.$meta.fallbackClassId);
             }
             if (typeof classId === "undefined") {
                 throw new Error(`unable to resolve ECClassId to root class id.`);
@@ -437,32 +661,23 @@ class PartialECChangeUnifier {
             throw new Error("this instance is marked as readonly.");
         }
         if (adaptor.op === "Updated" && adaptor.inserted && adaptor.deleted) {
-            this.combine(adaptor.inserted, adaptor.reader.db);
-            this.combine(adaptor.deleted, adaptor.reader.db);
+            this.combine(adaptor.inserted);
+            this.combine(adaptor.deleted);
         }
         else if (adaptor.op === "Inserted" && adaptor.inserted) {
-            this.combine(adaptor.inserted, adaptor.reader.db);
+            this.combine(adaptor.inserted);
         }
         else if (adaptor.op === "Deleted" && adaptor.deleted) {
-            this.combine(adaptor.deleted, adaptor.reader.db);
+            this.combine(adaptor.deleted);
         }
     }
-    /**
-     * Delete $meta from all the instances.
-     */
-    stripMetaData() {
-        for (const inst of this._cache.values()) {
-            if ("$meta" in inst) {
-                delete inst.$meta;
-            }
-        }
-        this._readonly = true;
-    }
     /**
      * Returns complete EC change instances.
      * @beta
      */
-    get instances() { return this._cache.values(); }
+    get instances() {
+        return this._cache.all();
+    }
 }
 exports.PartialECChangeUnifier = PartialECChangeUnifier;
 /**