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

package/lib/cjs/Schema.d.ts

@@ -1,6 +1,7 @@
 /** @packageDocumentation
  * @module Schema
  */
+import { SchemaKey } from "@itwin/ecschema-metadata";
 /** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).
  * @public
  */
@@ -11,6 +12,10 @@ export declare class Schema {
      * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)
      */
     static get schemaName(): string;
+    /** Unique identifier for this schema, typed variant of [[schemaName]].
+     * @internal
+     */
+    static get schemaKey(): SchemaKey;
     /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.
      * Classes generated for this Schema will disallow protected operations.
      * @internal
@@ -30,13 +35,32 @@ export declare class Schema {
      */
     protected constructor();
 }
+/**
+ * Holds a map of registered schemas.
+ * @public
+ */
+export declare class SchemaMap {
+    private readonly _schemas;
+    /** @internal */
+    get(schemaName: string): typeof Schema | undefined;
+    /** @internal */
+    set(schemaName: string, schema: typeof Schema): void;
+    /** @internal */
+    delete(schemaName: string): boolean;
+    /** Register a schema prior to using it.
+     * @throws [[IModelError]] if a schema of the same name is already registered.
+     * @public
+     */
+    registerSchema(schema: typeof Schema): void;
+}
 /** Manages registered schemas
  * @public
  */
 export declare class Schemas {
-    private static readonly _registeredSchemas;
+    private static readonly _globalSchemas;
     private constructor();
     /** Register a schema prior to using it.
+     * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.
      * @throws [[IModelError]] if a schema of the same name is already registered.
      */
     static registerSchema(schema: typeof Schema): void;

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

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH;;GAEG;AACH,qBAAa,MAAM;IACjB;;;;OAIG;IACH,WAAkB,UAAU,IAAI,MAAM,CAA4E;IAElH;;;OAGG;IACH,WAAkB,uBAAuB,IAAI,OAAO,CAAkB;IAEtE;;;;;;OAMG;WACW,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAQ3D;;;OAGG;IACH,SAAS;CACV;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAoC;IAC9E,OAAO;IAEP;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,OAAO,MAAM;IAOlD;;;;OAIG;WACW,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAQ3D;;;OAGG;WACW,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;CACjF"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAa,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAEhE;;GAEG;AACH,qBAAa,MAAM;IACjB;;;;OAIG;IACH,WAAkB,UAAU,IAAI,MAAM,CAA4E;IAElH;;OAEG;IACH,WAAkB,SAAS,IAAI,SAAS,CAGvC;IAED;;;OAGG;IACH,WAAkB,uBAAuB,IAAI,OAAO,CAAkB;IAEtE;;;;;;OAMG;WACW,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAQ3D;;;OAGG;IACH,SAAS;CACV;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoC;IAE3D,gBAAgB;IACT,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAIzD,gBAAgB;IACT,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM,GAAG,IAAI;IAI3D,gBAAgB;IACT,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAI5C;;;OAGG;IACI,cAAc,CAAC,MAAM,EAAE,OAAO,MAAM;CAM5C;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAmB;IACzD,OAAO;IAEP;;;OAGG;WACW,cAAc,CAAC,MAAM,EAAE,OAAO,MAAM;IAIlD;;;;OAIG;WACW,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAQ3D;;;OAGG;WACW,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;CACjF"}

package/lib/cjs/Schema.js

@@ -7,10 +7,11 @@
  * @module Schema
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schemas = exports.Schema = void 0;
+exports.Schemas = exports.SchemaMap = exports.Schema = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const ClassRegistry_1 = require("./ClassRegistry");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 /** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).
  * @public
  */
@@ -21,6 +22,13 @@ class Schema {
      * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)
      */
     static get schemaName() { throw new Error(`you must override static schemaName in ${this.name}`); }
+    /** Unique identifier for this schema, typed variant of [[schemaName]].
+     * @internal
+     */
+    static get schemaKey() {
+        // We cannot cache this here because the schemaName may be overridden without this being overridden
+        return new ecschema_metadata_1.SchemaKey(this.schemaName, ecschema_metadata_1.ECVersion.NO_VERSION); // backend cares little for versions right now, as only one version can exist in an imodel
+    }
     /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.
      * Classes generated for this Schema will disallow protected operations.
      * @internal
@@ -47,19 +55,48 @@ class Schema {
     constructor() { throw new Error(`cannot create an instance of a Schema ${this.constructor.name}`); }
 }
 exports.Schema = Schema;
+/**
+ * Holds a map of registered schemas.
+ * @public
+ */
+class SchemaMap {
+    _schemas = new Map();
+    /** @internal */
+    get(schemaName) {
+        return this._schemas.get(schemaName.toLowerCase());
+    }
+    /** @internal */
+    set(schemaName, schema) {
+        this._schemas.set(schemaName.toLowerCase(), schema);
+    }
+    /** @internal */
+    delete(schemaName) {
+        return this._schemas.delete(schemaName.toLowerCase());
+    }
+    /** Register a schema prior to using it.
+     * @throws [[IModelError]] if a schema of the same name is already registered.
+     * @public
+     */
+    registerSchema(schema) {
+        const key = schema.schemaName.toLowerCase();
+        if (this.get(key))
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.DuplicateName, `Schema "${schema.schemaName}" is already registered`);
+        this.set(key, schema);
+    }
+}
+exports.SchemaMap = SchemaMap;
 /** Manages registered schemas
  * @public
  */
 class Schemas {
+    static _globalSchemas = new SchemaMap();
     constructor() { } // this is a singleton
     /** Register a schema prior to using it.
+     * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.
      * @throws [[IModelError]] if a schema of the same name is already registered.
      */
     static registerSchema(schema) {
-        const key = schema.schemaName.toLowerCase();
-        if (this.getRegisteredSchema(key))
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.DuplicateName, `Schema "${schema.schemaName}" is already registered`);
-        this._registeredSchemas.set(key, schema);
+        this._globalSchemas.registerSchema(schema);
     }
     /** Unregister a schema, by name, if one is already registered.
      * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
@@ -70,14 +107,13 @@ class Schemas {
         const schema = this.getRegisteredSchema(schemaName);
         if (undefined !== schema)
             ClassRegistry_1.ClassRegistry.unregisterClassesFrom(schema);
-        return this._registeredSchemas.delete(schemaName.toLowerCase());
+        return this._globalSchemas.delete(schemaName.toLowerCase());
     }
     /** Look up a previously registered schema
      * @param schemaName The name of the schema
      * @returns the previously registered schema or undefined if not registered.
      */
-    static getRegisteredSchema(schemaName) { return this._registeredSchemas.get(schemaName.toLowerCase()); }
+    static getRegisteredSchema(schemaName) { return this._globalSchemas.get(schemaName.toLowerCase()); }
 }
 exports.Schemas = Schemas;
-Schemas._registeredSchemas = new Map();
 //# sourceMappingURL=Schema.js.map

