@itwin/core-backend 5.13.0-dev.9 → 5.14.0-dev.1

package/lib/cjs/internal/NoReservations.js

@@ -0,0 +1,21 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNoOpReservations = createNoOpReservations;
+const Symbols_1 = require("./Symbols");
+/** A null-implementation of SynchronousChannel.Reservations for iModels that don't use SchemaSync-backed reservations. */
+class NoReservations {
+    [Symbols_1._implementationProhibited] = undefined;
+    get isServerBased() { return false; }
+    [Symbols_1._close]() { }
+    [Symbols_1._onReservedElementInsert]() { }
+    needsElementReservation() { return false; }
+    async reserveElements() { }
+}
+function createNoOpReservations() {
+    return new NoReservations();
+}
+//# sourceMappingURL=NoReservations.js.map

package/lib/cjs/internal/NoReservations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NoReservations.js","sourceRoot":"","sources":["../../../src/internal/NoReservations.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;AAmB/F,wDAEC;AAdD,uCAAwF;AAExF,0HAA0H;AAC1H,MAAM,cAAc;IACF,CAAC,mCAAyB,CAAC,GAAG,SAAS,CAAC;IACxD,IAAW,aAAa,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC,gBAAM,CAAC,KAAW,CAAC;IACpB,CAAC,kCAAwB,CAAC,KAAW,CAAC;IACtC,uBAAuB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IACpD,KAAK,CAAC,eAAe,KAAoB,CAAC;CAClD;AAED,SAAgB,sBAAsB;IACpC,OAAO,IAAI,cAAc,EAAE,CAAC;AAC9B,CAAC","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\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { SynchronousChannel } from \"../SynchronousChannel\";\r\nimport { _close, _implementationProhibited, _onReservedElementInsert } from \"./Symbols\";\r\n\r\n/** A null-implementation of SynchronousChannel.Reservations for iModels that don't use SchemaSync-backed reservations. */\r\nclass NoReservations implements SynchronousChannel.Reservations {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  public get isServerBased() { return false; }\r\n  public [_close](): void { }\r\n  public [_onReservedElementInsert](): void { }\r\n  public needsElementReservation(): boolean { return false; }\r\n  public async reserveElements(): Promise<void> { }\r\n}\r\n\r\nexport function createNoOpReservations(): SynchronousChannel.Reservations {\r\n  return new NoReservations();\r\n}\r\n"]}

package/lib/cjs/internal/SchemaSyncReservations.d.ts

@@ -0,0 +1,4 @@
+import { IModelDb } from "../IModelDb";
+import { SynchronousChannel } from "../SynchronousChannel";
+export declare function createSchemaSyncReservations(iModel: IModelDb): Promise<SynchronousChannel.Reservations>;
+//# sourceMappingURL=SchemaSyncReservations.d.ts.map

package/lib/cjs/internal/SchemaSyncReservations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaSyncReservations.d.ts","sourceRoot":"","sources":["../../../src/internal/SchemaSyncReservations.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,QAAQ,EAAwB,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AA6H3D,wBAAsB,4BAA4B,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAE7G"}

package/lib/cjs/internal/SchemaSyncReservations.js

@@ -0,0 +1,118 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSchemaSyncReservations = createSchemaSyncReservations;
+/** @packageDocumentation
+ * @module iModels
+ */
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const SchemaSync_1 = require("../SchemaSync");
+const Symbols_1 = require("./Symbols");
+const Category_1 = require("../Category");
+class SchemaSyncReservations {
+    [Symbols_1._implementationProhibited] = undefined;
+    get isServerBased() { return true; }
+    _iModel;
+    _schemaSync;
+    constructor(iModel, schemaSync) {
+        this._iModel = iModel;
+        this._schemaSync = schemaSync;
+    }
+    static async create(iModel) {
+        const schemaSync = await SchemaSync_1.SchemaSync.getCloudAccess(iModel);
+        schemaSync.synchronizeWithCloud();
+        return new SchemaSyncReservations(iModel, schemaSync);
+    }
+    [Symbols_1._close]() {
+        try {
+            this._schemaSync.close();
+        }
+        catch {
+            // best-effort cleanup; never throw out of close hooks
+        }
+    }
+    needsElementReservation(federationGuid) {
+        if (!SchemaSync_1.SchemaSync.isEnabled(this._iModel))
+            return false;
+        if (!core_bentley_1.Guid.isGuid(federationGuid))
+            core_common_1.ElementReservationError.throwError("invalid-reservation", { message: "Invalid federationGuid" });
+        return !this._schemaSync.reader.findReservedElement(federationGuid);
+    }
+    async reserveElements(args) {
+        const validated = this.validateProposedReservations(args);
+        await this._schemaSync.writeLocker.reserveElements(validated);
+    }
+    [Symbols_1._onReservedElementInsert](arg) {
+        if (!SchemaSync_1.SchemaSync.isEnabled(arg.iModel) || arg.iModel.holdsSchemaLock)
+            return;
+        const fedGuid = arg.props.federationGuid;
+        // The hook is only invoked for elements with an explicitly-set federationGuid (gated in Element.onInsert),
+        // but validate defensively.
+        if (fedGuid === undefined || !core_bentley_1.Guid.isGuid(fedGuid))
+            core_common_1.ElementReservationError.throwError("invalid-reservation", { message: "Element inserts require a valid federationGuid when SchemaSync is enabled" });
+        // It should be impossible for us to still have local changes, but check just in case,
+        // since we can't trust the contents of the SchemaSyncDb until they've been successfully pushed.
+        if (this._schemaSync.container.hasLocalChanges)
+            core_common_1.ElementReservationError.throwError("container-has-local-changes", { message: "Element inserts are not allowed when there are local changes in the SchemaSync container" });
+        const code = core_common_1.Code.fromJSON(arg.props.code);
+        const existing = this._schemaSync.reader.findReservedElement(fedGuid);
+        if (!existing) {
+            core_common_1.ElementReservationError.throwError("reservation-not-found", {
+                message: `No SchemaSync reservation found for element with federationGuid ${fedGuid} — include it in a SynchronousChannel.Reservations.reserveElements call before inserting`,
+                federationGuid: fedGuid,
+            });
+        }
+        const expectedClassId = arg.iModel[Symbols_1._nativeDb].classNameToId(arg.props.classFullName);
+        if (existing.ecClassId !== expectedClassId) {
+            core_common_1.ElementReservationError.throwError("reservation-conflict", {
+                message: `Element ${existing.federationGuid} reserved as a different class than the insert (${existing.ecClassId} vs ${expectedClassId})`,
+                federationGuid: existing.federationGuid,
+            });
+        }
+        if (!existing.code.equals(code))
+            core_common_1.ElementReservationError.throwError("reservation-conflict", {
+                message: `Element ${existing.federationGuid} insert uses a different Code than was reserved`,
+                federationGuid: existing.federationGuid,
+            });
+        arg.props.id = existing.elementId;
+        const options = arg.options ?? (arg.options = {});
+        options.forceUseId = true;
+    }
+    validateProposedReservations(args) {
+        const out = [];
+        const errors = [];
+        for (const props of args.elements) {
+            if (!props.federationGuid || !core_bentley_1.Guid.isGuid(props.federationGuid)) {
+                errors.push(`element reservation requires an explicit, valid federationGuid (got '${props.federationGuid ?? "<none>"}')`);
+                continue;
+            }
+            const code = props.code ? core_common_1.Code.fromJSON(props.code) : core_common_1.Code.createEmpty();
+            if (code.value && !core_common_1.Code.isValid(code)) {
+                errors.push(`(${props.federationGuid}): invalid code '${code.toString()}'`);
+                continue;
+            }
+            const ecClassId = this._iModel[Symbols_1._nativeDb].classNameToId(props.classFullName);
+            if (!core_bentley_1.Id64.isValidId64(ecClassId)) {
+                errors.push(`(${props.federationGuid}): unknown class '${props.classFullName}'`);
+                continue;
+            }
+            out.push({
+                federationGuid: props.federationGuid,
+                ecClassId,
+                code,
+                isCategory: props.classFullName === Category_1.Category.classFullName || this._iModel[Symbols_1._nativeDb].isSubClassOf(props.classFullName, Category_1.Category.classFullName),
+            });
+        }
+        if (errors.length > 0)
+            core_common_1.ElementReservationError.throwError("invalid-reservation", { message: `Invalid element(s) for reservation:\n  ${errors.join("\n  ")}` });
+        return out;
+    }
+}
+async function createSchemaSyncReservations(iModel) {
+    return SchemaSyncReservations.create(iModel);
+}
+//# sourceMappingURL=SchemaSyncReservations.js.map

