@itwin/core-backend 5.9.0-dev.4 → 5.9.0-dev.6

package/lib/esm/SQLiteDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,OAAO,EAAY,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAiB,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,0CAA0C;AAE1C;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACnB,gBAAgB;IACA,CAAC,SAAS,CAAC,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3D,qBAAqB,GAAG,IAAI,cAAc,EAAmB,CAAC;IAEtE,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEzE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAElF,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC;IACxC,CAAC;IAED,+JAA+J;IACxJ,kBAAkB;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,WAAW,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,WAAW,CAAC,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;;;YAC3B,MAAM,IAAI,kCAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAA,CAAC;YAC9C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;;;;;;;;;KACpB;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,QAAQ;IAC5C,MAAM,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;IAatF;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAChK,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,WAAW,CAAC,UAAU,CAAC,2BAA2B,EAAE,yCAAyC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAChI,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,SAAe;QAChE,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,UAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,WAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnM,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAuH;QAChJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AAGH,cAAc;AACd,WAAiB,QAAQ;IAqEvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjIgB,QAAQ,KAAR,QAAQ,QAiIxB","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 SQLiteDb\n */\n\nimport * as fs from \"fs\";\nimport { dirname } from \"path\";\nimport * as semver from \"semver\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\nimport { LocalFileName, SqliteError } from \"@itwin/core-common\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { IModelJsFs } from \"./IModelJsFs\";\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n// cspell:ignore savepoint julianday rowid\n\n/**\n * A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\n * @public\n */\nexport class SQLiteDb {\n  /** @internal */\n  public readonly [_nativeDb] = new IModelNative.platform.SQLiteDb();\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\n\n  /** @internal */\n  public static createBlobIO(): SQLiteDb.BlobIO {\n    return new IModelNative.platform.BlobIO();\n  }\n\n  /** alias for closeDb.\n   * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[closeDb]]\n   */\n  public dispose(): void {\n    this.closeDb();\n  }\n\n  /** Create a SQLiteDb\n   * @param dbName The path to the SQLiteDb file to create.\n   */\n  public createDb(dbName: string): void;\n  /** @beta */\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\n    this[_nativeDb].createDb(dbName, container, params);\n  }\n\n  /** Open a SQLiteDb.\n   * @param dbName The path to the SQLiteDb file to open\n   */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\n  /**\n   * @param container optional CloudContainer holding database\n   * @beta\n   */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\n    this[_nativeDb].openDb(dbName, openMode, container);\n  }\n\n  /** Close SQLiteDb.\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\n   */\n  public closeDb(saveChanges?: boolean): void {\n    if (saveChanges && this.isOpen)\n      this.saveChanges();\n    this._sqliteStatementCache.clear();\n    this[_nativeDb].closeDb();\n  }\n\n  /** Returns true if this SQLiteDb is open */\n  public get isOpen(): boolean { return this[_nativeDb].isOpen(); }\n\n  /** Returns true if this SQLiteDb is open readonly */\n  public get isReadonly(): boolean { return this[_nativeDb].isReadonly(); }\n\n  /** Create a new table in this database. */\n  protected createTable(args: {\n    /** The name of the table to create. */\n    tableName: string;\n    /** all of the columns in the table. */\n    columns: string;\n    /** any unique or foreign key constraints */\n    constraints?: string;\n    /** if true, add a \"lastMod\" timestamp column and triggers to automatically update it. */\n    addTimestamp?: boolean;\n  }) {\n    const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\n    const constraints = args.constraints ? `,${args.constraints}` : \"\";\n    this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\n    if (args.addTimestamp)\n      this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\n  }\n\n  /**\n   * Get the last modified date for a row in a table of this database.\n   * @note the table must have been created with `addTimestamp: true`\n  */\n  public readLastModTime(tableName: string, rowId: number): Date {\n    return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\n      stmt.bindInteger(1, rowId);\n      return stmt.getValueDate(0);\n    });\n  }\n\n  /**\n   * Open a database, perform an operation, then close the database.\n   *\n   * Details:\n   * - if database is open, throw an error\n   * - open a database\n   * - call a function with the database opened. If it is async, await its return.\n   * - if function throws, abandon all changes, close database, and rethrow\n   * - save all changes\n   * - close the database\n   * @return value from operation\n   */\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\n    if (this.isOpen)\n      SqliteError.throwError(\"already-open\", \"database is already open\", args.dbName);\n\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\n    try {\n      const result = operation();\n      result instanceof Promise ? result.then(save, abandon) : save();\n      return result;\n    } catch (e) {\n      abandon();\n      throw e;\n    }\n  }\n\n  /** The cloud container backing this SQLite database, if any.\n   * @beta\n   */\n  public get cloudContainer(): CloudSqlite.CloudContainer | undefined {\n    return this[_nativeDb].cloudContainer;\n  }\n\n  /** Returns the Id of the most-recently-inserted row in this database, per [sqlite3_last_insert_rowid](https://www.sqlite.org/c3ref/last_insert_rowid.html). */\n  public getLastInsertRowId(): number {\n    return this[_nativeDb].getLastInsertRowId();\n  }\n\n  /**\n   * Perform an operation on a database in a CloudContainer with the write lock held.\n   *\n   * Details:\n   * - acquire the write lock on a CloudContainer\n   * - call `withOpenDb` with openMode `ReadWrite`\n   * - upload changes\n   * - release the write lock\n   * @param args arguments to lock the container and open the database\n   * @param operation an operation performed on the database with the write lock held.\n   * @return value from operation\n   * @internal\n   */\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => Promise<T>) {\n    return CloudSqlite.withWriteLock(args, async () => this.withOpenDb({ ...args, openMode: args.openMode ?? OpenMode.ReadWrite }, operation));\n  }\n\n  /** vacuum this database\n   * @see https://www.sqlite.org/lang_vacuum.html\n   */\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\n    this[_nativeDb].vacuum(args);\n  }\n\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */\n  public saveChanges(): void {\n    this[_nativeDb].saveChanges();\n  }\n\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */\n  public abandonChanges(): void {\n    this[_nativeDb].abandonChanges();\n  }\n\n  /**\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\n   * @param sql The SQLite SQL statement to execute\n   * @param callback the callback to invoke on the prepared statement\n   * @returns the value returned by `callback`.\n   */\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\n    try {\n      const val = callback(stmt);\n      val instanceof Promise ? val.then(release, release) : release();\n      return val;\n    } catch (err) {\n      release();\n      throw err;\n    }\n  }\n\n  /**\n   * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\n   * @param sql The SQLite SQL statement to execute\n   * @param callback the callback to invoke on the prepared statement\n   * @returns the value returned by `callback`.\n   */\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\n    const stmt = this.prepareSqliteStatement(sql);\n    const release = () => stmt[Symbol.dispose]();\n    try {\n      const val = callback(stmt);\n      val instanceof Promise ? val.then(release, release) : release();\n      return val;\n    } catch (err) {\n      release();\n      throw err;\n    }\n  }\n\n  /**\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\n   */\n  public withSavePoint(savePointName: string, operation: () => void) {\n    if (this.isReadonly)\n      SqliteError.throwError(\"readonly\", \"database is readonly\", this[_nativeDb].getFilePath());\n\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\n    try {\n      operation();\n      this.executeSQL(`RELEASE ${savePointName}`);\n    } catch (e) {\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\n      throw e;\n    }\n  }\n\n  /** Prepare an SQL statement.\n     * @param sql The SQLite SQL statement to prepare\n     * @param logErrors Determine if errors are logged or not\n     * @internal\n     */\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\n    const stmt = new SqliteStatement(sql);\n    stmt.prepare(this[_nativeDb], logErrors);\n    return stmt;\n  }\n\n  /** execute an SQL statement */\n  public executeSQL(sql: string): DbResult {\n    using stmt = this.prepareSqliteStatement(sql);\n    return stmt.step();\n  }\n}\n\n/**\n * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\n * always used for access.\n *\n * Notes:\n *  - This class may be used either to access a local file, or one stored in a cloud container.\n *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\n * tables.\n * @beta\n */\nexport abstract class VersionedSqliteDb extends SQLiteDb {\n  protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\n\n  /** The current semver \"persistence version\" of this class.\n   * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\n   * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\n   * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\n   * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\n   * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\n   * supported by it, the user will be informed that they need to upgrade their software.\n   * @note this identifier is independent of versions in `package.json` files.\n  */\n  public abstract myVersion: string;\n\n  /**\n   * Change the \"versions required to open this database\" property stored in this database. After this call,\n   * versions of software that don't meet the supplied ranges will fail.\n   * @param versions the new versions required for reading and writing this database.\n   * @note the database must be opened for write access.\n   */\n  public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\n    // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\n    this[_nativeDb].saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\n  }\n\n  /** Get the required version ranges necessary to open this VersionedSqliteDb. */\n  public getRequiredVersions() {\n    const checkIsString = (value: any) => {\n      if (typeof value !== \"string\")\n        SqliteError.throwError(\"invalid-versions-property\", `CloudDb has invalid \"versions\" property`, this[_nativeDb].getFilePath());\n      return value;\n    };\n    const versionJson = checkIsString(this[_nativeDb].queryFileProperty(VersionedSqliteDb._versionProps, true));\n    const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\n    checkIsString(versionRanges.readVersion);\n    checkIsString(versionRanges.writeVersion);\n    return versionRanges;\n  }\n\n  /**\n   * Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\n   */\n  protected abstract createDDL(args: any): void;\n\n  /**\n   * Create a new database file for the subclass of VersionedSqliteDb.\n   * @note The required versions are saved as [[myVersion]] or newer for both read and write.\n   */\n  public static createNewDb(fileName: LocalFileName, setupArgs?: any) {\n    const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\n    IModelJsFs.recursiveMkDirSync(dirname(fileName));\n    if (fs.existsSync(fileName))\n      fs.unlinkSync(fileName);\n\n    db.createDb(fileName);\n    db.createDDL(setupArgs);\n    const minVer = `^${db.myVersion}`;\n    db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\n    db.closeDb(true);\n  }\n\n  /**\n   * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\n   * Throws otherwise.\n   */\n  protected verifyVersions() {\n    const versions = this.getRequiredVersions();\n    const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\n    const range = isReadonly ? versions.readVersion : versions.writeVersion;\n    if (semver.satisfies(this.myVersion, range))\n      return;\n\n    this.closeDb();\n    const tooNew = semver.gtr(this.myVersion, range);\n    SqliteError.throwError(\"incompatible-version\", `requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`, this[_nativeDb].getFilePath());\n\n  }\n\n  /**\n   * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\n   * Throws otherwise.\n   * @see [[SqliteDb.openDb]] for argument types\n   */\n  public override openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\n    super.openDb(dbName, openMode, container);\n    this.verifyVersions();\n  }\n\n  public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }) {\n    // can't use \"this\" because it checks for version, which we don't want here\n    return (arg.lockContainer) ?\n      super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\n      super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\n  }\n}\n\n/** @public */\nexport namespace SQLiteDb {\n  /** A semver version range.\n   * @see https://docs.npmjs.com/cli/v6/using-npm/semver\n   */\n  export type VersionRange = string;\n\n  /**\n   * A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\n   * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\n   */\n  export interface RequiredVersionRanges {\n    /** a range of acceptable persistence versions for reading from a VersionedSqliteDb. */\n    readonly readVersion: VersionRange;\n    /** a range of acceptable persistence versions for writing to a VersionedSqliteDb. */\n    readonly writeVersion: VersionRange;\n  }\n\n  /** interface for reading and writing to a blob in a SQLiteDb\n   * @internal\n   */\n  export interface BlobIO {\n    /** Close this BlobIO if it is opened.\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\n      */\n    close(): void;\n    /** get the total number of bytes in the blob */\n    getNumBytes(): number;\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\n    isValid(): boolean;\n    /** Open this BlobIO against a table/row/column in a Db */\n    open(\n      /** The database for the blob */\n      db: IModelJsNative.AnyDb,\n      args: {\n        /** the name of the table for the blob*/\n        tableName: string;\n        /** the name of the column for the blob */\n        columnName: string;\n        /** The rowId of the blob */\n        row: number;\n        /** If true, open this BlobIO for write access */\n        writeable?: boolean;\n      }): void;\n    /** Read from a blob\n       * @returns the contents of the requested byte range\n       */\n    read(args: {\n      /** The number of bytes to read */\n      numBytes: number;\n      /** starting offset within the blob to read */\n      offset: number;\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\n      blob?: ArrayBuffer;\n    }): Uint8Array;\n    /** Reposition this BlobIO to a new rowId\n       * @note this BlobIO must be valid when this methods is called.\n       */\n    changeRow(row: number): void;\n    /** Write to a blob */\n    write(args: {\n      /** The number of bytes to write  */\n      numBytes: number;\n      /** starting offset within the blob to write */\n      offset: number;\n      /** the value to write */\n      blob: ArrayBuffer;\n    }): void;\n  }\n\n  /** Default transaction mode for SQLiteDbs.\n   * @see https://www.sqlite.org/lang_transaction.html\n   */\n  export enum DefaultTxnMode {\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\n    None = 0,\n    /** A deferred transaction is started when the file is first opened. This is the default. */\n    Deferred = 1,\n    /** An immediate transaction is started when the file is first opened. */\n    Immediate = 2,\n    /** An exclusive transaction is started when the file is first opened. */\n    Exclusive = 3\n  }\n\n  /** parameters common to opening or creating a new SQLiteDb */\n  export interface OpenOrCreateParams {\n    /** If true, do not require that the `be_Prop` table exist */\n    rawSQLite?: boolean;\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\n    immutable?: boolean;\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\n    skipFileCheck?: boolean;\n    /** the default transaction mode\n   * @see [[SQLiteDb.DefaultTxnMode]]\n  */\n    defaultTxn?: 0 | 1 | 2 | 3;\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\n    queryParam?: string;\n  }\n\n  /** Parameters for opening an existing SQLiteDb */\n  export interface OpenParams extends OpenOrCreateParams {\n    /** use OpenMode.ReadWrite to open the file with write access */\n    openMode: OpenMode;\n  }\n\n  /** Size of a SQLiteDb page in bytes */\n  export interface PageSize {\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\n    pageSize?: number;\n  }\n\n  /** Parameters for creating a new SQLiteDb */\n  export type CreateParams = OpenOrCreateParams & PageSize;\n\n  /** Arguments for `SqliteDb.withOpenDb` */\n  export interface WithOpenDbArgs {\n    /** The name of the database to open */\n    dbName: string;\n    /** either an object with the open parameters or just OpenMode value. */\n    openMode?: OpenMode | SQLiteDb.OpenParams;\n    /** @internal */\n    container?: CloudSqlite.CloudContainer;\n  }\n\n  /** Arguments for `SQLiteDb.vacuum` */\n  export interface VacuumDbArgs extends PageSize {\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\n    into?: LocalFileName;\n  }\n}\n"]}
+{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,OAAO,EAAY,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAiB,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,0CAA0C;AAE1C;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACnB,gBAAgB;IACA,CAAC,SAAS,CAAC,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3D,qBAAqB,GAAG,IAAI,cAAc,EAAmB,CAAC;IAEtE,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEzE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAElF,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC;IACxC,CAAC;IAED,+JAA+J;IACxJ,kBAAkB;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,WAAW,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,WAAW,CAAC,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;;;YAC3B,MAAM,IAAI,kCAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAA,CAAC;YAC9C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;;;;;;;;;KACpB;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,QAAQ;IAC5C,MAAM,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;IAatF;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAChK,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,WAAW,CAAC,UAAU,CAAC,2BAA2B,EAAE,yCAAyC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAChI,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,SAAe;QAChE,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,UAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,WAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnM,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAuH;QAChJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AAGH,cAAc;AACd,WAAiB,QAAQ;IAqEvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjIgB,QAAQ,KAAR,QAAQ,QAiIxB","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 SQLiteDb\r\n */\r\n\r\nimport * as fs from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName, SqliteError } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n// cspell:ignore savepoint julianday rowid\r\n\r\n/**\r\n * A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\r\n * @public\r\n */\r\nexport class SQLiteDb {\r\n  /** @internal */\r\n  public readonly [_nativeDb] = new IModelNative.platform.SQLiteDb();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** @internal */\r\n  public static createBlobIO(): SQLiteDb.BlobIO {\r\n    return new IModelNative.platform.BlobIO();\r\n  }\r\n\r\n  /** alias for closeDb.\r\n   * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[closeDb]]\r\n   */\r\n  public dispose(): void {\r\n    this.closeDb();\r\n  }\r\n\r\n  /** Create a SQLiteDb\r\n   * @param dbName The path to the SQLiteDb file to create.\r\n   */\r\n  public createDb(dbName: string): void;\r\n  /** @beta */\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\r\n    this[_nativeDb].createDb(dbName, container, params);\r\n  }\r\n\r\n  /** Open a SQLiteDb.\r\n   * @param dbName The path to the SQLiteDb file to open\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\r\n  /**\r\n   * @param container optional CloudContainer holding database\r\n   * @beta\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\r\n    this[_nativeDb].openDb(dbName, openMode, container);\r\n  }\r\n\r\n  /** Close SQLiteDb.\r\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\r\n   */\r\n  public closeDb(saveChanges?: boolean): void {\r\n    if (saveChanges && this.isOpen)\r\n      this.saveChanges();\r\n    this._sqliteStatementCache.clear();\r\n    this[_nativeDb].closeDb();\r\n  }\r\n\r\n  /** Returns true if this SQLiteDb is open */\r\n  public get isOpen(): boolean { return this[_nativeDb].isOpen(); }\r\n\r\n  /** Returns true if this SQLiteDb is open readonly */\r\n  public get isReadonly(): boolean { return this[_nativeDb].isReadonly(); }\r\n\r\n  /** Create a new table in this database. */\r\n  protected createTable(args: {\r\n    /** The name of the table to create. */\r\n    tableName: string;\r\n    /** all of the columns in the table. */\r\n    columns: string;\r\n    /** any unique or foreign key constraints */\r\n    constraints?: string;\r\n    /** if true, add a \"lastMod\" timestamp column and triggers to automatically update it. */\r\n    addTimestamp?: boolean;\r\n  }) {\r\n    const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\r\n    const constraints = args.constraints ? `,${args.constraints}` : \"\";\r\n    this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\r\n    if (args.addTimestamp)\r\n      this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\r\n  }\r\n\r\n  /**\r\n   * Get the last modified date for a row in a table of this database.\r\n   * @note the table must have been created with `addTimestamp: true`\r\n  */\r\n  public readLastModTime(tableName: string, rowId: number): Date {\r\n    return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\r\n      stmt.bindInteger(1, rowId);\r\n      return stmt.getValueDate(0);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Open a database, perform an operation, then close the database.\r\n   *\r\n   * Details:\r\n   * - if database is open, throw an error\r\n   * - open a database\r\n   * - call a function with the database opened. If it is async, await its return.\r\n   * - if function throws, abandon all changes, close database, and rethrow\r\n   * - save all changes\r\n   * - close the database\r\n   * @return value from operation\r\n   */\r\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\r\n    if (this.isOpen)\r\n      SqliteError.throwError(\"already-open\", \"database is already open\", args.dbName);\r\n\r\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\r\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\r\n    try {\r\n      const result = operation();\r\n      result instanceof Promise ? result.then(save, abandon) : save();\r\n      return result;\r\n    } catch (e) {\r\n      abandon();\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /** The cloud container backing this SQLite database, if any.\r\n   * @beta\r\n   */\r\n  public get cloudContainer(): CloudSqlite.CloudContainer | undefined {\r\n    return this[_nativeDb].cloudContainer;\r\n  }\r\n\r\n  /** Returns the Id of the most-recently-inserted row in this database, per [sqlite3_last_insert_rowid](https://www.sqlite.org/c3ref/last_insert_rowid.html). */\r\n  public getLastInsertRowId(): number {\r\n    return this[_nativeDb].getLastInsertRowId();\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on a database in a CloudContainer with the write lock held.\r\n   *\r\n   * Details:\r\n   * - acquire the write lock on a CloudContainer\r\n   * - call `withOpenDb` with openMode `ReadWrite`\r\n   * - upload changes\r\n   * - release the write lock\r\n   * @param args arguments to lock the container and open the database\r\n   * @param operation an operation performed on the database with the write lock held.\r\n   * @return value from operation\r\n   * @internal\r\n   */\r\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => Promise<T>) {\r\n    return CloudSqlite.withWriteLock(args, async () => this.withOpenDb({ ...args, openMode: args.openMode ?? OpenMode.ReadWrite }, operation));\r\n  }\r\n\r\n  /** vacuum this database\r\n   * @see https://www.sqlite.org/lang_vacuum.html\r\n   */\r\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\r\n    this[_nativeDb].vacuum(args);\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */\r\n  public saveChanges(): void {\r\n    this[_nativeDb].saveChanges();\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */\r\n  public abandonChanges(): void {\r\n    this[_nativeDb].abandonChanges();\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    const release = () => stmt[Symbol.dispose]();\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\r\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\r\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\r\n   */\r\n  public withSavePoint(savePointName: string, operation: () => void) {\r\n    if (this.isReadonly)\r\n      SqliteError.throwError(\"readonly\", \"database is readonly\", this[_nativeDb].getFilePath());\r\n\r\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\r\n    try {\r\n      operation();\r\n      this.executeSQL(`RELEASE ${savePointName}`);\r\n    } catch (e) {\r\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n     * @param sql The SQLite SQL statement to prepare\r\n     * @param logErrors Determine if errors are logged or not\r\n     * @internal\r\n     */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this[_nativeDb], logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** execute an SQL statement */\r\n  public executeSQL(sql: string): DbResult {\r\n    using stmt = this.prepareSqliteStatement(sql);\r\n    return stmt.step();\r\n  }\r\n}\r\n\r\n/**\r\n * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\r\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\r\n * always used for access.\r\n *\r\n * Notes:\r\n *  - This class may be used either to access a local file, or one stored in a cloud container.\r\n *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\r\n * tables.\r\n * @beta\r\n */\r\nexport abstract class VersionedSqliteDb extends SQLiteDb {\r\n  protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\r\n\r\n  /** The current semver \"persistence version\" of this class.\r\n   * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\r\n   * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\r\n   * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\r\n   * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\r\n   * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\r\n   * supported by it, the user will be informed that they need to upgrade their software.\r\n   * @note this identifier is independent of versions in `package.json` files.\r\n  */\r\n  public abstract myVersion: string;\r\n\r\n  /**\r\n   * Change the \"versions required to open this database\" property stored in this database. After this call,\r\n   * versions of software that don't meet the supplied ranges will fail.\r\n   * @param versions the new versions required for reading and writing this database.\r\n   * @note the database must be opened for write access.\r\n   */\r\n  public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\r\n    // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\r\n    this[_nativeDb].saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\r\n  }\r\n\r\n  /** Get the required version ranges necessary to open this VersionedSqliteDb. */\r\n  public getRequiredVersions() {\r\n    const checkIsString = (value: any) => {\r\n      if (typeof value !== \"string\")\r\n        SqliteError.throwError(\"invalid-versions-property\", `CloudDb has invalid \"versions\" property`, this[_nativeDb].getFilePath());\r\n      return value;\r\n    };\r\n    const versionJson = checkIsString(this[_nativeDb].queryFileProperty(VersionedSqliteDb._versionProps, true));\r\n    const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\r\n    checkIsString(versionRanges.readVersion);\r\n    checkIsString(versionRanges.writeVersion);\r\n    return versionRanges;\r\n  }\r\n\r\n  /**\r\n   * Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\r\n   */\r\n  protected abstract createDDL(args: any): void;\r\n\r\n  /**\r\n   * Create a new database file for the subclass of VersionedSqliteDb.\r\n   * @note The required versions are saved as [[myVersion]] or newer for both read and write.\r\n   */\r\n  public static createNewDb(fileName: LocalFileName, setupArgs?: any) {\r\n    const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\r\n    IModelJsFs.recursiveMkDirSync(dirname(fileName));\r\n    if (fs.existsSync(fileName))\r\n      fs.unlinkSync(fileName);\r\n\r\n    db.createDb(fileName);\r\n    db.createDDL(setupArgs);\r\n    const minVer = `^${db.myVersion}`;\r\n    db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\r\n    db.closeDb(true);\r\n  }\r\n\r\n  /**\r\n   * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n   * Throws otherwise.\r\n   */\r\n  protected verifyVersions() {\r\n    const versions = this.getRequiredVersions();\r\n    const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\r\n    const range = isReadonly ? versions.readVersion : versions.writeVersion;\r\n    if (semver.satisfies(this.myVersion, range))\r\n      return;\r\n\r\n    this.closeDb();\r\n    const tooNew = semver.gtr(this.myVersion, range);\r\n    SqliteError.throwError(\"incompatible-version\", `requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`, this[_nativeDb].getFilePath());\r\n\r\n  }\r\n\r\n  /**\r\n   * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n   * Throws otherwise.\r\n   * @see [[SqliteDb.openDb]] for argument types\r\n   */\r\n  public override openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\r\n    super.openDb(dbName, openMode, container);\r\n    this.verifyVersions();\r\n  }\r\n\r\n  public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }) {\r\n    // can't use \"this\" because it checks for version, which we don't want here\r\n    return (arg.lockContainer) ?\r\n      super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\r\n      super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace SQLiteDb {\r\n  /** A semver version range.\r\n   * @see https://docs.npmjs.com/cli/v6/using-npm/semver\r\n   */\r\n  export type VersionRange = string;\r\n\r\n  /**\r\n   * A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\r\n   * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\r\n   */\r\n  export interface RequiredVersionRanges {\r\n    /** a range of acceptable persistence versions for reading from a VersionedSqliteDb. */\r\n    readonly readVersion: VersionRange;\r\n    /** a range of acceptable persistence versions for writing to a VersionedSqliteDb. */\r\n    readonly writeVersion: VersionRange;\r\n  }\r\n\r\n  /** interface for reading and writing to a blob in a SQLiteDb\r\n   * @internal\r\n   */\r\n  export interface BlobIO {\r\n    /** Close this BlobIO if it is opened.\r\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\r\n      */\r\n    close(): void;\r\n    /** get the total number of bytes in the blob */\r\n    getNumBytes(): number;\r\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\r\n    isValid(): boolean;\r\n    /** Open this BlobIO against a table/row/column in a Db */\r\n    open(\r\n      /** The database for the blob */\r\n      db: IModelJsNative.AnyDb,\r\n      args: {\r\n        /** the name of the table for the blob*/\r\n        tableName: string;\r\n        /** the name of the column for the blob */\r\n        columnName: string;\r\n        /** The rowId of the blob */\r\n        row: number;\r\n        /** If true, open this BlobIO for write access */\r\n        writeable?: boolean;\r\n      }): void;\r\n    /** Read from a blob\r\n       * @returns the contents of the requested byte range\r\n       */\r\n    read(args: {\r\n      /** The number of bytes to read */\r\n      numBytes: number;\r\n      /** starting offset within the blob to read */\r\n      offset: number;\r\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\r\n      blob?: ArrayBuffer;\r\n    }): Uint8Array;\r\n    /** Reposition this BlobIO to a new rowId\r\n       * @note this BlobIO must be valid when this methods is called.\r\n       */\r\n    changeRow(row: number): void;\r\n    /** Write to a blob */\r\n    write(args: {\r\n      /** The number of bytes to write  */\r\n      numBytes: number;\r\n      /** starting offset within the blob to write */\r\n      offset: number;\r\n      /** the value to write */\r\n      blob: ArrayBuffer;\r\n    }): void;\r\n  }\r\n\r\n  /** Default transaction mode for SQLiteDbs.\r\n   * @see https://www.sqlite.org/lang_transaction.html\r\n   */\r\n  export enum DefaultTxnMode {\r\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\r\n    None = 0,\r\n    /** A deferred transaction is started when the file is first opened. This is the default. */\r\n    Deferred = 1,\r\n    /** An immediate transaction is started when the file is first opened. */\r\n    Immediate = 2,\r\n    /** An exclusive transaction is started when the file is first opened. */\r\n    Exclusive = 3\r\n  }\r\n\r\n  /** parameters common to opening or creating a new SQLiteDb */\r\n  export interface OpenOrCreateParams {\r\n    /** If true, do not require that the `be_Prop` table exist */\r\n    rawSQLite?: boolean;\r\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\r\n    immutable?: boolean;\r\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\r\n    skipFileCheck?: boolean;\r\n    /** the default transaction mode\r\n   * @see [[SQLiteDb.DefaultTxnMode]]\r\n  */\r\n    defaultTxn?: 0 | 1 | 2 | 3;\r\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\r\n    queryParam?: string;\r\n  }\r\n\r\n  /** Parameters for opening an existing SQLiteDb */\r\n  export interface OpenParams extends OpenOrCreateParams {\r\n    /** use OpenMode.ReadWrite to open the file with write access */\r\n    openMode: OpenMode;\r\n  }\r\n\r\n  /** Size of a SQLiteDb page in bytes */\r\n  export interface PageSize {\r\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\r\n    pageSize?: number;\r\n  }\r\n\r\n  /** Parameters for creating a new SQLiteDb */\r\n  export type CreateParams = OpenOrCreateParams & PageSize;\r\n\r\n  /** Arguments for `SqliteDb.withOpenDb` */\r\n  export interface WithOpenDbArgs {\r\n    /** The name of the database to open */\r\n    dbName: string;\r\n    /** either an object with the open parameters or just OpenMode value. */\r\n    openMode?: OpenMode | SQLiteDb.OpenParams;\r\n    /** @internal */\r\n    container?: CloudSqlite.CloudContainer;\r\n  }\r\n\r\n  /** Arguments for `SQLiteDb.vacuum` */\r\n  export interface VacuumDbArgs extends PageSize {\r\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\r\n    into?: LocalFileName;\r\n  }\r\n}\r\n"]}