package/lib/cjs/Schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmD;AACnD,oDAAiD;AACjD,mDAAgD;AAEhD;;GAEG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,KAAK,UAAU,KAAa,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAElH;;;OAGG;IACI,MAAM,KAAK,uBAAuB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtE;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,aAAqB;QAChD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,IAAI,cAAc;YAChB,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,gBAA0B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/G;AAlCD,wBAkCC;AAED;;GAEG;AACH,MAAa,OAAO;IAElB,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,MAAqB;QAChD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;YAC/B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,SAAS,KAAK,MAAM;YACtB,6BAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,UAAkB,IAA+B,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;;AA/BpJ,0BAgCC;AA/ByB,0BAAkB,GAAG,IAAI,GAAG,EAAyB,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 Schema\r\n */\r\n\r\nimport { IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { ClassRegistry } from \"./ClassRegistry\";\r\n\r\n/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).\r\n * @public\r\n */\r\nexport class Schema {\r\n  /** The name of the BIS schema handled by this Schema.\r\n   * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.\r\n   * Failure to do so will ordinarily result in an error when the schema is registered, since there may only\r\n   * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)\r\n   */\r\n  public static get schemaName(): string { throw new Error(`you must override static schemaName in ${this.name}`); }\r\n\r\n  /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.\r\n   * Classes generated for this Schema will disallow protected operations.\r\n   * @internal\r\n   */\r\n  public static get missingRequiredBehavior(): boolean { return false; }\r\n\r\n  /** Get a semver-compatible string from a padded version string.\r\n   * works on unpadded version strings as well\r\n   * if there is no write version, it will be added\r\n   * @example Schema.toSemverString(\"1.02.03\") === \"1.2.3\"\r\n   * @example Schema.toSemverString(\"1.01\") === \"1.0.1\" // write version was added\r\n   * @beta\r\n   */\r\n  public static toSemverString(paddedVersion: string): string {\r\n    const tuple = paddedVersion.split(\".\").map(Number);\r\n    const noWriteVersion = tuple.length === 2;\r\n    if (noWriteVersion)\r\n      tuple.splice(1, 0, 0); // insert 0 before the second element\r\n    return tuple.join(\".\");\r\n  }\r\n\r\n  /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an\r\n   * error if it is ever called.\r\n   * @internal\r\n   */\r\n  protected constructor() { throw new Error(`cannot create an instance of a Schema ${this.constructor.name}`); }\r\n}\r\n\r\n/** Manages registered schemas\r\n * @public\r\n */\r\nexport class Schemas {\r\n  private static readonly _registeredSchemas = new Map<string, typeof Schema>();\r\n  private constructor() { } // this is a singleton\r\n\r\n  /** Register a schema prior to using it.\r\n   * @throws [[IModelError]] if a schema of the same name is already registered.\r\n   */\r\n  public static registerSchema(schema: typeof Schema) {\r\n    const key = schema.schemaName.toLowerCase();\r\n    if (this.getRegisteredSchema(key))\r\n      throw new IModelError(IModelStatus.DuplicateName, `Schema \"${schema.schemaName}\" is already registered`);\r\n    this._registeredSchemas.set(key, schema);\r\n  }\r\n\r\n  /** Unregister a schema, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schemaName Name of the schema to unregister\r\n   * @return true if the schema was unregistered\r\n   */\r\n  public static unregisterSchema(schemaName: string): boolean {\r\n    const schema = this.getRegisteredSchema(schemaName);\r\n    if (undefined !== schema)\r\n      ClassRegistry.unregisterClassesFrom(schema);\r\n\r\n    return this._registeredSchemas.delete(schemaName.toLowerCase());\r\n  }\r\n\r\n  /** Look up a previously registered schema\r\n   * @param schemaName The name of the schema\r\n   * @returns the previously registered schema or undefined if not registered.\r\n   */\r\n  public static getRegisteredSchema(schemaName: string): typeof Schema | undefined { return this._registeredSchemas.get(schemaName.toLowerCase()); }\r\n}\r\n"]}
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmD;AACnD,oDAAiD;AACjD,mDAAgD;AAChD,gEAAgE;AAEhE;;GAEG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,KAAK,UAAU,KAAa,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAElH;;OAEG;IACI,MAAM,KAAK,SAAS;QACzB,mGAAmG;QACnG,OAAO,IAAI,6BAAS,CAAC,IAAI,CAAC,UAAU,EAAE,6BAAS,CAAC,UAAU,CAAC,CAAC,CAAC,0FAA0F;IACzJ,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,uBAAuB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtE;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,aAAqB;QAChD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,IAAI,cAAc;YAChB,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,gBAA0B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/G;AA1CD,wBA0CC;AAED;;;GAGG;AACH,MAAa,SAAS;IACH,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE3D,gBAAgB;IACT,GAAG,CAAC,UAAkB;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,UAAkB,EAAE,MAAqB;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACxD,CAAC;IAEH;;;OAGG;IACI,cAAc,CAAC,MAAqB;QACzC,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YACf,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AA5BD,8BA4BC;AAED;;GAEG;AACH,MAAa,OAAO;IACV,MAAM,CAAU,cAAc,GAAG,IAAI,SAAS,EAAE,CAAC;IACzD,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,MAAqB;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,SAAS,KAAK,MAAM;YACtB,6BAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,UAAkB,IAA+B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;;AA7BhJ,0BA8BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { IModelStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport { ECVersion, SchemaKey } from \"@itwin/ecschema-metadata\";\n\n/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).\n * @public\n */\nexport class Schema {\n  /** The name of the BIS schema handled by this Schema.\n   * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.\n   * Failure to do so will ordinarily result in an error when the schema is registered, since there may only\n   * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)\n   */\n  public static get schemaName(): string { throw new Error(`you must override static schemaName in ${this.name}`); }\n\n  /** Unique identifier for this schema, typed variant of [[schemaName]].\n   * @internal\n   */\n  public static get schemaKey(): SchemaKey {\n    // We cannot cache this here because the schemaName may be overridden without this being overridden\n    return new SchemaKey(this.schemaName, ECVersion.NO_VERSION); // backend cares little for versions right now, as only one version can exist in an imodel\n  }\n\n  /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.\n   * Classes generated for this Schema will disallow protected operations.\n   * @internal\n   */\n  public static get missingRequiredBehavior(): boolean { return false; }\n\n  /** Get a semver-compatible string from a padded version string.\n   * works on unpadded version strings as well\n   * if there is no write version, it will be added\n   * @example Schema.toSemverString(\"1.02.03\") === \"1.2.3\"\n   * @example Schema.toSemverString(\"1.01\") === \"1.0.1\" // write version was added\n   * @beta\n   */\n  public static toSemverString(paddedVersion: string): string {\n    const tuple = paddedVersion.split(\".\").map(Number);\n    const noWriteVersion = tuple.length === 2;\n    if (noWriteVersion)\n      tuple.splice(1, 0, 0); // insert 0 before the second element\n    return tuple.join(\".\");\n  }\n\n  /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an\n   * error if it is ever called.\n   * @internal\n   */\n  protected constructor() { throw new Error(`cannot create an instance of a Schema ${this.constructor.name}`); }\n}\n\n/**\n * Holds a map of registered schemas.\n * @public\n */\nexport class SchemaMap {\n  private readonly _schemas = new Map<string, typeof Schema>();\n\n    /** @internal */\n    public get(schemaName: string): typeof Schema | undefined {\n      return this._schemas.get(schemaName.toLowerCase());\n    }\n\n    /** @internal */\n    public set(schemaName: string, schema: typeof Schema): void {\n      this._schemas.set(schemaName.toLowerCase(), schema);\n    }\n\n    /** @internal */\n    public delete(schemaName: string): boolean {\n      return this._schemas.delete(schemaName.toLowerCase());\n    }\n\n  /** Register a schema prior to using it.\n   * @throws [[IModelError]] if a schema of the same name is already registered.\n   * @public\n   */\n  public registerSchema(schema: typeof Schema) {\n    const key = schema.schemaName.toLowerCase();\n    if (this.get(key))\n      throw new IModelError(IModelStatus.DuplicateName, `Schema \"${schema.schemaName}\" is already registered`);\n    this.set(key, schema);\n  }\n}\n\n/** Manages registered schemas\n * @public\n */\nexport class Schemas {\n  private static readonly _globalSchemas = new SchemaMap();\n  private constructor() { } // this is a singleton\n\n  /** Register a schema prior to using it.\n   * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.\n   * @throws [[IModelError]] if a schema of the same name is already registered.\n   */\n  public static registerSchema(schema: typeof Schema) {\n    this._globalSchemas.registerSchema(schema);\n  }\n\n  /** Unregister a schema, by name, if one is already registered.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\n   * @param schemaName Name of the schema to unregister\n   * @return true if the schema was unregistered\n   */\n  public static unregisterSchema(schemaName: string): boolean {\n    const schema = this.getRegisteredSchema(schemaName);\n    if (undefined !== schema)\n      ClassRegistry.unregisterClassesFrom(schema);\n\n    return this._globalSchemas.delete(schemaName.toLowerCase());\n  }\n\n  /** Look up a previously registered schema\n   * @param schemaName The name of the schema\n   * @returns the previously registered schema or undefined if not registered.\n   */\n  public static getRegisteredSchema(schemaName: string): typeof Schema | undefined { return this._globalSchemas.get(schemaName.toLowerCase()); }\n}\n"]}

package/lib/cjs/SchemaSync.js

@@ -21,10 +21,7 @@ var SchemaSync;
     const lockParams = { retryDelayMs: 1000, nRetries: 30 };
     /** A CloudSqlite database for synchronizing schema changes across briefcases.  */
     class SchemaSyncDb extends SQLiteDb_1.VersionedSqliteDb {
-        constructor() {
-            super(...arguments);
-            this.myVersion = "4.0.0";
-        }
+        myVersion = "4.0.0";
         createDDL() { }
     }
     SchemaSync.SchemaSyncDb = SchemaSyncDb;