package/lib/cjs/internal/SchemaSyncReservations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaSyncReservations.js","sourceRoot":"","sources":["../../../src/internal/SchemaSyncReservations.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;AAuI/F,oEAEC;AAvID;;GAEG;AAEH,sDAA6D;AAC7D,oDAAmE;AAInE,8CAA2C;AAC3C,uCAAmG;AACnG,0CAAuC;AAEvC,MAAM,sBAAsB;IACV,CAAC,mCAAyB,CAAC,GAAG,SAAS,CAAC;IACxD,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1B,OAAO,CAAW;IAClB,WAAW,CAAyB;IAErD,YAAoB,MAAgB,EAAE,UAAkC;QACtE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAgB;QACzC,MAAM,UAAU,GAAG,MAAM,uBAAU,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC3D,UAAU,CAAC,oBAAoB,EAAE,CAAC;QAClC,OAAO,IAAI,sBAAsB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IAEM,CAAC,gBAAM,CAAC;QACb,IAAI,CAAC;YACH,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,sDAAsD;QACxD,CAAC;IACH,CAAC;IAEM,uBAAuB,CAAC,cAA0B;QACvD,IAAI,CAAC,uBAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;YACrC,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,mBAAI,CAAC,MAAM,CAAC,cAAc,CAAC;YAC9B,qCAAuB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC,CAAC;QAEnG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,IAA4C;QACvE,MAAM,SAAS,GAAG,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;IAEM,CAAC,kCAAwB,CAAC,CAAC,GAAsB;QACtD,IAAI,CAAC,uBAAU,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,eAAe;YACjE,OAAO;QAET,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC;QACzC,2GAA2G;QAC3G,4BAA4B;QAC5B,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YAChD,qCAAuB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,2EAA2E,EAAE,CAAC,CAAC;QAEtJ,sFAAsF;QACtF,gGAAgG;QAChG,IAAI,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,eAAe;YAC5C,qCAAuB,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,OAAO,EAAE,0FAA0F,EAAE,CAAC,CAAC;QAE7K,MAAM,IAAI,GAAG,kBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE3C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACtE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,qCAAuB,CAAC,UAAU,CAAC,uBAAuB,EAAE;gBAC1D,OAAO,EAAE,mEAAmE,OAAO,0FAA0F;gBAC7K,cAAc,EAAE,OAAO;aACxB,CAAC,CAAC;QACL,CAAC;QAED,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,mBAAS,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACrF,IAAI,QAAQ,CAAC,SAAS,KAAK,eAAe,EAAE,CAAC;YAC3C,qCAAuB,CAAC,UAAU,CAAC,sBAAsB,EAAE;gBACzD,OAAO,EAAE,WAAW,QAAQ,CAAC,cAAc,mDAAmD,QAAQ,CAAC,SAAS,OAAO,eAAe,GAAG;gBACzI,cAAc,EAAE,QAAQ,CAAC,cAAc;aACxC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAC7B,qCAAuB,CAAC,UAAU,CAAC,sBAAsB,EAAE;gBACzD,OAAO,EAAE,WAAW,QAAQ,CAAC,cAAc,iDAAiD;gBAC5F,cAAc,EAAE,QAAQ,CAAC,cAAc;aACxC,CAAC,CAAC;QAEL,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC;QAClC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,EAA0B,CAAC,CAAC;QAC1E,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAC5B,CAAC;IAEO,4BAA4B,CAAC,IAA4C;QAC/E,MAAM,GAAG,GAA4C,EAAE,CAAC;QACxD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,CAAC,mBAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;gBAChE,MAAM,CAAC,IAAI,CAAC,wEAAwE,KAAK,CAAC,cAAc,IAAI,QAAQ,IAAI,CAAC,CAAC;gBAC1H,SAAS;YACX,CAAC;YAED,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC;YACzE,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,kBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,cAAc,oBAAoB,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;gBAC5E,SAAS;YACX,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAS,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC7E,IAAI,CAAC,mBAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,cAAc,qBAAqB,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC;gBACjF,SAAS;YACX,CAAC;YAED,GAAG,CAAC,IAAI,CAAC;gBACP,cAAc,EAAE,KAAK,CAAC,cAAc;gBACpC,SAAS;gBACT,IAAI;gBACJ,UAAU,EAAE,KAAK,CAAC,aAAa,KAAK,mBAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAS,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,EAAE,mBAAQ,CAAC,aAAa,CAAC;aAChJ,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YACnB,qCAAuB,CAAC,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,0CAA0C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAE1I,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAEM,KAAK,UAAU,4BAA4B,CAAC,MAAgB;IACjE,OAAO,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC","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\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { Guid, GuidString, Id64 } from \"@itwin/core-bentley\";\r\nimport { Code, ElementReservationError } from \"@itwin/core-common\";\r\nimport { OnElementPropsArg } from \"../Element\";\r\nimport { IModelDb, InsertElementOptions } from \"../IModelDb\";\r\nimport { SynchronousChannel } from \"../SynchronousChannel\";\r\nimport { SchemaSync } from \"../SchemaSync\";\r\nimport { _close, _implementationProhibited, _nativeDb, _onReservedElementInsert } from \"./Symbols\";\r\nimport { Category } from \"../Category\";\r\n\r\nclass SchemaSyncReservations implements SynchronousChannel.Reservations {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  public get isServerBased() { return true; }\r\n  private readonly _iModel: IModelDb;\r\n  private readonly _schemaSync: SchemaSync.CloudAccess;\r\n\r\n  private constructor(iModel: IModelDb, schemaSync: SchemaSync.CloudAccess) {\r\n    this._iModel = iModel;\r\n    this._schemaSync = schemaSync;\r\n  }\r\n\r\n  public static async create(iModel: IModelDb): Promise<SchemaSyncReservations> {\r\n    const schemaSync = await SchemaSync.getCloudAccess(iModel);\r\n    schemaSync.synchronizeWithCloud();\r\n    return new SchemaSyncReservations(iModel, schemaSync);\r\n  }\r\n\r\n  public [_close](): void {\r\n    try {\r\n      this._schemaSync.close();\r\n    } catch {\r\n      // best-effort cleanup; never throw out of close hooks\r\n    }\r\n  }\r\n\r\n  public needsElementReservation(federationGuid: GuidString): boolean {\r\n    if (!SchemaSync.isEnabled(this._iModel))\r\n      return false;\r\n\r\n    if (!Guid.isGuid(federationGuid))\r\n      ElementReservationError.throwError(\"invalid-reservation\", { message: \"Invalid federationGuid\" });\r\n\r\n    return !this._schemaSync.reader.findReservedElement(federationGuid);\r\n  }\r\n\r\n  public async reserveElements(args: SynchronousChannel.ReserveElementsArgs): Promise<void> {\r\n    const validated = this.validateProposedReservations(args);\r\n    await this._schemaSync.writeLocker.reserveElements(validated);\r\n  }\r\n\r\n  public [_onReservedElementInsert](arg: OnElementPropsArg): void {\r\n    if (!SchemaSync.isEnabled(arg.iModel) || arg.iModel.holdsSchemaLock)\r\n      return;\r\n\r\n    const fedGuid = arg.props.federationGuid;\r\n    // The hook is only invoked for elements with an explicitly-set federationGuid (gated in Element.onInsert),\r\n    // but validate defensively.\r\n    if (fedGuid === undefined || !Guid.isGuid(fedGuid))\r\n      ElementReservationError.throwError(\"invalid-reservation\", { message: \"Element inserts require a valid federationGuid when SchemaSync is enabled\" });\r\n\r\n    // It should be impossible for us to still have local changes, but check just in case,\r\n    // since we can't trust the contents of the SchemaSyncDb until they've been successfully pushed.\r\n    if (this._schemaSync.container.hasLocalChanges)\r\n      ElementReservationError.throwError(\"container-has-local-changes\", { message: \"Element inserts are not allowed when there are local changes in the SchemaSync container\" });\r\n\r\n    const code = Code.fromJSON(arg.props.code);\r\n\r\n    const existing = this._schemaSync.reader.findReservedElement(fedGuid);\r\n    if (!existing) {\r\n      ElementReservationError.throwError(\"reservation-not-found\", {\r\n        message: `No SchemaSync reservation found for element with federationGuid ${fedGuid} — include it in a SynchronousChannel.Reservations.reserveElements call before inserting`,\r\n        federationGuid: fedGuid,\r\n      });\r\n    }\r\n\r\n    const expectedClassId = arg.iModel[_nativeDb].classNameToId(arg.props.classFullName);\r\n    if (existing.ecClassId !== expectedClassId) {\r\n      ElementReservationError.throwError(\"reservation-conflict\", {\r\n        message: `Element ${existing.federationGuid} reserved as a different class than the insert (${existing.ecClassId} vs ${expectedClassId})`,\r\n        federationGuid: existing.federationGuid,\r\n      });\r\n    }\r\n\r\n    if (!existing.code.equals(code))\r\n      ElementReservationError.throwError(\"reservation-conflict\", {\r\n        message: `Element ${existing.federationGuid} insert uses a different Code than was reserved`,\r\n        federationGuid: existing.federationGuid,\r\n      });\r\n\r\n    arg.props.id = existing.elementId;\r\n    const options = arg.options ?? (arg.options = {} as InsertElementOptions);\r\n    options.forceUseId = true;\r\n  }\r\n\r\n  private validateProposedReservations(args: SynchronousChannel.ReserveElementsArgs): SchemaSync.ProposedElementReservation[] {\r\n    const out: SchemaSync.ProposedElementReservation[] = [];\r\n    const errors: string[] = [];\r\n    for (const props of args.elements) {\r\n      if (!props.federationGuid || !Guid.isGuid(props.federationGuid)) {\r\n        errors.push(`element reservation requires an explicit, valid federationGuid (got '${props.federationGuid ?? \"<none>\"}')`);\r\n        continue;\r\n      }\r\n\r\n      const code = props.code ? Code.fromJSON(props.code) : Code.createEmpty();\r\n      if (code.value && !Code.isValid(code)) {\r\n        errors.push(`(${props.federationGuid}): invalid code '${code.toString()}'`);\r\n        continue;\r\n      }\r\n\r\n      const ecClassId = this._iModel[_nativeDb].classNameToId(props.classFullName);\r\n      if (!Id64.isValidId64(ecClassId)) {\r\n        errors.push(`(${props.federationGuid}): unknown class '${props.classFullName}'`);\r\n        continue;\r\n      }\r\n\r\n      out.push({\r\n        federationGuid: props.federationGuid,\r\n        ecClassId,\r\n        code,\r\n        isCategory: props.classFullName === Category.classFullName || this._iModel[_nativeDb].isSubClassOf(props.classFullName, Category.classFullName),\r\n      });\r\n    }\r\n\r\n    if (errors.length > 0)\r\n      ElementReservationError.throwError(\"invalid-reservation\", { message: `Invalid element(s) for reservation:\\n  ${errors.join(\"\\n  \")}` });\r\n\r\n    return out;\r\n  }\r\n}\r\n\r\nexport async function createSchemaSyncReservations(iModel: IModelDb): Promise<SynchronousChannel.Reservations> {\r\n  return SchemaSyncReservations.create(iModel);\r\n}\r\n"]}