package/lib/esm/Schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,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,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,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;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IACH,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE7D,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;IAED;;;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,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,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,aAAa,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","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 *\n * When subclassing from Schema, it is good practice to follow this pattern:\n *\n * ```typescript\n * class MyCustomSchema extends Schema {\n *   public static override get schemaName(): string { return \"MyCustomSchema\"; }\n *   public static get classes(): typeof Entity[] {\n *     return [MyOwnECClass, AnotherECClass];\n *   }\n *   public static registerSchema() {\n *     if (this !== Schemas.getRegisteredSchema(this.schemaName)) {\n *       Schemas.unregisterSchema(this.schemaName);\n *       Schemas.registerSchema(this);\n *       for (const ecClass of this.classes) {\n *         ClassRegistry.register(ecClass, this);\n *       }\n *     }\n *   }\n *\n *   public static unregisterSchema() {\n *     Schemas.unregisterSchema(this.schemaName);\n *   }\n * }\n * ```\n *\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"]}
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,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,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,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;AAED;;;GAGG;AACH,MAAM,OAAO,SAAS;IACH,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE7D,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;IAED;;;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,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,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,aAAa,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","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\nimport { ECVersion, SchemaKey } from \"@itwin/ecschema-metadata\";\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 *\r\n * When subclassing from Schema, it is good practice to follow this pattern:\r\n *\r\n * ```typescript\r\n * class MyCustomSchema extends Schema {\r\n *   public static override get schemaName(): string { return \"MyCustomSchema\"; }\r\n *   public static get classes(): typeof Entity[] {\r\n *     return [MyOwnECClass, AnotherECClass];\r\n *   }\r\n *   public static registerSchema() {\r\n *     if (this !== Schemas.getRegisteredSchema(this.schemaName)) {\r\n *       Schemas.unregisterSchema(this.schemaName);\r\n *       Schemas.registerSchema(this);\r\n *       for (const ecClass of this.classes) {\r\n *         ClassRegistry.register(ecClass, this);\r\n *       }\r\n *     }\r\n *   }\r\n *\r\n *   public static unregisterSchema() {\r\n *     Schemas.unregisterSchema(this.schemaName);\r\n *   }\r\n * }\r\n * ```\r\n *\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  /** Unique identifier for this schema, typed variant of [[schemaName]].\r\n   * @internal\r\n   */\r\n  public static get schemaKey(): SchemaKey {\r\n    // We cannot cache this here because the schemaName may be overridden without this being overridden\r\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\r\n  }\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/**\r\n * Holds a map of registered schemas.\r\n * @public\r\n */\r\nexport class SchemaMap {\r\n  private readonly _schemas = new Map<string, typeof Schema>();\r\n\r\n  /** @internal */\r\n  public get(schemaName: string): typeof Schema | undefined {\r\n    return this._schemas.get(schemaName.toLowerCase());\r\n  }\r\n\r\n  /** @internal */\r\n  public set(schemaName: string, schema: typeof Schema): void {\r\n    this._schemas.set(schemaName.toLowerCase(), schema);\r\n  }\r\n\r\n  /** @internal */\r\n  public delete(schemaName: string): boolean {\r\n    return this._schemas.delete(schemaName.toLowerCase());\r\n  }\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   * @public\r\n   */\r\n  public registerSchema(schema: typeof Schema) {\r\n    const key = schema.schemaName.toLowerCase();\r\n    if (this.get(key))\r\n      throw new IModelError(IModelStatus.DuplicateName, `Schema \"${schema.schemaName}\" is already registered`);\r\n    this.set(key, schema);\r\n  }\r\n}\r\n\r\n/** Manages registered schemas\r\n * @public\r\n */\r\nexport class Schemas {\r\n  private static readonly _globalSchemas = new SchemaMap();\r\n  private constructor() { } // this is a singleton\r\n\r\n  /** Register a schema prior to using it.\r\n   * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.\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    this._globalSchemas.registerSchema(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._globalSchemas.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._globalSchemas.get(schemaName.toLowerCase()); }\r\n}\r\n"]}