package/lib/cjs/SchemaSync.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,+CAA4C;AAC5C,yCAA+C;AAC/C,yCAAmD;AACnD,sDAAyD;AACzD,oDAAgE;AAEhE,8DAAyD;AACzD,gDAA+C;AAE/C,gBAAgB;AAChB,IAAiB,UAAU,CAsI1B;AAtID,WAAiB,UAAU;IACzB,MAAM,UAAU,GAAiC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEtF,kFAAkF;IAClF,MAAa,YAAa,SAAQ,4BAAiB;QAAnD;;YAC2B,cAAS,GAAG,OAAO,CAAC;QAE/C,CAAC;QADoB,SAAS,KAAK,CAAC;KACnC;IAHY,uBAAY,eAGxB,CAAA;IAED,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAClE,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,MAAM,oBAAoB,GAAG,6BAA6B,CAAC;IAC3D,iBAAiB;IACJ,uBAAY,GAAG,CAAC,MAAgB,EAAE,SAAkB,EAAE,EAAE;QACnE,IAAI,SAAS;YACX,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,KAAK,EAAE,GAAoD,EAAE,EAAE;QACpF,IAAI,QAA0C,CAAC;QAC/C,MAAM,aAAa,GAAG,GAAG,YAAY,mBAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,mBAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAuB,CAAC;QACzF,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAA+B,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,yBAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;YACrE,IAAI,aAAa;gBACf,MAAM,CAAC,QAAQ,CAAC,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAClF,OAAO,MAAM,CAAC;QAChB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEW,2BAAgB,GAAG,KAAK,EAAE,MAAuD,EAAE,IAAmE,EAAE,SAAiD,EAAiB,EAAE;QACvO,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,6BAAkB,GAAG,KAAK,EAAE,MAAuD,EAAE,SAAiD,EAAiB,EAAE;QACpK,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAC9B,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,oBAAS,GAAG,CAAC,MAAgB,EAAE,EAAE;QAC5C,OAAO,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAChE,MAAM,UAAU,CAAC,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC5C,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAClD,MAAM,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEW,8BAAmB,GAAG,KAAK,EAAE,GAAkG,EAAE,EAAE;QAC9I,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,oCAAoC;QACrL,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,MAAM,YAAY,sBAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACjC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBACnC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,sFAAsF,CAAC,CAAC;YAC1I,CAAC;YACD,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,MAAM,WAAA,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,uBAAuB,EAAE,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;gBACzG,MAAM,CAAC,WAAW,CAAC,qCAAqC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,GAAG,CAAC,iBAAiB;gBACvB,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,uDAAuD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;;gBAEzH,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,mDAAmD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACzH,CAAC;IACH,CAAC,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,yBAAW,CAAC,QAAsB;QACjE,YAAmB,KAAuC;YACxD,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAChE,CAAC;QAEM,MAAM;YACX,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,aAAa,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1I,CAAC;QACD;;;;SAIC;QACM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAiC;YAChE,OAAO,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,CAAC;KACF;IAhBY,sBAAW,cAgBvB,CAAA;AACH,CAAC,EAtIgB,UAAU,0BAAV,UAAU,QAsI1B","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 SQLiteDb\r\n */\r\n\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\r\nimport { BriefcaseDb, IModelDb } from \"./IModelDb\";\r\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModelError, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n/** @internal */\r\nexport namespace SchemaSync {\r\n  const lockParams: CloudSqlite.ObtainLockParams = { retryDelayMs: 1000, nRetries: 30 };\r\n\r\n  /** A CloudSqlite database for synchronizing schema changes across briefcases.  */\r\n  export class SchemaSyncDb extends VersionedSqliteDb {\r\n    public override readonly myVersion = \"4.0.0\";\r\n    protected override createDDL() { }\r\n  }\r\n\r\n  const syncProperty = { namespace: \"itwinjs\", name: \"SchemaSync\" };\r\n  const defaultDbName = \"SchemaSyncDb\";\r\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\";\r\n  // for tests only\r\n  export const setTestCache = (iModel: IModelDb, cacheName?: string) => {\r\n    if (cacheName)\r\n      iModel[_nativeDb].saveLocalValue(testSyncCachePropKey, cacheName);\r\n    else\r\n      iModel[_nativeDb].deleteLocalValue(testSyncCachePropKey);\r\n  };\r\n\r\n  const getCloudAccess = async (arg: IModelDb | { readonly fileName: LocalFileName }) => {\r\n    let nativeDb: IModelJsNative.DgnDb | undefined;\r\n    const argIsIModelDb = arg instanceof IModelDb;\r\n    if (argIsIModelDb) {\r\n      nativeDb = arg[_nativeDb];\r\n    } else {\r\n      nativeDb = new IModelNative.platform.DgnDb();\r\n      nativeDb.openIModel(arg.fileName, OpenMode.Readonly);\r\n    }\r\n\r\n    const propsString = nativeDb.queryFileProperty(syncProperty, true) as string | undefined;\r\n    if (!propsString)\r\n      throw new Error(\"iModel does not have a SchemaSyncDb\");\r\n    try {\r\n      const props = JSON.parse(propsString) as CloudSqlite.ContainerProps;\r\n      const accessToken = await CloudSqlite.requestToken(props);\r\n      const access = new CloudAccess({ ...props, accessToken });\r\n      Object.assign(access.lockParams, lockParams);\r\n      const testSyncCache = nativeDb.queryLocalValue(testSyncCachePropKey);\r\n      if (testSyncCache)\r\n        access.setCache(CloudSqlite.CloudCaches.getCache({ cacheName: testSyncCache }));\r\n      return access;\r\n    } finally {\r\n      if (!argIsIModelDb) {\r\n        nativeDb.closeFile();\r\n      }\r\n    }\r\n  };\r\n\r\n  export const withLockedAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, args: { operationName: string, openMode?: OpenMode, user?: string }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\r\n    const access = await getCloudAccess(iModel);\r\n    try {\r\n      await access.withLockedDb(args, async () => operation(access));\r\n    } finally {\r\n      access.close();\r\n    }\r\n  };\r\n\r\n  export const withReadonlyAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\r\n    const access = await getCloudAccess(iModel);\r\n    access.synchronizeWithCloud();\r\n    access.openForRead();\r\n    try {\r\n      await operation(access);\r\n    } finally {\r\n      access.close();\r\n    }\r\n  };\r\n\r\n  export const isEnabled = (iModel: IModelDb) => {\r\n    return iModel[_nativeDb].schemaSyncEnabled();\r\n  };\r\n\r\n  /** Synchronize local briefcase schemas with cloud container */\r\n  export const pull = async (iModel: IModelDb) => {\r\n    if (iModel[_nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {\r\n      await SchemaSync.withReadonlyAccess(iModel, async (syncAccess) => {\r\n        const schemaSyncDbUri = syncAccess.getUri();\r\n        iModel.clearCaches();\r\n        iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);\r\n        iModel.saveChanges(\"schema synchronized with cloud container\");\r\n      });\r\n    }\r\n  };\r\n\r\n  export const initializeForIModel = async (arg: { iModel: IModelDb, containerProps: CloudSqlite.ContainerProps, overrideContainer?: boolean }) => {\r\n    const props = { baseUri: arg.containerProps.baseUri, containerId: arg.containerProps.containerId, storageType: arg.containerProps.storageType }; // sanitize to only known properties\r\n    const iModel = arg.iModel;\r\n    const briefcase = iModel instanceof BriefcaseDb ? iModel : undefined;\r\n    await iModel.acquireSchemaLock();\r\n    if (briefcase) {\r\n      if (briefcase.txns.hasLocalChanges) {\r\n        throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Enabling SchemaSync for iModel failed. There are unsaved or un-pushed local changes.\");\r\n      }\r\n      await briefcase.pullChanges();\r\n    }\r\n    try {\r\n      iModel.saveFileProperty(syncProperty, JSON.stringify(props));\r\n      await withLockedAccess(arg.iModel, { operationName: \"initialize schemaSync\", openMode: OpenMode.Readonly }, async (syncAccess) => {\r\n        iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);\r\n        iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);\r\n      });\r\n    } catch (err) {\r\n      throw err;\r\n    } finally {\r\n      iModel.abandonChanges();\r\n    }\r\n\r\n    if (briefcase) {\r\n      if (arg.overrideContainer)\r\n        await briefcase.pushChanges({ description: `Overriding SchemaSync for iModel with container-id: ${props.containerId}` });\r\n      else\r\n        await briefcase.pushChanges({ description: `Enable SchemaSync for iModel with container-id: ${props.containerId}` });\r\n    }\r\n  };\r\n\r\n  /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */\r\n  export class CloudAccess extends CloudSqlite.DbAccess<SchemaSyncDb> {\r\n    public constructor(props: CloudSqlite.ContainerAccessProps) {\r\n      super({ dbType: SchemaSyncDb, props, dbName: defaultDbName });\r\n    }\r\n\r\n    public getUri() {\r\n      return `${this.getCloudDb()[_nativeDb].getFilePath()}?vfs=${this.container.cache?.name}&writable=${this.container.isWriteable ? 1 : 0}`;\r\n    }\r\n    /**\r\n   * Initialize a cloud container for use as a SchemaSync. The container must first be created via its storage supplier api (e.g. Azure, or AWS).\r\n   * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty ChannelDb into the container.\r\n   * @note this deletes any existing content in the container.\r\n   */\r\n    public static async initializeDb(props: CloudSqlite.ContainerProps) {\r\n      return super._initializeDb({ props, dbType: SchemaSyncDb, dbName: defaultDbName });\r\n    }\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,+CAA4C;AAC5C,yCAA+C;AAC/C,yCAAmD;AACnD,sDAAyD;AACzD,oDAAgE;AAEhE,8DAAyD;AACzD,gDAA+C;AAE/C,gBAAgB;AAChB,IAAiB,UAAU,CAsI1B;AAtID,WAAiB,UAAU;IACzB,MAAM,UAAU,GAAiC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEtF,kFAAkF;IAClF,MAAa,YAAa,SAAQ,4BAAiB;QACxB,SAAS,GAAG,OAAO,CAAC;QAC1B,SAAS,KAAK,CAAC;KACnC;IAHY,uBAAY,eAGxB,CAAA;IAED,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAClE,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,MAAM,oBAAoB,GAAG,6BAA6B,CAAC;IAC3D,iBAAiB;IACJ,uBAAY,GAAG,CAAC,MAAgB,EAAE,SAAkB,EAAE,EAAE;QACnE,IAAI,SAAS;YACX,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,KAAK,EAAE,GAAoD,EAAE,EAAE;QACpF,IAAI,QAA0C,CAAC;QAC/C,MAAM,aAAa,GAAG,GAAG,YAAY,mBAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,mBAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAuB,CAAC;QACzF,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAA+B,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,yBAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;YACrE,IAAI,aAAa;gBACf,MAAM,CAAC,QAAQ,CAAC,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAClF,OAAO,MAAM,CAAC;QAChB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEW,2BAAgB,GAAG,KAAK,EAAE,MAAuD,EAAE,IAAmE,EAAE,SAAiD,EAAiB,EAAE;QACvO,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,6BAAkB,GAAG,KAAK,EAAE,MAAuD,EAAE,SAAiD,EAAiB,EAAE;QACpK,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAC9B,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,oBAAS,GAAG,CAAC,MAAgB,EAAE,EAAE;QAC5C,OAAO,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAChE,MAAM,UAAU,CAAC,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC5C,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAClD,MAAM,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEW,8BAAmB,GAAG,KAAK,EAAE,GAAkG,EAAE,EAAE;QAC9I,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,oCAAoC;QACrL,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,MAAM,YAAY,sBAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACjC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBACnC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,sFAAsF,CAAC,CAAC;YAC1I,CAAC;YACD,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,MAAM,WAAA,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,uBAAuB,EAAE,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;gBACzG,MAAM,CAAC,WAAW,CAAC,qCAAqC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,GAAG,CAAC,iBAAiB;gBACvB,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,uDAAuD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;;gBAEzH,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,mDAAmD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACzH,CAAC;IACH,CAAC,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,yBAAW,CAAC,QAAsB;QACjE,YAAmB,KAAuC;YACxD,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAChE,CAAC;QAEM,MAAM;YACX,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,aAAa,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1I,CAAC;QACD;;;;SAIC;QACM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAiC;YAChE,OAAO,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,CAAC;KACF;IAhBY,sBAAW,cAgBvB,CAAA;AACH,CAAC,EAtIgB,UAAU,0BAAV,UAAU,QAsI1B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module SQLiteDb\n */\n\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\nimport { BriefcaseDb, IModelDb } from \"./IModelDb\";\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\nimport { IModelError, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** @internal */\nexport namespace SchemaSync {\n  const lockParams: CloudSqlite.ObtainLockParams = { retryDelayMs: 1000, nRetries: 30 };\n\n  /** A CloudSqlite database for synchronizing schema changes across briefcases.  */\n  export class SchemaSyncDb extends VersionedSqliteDb {\n    public override readonly myVersion = \"4.0.0\";\n    protected override createDDL() { }\n  }\n\n  const syncProperty = { namespace: \"itwinjs\", name: \"SchemaSync\" };\n  const defaultDbName = \"SchemaSyncDb\";\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\";\n  // for tests only\n  export const setTestCache = (iModel: IModelDb, cacheName?: string) => {\n    if (cacheName)\n      iModel[_nativeDb].saveLocalValue(testSyncCachePropKey, cacheName);\n    else\n      iModel[_nativeDb].deleteLocalValue(testSyncCachePropKey);\n  };\n\n  const getCloudAccess = async (arg: IModelDb | { readonly fileName: LocalFileName }) => {\n    let nativeDb: IModelJsNative.DgnDb | undefined;\n    const argIsIModelDb = arg instanceof IModelDb;\n    if (argIsIModelDb) {\n      nativeDb = arg[_nativeDb];\n    } else {\n      nativeDb = new IModelNative.platform.DgnDb();\n      nativeDb.openIModel(arg.fileName, OpenMode.Readonly);\n    }\n\n    const propsString = nativeDb.queryFileProperty(syncProperty, true) as string | undefined;\n    if (!propsString)\n      throw new Error(\"iModel does not have a SchemaSyncDb\");\n    try {\n      const props = JSON.parse(propsString) as CloudSqlite.ContainerProps;\n      const accessToken = await CloudSqlite.requestToken(props);\n      const access = new CloudAccess({ ...props, accessToken });\n      Object.assign(access.lockParams, lockParams);\n      const testSyncCache = nativeDb.queryLocalValue(testSyncCachePropKey);\n      if (testSyncCache)\n        access.setCache(CloudSqlite.CloudCaches.getCache({ cacheName: testSyncCache }));\n      return access;\n    } finally {\n      if (!argIsIModelDb) {\n        nativeDb.closeFile();\n      }\n    }\n  };\n\n  export const withLockedAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, args: { operationName: string, openMode?: OpenMode, user?: string }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\n    const access = await getCloudAccess(iModel);\n    try {\n      await access.withLockedDb(args, async () => operation(access));\n    } finally {\n      access.close();\n    }\n  };\n\n  export const withReadonlyAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\n    const access = await getCloudAccess(iModel);\n    access.synchronizeWithCloud();\n    access.openForRead();\n    try {\n      await operation(access);\n    } finally {\n      access.close();\n    }\n  };\n\n  export const isEnabled = (iModel: IModelDb) => {\n    return iModel[_nativeDb].schemaSyncEnabled();\n  };\n\n  /** Synchronize local briefcase schemas with cloud container */\n  export const pull = async (iModel: IModelDb) => {\n    if (iModel[_nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {\n      await SchemaSync.withReadonlyAccess(iModel, async (syncAccess) => {\n        const schemaSyncDbUri = syncAccess.getUri();\n        iModel.clearCaches();\n        iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);\n        iModel.saveChanges(\"schema synchronized with cloud container\");\n      });\n    }\n  };\n\n  export const initializeForIModel = async (arg: { iModel: IModelDb, containerProps: CloudSqlite.ContainerProps, overrideContainer?: boolean }) => {\n    const props = { baseUri: arg.containerProps.baseUri, containerId: arg.containerProps.containerId, storageType: arg.containerProps.storageType }; // sanitize to only known properties\n    const iModel = arg.iModel;\n    const briefcase = iModel instanceof BriefcaseDb ? iModel : undefined;\n    await iModel.acquireSchemaLock();\n    if (briefcase) {\n      if (briefcase.txns.hasLocalChanges) {\n        throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Enabling SchemaSync for iModel failed. There are unsaved or un-pushed local changes.\");\n      }\n      await briefcase.pullChanges();\n    }\n    try {\n      iModel.saveFileProperty(syncProperty, JSON.stringify(props));\n      await withLockedAccess(arg.iModel, { operationName: \"initialize schemaSync\", openMode: OpenMode.Readonly }, async (syncAccess) => {\n        iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);\n        iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);\n      });\n    } catch (err) {\n      throw err;\n    } finally {\n      iModel.abandonChanges();\n    }\n\n    if (briefcase) {\n      if (arg.overrideContainer)\n        await briefcase.pushChanges({ description: `Overriding SchemaSync for iModel with container-id: ${props.containerId}` });\n      else\n        await briefcase.pushChanges({ description: `Enable SchemaSync for iModel with container-id: ${props.containerId}` });\n    }\n  };\n\n  /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */\n  export class CloudAccess extends CloudSqlite.DbAccess<SchemaSyncDb> {\n    public constructor(props: CloudSqlite.ContainerAccessProps) {\n      super({ dbType: SchemaSyncDb, props, dbName: defaultDbName });\n    }\n\n    public getUri() {\n      return `${this.getCloudDb()[_nativeDb].getFilePath()}?vfs=${this.container.cache?.name}&writable=${this.container.isWriteable ? 1 : 0}`;\n    }\n    /**\n   * Initialize a cloud container for use as a SchemaSync. The container must first be created via its storage supplier api (e.g. Azure, or AWS).\n   * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty ChannelDb into the container.\n   * @note this deletes any existing content in the container.\n   */\n    public static async initializeDb(props: CloudSqlite.ContainerProps) {\n      return super._initializeDb({ props, dbType: SchemaSyncDb, dbName: defaultDbName });\n    }\n  }\n}\n\n"]}