package/lib/cjs/internal/Symbols.d.ts

@@ -23,4 +23,5 @@ export declare const _instanceKeyCache: unique symbol;
 /** @internal */
 export declare const _activeTxn: unique symbol;
 export declare const _resetIModelDb: unique symbol;
+export declare const _onReservedElementInsert: unique symbol;
 //# sourceMappingURL=Symbols.d.ts.map

package/lib/cjs/internal/Symbols.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Symbols.d.ts","sourceRoot":"","sources":["../../../src/internal/Symbols.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,eAAO,MAAM,yBAAyB,eAAmG,CAAC;AAM1I,eAAO,MAAM,MAAM,eAA2B,CAAC;AAC/C,eAAO,MAAM,kBAAkB,eAAuC,CAAC;AACvE,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,QAAQ,eAA6B,CAAC;AACnD,eAAO,MAAM,IAAI,eAAyB,CAAC;AAC3C,gBAAgB;AAChB,eAAO,MAAM,YAAY,eAAiC,CAAC;AAC3D,gBAAgB;AAChB,eAAO,MAAM,SAAS,eAA8B,CAAC;AACrD,eAAO,MAAM,gBAAgB,eAAqC,CAAC;AACnE,eAAO,MAAM,cAAc,eAAmC,CAAC;AAC/D,gBAAgB;AAChB,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,aAAa,eAAkC,CAAC;AAC7D,eAAO,MAAM,aAAa,eAAkC,CAAC;AAC7D,eAAO,MAAM,eAAe,eAAoC,CAAC;AACjE,eAAO,MAAM,MAAM,eAA2B,CAAC;AAC/C,eAAO,MAAM,iBAAiB,eAAsC,CAAC;AACrE,gBAAgB;AAChB,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,cAAc,eAAmC,CAAC"}
+{"version":3,"file":"Symbols.d.ts","sourceRoot":"","sources":["../../../src/internal/Symbols.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,eAAO,MAAM,yBAAyB,eAAmG,CAAC;AAM1I,eAAO,MAAM,MAAM,eAA2B,CAAC;AAC/C,eAAO,MAAM,kBAAkB,eAAuC,CAAC;AACvE,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,QAAQ,eAA6B,CAAC;AACnD,eAAO,MAAM,IAAI,eAAyB,CAAC;AAC3C,gBAAgB;AAChB,eAAO,MAAM,YAAY,eAAiC,CAAC;AAC3D,gBAAgB;AAChB,eAAO,MAAM,SAAS,eAA8B,CAAC;AACrD,eAAO,MAAM,gBAAgB,eAAqC,CAAC;AACnE,eAAO,MAAM,cAAc,eAAmC,CAAC;AAC/D,gBAAgB;AAChB,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,aAAa,eAAkC,CAAC;AAC7D,eAAO,MAAM,aAAa,eAAkC,CAAC;AAC7D,eAAO,MAAM,eAAe,eAAoC,CAAC;AACjE,eAAO,MAAM,MAAM,eAA2B,CAAC;AAC/C,eAAO,MAAM,iBAAiB,eAAsC,CAAC;AACrE,gBAAgB;AAChB,eAAO,MAAM,UAAU,eAA+B,CAAC;AACvD,eAAO,MAAM,cAAc,eAAmC,CAAC;AAC/D,eAAO,MAAM,wBAAwB,eAA6C,CAAC"}

package/lib/cjs/internal/Symbols.js

@@ -7,7 +7,7 @@
  * @module Workspace
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._resetIModelDb = exports._activeTxn = exports._instanceKeyCache = exports._cache = exports._mockCheckpoint = exports._getHubAccess = exports._setHubAccess = exports._hubAccess = exports._verifyChannel = exports._releaseAllLocks = exports._nativeDb = exports._implicitTxn = exports._key = exports._getData = exports._faceProps = exports._elementWasCreated = exports._close = exports._implementationProhibited = void 0;
+exports._onReservedElementInsert = exports._resetIModelDb = exports._activeTxn = exports._instanceKeyCache = exports._cache = exports._mockCheckpoint = exports._getHubAccess = exports._setHubAccess = exports._hubAccess = exports._verifyChannel = exports._releaseAllLocks = exports._nativeDb = exports._implicitTxn = exports._key = exports._getData = exports._faceProps = exports._elementWasCreated = exports._close = exports._implementationProhibited = void 0;
 exports._implementationProhibited = Symbol.for("Implementations of this interface can only be obtained from the containing package");
 function sym(name) {
     return `${name}_core-backend_INTERNAL_ONLY_DO_NOT_USE`;
@@ -33,4 +33,5 @@ exports._instanceKeyCache = Symbol.for(sym("instanceKeyCache"));
 /** @internal */
 exports._activeTxn = Symbol.for(sym("activeTxn"));
 exports._resetIModelDb = Symbol.for(sym("resetIModelDb"));
+exports._onReservedElementInsert = Symbol.for(sym("onReservedElementInsert"));
 //# sourceMappingURL=Symbols.js.map

package/lib/cjs/internal/Symbols.js.map

@@ -1 +1 @@
-{"version":3,"file":"Symbols.js","sourceRoot":"","sources":["../../../src/internal/Symbols.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEU,QAAA,yBAAyB,GAAG,MAAM,CAAC,GAAG,CAAC,oFAAoF,CAAC,CAAC;AAE1I,SAAS,GAAG,CAAC,IAAY;IACvB,OAAO,GAAG,IAAI,wCAAwC,CAAC;AACzD,CAAC;AAEY,QAAA,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,QAAA,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAC1D,QAAA,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C,QAAA,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;AACtC,QAAA,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,gBAAgB;AACH,QAAA,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;AAC3D,gBAAgB;AACH,QAAA,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACxC,QAAA,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACtD,QAAA,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;AAC/D,gBAAgB;AACH,QAAA,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C,QAAA,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;AAChD,QAAA,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;AAChD,QAAA,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;AACpD,QAAA,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,QAAA,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;AACrE,gBAAgB;AACH,QAAA,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C,QAAA,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC","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 Workspace\r\n */\r\n\r\nexport const _implementationProhibited = Symbol.for(\"Implementations of this interface can only be obtained from the containing package\");\r\n\r\nfunction sym(name: string): string {\r\n  return `${name}_core-backend_INTERNAL_ONLY_DO_NOT_USE`;\r\n}\r\n\r\nexport const _close = Symbol.for(sym(\"close\"));\r\nexport const _elementWasCreated = Symbol.for(sym(\"elementWasCreated\"));\r\nexport const _faceProps = Symbol.for(sym(\"faceProps\"));\r\nexport const _getData = Symbol.for(sym(\"getData\"));\r\nexport const _key = Symbol.for(sym(\"key\"));\r\n/** @internal */\r\nexport const _implicitTxn = Symbol.for(sym(\"implicitTxn\"));\r\n/** @internal */\r\nexport const _nativeDb = Symbol.for(sym(\"nativeDb\"));\r\nexport const _releaseAllLocks = Symbol.for(sym(\"releaseAllLocks\"));\r\nexport const _verifyChannel = Symbol.for(sym(\"verifyChannel\"));\r\n/** @internal */\r\nexport const _hubAccess = Symbol.for(sym(\"hubAccess\"));\r\nexport const _setHubAccess = Symbol.for(sym(\"setHubAccess\"));\r\nexport const _getHubAccess = Symbol.for(sym(\"getHubAccess\"));\r\nexport const _mockCheckpoint = Symbol.for(sym(\"mockCheckpoint\"));\r\nexport const _cache = Symbol.for(sym(\"cache\"));\r\nexport const _instanceKeyCache = Symbol.for(sym(\"instanceKeyCache\"));\r\n/** @internal */\r\nexport const _activeTxn = Symbol.for(sym(\"activeTxn\"));\r\nexport const _resetIModelDb = Symbol.for(sym(\"resetIModelDb\"));\r\n"]}
+{"version":3,"file":"Symbols.js","sourceRoot":"","sources":["../../../src/internal/Symbols.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEU,QAAA,yBAAyB,GAAG,MAAM,CAAC,GAAG,CAAC,oFAAoF,CAAC,CAAC;AAE1I,SAAS,GAAG,CAAC,IAAY;IACvB,OAAO,GAAG,IAAI,wCAAwC,CAAC;AACzD,CAAC;AAEY,QAAA,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,QAAA,kBAAkB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAC1D,QAAA,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C,QAAA,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;AACtC,QAAA,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,gBAAgB;AACH,QAAA,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;AAC3D,gBAAgB;AACH,QAAA,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;AACxC,QAAA,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACtD,QAAA,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;AAC/D,gBAAgB;AACH,QAAA,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C,QAAA,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;AAChD,QAAA,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;AAChD,QAAA,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;AACpD,QAAA,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;AAClC,QAAA,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;AACrE,gBAAgB;AACH,QAAA,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C,QAAA,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;AAClD,QAAA,wBAAwB,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,CAAC","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 Workspace\r\n */\r\n\r\nexport const _implementationProhibited = Symbol.for(\"Implementations of this interface can only be obtained from the containing package\");\r\n\r\nfunction sym(name: string): string {\r\n  return `${name}_core-backend_INTERNAL_ONLY_DO_NOT_USE`;\r\n}\r\n\r\nexport const _close = Symbol.for(sym(\"close\"));\r\nexport const _elementWasCreated = Symbol.for(sym(\"elementWasCreated\"));\r\nexport const _faceProps = Symbol.for(sym(\"faceProps\"));\r\nexport const _getData = Symbol.for(sym(\"getData\"));\r\nexport const _key = Symbol.for(sym(\"key\"));\r\n/** @internal */\r\nexport const _implicitTxn = Symbol.for(sym(\"implicitTxn\"));\r\n/** @internal */\r\nexport const _nativeDb = Symbol.for(sym(\"nativeDb\"));\r\nexport const _releaseAllLocks = Symbol.for(sym(\"releaseAllLocks\"));\r\nexport const _verifyChannel = Symbol.for(sym(\"verifyChannel\"));\r\n/** @internal */\r\nexport const _hubAccess = Symbol.for(sym(\"hubAccess\"));\r\nexport const _setHubAccess = Symbol.for(sym(\"setHubAccess\"));\r\nexport const _getHubAccess = Symbol.for(sym(\"getHubAccess\"));\r\nexport const _mockCheckpoint = Symbol.for(sym(\"mockCheckpoint\"));\r\nexport const _cache = Symbol.for(sym(\"cache\"));\r\nexport const _instanceKeyCache = Symbol.for(sym(\"instanceKeyCache\"));\r\n/** @internal */\r\nexport const _activeTxn = Symbol.for(sym(\"activeTxn\"));\r\nexport const _resetIModelDb = Symbol.for(sym(\"resetIModelDb\"));\r\nexport const _onReservedElementInsert = Symbol.for(sym(\"onReservedElementInsert\"));\r\n"]}

package/lib/esm/Category.d.ts

@@ -72,7 +72,7 @@ export declare class SubCategory extends DefinitionElement {
     static insert(txn: EditTxn, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
     /**
      * Insert a new SubCategory
-     * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use SubCategory.insert(txn, ...) instead.
+     * @deprecated in 5.9.0 - might be removed in next major version. Use SubCategory.insert(txn, ...) instead.
      */
     static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
@@ -112,7 +112,7 @@ export declare class Category extends DefinitionElement {
     setDefaultAppearance(txn: EditTxn, props: SubCategoryAppearance.Props | SubCategoryAppearance): void;
     /**
      * Set the appearance of the default SubCategory for this Category
-     * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use Category.setDefaultAppearance(txn, ...) instead.
+     * @deprecated in 5.9.0 - might be removed in next major version. Use Category.setDefaultAppearance(txn, ...) instead.
      */
     setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;
 }
@@ -154,7 +154,7 @@ export declare class DrawingCategory extends Category {
     static insert(txn: EditTxn, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
     /**
      * Insert a new DrawingCategory
-     * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use DrawingCategory.insert(txn, ...) instead.
+     * @deprecated in 5.9.0 - might be removed in next major version. Use DrawingCategory.insert(txn, ...) instead.
      */
     static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
@@ -196,7 +196,7 @@ export declare class SpatialCategory extends Category {
     static insert(txn: EditTxn, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
     /**
      * Insert a new SpatialCategory
-     * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use SpatialCategory.insert(txn, ...) instead.
+     * @deprecated in 5.9.0 - might be removed in next major version. Use SpatialCategory.insert(txn, ...) instead.
      */
     static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }

package/lib/esm/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,WAAW,EAAiB,IAAI,EAA0C,IAAI,EAAE,qBAAqB,GACtG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,iBAAiB;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,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,SAAS,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,SAAS,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,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,QAAQ,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,WAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,IAAI,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,qBAAqB;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,yBAAyB,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;IAkBM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAC3J,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAChF,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,IAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,SAAS,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,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,SAAS,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,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAY1F,oBAAoB,CAAC,UAAyE,EAAE,KAA2D;QAChK,IAAI,GAAY,CAAC;QACjB,IAAI,UAA+D,CAAC;QACpE,IAAI,UAAU,YAAY,OAAO,EAAE,CAAC;YAClC,GAAG,GAAG,UAAU,CAAC;YACjB,IAAI,KAAK,KAAK,SAAS;gBACrB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACtC,UAAU,GAAG,KAAK,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAChC,UAAU,GAAG,UAAU,CAAC;QAC1B,CAAC;QACD,IAAI,UAAU,YAAY,qBAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,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,WAAW,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,IAAI,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;IAkBM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QACnK,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAClE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,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,WAAW,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,IAAI,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;IAkBM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QACnK,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAClE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF","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 iModels\r\n */\r\n\r\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement } from \"./Element\";\r\nimport { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\r\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\r\nimport { _implicitTxn } from \"./internal/Symbols\";\r\n\r\n/** Defines the appearance for graphics in Geometric elements\r\n * @public @preview\r\n */\r\nexport class SubCategory extends DefinitionElement {\r\n  public static override get className(): string { return \"SubCategory\"; }\r\n  /** The Appearance parameters for this SubCategory */\r\n  public appearance: SubCategoryAppearance;\r\n  /** Optional description of this SubCategory. */\r\n  public description?: string;\r\n\r\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.appearance = new SubCategoryAppearance(props.appearance);\r\n    this.description = JsonUtils.asString(props.description);\r\n  }\r\n\r\n  /**\r\n   * SubCategory custom HandledProps include 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"description\", source: \"Class\" },\r\n    { propertyName: \"properties\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * SubCategory deserializes 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\r\n    const elProps = super.deserialize(props) as SubCategoryProps;\r\n    elProps.description = JsonUtils.asString(props.row.description);\r\n    if (props.row.properties !== '') {\r\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\r\n    } else {\r\n      elProps.appearance = undefined;\r\n    }\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * SubCategory serialize 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    if (props.description !== undefined) {\r\n      inst.description = props.description;\r\n    }\r\n    if (props.appearance !== undefined) {\r\n      inst.properties = JSON.stringify(props.appearance);\r\n    }\r\n    return inst;\r\n  }\r\n\r\n  public override toJSON(): SubCategoryProps {\r\n    const val = super.toJSON() as SubCategoryProps;\r\n    val.appearance = this.appearance.toJSON();\r\n    if (this.description && this.description.length > 0)\r\n      val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Get the SubCategory's name (its Code value). */\r\n  public getSubCategoryName(): string { return this.code.value; }\r\n  /** Get the Id of the SubCategory. */\r\n  public getSubCategoryId(): Id64String { return this.id; }\r\n  /** Get the Id of this SubCategory's parent Category. */\r\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\r\n  /** Check if this is the default SubCategory of its parent Category. */\r\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\r\n\r\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\r\n   * @param iModel  The IModel\r\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\r\n   * @param codeValue The name of the SubCategory\r\n   */\r\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\r\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new SubCategory\r\n   * @param iModelDb The iModel\r\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\r\n   * @param name The name of the SubCategory\r\n   * @param appearance The appearance settings to use for this SubCategory\r\n   * @returns The newly constructed SubCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\r\n    if (appearance instanceof SubCategoryAppearance)\r\n      appearance = appearance.toJSON();\r\n\r\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\r\n    const subCategoryProps: SubCategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: parentCategory.model,\r\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\r\n      code: this.createCode(iModelDb, parentCategoryId, name),\r\n      appearance,\r\n    };\r\n    return new SubCategory(subCategoryProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new SubCategory\r\n   * @param txn The EditTxn to use\r\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\r\n   * @param name The name of the SubCategory\r\n   * @param appearance The appearance settings to use for this SubCategory\r\n   * @returns The Id of the newly inserted SubCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  /**\r\n   * Insert a new SubCategory\r\n   * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use SubCategory.insert(txn, ...) instead.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const subCategory = this.create(txn.iModel, parentCategoryId, name, appearance);\r\n    return subCategory.insert(txn);\r\n  }\r\n}\r\n\r\n/** A Category element is the target of the `category` member of [[GeometricElement]].\r\n * @public @preview\r\n */\r\nexport class Category extends DefinitionElement {\r\n  public static override get className(): string { return \"Category\"; }\r\n  public rank: Rank = Rank.User;\r\n  public description?: string;\r\n\r\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.rank = JsonUtils.asInt(props.rank);\r\n    this.description = JsonUtils.asString(props.description);\r\n  }\r\n\r\n  /**\r\n   * Category custom HandledProps include 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"rank\", source: \"Class\" },\r\n    { propertyName: \"description\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * Category deserializes 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\r\n    const elProps = super.deserialize(props) as CategoryProps;\r\n    elProps.description = JsonUtils.asString(props.row.description);\r\n    elProps.rank = JsonUtils.asInt(props.row.rank);\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * Category serialize 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    if (undefined !== props.description) {\r\n      inst.description = props.description;\r\n    }\r\n    inst.rank = props.rank;\r\n    return inst;\r\n  }\r\n  public override toJSON(): CategoryProps {\r\n    const val = super.toJSON() as CategoryProps;\r\n    val.rank = this.rank;\r\n    if (this.description && this.description.length > 0)\r\n      val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Get the Id of the default SubCategory for this Category. */\r\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\r\n\r\n  /**\r\n   * Set the appearance of the default SubCategory for this Category\r\n   * @beta\r\n   */\r\n  public setDefaultAppearance(txn: EditTxn, props: SubCategoryAppearance.Props | SubCategoryAppearance): void;\r\n  /**\r\n   * Set the appearance of the default SubCategory for this Category\r\n   * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use Category.setDefaultAppearance(txn, ...) instead.\r\n   */\r\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;\r\n  public setDefaultAppearance(txnOrProps: EditTxn | SubCategoryAppearance.Props | SubCategoryAppearance, props?: SubCategoryAppearance.Props | SubCategoryAppearance): void {\r\n    let txn: EditTxn;\r\n    let appearance: SubCategoryAppearance.Props | SubCategoryAppearance;\r\n    if (txnOrProps instanceof EditTxn) {\r\n      txn = txnOrProps;\r\n      if (props === undefined)\r\n        throw new Error(\"Invalid argument\");\r\n      appearance = props;\r\n    } else {\r\n      txn = this.iModel[_implicitTxn];\r\n      appearance = txnOrProps;\r\n    }\r\n    if (appearance instanceof SubCategoryAppearance)\r\n      appearance = appearance.toJSON();\r\n\r\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\r\n    subCat.appearance = new SubCategoryAppearance(appearance);\r\n    subCat.update(txn);\r\n  }\r\n}\r\n\r\n/** Categorizes 2d GeometricElements.\r\n * @public @preview\r\n */\r\nexport class DrawingCategory extends Category {\r\n  public static override get className(): string { return \"DrawingCategory\"; }\r\n\r\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\r\n\r\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\r\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\r\n\r\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\r\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\r\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\r\n    return iModel.elements.queryElementIdByCode(code);\r\n  }\r\n\r\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\r\n   * @param codeValue The name of the category\r\n   * @return A drawing category Code\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new DrawingCategory\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name of the DrawingCategory\r\n   * @returns The newly constructed DrawingCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\r\n    const categoryProps: CategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      isPrivate: false,\r\n    };\r\n    return new DrawingCategory(categoryProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new DrawingCategory\r\n   * @param txn The EditTxn to use\r\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\r\n   * @param name The name of the DrawingCategory\r\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\r\n   * @returns The Id of the newly inserted DrawingCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  /**\r\n   * Insert a new DrawingCategory\r\n   * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use DrawingCategory.insert(txn, ...) instead.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const category = this.create(txn.iModel, definitionModelId, name);\r\n    category.id = category.insert(txn);\r\n    category.setDefaultAppearance(txn, defaultAppearance);\r\n    return category.id;\r\n  }\r\n}\r\n\r\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\r\n * @public @preview\r\n */\r\nexport class SpatialCategory extends Category {\r\n  public static override get className(): string { return \"SpatialCategory\"; }\r\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\r\n\r\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\r\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\r\n\r\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\r\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\r\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\r\n    return iModel.elements.queryElementIdByCode(code);\r\n  }\r\n\r\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\r\n   * @param codeValue The name of the category\r\n   * @return A spatial category Code\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new SpatialCategory\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the SpatialCategory\r\n   * @returns The newly constructed SpatialCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\r\n    const categoryProps: CategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      isPrivate: false,\r\n    };\r\n    return new SpatialCategory(categoryProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new SpatialCategory\r\n   * @param txn The EditTxn to use\r\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\r\n   * @param name The name of the SpatialCategory\r\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\r\n   * @returns The Id of the newly inserted SpatialCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  /**\r\n   * Insert a new SpatialCategory\r\n   * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use SpatialCategory.insert(txn, ...) instead.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const category = this.create(txn.iModel, definitionModelId, name);\r\n    category.id = category.insert(txn);\r\n    category.setDefaultAppearance(txn, defaultAppearance);\r\n    return category.id;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,WAAW,EAAiB,IAAI,EAA0C,IAAI,EAAE,qBAAqB,GACtG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,iBAAiB;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,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,SAAS,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,SAAS,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,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,QAAQ,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,WAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,IAAI,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,qBAAqB;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,yBAAyB,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;IAkBM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAC3J,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAChF,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,IAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,SAAS,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,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,SAAS,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,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAY1F,oBAAoB,CAAC,UAAyE,EAAE,KAA2D;QAChK,IAAI,GAAY,CAAC;QACjB,IAAI,UAA+D,CAAC;QACpE,IAAI,UAAU,YAAY,OAAO,EAAE,CAAC;YAClC,GAAG,GAAG,UAAU,CAAC;YACjB,IAAI,KAAK,KAAK,SAAS;gBACrB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACtC,UAAU,GAAG,KAAK,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAChC,UAAU,GAAG,UAAU,CAAC;QAC1B,CAAC;QACD,IAAI,UAAU,YAAY,qBAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,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,WAAW,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,IAAI,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;IAkBM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QACnK,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAClE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,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,WAAW,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,IAAI,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;IAkBM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QACnK,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAClE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF","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 iModels\r\n */\r\n\r\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement } from \"./Element\";\r\nimport { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\r\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\r\nimport { _implicitTxn } from \"./internal/Symbols\";\r\n\r\n/** Defines the appearance for graphics in Geometric elements\r\n * @public @preview\r\n */\r\nexport class SubCategory extends DefinitionElement {\r\n  public static override get className(): string { return \"SubCategory\"; }\r\n  /** The Appearance parameters for this SubCategory */\r\n  public appearance: SubCategoryAppearance;\r\n  /** Optional description of this SubCategory. */\r\n  public description?: string;\r\n\r\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.appearance = new SubCategoryAppearance(props.appearance);\r\n    this.description = JsonUtils.asString(props.description);\r\n  }\r\n\r\n  /**\r\n   * SubCategory custom HandledProps include 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"description\", source: \"Class\" },\r\n    { propertyName: \"properties\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * SubCategory deserializes 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\r\n    const elProps = super.deserialize(props) as SubCategoryProps;\r\n    elProps.description = JsonUtils.asString(props.row.description);\r\n    if (props.row.properties !== '') {\r\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\r\n    } else {\r\n      elProps.appearance = undefined;\r\n    }\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * SubCategory serialize 'description' and 'properties'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    if (props.description !== undefined) {\r\n      inst.description = props.description;\r\n    }\r\n    if (props.appearance !== undefined) {\r\n      inst.properties = JSON.stringify(props.appearance);\r\n    }\r\n    return inst;\r\n  }\r\n\r\n  public override toJSON(): SubCategoryProps {\r\n    const val = super.toJSON() as SubCategoryProps;\r\n    val.appearance = this.appearance.toJSON();\r\n    if (this.description && this.description.length > 0)\r\n      val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Get the SubCategory's name (its Code value). */\r\n  public getSubCategoryName(): string { return this.code.value; }\r\n  /** Get the Id of the SubCategory. */\r\n  public getSubCategoryId(): Id64String { return this.id; }\r\n  /** Get the Id of this SubCategory's parent Category. */\r\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\r\n  /** Check if this is the default SubCategory of its parent Category. */\r\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\r\n\r\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\r\n   * @param iModel  The IModel\r\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\r\n   * @param codeValue The name of the SubCategory\r\n   */\r\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\r\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new SubCategory\r\n   * @param iModelDb The iModel\r\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\r\n   * @param name The name of the SubCategory\r\n   * @param appearance The appearance settings to use for this SubCategory\r\n   * @returns The newly constructed SubCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\r\n    if (appearance instanceof SubCategoryAppearance)\r\n      appearance = appearance.toJSON();\r\n\r\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\r\n    const subCategoryProps: SubCategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: parentCategory.model,\r\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\r\n      code: this.createCode(iModelDb, parentCategoryId, name),\r\n      appearance,\r\n    };\r\n    return new SubCategory(subCategoryProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new SubCategory\r\n   * @param txn The EditTxn to use\r\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\r\n   * @param name The name of the SubCategory\r\n   * @param appearance The appearance settings to use for this SubCategory\r\n   * @returns The Id of the newly inserted SubCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  /**\r\n   * Insert a new SubCategory\r\n   * @deprecated in 5.9.0 - might be removed in next major version. Use SubCategory.insert(txn, ...) instead.\r\n   */\r\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const subCategory = this.create(txn.iModel, parentCategoryId, name, appearance);\r\n    return subCategory.insert(txn);\r\n  }\r\n}\r\n\r\n/** A Category element is the target of the `category` member of [[GeometricElement]].\r\n * @public @preview\r\n */\r\nexport class Category extends DefinitionElement {\r\n  public static override get className(): string { return \"Category\"; }\r\n  public rank: Rank = Rank.User;\r\n  public description?: string;\r\n\r\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.rank = JsonUtils.asInt(props.rank);\r\n    this.description = JsonUtils.asString(props.description);\r\n  }\r\n\r\n  /**\r\n   * Category custom HandledProps include 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\r\n    { propertyName: \"rank\", source: \"Class\" },\r\n    { propertyName: \"description\", source: \"Class\" },\r\n  ];\r\n\r\n  /**\r\n   * Category deserializes 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\r\n    const elProps = super.deserialize(props) as CategoryProps;\r\n    elProps.description = JsonUtils.asString(props.row.description);\r\n    elProps.rank = JsonUtils.asInt(props.row.rank);\r\n    return elProps;\r\n  }\r\n\r\n  /**\r\n   * Category serialize 'rank' and 'description'.\r\n   * @inheritdoc\r\n   * @beta\r\n   */\r\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\r\n    const inst = super.serialize(props, iModel);\r\n    if (undefined !== props.description) {\r\n      inst.description = props.description;\r\n    }\r\n    inst.rank = props.rank;\r\n    return inst;\r\n  }\r\n  public override toJSON(): CategoryProps {\r\n    const val = super.toJSON() as CategoryProps;\r\n    val.rank = this.rank;\r\n    if (this.description && this.description.length > 0)\r\n      val.description = this.description;\r\n    return val;\r\n  }\r\n\r\n  /** Get the Id of the default SubCategory for this Category. */\r\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\r\n\r\n  /**\r\n   * Set the appearance of the default SubCategory for this Category\r\n   * @beta\r\n   */\r\n  public setDefaultAppearance(txn: EditTxn, props: SubCategoryAppearance.Props | SubCategoryAppearance): void;\r\n  /**\r\n   * Set the appearance of the default SubCategory for this Category\r\n   * @deprecated in 5.9.0 - might be removed in next major version. Use Category.setDefaultAppearance(txn, ...) instead.\r\n   */\r\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;\r\n  public setDefaultAppearance(txnOrProps: EditTxn | SubCategoryAppearance.Props | SubCategoryAppearance, props?: SubCategoryAppearance.Props | SubCategoryAppearance): void {\r\n    let txn: EditTxn;\r\n    let appearance: SubCategoryAppearance.Props | SubCategoryAppearance;\r\n    if (txnOrProps instanceof EditTxn) {\r\n      txn = txnOrProps;\r\n      if (props === undefined)\r\n        throw new Error(\"Invalid argument\");\r\n      appearance = props;\r\n    } else {\r\n      txn = this.iModel[_implicitTxn];\r\n      appearance = txnOrProps;\r\n    }\r\n    if (appearance instanceof SubCategoryAppearance)\r\n      appearance = appearance.toJSON();\r\n\r\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\r\n    subCat.appearance = new SubCategoryAppearance(appearance);\r\n    subCat.update(txn);\r\n  }\r\n}\r\n\r\n/** Categorizes 2d GeometricElements.\r\n * @public @preview\r\n */\r\nexport class DrawingCategory extends Category {\r\n  public static override get className(): string { return \"DrawingCategory\"; }\r\n\r\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\r\n\r\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\r\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\r\n\r\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\r\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\r\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\r\n    return iModel.elements.queryElementIdByCode(code);\r\n  }\r\n\r\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\r\n   * @param codeValue The name of the category\r\n   * @return A drawing category Code\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new DrawingCategory\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name of the DrawingCategory\r\n   * @returns The newly constructed DrawingCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\r\n    const categoryProps: CategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      isPrivate: false,\r\n    };\r\n    return new DrawingCategory(categoryProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new DrawingCategory\r\n   * @param txn The EditTxn to use\r\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\r\n   * @param name The name of the DrawingCategory\r\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\r\n   * @returns The Id of the newly inserted DrawingCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  /**\r\n   * Insert a new DrawingCategory\r\n   * @deprecated in 5.9.0 - might be removed in next major version. Use DrawingCategory.insert(txn, ...) instead.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const category = this.create(txn.iModel, definitionModelId, name);\r\n    category.id = category.insert(txn);\r\n    category.setDefaultAppearance(txn, defaultAppearance);\r\n    return category.id;\r\n  }\r\n}\r\n\r\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\r\n * @public @preview\r\n */\r\nexport class SpatialCategory extends Category {\r\n  public static override get className(): string { return \"SpatialCategory\"; }\r\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\r\n\r\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\r\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\r\n\r\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\r\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\r\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\r\n    return iModel.elements.queryElementIdByCode(code);\r\n  }\r\n\r\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\r\n   * @param codeValue The name of the category\r\n   * @return A spatial category Code\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a new SpatialCategory\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the SpatialCategory\r\n   * @returns The newly constructed SpatialCategory element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\r\n    const categoryProps: CategoryProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      isPrivate: false,\r\n    };\r\n    return new SpatialCategory(categoryProps, iModelDb);\r\n  }\r\n\r\n  /**\r\n   * Insert a new SpatialCategory\r\n   * @param txn The EditTxn to use\r\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\r\n   * @param name The name of the SpatialCategory\r\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\r\n   * @returns The Id of the newly inserted SpatialCategory element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   * @beta\r\n   */\r\n  public static insert(txn: EditTxn, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  /**\r\n   * Insert a new SpatialCategory\r\n   * @deprecated in 5.9.0 - might be removed in next major version. Use SpatialCategory.insert(txn, ...) instead.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const category = this.create(txn.iModel, definitionModelId, name);\r\n    category.id = category.insert(txn);\r\n    category.setDefaultAppearance(txn, defaultAppearance);\r\n    return category.id;\r\n  }\r\n}\r\n"]}

package/lib/esm/ChangesetECAdaptor.d.ts

@@ -225,6 +225,11 @@ export declare class ChangesetECAdaptor implements Disposable {
      * @param accessString access string token separated by '.'.
      */
     private static setValue;
+    /**
+     * Determine if a property path segment could be used to reach the prototype chain.
+     * @param propertyName single segment of an access string.
+     */
+    private static isUnsafePropertyName;
     /**
      * Check if sqlite change table is a EC data table
      * @param tableName name of the table.

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

@@ -1 +1 @@
-{"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;AAyVvH;;;;KAIK;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;;;;GAIG;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;AA8BD;;;;GAIG;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;;;EAGE;AACF,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;;;;;;GAMG;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;IAOlB;;;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;;;;;;;EAOE;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"}
+{"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;AAyVvH;;;;KAIK;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;;;;GAIG;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;AA8BD;;;;GAIG;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;;;EAGE;AACF,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;;;;;;GAMG;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;IAOlB;;;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;;;;;;;EAOE;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;IAuBvB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAInC;;;;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/esm/ChangesetECAdaptor.js

@@ -804,20 +804,30 @@ export class ChangesetECAdaptor {
     static setValue(targetObj, accessString, value) {
         let cursor = targetObj;
         const propPath = accessString.split(".");
+        // Validate every segment before mutating anything so a dangerous segment later in the path
+        // cannot leave partially written data behind.
         propPath.forEach((propertyName) => {
-            if (propertyName === "__proto__")
-                throw new Error("access string cannot container __proto__");
+            if (ChangesetECAdaptor.isUnsafePropertyName(propertyName))
+                throw new Error(`access string cannot contain ${propertyName}`);
         });
         const leafProp = propPath.splice(-1).shift();
         if (!leafProp)
             throw new Error("not access string was specified.");
         for (const elem of propPath) {
-            if (typeof cursor[elem] === "undefined")
+            // Only follow own properties. Inherited members must never be traversed or mutated.
+            if (!Object.prototype.hasOwnProperty.call(cursor, elem) || typeof cursor[elem] === "undefined")
                 cursor[elem] = {};
             cursor = cursor[elem];
         }
         cursor[leafProp] = value;
     }
+    /**
+     * Determine if a property path segment could be used to reach the prototype chain.
+     * @param propertyName single segment of an access string.
+     */
+    static isUnsafePropertyName(propertyName) {
+        return propertyName === "__proto__" || propertyName === "constructor" || propertyName === "prototype";
+    }
     /**
      * Check if sqlite change table is a EC data table
      * @param tableName name of the table.