package/lib/esm/SchemaSync.js

@@ -11,7 +11,7 @@ import { BriefcaseDb, IModelDb } from "./IModelDb";
 import { DbResult, OpenMode } from "@itwin/core-bentley";
 import { IModelError } from "@itwin/core-common";
 import { IModelNative } from "./internal/NativePlatform";
-import { _nativeDb } from "./internal/Symbols";
+import { _implicitTxn, _nativeDb } from "./internal/Symbols";
 /** @internal */
 export var SchemaSync;
 (function (SchemaSync) {
@@ -91,7 +91,7 @@ export var SchemaSync;
                 const schemaSyncDbUri = syncAccess.getUri();
                 iModel.clearCaches();
                 iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);
-                iModel.saveChanges("schema synchronized with cloud container");
+                iModel[_implicitTxn].saveChanges("schema synchronized with cloud container");
             });
         }
     };
@@ -107,17 +107,17 @@ export var SchemaSync;
             await briefcase.pullChanges();
         }
         try {
-            iModel.saveFileProperty(syncProperty, JSON.stringify(props));
+            iModel[_implicitTxn].saveFileProperty(syncProperty, JSON.stringify(props));
             await SchemaSync.withLockedAccess(arg.iModel, { operationName: "initialize schemaSync", openMode: OpenMode.Readonly }, async (syncAccess) => {
                 iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);
-                iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);
+                iModel[_implicitTxn].saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);
             });
         }
         catch (err) {
             throw err;
         }
         finally {
-            iModel.abandonChanges();
+            iModel[_implicitTxn].abandonChanges();
         }
         if (briefcase) {
             if (arg.overrideContainer)

package/lib/esm/SchemaSync.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAiB,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,gBAAgB;AAChB,MAAM,KAAW,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,iBAAiB;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,SAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,SAAS,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,QAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,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,WAAW,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,WAAW,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,SAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,SAAS,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,SAAS,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,WAAW,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,WAAW,CAAC,QAAQ,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,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,SAAS,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,WAAW,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,SAAS,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,KAAV,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"]}
+{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAiB,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE7D,gBAAgB;AAChB,MAAM,KAAW,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,iBAAiB;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,SAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,SAAS,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,QAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,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,WAAW,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,WAAW,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,SAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,SAAS,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,SAAS,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAClD,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAAC;YAC/E,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,WAAW,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,WAAW,CAAC,QAAQ,CAAC,eAAe,EAAE,sFAAsF,CAAC,CAAC;YAC1I,CAAC;YACD,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,YAAY,CAAC,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3E,MAAM,WAAA,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,uBAAuB,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;gBACzG,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,qCAAqC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;YAC9F,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,YAAY,CAAC,CAAC,cAAc,EAAE,CAAC;QACxC,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,WAAW,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,SAAS,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,KAAV,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 { _implicitTxn, _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[_implicitTxn].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[_implicitTxn].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[_implicitTxn].saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);\r\n      });\r\n    } catch (err) {\r\n      throw err;\r\n    } finally {\r\n      iModel[_implicitTxn].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"]}

package/lib/esm/SchemaUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,WAAW,CAAC,aAAa,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"]}
+{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,WAAW,CAAC,aAAa,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"]}

package/lib/esm/SheetIndex.d.ts

@@ -3,6 +3,7 @@
  */
 import { Code, CodeScopeProps, EntityReferenceSet, RelatedElementProps, SheetIndexEntryProps, SheetIndexReferenceProps, SheetReferenceProps } from "@itwin/core-common";
 import { InformationReferenceElement } from "./Element";
+import { EditTxn } from "./EditTxn";
 import { IModelDb } from "./IModelDb";
 import { Id64String } from "@itwin/core-bentley";
 import { SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from "./NavigationRelationship";
@@ -63,6 +64,8 @@ export declare class SheetIndex extends InformationReferenceElement {
      * @returns The Id of the newly inserted SheetIndex
      * @throws [[IModelError]] if there is a problem inserting the SheetIndex
      */
+    static insert(txn: EditTxn, modelId: Id64String, name: string): Id64String;
+    /** @deprecated Use SheetIndex.insert(txn, ...) instead. */
     static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String;
 }
 /** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.
@@ -97,6 +100,8 @@ export declare class SheetIndexFolder extends SheetIndexEntry {
      * @returns The Id of the newly inserted SheetIndexFolder element.
      * @throws [[IModelError]] if unable to create the element.
      */
+    static insert(txn: EditTxn, arg: Omit<SheetIndexEntryCreateArgs, "iModelDb">): Id64String;
+    /** @deprecated Use SheetIndexFolder.insert(txn, ...) instead. */
     static insert(arg: SheetIndexEntryCreateArgs): Id64String;
 }
 /** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.
@@ -118,6 +123,8 @@ export declare class SheetIndexReference extends SheetIndexEntry {
      * @returns The Id of the newly inserted SheetIndexReference element.
      * @throws [[IModelError]] if unable to create the element.
      */
+    static insert(txn: EditTxn, arg: Omit<SheetIndexReferenceCreateArgs, "iModelDb">): Id64String;
+    /** @deprecated Use SheetIndexReference.insert(txn, ...) instead. */
     static insert(arg: SheetIndexReferenceCreateArgs): Id64String;
     /** @alpha */
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
@@ -141,6 +148,8 @@ export declare class SheetReference extends SheetIndexEntry {
      * @returns The Id of the newly inserted SheetReference element.
      * @throws [[IModelError]] if unable to create the element.
      */
+    static insert(txn: EditTxn, arg: Omit<SheetReferenceCreateArgs, "iModelDb">): Id64String;
+    /** @deprecated Use SheetReference.insert(txn, ...) instead. */
     static insert(arg: SheetReferenceCreateArgs): Id64String;
     /** @alpha */
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;

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

@@ -1 +1 @@
-{"version":3,"file":"SheetIndex.d.ts","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAe,IAAI,EAAE,cAAc,EAA0B,kBAAkB,EAAe,mBAAmB,EAAE,oBAAoB,EAAyB,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACjP,OAAO,EAAE,2BAA2B,EAAS,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAsD,qCAAqC,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAElK;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,QAAQ,EAAE,QAAQ,CAAC;IACnB,iFAAiF;IACjF,iBAAiB,EAAE,UAAU,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,EAAE,UAAU,CAAC;IACrB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC9E,wDAAwD;IACxD,YAAY,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,yBAAyB;IACzE,mDAAmD;IACnD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,2BAA2B;IACzD,WAA2B,SAAS,IAAI,MAAM,CAAyB;IAEvE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAK3G;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IASvF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAMxF;AAED;;EAEE;AACF,8BAAsB,eAAgB,SAAQ,2BAA2B;IACvE,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,0FAA0F;IACnF,aAAa,EAAE,MAAM,CAAC;IAE7B,SAAS,aAAa,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,QAAQ;IAKnD,MAAM,IAAI,oBAAoB;IAI9C;;;;OAIG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKnG,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAOvG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB;CAW5D;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB;IAKnD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB,GAAG,UAAU;CAMjE;AAED;;EAEE;AACF,qBAAa,mBAAoB,SAAQ,eAAe;IACtD,WAA2B,SAAS,IAAI,MAAM,CAAkC;IAEhF,2EAA2E;IACpE,UAAU,CAAC,EAAE,qCAAqC,CAAC;IAE1D,SAAS,aAAa,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,QAAQ;IAWvE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,wBAAwB;IAOlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B;IAQvD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B,GAAG,UAAU;IAOpE,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;EAEE;AACF,qBAAa,cAAe,SAAQ,eAAe;IACjD,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,iEAAiE;IAC1D,KAAK,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAEtD,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAWlE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,mBAAmB;IAO7C;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB;IAQlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,UAAU;IAO/D,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E"}
+{"version":3,"file":"SheetIndex.d.ts","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAe,IAAI,EAAE,cAAc,EAA0B,kBAAkB,EAAe,mBAAmB,EAAE,oBAAoB,EAAyB,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACjP,OAAO,EAAE,2BAA2B,EAAS,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAsD,qCAAqC,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAGlK;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,QAAQ,EAAE,QAAQ,CAAC;IACnB,iFAAiF;IACjF,iBAAiB,EAAE,UAAU,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,EAAE,UAAU,CAAC;IACrB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC9E,wDAAwD;IACxD,YAAY,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,yBAAyB;IACzE,mDAAmD;IACnD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,2BAA2B;IACzD,WAA2B,SAAS,IAAI,MAAM,CAAyB;IAEvE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAK3G;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IASvF;;;;;;OAMG;WACW,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IACjF,2DAA2D;WAC7C,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAOxF;AAED;;EAEE;AACF,8BAAsB,eAAgB,SAAQ,2BAA2B;IACvE,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,0FAA0F;IACnF,aAAa,EAAE,MAAM,CAAC;IAE7B,SAAS,aAAa,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,QAAQ;IAKnD,MAAM,IAAI,oBAAoB;IAI9C;;;;OAIG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKnG,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAOvG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB;CAW5D;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB;IAKnD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,yBAAyB,EAAE,UAAU,CAAC,GAAG,UAAU;IAChG,iEAAiE;WACnD,MAAM,CAAC,GAAG,EAAE,yBAAyB,GAAG,UAAU;CAajE;AAED;;EAEE;AACF,qBAAa,mBAAoB,SAAQ,eAAe;IACtD,WAA2B,SAAS,IAAI,MAAM,CAAkC;IAEhF,2EAA2E;IACpE,UAAU,CAAC,EAAE,qCAAqC,CAAC;IAE1D,SAAS,aAAa,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,QAAQ;IAWvE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,wBAAwB;IAOlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B;IAQvD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC,GAAG,UAAU;IACpG,oEAAoE;WACtD,MAAM,CAAC,GAAG,EAAE,6BAA6B,GAAG,UAAU;IAepE,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;EAEE;AACF,qBAAa,cAAe,SAAQ,eAAe;IACjD,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,iEAAiE;IAC1D,KAAK,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAEtD,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAWlE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,mBAAmB;IAO7C;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB;IAQlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG,UAAU;IAC/F,+DAA+D;WACjD,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,UAAU;IAe/D,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E"}

package/lib/esm/SheetIndex.js

@@ -7,8 +7,10 @@
  */
 import { BisCodeSpec, Code, IModelError } from "@itwin/core-common";
 import { InformationReferenceElement } from "./Element";
+import { EditTxn } from "./EditTxn";
 import { IModelStatus } from "@itwin/core-bentley";
 import { SheetIndexFolderOwnsEntries, SheetIndexOwnsEntries, SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from "./NavigationRelationship";
+import { _implicitTxn } from "./internal/Symbols";
 /** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.
  * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating
  * sub-trees via [[SheetIndexReference]]s.
@@ -40,17 +42,10 @@ export class SheetIndex extends InformationReferenceElement {
         };
         return new this(props, iModelDb);
     }
-    /** Insert a SheetIndex
-     * @param iModelDb The IModelDb
-     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
-     * @param name The name (codeValue) of the SheetIndex
-     * @returns The Id of the newly inserted SheetIndex
-     * @throws [[IModelError]] if there is a problem inserting the SheetIndex
-     */
-    static insert(iModelDb, modelId, name) {
-        const instance = this.create(iModelDb, modelId, name);
-        const elements = iModelDb.elements;
-        instance.id = elements.insertElement(instance.toJSON());
+    static insert(txnOrDb, modelId, name) {
+        const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];
+        const instance = this.create(txn.iModel, modelId, name);
+        instance.id = instance.insert(txn);
         return instance.id;
     }
 }
@@ -108,14 +103,16 @@ export class SheetIndexFolder extends SheetIndexEntry {
         const props = this.createProps(arg);
         return new this(props, arg.iModelDb);
     }
-    /** Create a new SheetIndexFolder
-     * @returns The Id of the newly inserted SheetIndexFolder element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static insert(arg) {
-        const instance = this.create(arg);
-        const elements = arg.iModelDb.elements;
-        instance.id = elements.insertElement(instance.toJSON());
+    static insert(txnOrArg, arg) {
+        const txn = txnOrArg instanceof EditTxn ? txnOrArg : txnOrArg.iModelDb[_implicitTxn];
+        const createArg = txnOrArg instanceof EditTxn ? arg : {
+            sheetIndexModelId: txnOrArg.sheetIndexModelId,
+            parentId: txnOrArg.parentId,
+            name: txnOrArg.name,
+            priority: txnOrArg.priority,
+        };
+        const instance = this.create({ ...createArg, iModelDb: txn.iModel });
+        instance.id = instance.insert(txn);
         return instance.id;
     }
 }
@@ -155,14 +152,17 @@ export class SheetIndexReference extends SheetIndexEntry {
         };
         return new this(props, arg.iModelDb);
     }
-    /** Create a new SheetIndexReference
-     * @returns The Id of the newly inserted SheetIndexReference element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static insert(arg) {
-        const instance = this.create(arg);
-        const elements = arg.iModelDb.elements;
-        instance.id = elements.insertElement(instance.toJSON());
+    static insert(txnOrArg, arg) {
+        const txn = txnOrArg instanceof EditTxn ? txnOrArg : txnOrArg.iModelDb[_implicitTxn];
+        const createArg = txnOrArg instanceof EditTxn ? arg : {
+            sheetIndexModelId: txnOrArg.sheetIndexModelId,
+            parentId: txnOrArg.parentId,
+            name: txnOrArg.name,
+            priority: txnOrArg.priority,
+            sheetIndexId: txnOrArg.sheetIndexId,
+        };
+        const instance = this.create({ ...createArg, iModelDb: txn.iModel });
+        instance.id = instance.insert(txn);
         return instance.id;
     }
     /** @alpha */
@@ -208,14 +208,17 @@ export class SheetReference extends SheetIndexEntry {
         };
         return new this(props, arg.iModelDb);
     }
-    /** Insert a new SheetReference
-     * @returns The Id of the newly inserted SheetReference element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static insert(arg) {
-        const instance = this.create(arg);
-        const elements = arg.iModelDb.elements;
-        instance.id = elements.insertElement(instance.toJSON());
+    static insert(txnOrArg, arg) {
+        const txn = txnOrArg instanceof EditTxn ? txnOrArg : txnOrArg.iModelDb[_implicitTxn];
+        const createArg = txnOrArg instanceof EditTxn ? arg : {
+            sheetIndexModelId: txnOrArg.sheetIndexModelId,
+            parentId: txnOrArg.parentId,
+            name: txnOrArg.name,
+            priority: txnOrArg.priority,
+            sheetId: txnOrArg.sheetId,
+        };
+        const instance = this.create({ ...createArg, iModelDb: txn.iModel });
+        instance.id = instance.insert(txn);
         return instance.id;
     }
     /** @alpha */

package/lib/esm/SheetIndex.js.map

@@ -1 +1 @@
-{"version":3,"file":"SheetIndex.js","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,IAAI,EAA8D,WAAW,EAAmH,MAAM,oBAAoB,CAAC;AACjP,OAAO,EAAE,2BAA2B,EAAS,MAAM,WAAW,CAAC;AAE/D,OAAO,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,qCAAqC,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAkClK;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,2BAA2B;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,WAAW,CAAC,UAAU,CAAC,CAAC;QAC9E,OAAO,IAAI,IAAI,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;AAED;;EAEE;AACF,MAAM,OAAgB,eAAgB,SAAQ,2BAA2B;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,WAAW,CAAC,eAAe,CAAC,CAAC;QACrF,OAAO,IAAI,IAAI,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,2BAA2B,CAAC,CAAC,CAAC,qBAAqB,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;AAED;;GAEG;AACH,MAAM,OAAO,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;AAED;;EAEE;AACF,MAAM,OAAO,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,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAEvE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAqC,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,qCAAqC,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;AAED;;EAEE;AACF,MAAM,OAAO,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,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAElE,IAAI,CAAC,KAAK,GAAG,IAAI,2BAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,qCAAqC,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","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"]}
+{"version":3,"file":"SheetIndex.js","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,IAAI,EAA8D,WAAW,EAAmH,MAAM,oBAAoB,CAAC;AACjP,OAAO,EAAE,2BAA2B,EAAS,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAc,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,qCAAqC,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAClK,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAkClD;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,2BAA2B;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,WAAW,CAAC,UAAU,CAAC,CAAC;QAC9E,OAAO,IAAI,IAAI,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;IAYM,MAAM,CAAC,MAAM,CAAC,OAA2B,EAAE,OAAmB,EAAE,IAAY;QACjF,MAAM,GAAG,GAAG,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACxD,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;EAEE;AACF,MAAM,OAAgB,eAAgB,SAAQ,2BAA2B;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,WAAW,CAAC,eAAe,CAAC,CAAC;QACrF,OAAO,IAAI,IAAI,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,2BAA2B,CAAC,CAAC,CAAC,qBAAqB,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;AAED;;GAEG;AACH,MAAM,OAAO,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;IASM,MAAM,CAAC,MAAM,CAAC,QAA6C,EAAE,GAAiD;QACnH,MAAM,GAAG,GAAG,QAAQ,YAAY,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACrF,MAAM,SAAS,GAAG,QAAQ,YAAY,OAAO,CAAC,CAAC,CAAC,GAAI,CAAC,CAAC,CAAC;YACrD,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;YAC7C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;SAC5B,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACrE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;EAEE;AACF,MAAM,OAAO,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,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAEvE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAqC,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,qCAAqC,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;IASM,MAAM,CAAC,MAAM,CAAC,QAAiD,EAAE,GAAqD;QAC3H,MAAM,GAAG,GAAG,QAAQ,YAAY,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACrF,MAAM,SAAS,GAAG,QAAQ,YAAY,OAAO,CAAC,CAAC,CAAC,GAAI,CAAC,CAAC,CAAC;YACrD,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;YAC7C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,YAAY,EAAE,QAAQ,CAAC,YAAY;SACpC,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACrE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,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;AAED;;EAEE;AACF,MAAM,OAAO,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,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAElE,IAAI,CAAC,KAAK,GAAG,IAAI,2BAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,qCAAqC,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;IASM,MAAM,CAAC,MAAM,CAAC,QAA4C,EAAE,GAAgD;QACjH,MAAM,GAAG,GAAG,QAAQ,YAAY,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACrF,MAAM,SAAS,GAAG,QAAQ,YAAY,OAAO,CAAC,CAAC,CAAC,GAAI,CAAC,CAAC,CAAC;YACrD,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;YAC7C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;SAC1B,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACrE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnC,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","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 { EditTxn } from \"./EditTxn\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { SheetIndexFolderOwnsEntries, SheetIndexOwnsEntries, SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from \"./NavigationRelationship\";\r\nimport { _implicitTxn } from \"./internal/Symbols\";\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(txn: EditTxn, modelId: Id64String, name: string): Id64String;\r\n  /** @deprecated Use SheetIndex.insert(txn, ...) instead. */\r\n  public static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String;\r\n  public static insert(txnOrDb: EditTxn | IModelDb, modelId: Id64String, name: string): Id64String {\r\n    const txn = txnOrDb instanceof EditTxn ? txnOrDb : txnOrDb[_implicitTxn];\r\n    const instance = this.create(txn.iModel, modelId, name);\r\n    instance.id = instance.insert(txn);\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(txn: EditTxn, arg: Omit<SheetIndexEntryCreateArgs, \"iModelDb\">): Id64String;\r\n  /** @deprecated Use SheetIndexFolder.insert(txn, ...) instead. */\r\n  public static insert(arg: SheetIndexEntryCreateArgs): Id64String;\r\n  public static insert(txnOrArg: EditTxn | SheetIndexEntryCreateArgs, arg?: Omit<SheetIndexEntryCreateArgs, \"iModelDb\">): Id64String {\r\n    const txn = txnOrArg instanceof EditTxn ? txnOrArg : txnOrArg.iModelDb[_implicitTxn];\r\n    const createArg = txnOrArg instanceof EditTxn ? arg! : {\r\n      sheetIndexModelId: txnOrArg.sheetIndexModelId,\r\n      parentId: txnOrArg.parentId,\r\n      name: txnOrArg.name,\r\n      priority: txnOrArg.priority,\r\n    };\r\n    const instance = this.create({ ...createArg, iModelDb: txn.iModel });\r\n    instance.id = instance.insert(txn);\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(txn: EditTxn, arg: Omit<SheetIndexReferenceCreateArgs, \"iModelDb\">): Id64String;\r\n  /** @deprecated Use SheetIndexReference.insert(txn, ...) instead. */\r\n  public static insert(arg: SheetIndexReferenceCreateArgs): Id64String;\r\n  public static insert(txnOrArg: EditTxn | SheetIndexReferenceCreateArgs, arg?: Omit<SheetIndexReferenceCreateArgs, \"iModelDb\">): Id64String {\r\n    const txn = txnOrArg instanceof EditTxn ? txnOrArg : txnOrArg.iModelDb[_implicitTxn];\r\n    const createArg = txnOrArg instanceof EditTxn ? arg! : {\r\n      sheetIndexModelId: txnOrArg.sheetIndexModelId,\r\n      parentId: txnOrArg.parentId,\r\n      name: txnOrArg.name,\r\n      priority: txnOrArg.priority,\r\n      sheetIndexId: txnOrArg.sheetIndexId,\r\n    };\r\n    const instance = this.create({ ...createArg, iModelDb: txn.iModel });\r\n    instance.id = instance.insert(txn);\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(txn: EditTxn, arg: Omit<SheetReferenceCreateArgs, \"iModelDb\">): Id64String;\r\n  /** @deprecated Use SheetReference.insert(txn, ...) instead. */\r\n  public static insert(arg: SheetReferenceCreateArgs): Id64String;\r\n  public static insert(txnOrArg: EditTxn | SheetReferenceCreateArgs, arg?: Omit<SheetReferenceCreateArgs, \"iModelDb\">): Id64String {\r\n    const txn = txnOrArg instanceof EditTxn ? txnOrArg : txnOrArg.iModelDb[_implicitTxn];\r\n    const createArg = txnOrArg instanceof EditTxn ? arg! : {\r\n      sheetIndexModelId: txnOrArg.sheetIndexModelId,\r\n      parentId: txnOrArg.parentId,\r\n      name: txnOrArg.name,\r\n      priority: txnOrArg.priority,\r\n      sheetId: txnOrArg.sheetId,\r\n    };\r\n    const instance = this.create({ ...createArg, iModelDb: txn.iModel });\r\n    instance.id = instance.insert(txn);\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"]}