package/lib/cjs/SchemaUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAaH,sEAOC;AAQD,oEAOC;AAjCD,sDAAoD;AACpD,oDAAiD;AAEjD,8DAAyD;AAEzD;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,mDAAmD,CAAC,CAAC;IAElG,OAAO,sBAAsB,CAAC;AAChC,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 Schema\r\n */\r\n\r\nimport { BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { ECSchemaXmlContext } from \"./ECSchemaXmlContext\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\n\r\n/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.\r\n * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.\r\n * @returns EC3.2 Xml ECSchema(s).\r\n * @throws [[IModelError]] if there is a problem converting the EC2 schemas.\r\n * @beta\r\n */\r\nexport function convertEC2SchemasToEC3Schemas(ec2XmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\r\n  const maybeNativeContext = schemaContext?.nativeContext;\r\n  const ec3XmlSchemas: string[] = IModelNative.platform.SchemaUtility.convertEC2XmlSchemas(ec2XmlSchemas, maybeNativeContext);\r\n  if (ec2XmlSchemas.length === 0)\r\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting EC2 Xml schemas\");\r\n\r\n  return ec3XmlSchemas;\r\n}\r\n\r\n/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName\r\n * @param xmlSchemas The ECSchema Xml string(s).\r\n * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.\r\n * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.\r\n * @beta\r\n */\r\nexport function upgradeCustomAttributesToEC3(xmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\r\n  const maybeNativeContext = schemaContext?.nativeContext;\r\n  const schemasWithConvertedCA: string[] = IModelNative.platform.SchemaUtility.convertCustomAttributes(xmlSchemas, maybeNativeContext);\r\n  if (schemasWithConvertedCA.length === 0)\r\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting custom attributes of Xml schemas\");\r\n\r\n  return schemasWithConvertedCA;\r\n}\r\n"]}
+{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAaH,sEAOC;AAQD,oEAOC;AAjCD,sDAAoD;AACpD,oDAAiD;AAEjD,8DAAyD;AAEzD;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,mDAAmD,CAAC,CAAC;IAElG,OAAO,sBAAsB,CAAC;AAChC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { BentleyStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { ECSchemaXmlContext } from \"./ECSchemaXmlContext\";\nimport { IModelNative } from \"./internal/NativePlatform\";\n\n/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.\n * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.\n * @returns EC3.2 Xml ECSchema(s).\n * @throws [[IModelError]] if there is a problem converting the EC2 schemas.\n * @beta\n */\nexport function convertEC2SchemasToEC3Schemas(ec2XmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\n  const maybeNativeContext = schemaContext?.nativeContext;\n  const ec3XmlSchemas: string[] = IModelNative.platform.SchemaUtility.convertEC2XmlSchemas(ec2XmlSchemas, maybeNativeContext);\n  if (ec2XmlSchemas.length === 0)\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting EC2 Xml schemas\");\n\n  return ec3XmlSchemas;\n}\n\n/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName\n * @param xmlSchemas The ECSchema Xml string(s).\n * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.\n * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.\n * @beta\n */\nexport function upgradeCustomAttributesToEC3(xmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\n  const maybeNativeContext = schemaContext?.nativeContext;\n  const schemasWithConvertedCA: string[] = IModelNative.platform.SchemaUtility.convertCustomAttributes(xmlSchemas, maybeNativeContext);\n  if (schemasWithConvertedCA.length === 0)\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting custom attributes of Xml schemas\");\n\n  return schemasWithConvertedCA;\n}\n"]}

package/lib/cjs/SheetIndex.js

@@ -63,6 +63,8 @@ exports.SheetIndex = SheetIndex;
 */
 class SheetIndexEntry extends Element_1.InformationReferenceElement {
     static get className() { return "SheetIndexEntry"; }
+    /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */
+    entryPriority;
     constructor(props, iModel) {
         super(props, iModel);
         this.entryPriority = props.entryPriority;
@@ -128,6 +130,8 @@ exports.SheetIndexFolder = SheetIndexFolder;
 */
 class SheetIndexReference extends SheetIndexEntry {
     static get className() { return "SheetIndexReference"; }
+    /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */
+    sheetIndex;
     constructor(props, iModel) {
         super(props, iModel);
         if (props.sheetIndex) {
@@ -180,6 +184,8 @@ exports.SheetIndexReference = SheetIndexReference;
 */
 class SheetReference extends SheetIndexEntry {
     static get className() { return "SheetReference"; }
+    /** The bis:Sheet that this bis:SheetReference is pointing to. */
+    sheet;
     constructor(props, iModel) {
         super(props, iModel);
         if (props.sheet) {

package/lib/cjs/SheetIndex.js.map

@@ -1 +1 @@
-{"version":3,"file":"SheetIndex.js","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAiP;AACjP,uCAA+D;AAE/D,sDAA+D;AAC/D,qEAAkK;AAkClK;;;;GAIG;AACH,MAAa,UAAW,SAAQ,qCAA2B;IAClD,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,sBAAsC,EAAE,SAAiB;QAClG,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,UAAU,CAAC,CAAC;QAC9E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,KAAK,GAAiB;YAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE;YACvD,KAAK,EAAE,OAAO;SACf,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AA1CD,gCA0CC;AAED;;EAEE;AACF,MAAsB,eAAgB,SAAQ,qCAA2B;IAChE,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAI5E,YAAsB,KAA2B,EAAE,MAAgB;QACjE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAC3C,CAAC;IAEe,MAAM;QACpB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,YAA4B,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,eAAe,CAAC,CAAC;QACrF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAES,MAAM,CAAC,6BAA6B,CAAC,QAAkB,EAAE,EAAc;QAC/E,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,aAAa,KAAK,gBAAgB,CAAC,aAAa,CAAC;QACrF,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,oDAA2B,CAAC,CAAC,CAAC,8CAAqB,CAAC;QAChF,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC;IAES,MAAM,CAAC,WAAW,CAAC,GAA8B;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAyB;YAClC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,GAAG,CAAC,iBAAiB;YAC5B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC;YACpE,aAAa,EAAE,GAAG,CAAC,QAAQ;YAC3B,MAAM;SACP,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA1CD,0CA0CC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,eAAe;IAC5C,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAE7E;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,KAAK,GAA0B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC3D,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAtBD,4CAsBC;AAED;;EAEE;AACF,MAAa,mBAAoB,SAAQ,eAAe;IAC/C,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAKhF,YAAsB,KAA+B,EAAE,MAAgB;QACrE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAa,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAEvE,IAAI,CAAC,UAAU,GAAG,IAAI,8DAAqC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SACvC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,KAAK,GAA6B;YACtC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SACnG,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU;YACjB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAzDD,kDAyDC;AAED;;EAEE;AACF,MAAa,cAAe,SAAQ,eAAe;IAC1C,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAK3E,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAQ,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK;gBACR,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAElE,IAAI,CAAC,KAAK,GAAG,IAAI,oDAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SAC7B,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,KAAK,GAAwB;YACjC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC;CACF;AAzDD,wCAyDC","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 Elements\r\n */\r\n\r\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, ElementProps, EntityReferenceSet, IModelError, RelatedElementProps, SheetIndexEntryProps, SheetIndexFolderProps, SheetIndexReferenceProps, SheetReferenceProps } from \"@itwin/core-common\";\r\nimport { InformationReferenceElement, Sheet } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { SheetIndexFolderOwnsEntries, SheetIndexOwnsEntries, SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from \"./NavigationRelationship\";\r\n\r\n/** Arguments used to create a [[SheetIndexEntry]].\r\n * @beta\r\n */\r\nexport interface SheetIndexEntryCreateArgs {\r\n  /** The iModel that will contain the sheet index entry. */\r\n  iModelDb: IModelDb;\r\n  /** The Id of the [[SheetIndexModel]] that will contain the sheet index entry. */\r\n  sheetIndexModelId: Id64String;\r\n  /** The [[SheetIndex]] or [[SheetIndexFolder]] that is parent to this SheetIndexEntry */\r\n  parentId: Id64String;\r\n  /** The name of the SheetIndexEntry */\r\n  name: string;\r\n  /** The priority of the SheetIndexEntry */\r\n  priority: number;\r\n}\r\n\r\n/** Arguments supplied when creating a [[SheetIndexReference]].\r\n * @beta\r\n */\r\nexport interface SheetIndexReferenceCreateArgs extends SheetIndexEntryCreateArgs {\r\n  /** The [[SheetIndex]] to which the reference refers. */\r\n  sheetIndexId?: Id64String;\r\n}\r\n\r\n/** Arguments supplied when creating a [[SheetReference]].\r\n * @beta\r\n */\r\nexport interface SheetReferenceCreateArgs extends SheetIndexEntryCreateArgs {\r\n  /** The [[Sheet]] to which the reference refers. */\r\n  sheetId?: Id64String;\r\n}\r\n\r\n/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.\r\n * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating\r\n * sub-trees via [[SheetIndexReference]]s.\r\n * @beta\r\n */\r\nexport class SheetIndex extends InformationReferenceElement {\r\n  public static override get className(): string { return \"SheetIndex\"; }\r\n\r\n  /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.\r\n   * @param codeValue The SheetIndex name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeSheetIndexModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.sheetIndex);\r\n    return new Code({ spec: codeSpec.id, scope: scopeSheetIndexModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a SheetIndex\r\n   * @param iModelDb The IModelDb\r\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\r\n   * @param name The name (codeValue) of the SheetIndex\r\n   * @returns The newly constructed SheetIndex\r\n   * @throws [[IModelError]] if there is a problem creating the SheetIndex\r\n   */\r\n  public static create(iModelDb: IModelDb, modelId: Id64String, name: string): SheetIndex {\r\n    const props: ElementProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, modelId, name).toJSON(),\r\n      model: modelId,\r\n    };\r\n    return new this(props, iModelDb);\r\n  }\r\n\r\n  /** Insert a SheetIndex\r\n   * @param iModelDb The IModelDb\r\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\r\n   * @param name The name (codeValue) of the SheetIndex\r\n   * @returns The Id of the newly inserted SheetIndex\r\n   * @throws [[IModelError]] if there is a problem inserting the SheetIndex\r\n   */\r\n  public static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String {\r\n    const instance = this.create(iModelDb, modelId, name);\r\n    const elements = iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n}\r\n\r\n/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.\r\n * @beta\r\n*/\r\nexport abstract class SheetIndexEntry extends InformationReferenceElement {\r\n  public static override get className(): string { return \"SheetIndexEntry\"; }\r\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\r\n  public entryPriority: number;\r\n\r\n  protected constructor(props: SheetIndexEntryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.entryPriority = props.entryPriority;\r\n  }\r\n\r\n  public override toJSON(): SheetIndexEntryProps {\r\n    return { ...super.toJSON(), entryPriority: this.entryPriority };\r\n  }\r\n\r\n  /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.\r\n   * @param codeValue The name of the entry\r\n   */\r\n  public static createCode(iModelDb: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.sheetIndexEntry);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  protected static createParentRelationshipProps(iModelDb: IModelDb, id: Id64String): RelatedElementProps {\r\n    const parentElementProps = iModelDb.elements.getElementProps(id);\r\n    const isFolder = parentElementProps.classFullName === SheetIndexFolder.classFullName;\r\n    const relClass = isFolder ? SheetIndexFolderOwnsEntries : SheetIndexOwnsEntries;\r\n    return { id, relClassName: relClass.classFullName };\r\n  }\r\n\r\n  protected static createProps(arg: SheetIndexEntryCreateArgs) {\r\n    const parent = this.createParentRelationshipProps(arg.iModelDb, arg.parentId);\r\n    const props: SheetIndexEntryProps = {\r\n      classFullName: this.classFullName,\r\n      model: arg.sheetIndexModelId,\r\n      code: this.createCode(arg.iModelDb, arg.sheetIndexModelId, arg.name),\r\n      entryPriority: arg.priority,\r\n      parent,\r\n    };\r\n    return props;\r\n  }\r\n}\r\n\r\n/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].\r\n * @beta\r\n */\r\nexport class SheetIndexFolder extends SheetIndexEntry {\r\n  public static override get className(): string { return \"SheetIndexFolder\"; }\r\n\r\n  /** Create a new SheetIndexFolder\r\n   * @returns The newly constructed SheetIndexFolder element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(arg: SheetIndexEntryCreateArgs) {\r\n    const props: SheetIndexFolderProps = this.createProps(arg);\r\n    return new this(props, arg.iModelDb);\r\n  }\r\n\r\n  /** Create a new SheetIndexFolder\r\n   * @returns The Id of the newly inserted SheetIndexFolder element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static insert(arg: SheetIndexEntryCreateArgs): Id64String {\r\n    const instance = this.create(arg);\r\n    const elements = arg.iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n}\r\n\r\n/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.\r\n * @beta\r\n*/\r\nexport class SheetIndexReference extends SheetIndexEntry {\r\n  public static override get className(): string { return \"SheetIndexReference\"; }\r\n\r\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\r\n  public sheetIndex?: SheetIndexReferenceRefersToSheetIndex;\r\n\r\n  protected constructor(props: SheetIndexReferenceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.sheetIndex) {\r\n      const sheetIndex = iModel.elements.tryGetElement<SheetIndex>(props.sheetIndex.id);\r\n      if (!sheetIndex)\r\n        throw new IModelError(IModelStatus.NotFound, \"SheetIndex not found\");\r\n\r\n      this.sheetIndex = new SheetIndexReferenceRefersToSheetIndex(props.sheetIndex.id);\r\n    }\r\n  }\r\n\r\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\r\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\r\n  }\r\n\r\n  public override toJSON(): SheetIndexReferenceProps { // This override only specializes the return type\r\n    return {\r\n      ...super.toJSON(),\r\n      sheetIndex: this.sheetIndex ? this.sheetIndex.toJSON() : undefined,\r\n    } as SheetIndexReferenceProps;\r\n  }\r\n\r\n  /** Create a new SheetIndexReference\r\n   * @returns The newly constructed SheetIndexReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(arg: SheetIndexReferenceCreateArgs) {\r\n    const props: SheetIndexReferenceProps = {\r\n      ...this.createProps(arg),\r\n      sheetIndex: arg.sheetIndexId ? this.createReferenceRelationshipProps(arg.sheetIndexId) : undefined,\r\n    };\r\n    return new this(props, arg.iModelDb);\r\n  }\r\n\r\n  /** Create a new SheetIndexReference\r\n   * @returns The Id of the newly inserted SheetIndexReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static insert(arg: SheetIndexReferenceCreateArgs): Id64String {\r\n    const instance = this.create(arg);\r\n    const elements = arg.iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.sheetIndex)\r\n      referenceIds.addElement(this.sheetIndex.id);\r\n  }\r\n}\r\n\r\n/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].\r\n * @beta\r\n*/\r\nexport class SheetReference extends SheetIndexEntry {\r\n  public static override get className(): string { return \"SheetReference\"; }\r\n\r\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\r\n  public sheet: SheetReferenceRefersToSheet | undefined;\r\n\r\n  protected constructor(props: SheetReferenceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.sheet) {\r\n      const sheet = iModel.elements.tryGetElement<Sheet>(props.sheet.id);\r\n      if (!sheet)\r\n        throw new IModelError(IModelStatus.NotFound, \"Sheet not found\");\r\n\r\n      this.sheet = new SheetReferenceRefersToSheet(sheet.id);\r\n    }\r\n  }\r\n\r\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\r\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\r\n  }\r\n\r\n  public override toJSON(): SheetReferenceProps { // This override only specializes the return type\r\n    return {\r\n      ...super.toJSON(),\r\n      sheet: this.sheet ? this.sheet.toJSON() : undefined,\r\n    } as SheetReferenceProps;\r\n  }\r\n\r\n  /** Create a new SheetReference\r\n   * @returns The newly constructed SheetReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(arg: SheetReferenceCreateArgs) {\r\n    const props: SheetReferenceProps = {\r\n      ...this.createProps(arg),\r\n      sheet: arg.sheetId ? this.createReferenceRelationshipProps(arg.sheetId) : undefined,\r\n    };\r\n    return new this(props, arg.iModelDb);\r\n  }\r\n\r\n  /** Insert a new SheetReference\r\n   * @returns The Id of the newly inserted SheetReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static insert(arg: SheetReferenceCreateArgs): Id64String {\r\n    const instance = this.create(arg);\r\n    const elements = arg.iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.sheet)\r\n      referenceIds.addModel(this.sheet.id);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SheetIndex.js","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAiP;AACjP,uCAA+D;AAE/D,sDAA+D;AAC/D,qEAAkK;AAkClK;;;;GAIG;AACH,MAAa,UAAW,SAAQ,qCAA2B;IAClD,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,sBAAsC,EAAE,SAAiB;QAClG,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,UAAU,CAAC,CAAC;QAC9E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,KAAK,GAAiB;YAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE;YACvD,KAAK,EAAE,OAAO;SACf,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AA1CD,gCA0CC;AAED;;EAEE;AACF,MAAsB,eAAgB,SAAQ,qCAA2B;IAChE,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,0FAA0F;IACnF,aAAa,CAAS;IAE7B,YAAsB,KAA2B,EAAE,MAAgB;QACjE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAC3C,CAAC;IAEe,MAAM;QACpB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,YAA4B,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,eAAe,CAAC,CAAC;QACrF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAES,MAAM,CAAC,6BAA6B,CAAC,QAAkB,EAAE,EAAc;QAC/E,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,aAAa,KAAK,gBAAgB,CAAC,aAAa,CAAC;QACrF,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,oDAA2B,CAAC,CAAC,CAAC,8CAAqB,CAAC;QAChF,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC;IAES,MAAM,CAAC,WAAW,CAAC,GAA8B;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAyB;YAClC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,GAAG,CAAC,iBAAiB;YAC5B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC;YACpE,aAAa,EAAE,GAAG,CAAC,QAAQ;YAC3B,MAAM;SACP,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA1CD,0CA0CC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,eAAe;IAC5C,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAE7E;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,KAAK,GAA0B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC3D,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAtBD,4CAsBC;AAED;;EAEE;AACF,MAAa,mBAAoB,SAAQ,eAAe;IAC/C,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAEhF,2EAA2E;IACpE,UAAU,CAAyC;IAE1D,YAAsB,KAA+B,EAAE,MAAgB;QACrE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAa,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAEvE,IAAI,CAAC,UAAU,GAAG,IAAI,8DAAqC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SACvC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,KAAK,GAA6B;YACtC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SACnG,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU;YACjB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAzDD,kDAyDC;AAED;;EAEE;AACF,MAAa,cAAe,SAAQ,eAAe;IAC1C,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,iEAAiE;IAC1D,KAAK,CAA0C;IAEtD,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAQ,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK;gBACR,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAElE,IAAI,CAAC,KAAK,GAAG,IAAI,oDAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SAC7B,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,KAAK,GAAwB;YACjC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC;CACF;AAzDD,wCAyDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, ElementProps, EntityReferenceSet, IModelError, RelatedElementProps, SheetIndexEntryProps, SheetIndexFolderProps, SheetIndexReferenceProps, SheetReferenceProps } from \"@itwin/core-common\";\nimport { InformationReferenceElement, Sheet } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { SheetIndexFolderOwnsEntries, SheetIndexOwnsEntries, SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from \"./NavigationRelationship\";\n\n/** Arguments used to create a [[SheetIndexEntry]].\n * @beta\n */\nexport interface SheetIndexEntryCreateArgs {\n  /** The iModel that will contain the sheet index entry. */\n  iModelDb: IModelDb;\n  /** The Id of the [[SheetIndexModel]] that will contain the sheet index entry. */\n  sheetIndexModelId: Id64String;\n  /** The [[SheetIndex]] or [[SheetIndexFolder]] that is parent to this SheetIndexEntry */\n  parentId: Id64String;\n  /** The name of the SheetIndexEntry */\n  name: string;\n  /** The priority of the SheetIndexEntry */\n  priority: number;\n}\n\n/** Arguments supplied when creating a [[SheetIndexReference]].\n * @beta\n */\nexport interface SheetIndexReferenceCreateArgs extends SheetIndexEntryCreateArgs {\n  /** The [[SheetIndex]] to which the reference refers. */\n  sheetIndexId?: Id64String;\n}\n\n/** Arguments supplied when creating a [[SheetReference]].\n * @beta\n */\nexport interface SheetReferenceCreateArgs extends SheetIndexEntryCreateArgs {\n  /** The [[Sheet]] to which the reference refers. */\n  sheetId?: Id64String;\n}\n\n/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.\n * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating\n * sub-trees via [[SheetIndexReference]]s.\n * @beta\n */\nexport class SheetIndex extends InformationReferenceElement {\n  public static override get className(): string { return \"SheetIndex\"; }\n\n  /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.\n   * @param iModel  The IModelDb\n   * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.\n   * @param codeValue The SheetIndex name\n   */\n  public static createCode(iModel: IModelDb, scopeSheetIndexModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.sheetIndex);\n    return new Code({ spec: codeSpec.id, scope: scopeSheetIndexModelId, value: codeValue });\n  }\n\n  /** Create a SheetIndex\n   * @param iModelDb The IModelDb\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\n   * @param name The name (codeValue) of the SheetIndex\n   * @returns The newly constructed SheetIndex\n   * @throws [[IModelError]] if there is a problem creating the SheetIndex\n   */\n  public static create(iModelDb: IModelDb, modelId: Id64String, name: string): SheetIndex {\n    const props: ElementProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, modelId, name).toJSON(),\n      model: modelId,\n    };\n    return new this(props, iModelDb);\n  }\n\n  /** Insert a SheetIndex\n   * @param iModelDb The IModelDb\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\n   * @param name The name (codeValue) of the SheetIndex\n   * @returns The Id of the newly inserted SheetIndex\n   * @throws [[IModelError]] if there is a problem inserting the SheetIndex\n   */\n  public static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String {\n    const instance = this.create(iModelDb, modelId, name);\n    const elements = iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n}\n\n/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.\n * @beta\n*/\nexport abstract class SheetIndexEntry extends InformationReferenceElement {\n  public static override get className(): string { return \"SheetIndexEntry\"; }\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\n  public entryPriority: number;\n\n  protected constructor(props: SheetIndexEntryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.entryPriority = props.entryPriority;\n  }\n\n  public override toJSON(): SheetIndexEntryProps {\n    return { ...super.toJSON(), entryPriority: this.entryPriority };\n  }\n\n  /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.\n   * @param codeValue The name of the entry\n   */\n  public static createCode(iModelDb: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.sheetIndexEntry);\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  protected static createParentRelationshipProps(iModelDb: IModelDb, id: Id64String): RelatedElementProps {\n    const parentElementProps = iModelDb.elements.getElementProps(id);\n    const isFolder = parentElementProps.classFullName === SheetIndexFolder.classFullName;\n    const relClass = isFolder ? SheetIndexFolderOwnsEntries : SheetIndexOwnsEntries;\n    return { id, relClassName: relClass.classFullName };\n  }\n\n  protected static createProps(arg: SheetIndexEntryCreateArgs) {\n    const parent = this.createParentRelationshipProps(arg.iModelDb, arg.parentId);\n    const props: SheetIndexEntryProps = {\n      classFullName: this.classFullName,\n      model: arg.sheetIndexModelId,\n      code: this.createCode(arg.iModelDb, arg.sheetIndexModelId, arg.name),\n      entryPriority: arg.priority,\n      parent,\n    };\n    return props;\n  }\n}\n\n/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].\n * @beta\n */\nexport class SheetIndexFolder extends SheetIndexEntry {\n  public static override get className(): string { return \"SheetIndexFolder\"; }\n\n  /** Create a new SheetIndexFolder\n   * @returns The newly constructed SheetIndexFolder element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(arg: SheetIndexEntryCreateArgs) {\n    const props: SheetIndexFolderProps = this.createProps(arg);\n    return new this(props, arg.iModelDb);\n  }\n\n  /** Create a new SheetIndexFolder\n   * @returns The Id of the newly inserted SheetIndexFolder element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static insert(arg: SheetIndexEntryCreateArgs): Id64String {\n    const instance = this.create(arg);\n    const elements = arg.iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n}\n\n/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.\n * @beta\n*/\nexport class SheetIndexReference extends SheetIndexEntry {\n  public static override get className(): string { return \"SheetIndexReference\"; }\n\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\n  public sheetIndex?: SheetIndexReferenceRefersToSheetIndex;\n\n  protected constructor(props: SheetIndexReferenceProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.sheetIndex) {\n      const sheetIndex = iModel.elements.tryGetElement<SheetIndex>(props.sheetIndex.id);\n      if (!sheetIndex)\n        throw new IModelError(IModelStatus.NotFound, \"SheetIndex not found\");\n\n      this.sheetIndex = new SheetIndexReferenceRefersToSheetIndex(props.sheetIndex.id);\n    }\n  }\n\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\n  }\n\n  public override toJSON(): SheetIndexReferenceProps { // This override only specializes the return type\n    return {\n      ...super.toJSON(),\n      sheetIndex: this.sheetIndex ? this.sheetIndex.toJSON() : undefined,\n    } as SheetIndexReferenceProps;\n  }\n\n  /** Create a new SheetIndexReference\n   * @returns The newly constructed SheetIndexReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(arg: SheetIndexReferenceCreateArgs) {\n    const props: SheetIndexReferenceProps = {\n      ...this.createProps(arg),\n      sheetIndex: arg.sheetIndexId ? this.createReferenceRelationshipProps(arg.sheetIndexId) : undefined,\n    };\n    return new this(props, arg.iModelDb);\n  }\n\n  /** Create a new SheetIndexReference\n   * @returns The Id of the newly inserted SheetIndexReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static insert(arg: SheetIndexReferenceCreateArgs): Id64String {\n    const instance = this.create(arg);\n    const elements = arg.iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n\n  /** @alpha */\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.sheetIndex)\n      referenceIds.addElement(this.sheetIndex.id);\n  }\n}\n\n/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].\n * @beta\n*/\nexport class SheetReference extends SheetIndexEntry {\n  public static override get className(): string { return \"SheetReference\"; }\n\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\n  public sheet: SheetReferenceRefersToSheet | undefined;\n\n  protected constructor(props: SheetReferenceProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.sheet) {\n      const sheet = iModel.elements.tryGetElement<Sheet>(props.sheet.id);\n      if (!sheet)\n        throw new IModelError(IModelStatus.NotFound, \"Sheet not found\");\n\n      this.sheet = new SheetReferenceRefersToSheet(sheet.id);\n    }\n  }\n\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\n  }\n\n  public override toJSON(): SheetReferenceProps { // This override only specializes the return type\n    return {\n      ...super.toJSON(),\n      sheet: this.sheet ? this.sheet.toJSON() : undefined,\n    } as SheetReferenceProps;\n  }\n\n  /** Create a new SheetReference\n   * @returns The newly constructed SheetReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(arg: SheetReferenceCreateArgs) {\n    const props: SheetReferenceProps = {\n      ...this.createProps(arg),\n      sheet: arg.sheetId ? this.createReferenceRelationshipProps(arg.sheetId) : undefined,\n    };\n    return new this(props, arg.iModelDb);\n  }\n\n  /** Insert a new SheetReference\n   * @returns The Id of the newly inserted SheetReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static insert(arg: SheetReferenceCreateArgs): Id64String {\n    const instance = this.create(arg);\n    const elements = arg.iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n\n  /** @alpha */\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.sheet)\n      referenceIds.addModel(this.sheet.id);\n  }\n}\n"]}

package/lib/cjs/SqliteChangesetReader.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module SQLiteDb
  */
-import { DbValueType, Id64String, IDisposable } from "@itwin/core-bentley";
+import { DbValueType, Id64String } from "@itwin/core-bentley";
 import { ECDb } from "./ECDb";
 import { IModelDb } from "./IModelDb";
 /** Changed value type
@@ -71,7 +71,7 @@ export interface SqliteChange {
  * a db provided.
  * @beta
  */
-export declare class SqliteChangesetReader implements IDisposable {
+export declare class SqliteChangesetReader implements Disposable {
     /** db from where sql schema will be read */
     readonly db: AnyDb;
     private readonly _nativeReader;
@@ -97,6 +97,14 @@ export declare class SqliteChangesetReader implements IDisposable {
     static openGroup(args: {
         readonly changesetFiles: string[];
     } & SqliteChangesetReaderArgs): SqliteChangesetReader;
+    /**
+     * Open txn change in iModel.
+     * @param args iModel and other options.
+     * @returns SqliteChangesetReader instance
+     */
+    static openTxn(args: {
+        txnId: Id64String;
+    } & SqliteChangesetReaderArgs): SqliteChangesetReader;
     /**
      * Writes the changeset to a file.
      * @note can be use with openGroup() or openLocalChanges() to persist changeset.
@@ -264,7 +272,7 @@ export declare class SqliteChangesetReader implements IDisposable {
      * Dispose this object
      * @beta
      */
-    dispose(): void;
+    [Symbol.dispose](): void;
 }
 export {};
 //# sourceMappingURL=SqliteChangesetReader.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SqliteChangesetReader.d.ts","sourceRoot":"","sources":["../../src/SqliteChangesetReader.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAqC,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC9G,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;EAEE;AACF,KAAK,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAEnE;;EAEE;AACF,KAAK,gBAAgB,GAAG,WAAW,EAAE,CAAC;AACtC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACxB,sBAAsB;IACtB,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,2BAA2B;IAC3B,kBAAkB,CAAC,EAAE,IAAI,CAAC;IAC1B,4BAA4B;IAC5B,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,2CAA2C;IAC3C,4BAA4B,CAAC,EAAE,IAAI,CAAC;CACrC;AAED;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;AAEhE;;EAEE;AACF,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,CAAC;AAE7C;;EAEE;AACF,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAC;AAEpC;;EAEE;AACF,MAAM,WAAW,yBAAyB;IACxC,uGAAuG;IACvG,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,sCAAsC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;IACvB,uFAAuF;IACvF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,IAAI,CAAC;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB,iCAAiC;IACjC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,wBAAwB;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,WAAW;IAMrD,4CAA4C;aAC5B,EAAE,EAAE,KAAK;IAN3B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA+C;IAC7E,OAAO,CAAC,YAAY,CAA+B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,YAAY,CAAK;IACzB,SAAS;IACP,4CAA4C;IAC5B,EAAE,EAAE,KAAK;IAG3B;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,yBAAyB,GAAG,qBAAqB;IAM9G;;;;OAIG;WACW,SAAS,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,yBAAyB,GAAG,qBAAqB;IASvH;;;;;;;OAOG;IACI,WAAW,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,qBAAqB,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAG7G;;;;;OAKG;WACW,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE,IAAI,CAAC,GAAG;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,sBAAsB,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,qBAAqB;IAMpJ,+CAA+C;IAC/C,IAAW,kBAAkB,IAAI,OAAO,CAAqC;IAC7E;;;MAGE;IACK,IAAI,IAAI,OAAO;IAOtB;;MAEE;IACF,IAAW,MAAM,IAAI,OAAO,CAE3B;IACD;;MAEE;IACF,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD;;MAEE;IACF,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD;;MAEE;IACF,IAAW,EAAE,IAAI,cAAc,CAQ9B;IACD;;MAEE;IACF,IAAW,gBAAgB,IAAI,gBAAgB,CAE9C;IACD;;;OAGG;IACI,wBAAwB,IAAI,MAAM,EAAE;IAO3C;;MAEE;IACF,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,WAAW,GAAG,SAAS;IAIhG;;;;;;OAMG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS;IAIxG;;;;;;OAMG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAIpG;;;;;;OAMG;IACI,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS;IAIpG;;;;;;OAMG;IACI,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAIrG;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAIlG;;;;;;OAMG;IACI,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,GAAG,SAAS;IAI3F;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,WAAW,GAAG,SAAS;IAIhG;;;;;;OAMG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,WAAW;IAGhF;;;;;OAKG;IACI,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;IAGlF;;;;;;OAMG;IACI,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,GAAE,gBAAqB,GAAG,YAAY,GAAG,SAAS;IAyC5G;;;;;;OAMG;IACI,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE;IAelD;;OAEG;IACH,IAAW,WAAW,WAAgC;IACtD;;;OAGG;IACI,KAAK;IAIZ;;;OAGG;IACI,OAAO,IAAI,IAAI;CAGvB"}
+{"version":3,"file":"SqliteChangesetReader.d.ts","sourceRoot":"","sources":["../../src/SqliteChangesetReader.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAqC,WAAW,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjG,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;EAEE;AACF,KAAK,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAEnE;;EAEE;AACF,KAAK,gBAAgB,GAAG,WAAW,EAAE,CAAC;AACtC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACxB,sBAAsB;IACtB,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,2BAA2B;IAC3B,kBAAkB,CAAC,EAAE,IAAI,CAAC;IAC1B,4BAA4B;IAC5B,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,2CAA2C;IAC3C,4BAA4B,CAAC,EAAE,IAAI,CAAC;CACrC;AAED;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;AAEhE;;EAEE;AACF,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,CAAC;AAE7C;;EAEE;AACF,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,IAAI,CAAC;AAEpC;;EAEE;AACF,MAAM,WAAW,yBAAyB;IACxC,uGAAuG;IACvG,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IACnB,sCAAsC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;IACvB,uFAAuF;IACvF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,IAAI,CAAC;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB,iCAAiC;IACjC,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,wBAAwB;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,UAAU;IAMpD,4CAA4C;aAC5B,EAAE,EAAE,KAAK;IAN3B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA+C;IAC7E,OAAO,CAAC,YAAY,CAA+B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,YAAY,CAAK;IACzB,SAAS;IACP,4CAA4C;IAC5B,EAAE,EAAE,KAAK;IAG3B;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,yBAAyB,GAAG,qBAAqB;IAM9G;;;;OAIG;WACW,SAAS,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,yBAAyB,GAAG,qBAAqB;IASvH;;;;OAIG;WACW,OAAO,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,UAAU,CAAA;KAAE,GAAG,yBAAyB,GAAG,qBAAqB;IASrG;;;;;;;OAOG;IACI,WAAW,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,qBAAqB,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAG7G;;;;;OAKG;WACW,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE,IAAI,CAAC,GAAG;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,sBAAsB,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,qBAAqB;IAMpJ,+CAA+C;IAC/C,IAAW,kBAAkB,IAAI,OAAO,CAAqC;IAC7E;;;MAGE;IACK,IAAI,IAAI,OAAO;IAOtB;;MAEE;IACF,IAAW,MAAM,IAAI,OAAO,CAE3B;IACD;;MAEE;IACF,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD;;MAEE;IACF,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD;;MAEE;IACF,IAAW,EAAE,IAAI,cAAc,CAQ9B;IACD;;MAEE;IACF,IAAW,gBAAgB,IAAI,gBAAgB,CAE9C;IACD;;;OAGG;IACI,wBAAwB,IAAI,MAAM,EAAE;IAO3C;;MAEE;IACF,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,WAAW,GAAG,SAAS;IAIhG;;;;;;OAMG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS;IAIxG;;;;;;OAMG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAIpG;;;;;;OAMG;IACI,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS;IAIpG;;;;;;OAMG;IACI,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAIrG;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAIlG;;;;;;OAMG;IACI,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,GAAG,SAAS;IAI3F;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,WAAW,GAAG,SAAS;IAIhG;;;;;;OAMG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,WAAW;IAGhF;;;;;OAKG;IACI,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;IAGlF;;;;;;OAMG;IACI,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,GAAE,gBAAqB,GAAG,YAAY,GAAG,SAAS;IAyC5G;;;;;;OAMG;IACI,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE;IAelD;;OAEG;IACH,IAAW,WAAW,WAAgC;IACtD;;;OAGG;IACI,KAAK;IAIZ;;;OAGG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGhC"}

package/lib/cjs/SqliteChangesetReader.js

@@ -9,6 +9,7 @@ exports.SqliteChangesetReader = void 0;
  * @module SQLiteDb
  */
 const core_bentley_1 = require("@itwin/core-bentley");
+const ECDb_1 = require("./ECDb");
 const NativePlatform_1 = require("./internal/NativePlatform");
 const Symbols_1 = require("./internal/Symbols");
 /**
@@ -18,14 +19,15 @@ const Symbols_1 = require("./internal/Symbols");
  * @beta
  */
 class SqliteChangesetReader {
+    db;
+    _nativeReader = new NativePlatform_1.IModelNative.platform.ChangesetReader();
+    _schemaCache = new Map();
+    _disableSchemaCheck = false;
+    _changeIndex = 0;
     constructor(
     /** db from where sql schema will be read */
     db) {
         this.db = db;
-        this._nativeReader = new NativePlatform_1.IModelNative.platform.ChangesetReader();
-        this._schemaCache = new Map();
-        this._disableSchemaCheck = false;
-        this._changeIndex = 0;
     }
     /**
      * Open changeset file from disk
@@ -52,6 +54,20 @@ class SqliteChangesetReader {
         reader._nativeReader.openGroup(args.changesetFiles, args.db[Symbols_1._nativeDb], args.invert ?? false);
         return reader;
     }
+    /**
+     * Open txn change in iModel.
+     * @param args iModel and other options.
+     * @returns SqliteChangesetReader instance
+     */
+    static openTxn(args) {
+        if (args.db instanceof ECDb_1.ECDb) {
+            throw new Error("ECDb does not support openTxn");
+        }
+        const reader = new SqliteChangesetReader(args.db);
+        reader._disableSchemaCheck = args.disableSchemaCheck ?? false;
+        reader._nativeReader.openTxn(args.db[Symbols_1._nativeDb], args.txnId, args.invert ?? false);
+        return reader;
+    }
     /**
      * Writes the changeset to a file.
      * @note can be use with openGroup() or openLocalChanges() to persist changeset.
@@ -317,7 +333,7 @@ class SqliteChangesetReader {
      * Dispose this object
      * @beta
      */
-    dispose() {
+    [Symbol.dispose]() {
         this.close();
     }
 }