@itwin/core-backend 5.9.0-dev.1 → 5.9.0-dev.11

package/lib/esm/TileStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAY1C;;;GAGG;AACH,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACa,OAAO,CAAgB;IAEvC,YAAmB,OAAsB;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEO,mBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAErD;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,OAAO;QACT,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3E,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;YACtE,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,gGAAgG;gBAChG,0FAA0F;gBAC1F,IAAG,CAAC,CAAC,UAAU,KAAK,GAAG;oBACrB,MAAM,CAAC,CAAC;YACZ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI,CAAC;YACH,IAAI,gBAAgB,KAAK,SAAS;gBAChC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YACjG,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;YAC7B,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc;YACjF,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,sBAAsB;YACtD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1F,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACnF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,CAAC,uBAAuB,CAAC,QAAgB;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAClC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,CAAC,kBAAkB,CAAC,QAAgB;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5F,IAAI,QAA4D,CAAC;QACjE,GAAG,CAAC;YACF,iCAAiC;YACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC7B,yCAAyC;YACzC,IAAI,QAAQ;gBACV,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACzC,+BAA+B;YAC/B,QAAQ,GAAG,MAAM,IAAI,CAAC;QACxB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;IAC3B,CAAC;IAEO,WAAW,CAAC,IAAuB;QACzC,OAAO,IAAI;aACR,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACzB,KAAK,EAAE,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,UAAU,EAAE,eAAe,CAAC,UAAU;SACvC,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAChC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO;gBACtB,OAAO,KAAK,CAAC;YACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,iDAAiD,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5J,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,4CAA4C;YAC5C,2BAA2B;YAC3B,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,SAAS,EAAE,UAAU;gBACrB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,MAAM,CAAC,QAAQ,CACb,qBAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,EAAE,YAAY,EAAE,OAAO,EAAE,CAC1B,CAAC;IACJ,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*--------------------------------------------------------------------------------------------*/\nimport { gunzip, gzip } from \"zlib\";\nimport { promisify } from \"util\";\nimport type { Metadata, ObjectReference, ServerStorage, TransferConfig } from \"@itwin/object-storage-core\";\nimport { getTileObjectReference } from \"@itwin/core-common\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { IModelHost } from \"./IModelHost\";\n\n/**\n * Identifies a tile in cloud tile cache.\n * @beta\n */\nexport interface TileId {\n  treeId: string;\n  contentId: string;\n  guid: string;\n}\n\n/**\n * Facilitates interaction with cloud tile cache.\n * @beta\n */\nexport class TileStorage {\n  /**\n   * Allows using the underlying `ServerStorage` API directly.\n   * @see https://github.com/iTwin/object-storage/\n   */\n  public readonly storage: ServerStorage;\n\n  public constructor(storage: ServerStorage) {\n    this.storage = storage;\n  }\n\n  private _initializedIModels: Set<string> = new Set();\n\n  /**\n   * Ensures any required cloud storage resources for a specific iModel are ready to use.\n   */\n  public async initialize(iModelId: string): Promise<void> {\n    if (this._initializedIModels.has(iModelId))\n      return;\n    if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {\n      try {\n        await this.storage.createBaseDirectory({ baseDirectory: iModelId });\n      } catch (e: any) {\n        // Ignore 409 errors. This is what Azure blob storage returns when the container already exists.\n        // Usually this means multiple backends tried to initialize tile storage at the same time.\n        if(e.statusCode !== 409)\n          throw e;\n      }\n    }\n    this._initializedIModels.add(iModelId);\n  }\n\n  /**\n   * Returns config that can be used by frontends to download tiles\n   * @param iModelId Id of the iModel\n   * @param expiresInSeconds Optional number of seconds until the download URL expires. Defaults to expiring exactly at midnight of next Sunday to enable persistent client-side caching.\n   *  It is recommended to set this to a shorter period when using S3-compatible storage - an exact expiry date cannot be ensured due to limitations in their API.\n   * @see [TileStorage]($frontend)\n   */\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\n    try {\n      if (expiresInSeconds !== undefined)\n        return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresInSeconds });\n      const expiresOn = new Date();\n      expiresOn.setDate(expiresOn.getDate() + (7 - expiresOn.getDay())); // next Sunday\n      expiresOn.setHours(0, 0, 0, 0); // exactly at midnight\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresOn });\n    } catch (err) {\n      this.logException(\"Failed to get download config\", err);\n      throw err;\n    }\n  }\n\n  /**\n   * Uploads a tile to the cloud cache.\n   */\n  public async uploadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, content: Uint8Array, guid?: string, metadata?: Metadata): Promise<void> {\n    try {\n      await this.storage.upload(\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\n        Buffer.from(IModelHost.compressCachedTiles ? await promisify(gzip)(content.buffer) : content.buffer),\n        metadata,\n        IModelHost.compressCachedTiles ? { contentEncoding: \"gzip\" } : undefined,\n      );\n    } catch (err) {\n      this.logException(\"Failed to upload tile\", err);\n      throw err;\n    }\n  }\n\n  /**\n   * Downloads a tile from the cloud cache.\n   */\n  public async downloadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<Uint8Array> {\n    try {\n      const buffer = await this.storage.download(\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\n        \"buffer\",\n      );\n      return IModelHost.compressCachedTiles ? await promisify(gunzip)(buffer) : buffer;\n    } catch (err) {\n      this.logException(\"Failed to download tile\", err);\n      throw err;\n    }\n  }\n\n  /**\n   * Returns an async iterator of all tiles that are found in the cloud cache.\n   */\n  public async *getCachedTilesGenerator(iModelId: string): AsyncGenerator<TileId> {\n    const iterator = this.getCachedTilePages(iModelId);\n    for await (const page of iterator) {\n      for (const tile of page) {\n        yield tile;\n      }\n    }\n  }\n\n  private async *getCachedTilePages(iModelId: string): AsyncGenerator<TileId[]> {\n    const iterator = this.storage.getListObjectsPagedIterator({ baseDirectory: iModelId }, 500);\n    let prevPage: IteratorResult<ObjectReference[], any> | undefined;\n    do {\n      // initiate loading the next page\n      const page = iterator.next();\n      // process results from the previous page\n      if (prevPage)\n        yield this.convertPage(prevPage.value);\n      // finish loading the next page\n      prevPage = await page;\n    } while (!prevPage.done);\n  }\n\n  private convertPage(page: ObjectReference[]): TileId[] {\n    return page\n      .map((objectReference) => ({\n        parts: objectReference.relativeDirectory?.split(\"/\") ?? [\"\"],\n        objectName: objectReference.objectName,\n      }))\n      .filter(({ parts, objectName }) => {\n        if (parts[0] !== \"tiles\")\n          return false;\n        if (parts.length !== 3) {\n          Logger.logWarning(BackendLoggerCategory.IModelTileStorage, \"Malformed tile id found in tile cache: {tileId}\", { tileId: [...parts, objectName].join(\"/\") });\n          return false;\n        }\n        return true;\n      }).map(({ parts, objectName }) => {\n        // relativeDirectory = tiles/<treeId>/<guid>\n        // objectName = <contentId>\n        return {\n          treeId: parts[1],\n          contentId: objectName,\n          guid: parts[2],\n        };\n      });\n  }\n\n  /**\n   * Returns a list of all tiles that are found in the cloud cache.\n   */\n  public async getCachedTiles(iModelId: string): Promise<TileId[]> {\n    const results: TileId[] = [];\n    for await (const page of this.getCachedTilePages(iModelId)) {\n      results.push(...page);\n    }\n    return results;\n  }\n\n  /**\n   * Returns a boolean indicating whether a tile exists in the cloud cache\n   */\n  public async isTileCached(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<boolean> {\n    return this.storage.objectExists(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid));\n  }\n\n  private logException(message: string, err: unknown): void {\n    Logger.logError(\n      BackendLoggerCategory.IModelTileStorage,\n      err,\n      { errorMessage: message },\n    );\n  }\n}\n"]}
+{"version":3,"file":"TileStorage.js","sourceRoot":"","sources":["../../src/TileStorage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAY1C;;;GAGG;AACH,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACa,OAAO,CAAgB;IAEvC,YAAmB,OAAsB;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEO,mBAAmB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAErD;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,OAAO;QACT,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3E,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;YACtE,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,gGAAgG;gBAChG,0FAA0F;gBAC1F,IAAG,CAAC,CAAC,UAAU,KAAK,GAAG;oBACrB,MAAM,CAAC,CAAC;YACZ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,gBAAyB;QACxE,IAAI,CAAC;YACH,IAAI,gBAAgB,KAAK,SAAS;gBAChC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC;YACjG,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;YAC7B,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc;YACjF,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,sBAAsB;YACtD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1F,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,OAAmB,EAAE,IAAa,EAAE,QAAmB;QACvJ,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CACvB,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EACpG,QAAQ,EACR,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CACzE,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACxC,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EACtE,QAAQ,CACT,CAAC;YACF,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACnF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,CAAC,uBAAuB,CAAC,QAAgB;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAClC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,CAAC,kBAAkB,CAAC,QAAgB;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5F,IAAI,QAA4D,CAAC;QACjE,GAAG,CAAC;YACF,iCAAiC;YACjC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC7B,yCAAyC;YACzC,IAAI,QAAQ;gBACV,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACzC,+BAA+B;YAC/B,QAAQ,GAAG,MAAM,IAAI,CAAC;QACxB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;IAC3B,CAAC;IAEO,WAAW,CAAC,IAAuB;QACzC,OAAO,IAAI;aACR,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACzB,KAAK,EAAE,eAAe,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,UAAU,EAAE,eAAe,CAAC,UAAU;SACvC,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAChC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO;gBACtB,OAAO,KAAK,CAAC;YACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,iBAAiB,EAAE,iDAAiD,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5J,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC/B,4CAA4C;YAC5C,2BAA2B;YAC3B,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChB,SAAS,EAAE,UAAU;gBACrB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3D,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAa;QAC/G,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,YAAY,CAAC,OAAe,EAAE,GAAY;QAChD,MAAM,CAAC,QAAQ,CACb,qBAAqB,CAAC,iBAAiB,EACvC,GAAG,EACH,EAAE,YAAY,EAAE,OAAO,EAAE,CAC1B,CAAC;IACJ,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\nimport { gunzip, gzip } from \"zlib\";\r\nimport { promisify } from \"util\";\r\nimport type { Metadata, ObjectReference, ServerStorage, TransferConfig } from \"@itwin/object-storage-core\";\r\nimport { getTileObjectReference } from \"@itwin/core-common\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { IModelHost } from \"./IModelHost\";\r\n\r\n/**\r\n * Identifies a tile in cloud tile cache.\r\n * @beta\r\n */\r\nexport interface TileId {\r\n  treeId: string;\r\n  contentId: string;\r\n  guid: string;\r\n}\r\n\r\n/**\r\n * Facilitates interaction with cloud tile cache.\r\n * @beta\r\n */\r\nexport class TileStorage {\r\n  /**\r\n   * Allows using the underlying `ServerStorage` API directly.\r\n   * @see https://github.com/iTwin/object-storage/\r\n   */\r\n  public readonly storage: ServerStorage;\r\n\r\n  public constructor(storage: ServerStorage) {\r\n    this.storage = storage;\r\n  }\r\n\r\n  private _initializedIModels: Set<string> = new Set();\r\n\r\n  /**\r\n   * Ensures any required cloud storage resources for a specific iModel are ready to use.\r\n   */\r\n  public async initialize(iModelId: string): Promise<void> {\r\n    if (this._initializedIModels.has(iModelId))\r\n      return;\r\n    if (!(await this.storage.baseDirectoryExists({ baseDirectory: iModelId }))) {\r\n      try {\r\n        await this.storage.createBaseDirectory({ baseDirectory: iModelId });\r\n      } catch (e: any) {\r\n        // Ignore 409 errors. This is what Azure blob storage returns when the container already exists.\r\n        // Usually this means multiple backends tried to initialize tile storage at the same time.\r\n        if(e.statusCode !== 409)\r\n          throw e;\r\n      }\r\n    }\r\n    this._initializedIModels.add(iModelId);\r\n  }\r\n\r\n  /**\r\n   * Returns config that can be used by frontends to download tiles\r\n   * @param iModelId Id of the iModel\r\n   * @param expiresInSeconds Optional number of seconds until the download URL expires. Defaults to expiring exactly at midnight of next Sunday to enable persistent client-side caching.\r\n   *  It is recommended to set this to a shorter period when using S3-compatible storage - an exact expiry date cannot be ensured due to limitations in their API.\r\n   * @see [TileStorage]($frontend)\r\n   */\r\n  public async getDownloadConfig(iModelId: string, expiresInSeconds?: number): Promise<TransferConfig> {\r\n    try {\r\n      if (expiresInSeconds !== undefined)\r\n        return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresInSeconds });\r\n      const expiresOn = new Date();\r\n      expiresOn.setDate(expiresOn.getDate() + (7 - expiresOn.getDay())); // next Sunday\r\n      expiresOn.setHours(0, 0, 0, 0); // exactly at midnight\r\n      return await this.storage.getDownloadConfig({ baseDirectory: iModelId }, { expiresOn });\r\n    } catch (err) {\r\n      this.logException(\"Failed to get download config\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Uploads a tile to the cloud cache.\r\n   */\r\n  public async uploadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, content: Uint8Array, guid?: string, metadata?: Metadata): Promise<void> {\r\n    try {\r\n      await this.storage.upload(\r\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\r\n        Buffer.from(IModelHost.compressCachedTiles ? await promisify(gzip)(content.buffer) : content.buffer),\r\n        metadata,\r\n        IModelHost.compressCachedTiles ? { contentEncoding: \"gzip\" } : undefined,\r\n      );\r\n    } catch (err) {\r\n      this.logException(\"Failed to upload tile\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Downloads a tile from the cloud cache.\r\n   */\r\n  public async downloadTile(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<Uint8Array> {\r\n    try {\r\n      const buffer = await this.storage.download(\r\n        getTileObjectReference(iModelId, changesetId, treeId, contentId, guid),\r\n        \"buffer\",\r\n      );\r\n      return IModelHost.compressCachedTiles ? await promisify(gunzip)(buffer) : buffer;\r\n    } catch (err) {\r\n      this.logException(\"Failed to download tile\", err);\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Returns an async iterator of all tiles that are found in the cloud cache.\r\n   */\r\n  public async *getCachedTilesGenerator(iModelId: string): AsyncGenerator<TileId> {\r\n    const iterator = this.getCachedTilePages(iModelId);\r\n    for await (const page of iterator) {\r\n      for (const tile of page) {\r\n        yield tile;\r\n      }\r\n    }\r\n  }\r\n\r\n  private async *getCachedTilePages(iModelId: string): AsyncGenerator<TileId[]> {\r\n    const iterator = this.storage.getListObjectsPagedIterator({ baseDirectory: iModelId }, 500);\r\n    let prevPage: IteratorResult<ObjectReference[], any> | undefined;\r\n    do {\r\n      // initiate loading the next page\r\n      const page = iterator.next();\r\n      // process results from the previous page\r\n      if (prevPage)\r\n        yield this.convertPage(prevPage.value);\r\n      // finish loading the next page\r\n      prevPage = await page;\r\n    } while (!prevPage.done);\r\n  }\r\n\r\n  private convertPage(page: ObjectReference[]): TileId[] {\r\n    return page\r\n      .map((objectReference) => ({\r\n        parts: objectReference.relativeDirectory?.split(\"/\") ?? [\"\"],\r\n        objectName: objectReference.objectName,\r\n      }))\r\n      .filter(({ parts, objectName }) => {\r\n        if (parts[0] !== \"tiles\")\r\n          return false;\r\n        if (parts.length !== 3) {\r\n          Logger.logWarning(BackendLoggerCategory.IModelTileStorage, \"Malformed tile id found in tile cache: {tileId}\", { tileId: [...parts, objectName].join(\"/\") });\r\n          return false;\r\n        }\r\n        return true;\r\n      }).map(({ parts, objectName }) => {\r\n        // relativeDirectory = tiles/<treeId>/<guid>\r\n        // objectName = <contentId>\r\n        return {\r\n          treeId: parts[1],\r\n          contentId: objectName,\r\n          guid: parts[2],\r\n        };\r\n      });\r\n  }\r\n\r\n  /**\r\n   * Returns a list of all tiles that are found in the cloud cache.\r\n   */\r\n  public async getCachedTiles(iModelId: string): Promise<TileId[]> {\r\n    const results: TileId[] = [];\r\n    for await (const page of this.getCachedTilePages(iModelId)) {\r\n      results.push(...page);\r\n    }\r\n    return results;\r\n  }\r\n\r\n  /**\r\n   * Returns a boolean indicating whether a tile exists in the cloud cache\r\n   */\r\n  public async isTileCached(iModelId: string, changesetId: string, treeId: string, contentId: string, guid?: string): Promise<boolean> {\r\n    return this.storage.objectExists(getTileObjectReference(iModelId, changesetId, treeId, contentId, guid));\r\n  }\r\n\r\n  private logException(message: string, err: unknown): void {\r\n    Logger.logError(\r\n      BackendLoggerCategory.IModelTileStorage,\r\n      err,\r\n      { errorMessage: message },\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/esm/TxnManager.d.ts

@@ -2,8 +2,8 @@
  * @module iModels
  */
 import { BeEvent, DbConflictResolution, DbResult, Id64String, IModelStatus } from "@itwin/core-bentley";
-import { ChangesetIdWithIndex, ChangesetIndexAndId, ChangesetProps, EntityIdAndClassIdIterable, ModelGeometryChangesProps, ModelIdAndGeometryGuid, TxnProps } from "@itwin/core-common";
-import { BriefcaseDb, StandaloneDb } from "./IModelDb";
+import { ChangesetIdWithIndex, ChangesetIndexAndId, ChangesetProps, EntityIdAndClassIdIterable, ModelGeometryChangesProps, ModelIdAndGeometryGuid, ReinstateTxnArgs, ReverseTxnArgs, TxnProps } from "@itwin/core-common";
+import { BriefcaseDb } from "./IModelDb";
 import { RelationshipProps } from "./Relationship";
 import { DbRebaseChangesetConflictArgs, RebaseChangesetConflictArgs } from "./internal/ChangesetConflictArgs";
 /** A string that identifies a Txn.
@@ -63,7 +63,7 @@ export declare function setMaxEntitiesPerEvent(max: number): number;
  */
 export type TxnMode = "direct" | "indirect";
 /**
- * Manages the process of merging and rebasing local changes (transactions) in a [[BriefcaseDb]] or [[StandaloneDb]].
+ * Manages the process of merging and rebasing local changes (transactions) in a [[BriefcaseDb]].
  *
  * The `RebaseManager` coordinates the rebase of local transactions when pulling and merging changes from other sources,
  * such as remote repositories or other users. It provides mechanisms to handle transaction conflicts, register custom conflict
@@ -156,7 +156,7 @@ export declare class RebaseManager {
     notifyRebaseTxnBegin(txnProps: TxnProps): void;
     /** @internal */
     notifyRebaseTxnEnd(txnProps: TxnProps): void;
-    constructor(_iModel: BriefcaseDb | StandaloneDb);
+    constructor(_iModel: BriefcaseDb);
     /**
      * Resumes the rebase process for the current iModel, applying any pending local changes
      * on top of the latest pulled changes from the remote source.
@@ -305,7 +305,7 @@ export declare class RebaseManager {
      */
     removeConflictHandler(id: string): void;
 }
-/** Manages local changes to a [[BriefcaseDb]] or [[StandaloneDb]] via [Txns]($docs/learning/InteractiveEditing.md)
+/** Manages local changes to a [[BriefcaseDb]] via [Txns]($docs/learning/InteractiveEditing.md)
  * @public @preview
  */
 export declare class TxnManager {
@@ -319,7 +319,7 @@ export declare class TxnManager {
     /** @internal */
     readonly rebaser: RebaseManager;
     /** @internal */
-    constructor(_iModel: BriefcaseDb | StandaloneDb);
+    constructor(_iModel: BriefcaseDb);
     /** Array of errors from dependency propagation */
     readonly validationErrors: ValidationError[];
     private get _nativeDb();
@@ -482,6 +482,7 @@ export declare class TxnManager {
     /** Return the depth of the multi-Txn stack. Generally for diagnostic use only. */
     getMultiTxnOperationDepth(): number;
     /** Reverse (undo) the most recent operation(s) to this IModelDb.
+     * @note Consider using [[reverseTxnsAsync]] instead.
      * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
      *  be reinstated together when/if ReinstateTxn is called.
      * @note If there are any outstanding uncommitted changes, they are reversed.
@@ -490,27 +491,122 @@ export declare class TxnManager {
      * @note If numOperations is too large only the operations are reversible are reversed.
      */
     reverseTxns(numOperations: number): IModelStatus;
-    /** Reverse the most recent operation. */
+    /** Reverse the most recent operation.
+     * @note Consider using [[reverseSingleTxnAsync]] instead.
+     */
     reverseSingleTxn(): IModelStatus;
-    /** Reverse all changes back to the beginning of the session. */
+    /** Reverse all changes back to the beginning of the session.
+     * @note Consider using [[reverseAllTxnsAsync]] instead.
+     */
     reverseAll(): IModelStatus;
     /** Reverse all changes back to a previously saved TxnId.
+     * @note Consider using [[reverseToTxnAsync]] instead.
      * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
      * @returns Success if the transactions were reversed, error status otherwise.
      * @see  [[getCurrentTxnId]] [[cancelTo]]
      */
     reverseTo(txnId: TxnIdString): IModelStatus;
     /** Reverse and then cancel (make non-reinstatable) all changes back to a previous TxnId.
+     * @note Consider using [[cancelToTxnAsync]] instead.
      * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
      * @returns Success if the transactions were reversed and cleared, error status otherwise.
      */
     cancelTo(txnId: TxnIdString): IModelStatus;
+    /** Reverse (undo) the most recent operation(s) to this IModelDb. By default, this method also
+     * abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If you do not want to abandon any locks, set [ReverseTxnArgs.retainLocks]($common) to true.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
+     * even if numOperations is 1, multiple Txns may be reversed if they were grouped together when they were made.
+     * @note If numOperations is too large only the operations are reversible are reversed.
+     * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
+     *  be reinstated together when/if ReinstateTxn is called.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     */
+    reverseTxnsAsync(numOperations: number, args?: ReverseTxnArgs): Promise<void>;
+    /** Reverse (undo) the most recent operation to this IModelDb. By default, this method also
+     * abandons the locks that were acquired for that operation.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
+     * even though this method reverses only one operation, multiple Txns may be reversed if they were grouped together when they were made.
+     * @note If there are no reversible operations, this method does nothing and returns Success.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     */
+    reverseSingleTxnAsync(args?: ReverseTxnArgs): Promise<void>;
+    /** Reverse (undo) all operations back to the beginning of the session. By default, this method also
+     * abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note If there are no reversible operations, this method does nothing and returns Success.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     */
+    reverseAllTxnsAsync(args?: ReverseTxnArgs): Promise<void>;
+    /** Reverse (undo) all operations back to a previously saved TxnId. By default, this method also
+     * abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to abandon locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     * @see  [[getCurrentTxnId]] [[cancelTo]]
+     */
+    reverseToTxnAsync(txnId: TxnIdString, args?: ReverseTxnArgs): Promise<void>;
+    /** Reverse and then cancel (make non-reinstatable) all operations back to a previous TxnId. By default, this
+     * method also abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to abandon locks.
+     * @returns A promise that resolves to success if the transactions were reversed and cleared, or rejects with an IModelError otherwise.
+     */
+    cancelToTxnAsync(txnId: TxnIdString, args?: ReverseTxnArgs): Promise<void>;
+    private withLockAbandonment;
     /** Reinstate the most recently reversed transaction. Since at any time multiple transactions can be reversed, it
      * may take multiple calls to this method to reinstate all reversed operations.
      * @returns Success if a reversed transaction was reinstated, error status otherwise.
      * @note If there are any outstanding uncommitted changes, they are canceled before the Txn is reinstated.
+     * @note This method will return [[IModelStatus.LockNotHeld]] and will not reinstate the Txn if the locks
+     * originally acquired by the Txn have been abandoned. Use [[reinstateTxnAsync]] to re-acquire the locks
+     * and reinstate the Txn in a single operation.
      */
     reinstateTxn(): IModelStatus;
+    /** Reinstate the most recently reversed transaction. This method will first attempt
+     * to re-acquire the required locks, if they were abandoned after the operation was reversed.
+     * Since at any time multiple transactions can be reversed, it may take multiple calls to this
+     * method to reinstate all reversed operations.
+     * @beta
+     * @note If there are any outstanding unsaved changes, they are canceled before the Txn is reinstated. Unless
+     * [ReinstateTxnArgs.retainLocks]($common) is true, the locks associated with the unsaved changes are also abandoned.
+     * @param args Optional arguments to control the behavior of the reinstate operation, such as whether to retain
+     * locks when abandoning unsaved changes.
+     * @returns A Promise that resolves to success if a reversed transaction was reinstated, or rejects with an IModelError otherwise.
+     */
+    reinstateTxnAsync(args?: ReinstateTxnArgs): Promise<void>;
     /** Get the Id of the first transaction, if any.
      */
     queryFirstTxnId(): TxnIdString;
@@ -551,7 +647,7 @@ export declare class TxnManager {
     get hasLocalChanges(): boolean;
     /** Destroy the record of all local changes that have yet to be saved and/or pushed.
      * This permanently eradicates your changes - use with caution!
-     * Typically, callers will want to subsequently use [[LockControl.releaseAllLocks]].
+     * Typically, callers will want to subsequently use [[LockControl.abandonAllLocks]].
      * After calling this function, [[hasLocalChanges]], [[hasPendingTxns]], and [[hasUnsavedChanges]] will all be `false`.
      */
     deleteAllTxns(): void;

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

@@ -1 +1 @@
-{"version":3,"file":"TxnManager.d.ts","sourceRoot":"","sources":["../../src/TxnManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACG,OAAO,EAAmD,oBAAoB,EAAE,QAAQ,EAAa,UAAU,EAAE,YAAY,EACtI,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,cAAc,EAAE,0BAA0B,EAAe,yBAAyB,EAAE,sBAAsB,EAA4D,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE/P,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,EAAgB,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGjE,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAI9G;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAC7C,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAC7C,4IAA4I;IAC5I,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,8IAA8I;IAC9I,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,+DAA+D;IAC/D,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;EAGE;AACF,MAAM,WAAW,iBAAiB;IAChC,oCAAoC;IACpC,EAAE,EAAE,UAAU,CAAC;IACf,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;CAChD;AAID,oCAAoC;AACpC,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAI1D;AAsND;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAa;IA6HL,OAAO,CAAC,OAAO;IA5HlC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,SAAS,CAAkB;IAEnC;;OAEG;IACH,SAAgB,gBAAgB,sBAA2B,oBAAoB,KAAK,IAAI,EAAI;IAE5F;;OAEG;IACH,SAAgB,aAAa,iBAAsB,QAAQ,EAAE,KAAK,IAAI,EAAI;IAE1E;;OAEG;IACH,SAAgB,gBAAgB,qBAA0B,QAAQ,KAAK,IAAI,EAAI;IAC/E;;OAEG;IACH,SAAgB,cAAc,qBAA0B,QAAQ,KAAK,IAAI,EAAI;IAE7E;;OAEG;IACH,SAAgB,WAAW,iBAAsB,QAAQ,EAAE,KAAK,IAAI,EAAI;IACxE;;OAEG;IACH,SAAgB,cAAc,sBAA2B,oBAAoB,KAAK,IAAI,EAAI;IAE1F;;OAEG;IACH,SAAgB,2BAA2B,uBAA4B,cAAc,EAAE,KAAK,IAAI,EAAI;IAEpG;;OAEG;IACH,SAAgB,yBAAyB,oBAAyB,cAAc,EAAE,KAAK,IAAI,EAAI;IAE/F;;OAEG;IACH,SAAgB,0BAA0B,gBAAqB,IAAI,EAAI;IAEvE;;OAEG;IACH,SAAgB,wBAAwB,iBAAsB,QAAQ,EAAE,KAAK,IAAI,EAAI;IAErF;;OAEG;IACH,SAAgB,yBAAyB,gBAAqB,IAAI,EAAI;IAEtE;;OAEG;IACH,SAAgB,uBAAuB,gBAAqB,IAAI,EAAI;IAGpE,gBAAgB;IACT,oBAAoB,CAAC,SAAS,EAAE,oBAAoB;IAI3D,gBAAgB;IACT,kBAAkB,CAAC,SAAS,EAAE,oBAAoB;IAIzD,gBAAgB;IACT,+BAA+B,CAAC,OAAO,EAAE,cAAc,EAAE;IAIhE,gBAAgB;IACT,6BAA6B,CAAC,OAAO,EAAE,cAAc,EAAE;IAI9D,gBAAgB;IACT,8BAA8B;IAIrC,gBAAgB;IACT,4BAA4B,CAAC,IAAI,EAAE,QAAQ,EAAE;IAIpD,gBAAgB;IACT,6BAA6B;IAIpC,gBAAgB;IACT,2BAA2B;IAIlC,gBAAgB;IACT,iBAAiB,CAAC,IAAI,EAAE,QAAQ,EAAE;IAIzC,gBAAgB;IACT,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE;IAIvC,gBAAgB;IACT,oBAAoB,CAAC,QAAQ,EAAE,QAAQ;IAI9C,gBAAgB;IACT,kBAAkB,CAAC,QAAQ,EAAE,QAAQ;gBAKjB,OAAO,EAAE,WAAW,GAAG,YAAY;IAE9D;;;;;;;;;;;;;;;;;;OAkBG;IACU,MAAM;IA8CnB;;;;;;;;;;;;;;;;;;OAkBG;IAEU,cAAc;IAmD3B;;;;OAIG;IACH,OAAO,CAAC,oCAAoC;IAQ5C;;;;;OAKG;YACW,0BAA0B;IA0CxC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;;;;;OAOG;IACI,QAAQ;IAIf;;;;;;;;;;OAUG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBnC;;;;OAIG;IACI,gBAAgB,CAAC,OAAO,EAAE,aAAa;IAO9C;;;OAGG;IACI,UAAU;IAIjB;;;;OAIG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACH,IAAW,UAAU,YAEpB;IAED;;;;OAIG;IACH,IAAW,SAAS,YAEnB;IAED;;;;;;;;;OASG;IACI,UAAU,CAAC,IAAI,EAAE,2BAA2B,GAAG,oBAAoB,GAAG,SAAS;IAatF;;;;;;;;;;;OAWG;IACI,kBAAkB,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC,IAAI,EAAE,2BAA2B,KAAK,oBAAoB,GAAG,SAAS,CAAA;KAAE;IAehI;;;;;;;OAOG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM;CAoBxC;AAED;;GAEG;AACH,qBAAa,UAAU;IAcT,OAAO,CAAC,OAAO;IAb3B,gBAAgB;IAChB,OAAO,CAAC,WAAW,CAAS;IAC5B,gBAAgB;IAChB,OAAO,CAAC,6BAA6B,CAAK;IAC1C,gBAAgB;IAChB,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,gBAAgB;IAChB,SAAgB,OAAO,EAAE,aAAa,CAAC;IAEvC,gBAAgB;gBACI,OAAO,EAAE,WAAW,GAAG,YAAY;IAOvD,kDAAkD;IAClD,SAAgB,gBAAgB,EAAE,eAAe,EAAE,CAAM;IAEzD,OAAO,KAAK,SAAS,GAAsC;IAC3D,OAAO,CAAC,gBAAgB;IAGxB,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACI,cAAc,IAAI,IAAI;IAM7B,gBAAgB;IAChB,SAAS,CAAC,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI;IAG9E,gBAAgB;IAChB,SAAS,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI;IAG1E,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAGxD,gBAAgB;IAChB,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAG9D,gBAAgB;IAChB,SAAS,CAAC,gBAAgB;IAE1B;;OAEG;IACH,SAAS,CAAC,cAAc;IAMxB,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,UAAU,EAAE,yBAAyB,EAAE;IAKpE,gBAAgB;IAChB,SAAS,CAAC,uBAAuB,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAK1E,gBAAgB;IAChB,SAAS,CAAC,SAAS;IAKnB,gBAAgB;IAChB,SAAS,CAAC,YAAY;IAMtB,gBAAgB;IAChB,SAAS,CAAC,qBAAqB;IAK/B,gBAAgB;IAChB,SAAS,CAAC,uBAAuB;IAKjC,gBAAgB;IAChB,SAAS,CAAC,iBAAiB;IAQ3B,gBAAgB;IAChB,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO;IAK3C,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO;IAM1C,gBAAgB;IAET,gBAAgB,CAAC,SAAS,EAAE,mBAAmB;IAMtD,gBAAgB;IAET,gBAAgB,CAAC,SAAS,EAAE,mBAAmB;IAMtD,OAAO,CAAC,yBAAyB;IA8EjC;;;;;;OAMG;IACI,WAAW,CAAC,EAAE,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS;IAIzD;;;;;OAKG;IACK,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC;IAQxC;;;;;OAKG;IACI,oBAAoB,IAAI,QAAQ,GAAG,SAAS;IAInD;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,eAAe;IAKzC,kGAAkG;IAClG,IAAW,aAAa,IAAI,OAAO,CAA8C;IAEjF,gBAAgB;IAChB,SAAgB,eAAe,gBAAqB,IAAI,EAAI;IAE5D;;;OAGG;IACH,SAAgB,iBAAiB,oBAAyB,kBAAkB,KAAK,IAAI,EAAI;IAEzF;;;OAGG;IACH,SAAgB,eAAe,oBAAyB,kBAAkB,KAAK,IAAI,EAAI;IAEvF;;;;;OAKG;IACH,SAAgB,sBAAsB,oBAAyB,aAAa,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAI;IAEjH,SAAgB,iBAAiB,mBAAwB,yBAAyB,EAAE,KAAK,IAAI,EAAI;IACjG,iJAAiJ;IACjJ,SAAgB,QAAQ,gBAAqB,IAAI,EAAI;IACrD,wJAAwJ;IACxJ,SAAgB,WAAW,gBAAqB,IAAI,EAAI;IACxD,wEAAwE;IACxE,SAAgB,gBAAgB,gBAAqB,IAAI,EAAI;IAC7D,+DAA+D;IAC/D,SAAgB,gBAAgB,mBAAwB,OAAO,KAAK,IAAI,EAAI;IAC5E;;OAEG;IACH,SAAgB,eAAe,mBAAwB,OAAO,KAAK,IAAI,EAAI;IAC3E;;OAEG;IACH,SAAgB,oBAAoB,gBAAqB,IAAI,EAAI;IACjE;;OAEG;IACH,SAAgB,sBAAsB,gBAAqB,IAAI,EAAI;IAEnE;;OAEG;IACH,SAAgB,eAAe,4BAAiC,mBAAmB,KAAK,IAAI,EAAI;IAEhG;;OAEG;IACH,SAAgB,eAAe,4BAAiC,mBAAmB,KAAK,IAAI,EAAI;IAEhG;;;SAGK;IACE,wBAAwB,CAAC,EAAE,CAAC,IAAI,EAAE,6BAA6B,KAAK,oBAAoB,GAAG,SAAS,CAAC;IAE5G;;;;;;OAMG;IACI,cAAc;IAIrB,4EAA4E;IAC5E,IAAW,iBAAiB,IAAI,OAAO,CAAyC;IAEhF,oGAAoG;IACpG,IAAW,cAAc,IAAI,OAAO,CAA4C;IAEhF,2EAA2E;IAC3E,IAAW,cAAc,IAAI,OAAO,CAA4C;IAEhF;;OAEG;IACI,aAAa,IAAI,MAAM;IAE9B;;OAEG;IACI,aAAa,IAAI,MAAM;IAE9B;;;;;OAKG;IACI,sBAAsB,IAAI,QAAQ;IAEzC,gCAAgC;IACzB,oBAAoB,IAAI,QAAQ;IAEvC,kFAAkF;IAC3E,yBAAyB,IAAI,MAAM;IAE1C;;;;;;;OAOG;IACI,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY;IAIvD,yCAAyC;IAClC,gBAAgB,IAAI,YAAY;IAEvC,gEAAgE;IACzD,UAAU,IAAI,YAAY;IAEjC;;;;OAIG;IACI,SAAS,CAAC,KAAK,EAAE,WAAW,GAAG,YAAY;IAElD;;;OAGG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,YAAY;IAEjD;;;;OAIG;IACI,YAAY,IAAI,YAAY;IAEnC;OACG;IACI,eAAe,IAAI,WAAW;IAErC,+CAA+C;IACxC,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAEtD,iDAAiD;IAC1C,kBAAkB,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAE1D,oDAAoD;IAC7C,eAAe,IAAI,WAAW;IAErC;;;OAGG;IACI,mBAAmB,IAAI,MAAM;IAEpC,sFAAsF;IAC/E,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAEpD,+BAA+B;IACxB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAEhD;;OAEG;IACH,IAAW,cAAc,IAAI,OAAO,CAA4C;IAEhF;;;OAGG;IACH,IAAW,iBAAiB,IAAI,OAAO,CAA+C;IAEtF;;;OAGG;IACH,IAAW,uBAAuB,IAAI,OAAO,CAAqD;IAElG;;;;OAIG;IACH,IAAW,eAAe,IAAI,OAAO,CAA0D;IAE/F;;;;OAIG;IACI,aAAa,IAAI,IAAI;IAI5B;;MAEE;IACK,iBAAiB,CAAC,IAAI,CAAC,EAAE,qBAAqB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAOnF;;OAEG;IACI,2BAA2B,IAAI,MAAM;IAI5C;;;;OAIG;IACI,OAAO,IAAI,OAAO;IAIzB;;;;OAIG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAetD;;;;OAIG;IACU,wBAAwB,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAcpF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC;IACxC;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC"}
+{"version":3,"file":"TxnManager.d.ts","sourceRoot":"","sources":["../../src/TxnManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACG,OAAO,EAAmD,oBAAoB,EAAE,QAAQ,EAAa,UAAU,EAAE,YAAY,EACtI,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,cAAc,EAAE,0BAA0B,EAAe,yBAAyB,EAAE,sBAAsB,EAA4D,gBAAgB,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEjS,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAgB,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGjE,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAI9G;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAC7C,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAC7C,4IAA4I;IAC5I,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,8IAA8I;IAC9I,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,+DAA+D;IAC/D,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;EAGE;AACF,MAAM,WAAW,iBAAiB;IAChC,oCAAoC;IACpC,EAAE,EAAE,UAAU,CAAC;IACf,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;CAChD;AAID,oCAAoC;AACpC,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAI1D;AAsND;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAa;IA6HL,OAAO,CAAC,OAAO;IA5HlC,OAAO,CAAC,iBAAiB,CAAC,CAAmB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,SAAS,CAAkB;IAEnC;;OAEG;IACH,SAAgB,gBAAgB,sBAA2B,oBAAoB,KAAK,IAAI,EAAI;IAE5F;;OAEG;IACH,SAAgB,aAAa,iBAAsB,QAAQ,EAAE,KAAK,IAAI,EAAI;IAE1E;;OAEG;IACH,SAAgB,gBAAgB,qBAA0B,QAAQ,KAAK,IAAI,EAAI;IAC/E;;OAEG;IACH,SAAgB,cAAc,qBAA0B,QAAQ,KAAK,IAAI,EAAI;IAE7E;;OAEG;IACH,SAAgB,WAAW,iBAAsB,QAAQ,EAAE,KAAK,IAAI,EAAI;IACxE;;OAEG;IACH,SAAgB,cAAc,sBAA2B,oBAAoB,KAAK,IAAI,EAAI;IAE1F;;OAEG;IACH,SAAgB,2BAA2B,uBAA4B,cAAc,EAAE,KAAK,IAAI,EAAI;IAEpG;;OAEG;IACH,SAAgB,yBAAyB,oBAAyB,cAAc,EAAE,KAAK,IAAI,EAAI;IAE/F;;OAEG;IACH,SAAgB,0BAA0B,gBAAqB,IAAI,EAAI;IAEvE;;OAEG;IACH,SAAgB,wBAAwB,iBAAsB,QAAQ,EAAE,KAAK,IAAI,EAAI;IAErF;;OAEG;IACH,SAAgB,yBAAyB,gBAAqB,IAAI,EAAI;IAEtE;;OAEG;IACH,SAAgB,uBAAuB,gBAAqB,IAAI,EAAI;IAGpE,gBAAgB;IACT,oBAAoB,CAAC,SAAS,EAAE,oBAAoB;IAI3D,gBAAgB;IACT,kBAAkB,CAAC,SAAS,EAAE,oBAAoB;IAIzD,gBAAgB;IACT,+BAA+B,CAAC,OAAO,EAAE,cAAc,EAAE;IAIhE,gBAAgB;IACT,6BAA6B,CAAC,OAAO,EAAE,cAAc,EAAE;IAI9D,gBAAgB;IACT,8BAA8B;IAIrC,gBAAgB;IACT,4BAA4B,CAAC,IAAI,EAAE,QAAQ,EAAE;IAIpD,gBAAgB;IACT,6BAA6B;IAIpC,gBAAgB;IACT,2BAA2B;IAIlC,gBAAgB;IACT,iBAAiB,CAAC,IAAI,EAAE,QAAQ,EAAE;IAIzC,gBAAgB;IACT,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE;IAIvC,gBAAgB;IACT,oBAAoB,CAAC,QAAQ,EAAE,QAAQ;IAI9C,gBAAgB;IACT,kBAAkB,CAAC,QAAQ,EAAE,QAAQ;gBAKjB,OAAO,EAAE,WAAW;IAE/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,MAAM;IA8CnB;;;;;;;;;;;;;;;;;;OAkBG;IAEU,cAAc;IAmD3B;;;;OAIG;IACH,OAAO,CAAC,oCAAoC;IAQ5C;;;;;OAKG;YACW,0BAA0B;IA0CxC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;;;;;OAOG;IACI,QAAQ;IAIf;;;;;;;;;;OAUG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBnC;;;;OAIG;IACI,gBAAgB,CAAC,OAAO,EAAE,aAAa;IAO9C;;;OAGG;IACI,UAAU;IAIjB;;;;OAIG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACH,IAAW,UAAU,YAEpB;IAED;;;;OAIG;IACH,IAAW,SAAS,YAEnB;IAED;;;;;;;;;OASG;IACI,UAAU,CAAC,IAAI,EAAE,2BAA2B,GAAG,oBAAoB,GAAG,SAAS;IAatF;;;;;;;;;;;OAWG;IACI,kBAAkB,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC,IAAI,EAAE,2BAA2B,KAAK,oBAAoB,GAAG,SAAS,CAAA;KAAE;IAehI;;;;;;;OAOG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM;CAoBxC;AAED;;GAEG;AACH,qBAAa,UAAU;IAcT,OAAO,CAAC,OAAO;IAb3B,gBAAgB;IAChB,OAAO,CAAC,WAAW,CAAS;IAC5B,gBAAgB;IAChB,OAAO,CAAC,6BAA6B,CAAK;IAC1C,gBAAgB;IAChB,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,gBAAgB;IAChB,SAAgB,OAAO,EAAE,aAAa,CAAC;IAEvC,gBAAgB;gBACI,OAAO,EAAE,WAAW;IAOxC,kDAAkD;IAClD,SAAgB,gBAAgB,EAAE,eAAe,EAAE,CAAM;IAEzD,OAAO,KAAK,SAAS,GAAsC;IAC3D,OAAO,CAAC,gBAAgB;IAGxB,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACI,cAAc,IAAI,IAAI;IAM7B,gBAAgB;IAChB,SAAS,CAAC,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI;IAO9E,gBAAgB;IAChB,SAAS,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI;IAO1E,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAMxD,gBAAgB;IAChB,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAM9D,gBAAgB;IAChB,SAAS,CAAC,gBAAgB;IAE1B;;OAEG;IACH,SAAS,CAAC,cAAc;IAMxB,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,UAAU,EAAE,yBAAyB,EAAE;IAKpE,gBAAgB;IAChB,SAAS,CAAC,uBAAuB,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,IAAI;IAK1E,gBAAgB;IAChB,SAAS,CAAC,SAAS;IAKnB,gBAAgB;IAChB,SAAS,CAAC,YAAY;IAMtB,gBAAgB;IAChB,SAAS,CAAC,qBAAqB;IAK/B,gBAAgB;IAChB,SAAS,CAAC,uBAAuB;IAKjC,gBAAgB;IAChB,SAAS,CAAC,iBAAiB;IAQ3B,gBAAgB;IAChB,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO;IAK3C,gBAAgB;IAChB,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO;IAM1C,gBAAgB;IAET,gBAAgB,CAAC,SAAS,EAAE,mBAAmB;IAMtD,gBAAgB;IAET,gBAAgB,CAAC,SAAS,EAAE,mBAAmB;IAMtD,OAAO,CAAC,yBAAyB;IA8EjC;;;;;;OAMG;IACI,WAAW,CAAC,EAAE,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS;IAIzD;;;;;OAKG;IACK,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC;IAQxC;;;;;OAKG;IACI,oBAAoB,IAAI,QAAQ,GAAG,SAAS;IAInD;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,eAAe;IAKzC,kGAAkG;IAClG,IAAW,aAAa,IAAI,OAAO,CAA8C;IAEjF,gBAAgB;IAChB,SAAgB,eAAe,gBAAqB,IAAI,EAAI;IAE5D;;;OAGG;IACH,SAAgB,iBAAiB,oBAAyB,kBAAkB,KAAK,IAAI,EAAI;IAEzF;;;OAGG;IACH,SAAgB,eAAe,oBAAyB,kBAAkB,KAAK,IAAI,EAAI;IAEvF;;;;;OAKG;IACH,SAAgB,sBAAsB,oBAAyB,aAAa,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAI;IAEjH,SAAgB,iBAAiB,mBAAwB,yBAAyB,EAAE,KAAK,IAAI,EAAI;IACjG,iJAAiJ;IACjJ,SAAgB,QAAQ,gBAAqB,IAAI,EAAI;IACrD,wJAAwJ;IACxJ,SAAgB,WAAW,gBAAqB,IAAI,EAAI;IACxD,wEAAwE;IACxE,SAAgB,gBAAgB,gBAAqB,IAAI,EAAI;IAC7D,+DAA+D;IAC/D,SAAgB,gBAAgB,mBAAwB,OAAO,KAAK,IAAI,EAAI;IAC5E;;OAEG;IACH,SAAgB,eAAe,mBAAwB,OAAO,KAAK,IAAI,EAAI;IAC3E;;OAEG;IACH,SAAgB,oBAAoB,gBAAqB,IAAI,EAAI;IACjE;;OAEG;IACH,SAAgB,sBAAsB,gBAAqB,IAAI,EAAI;IAEnE;;OAEG;IACH,SAAgB,eAAe,4BAAiC,mBAAmB,KAAK,IAAI,EAAI;IAEhG;;OAEG;IACH,SAAgB,eAAe,4BAAiC,mBAAmB,KAAK,IAAI,EAAI;IAEhG;;;SAGK;IACE,wBAAwB,CAAC,EAAE,CAAC,IAAI,EAAE,6BAA6B,KAAK,oBAAoB,GAAG,SAAS,CAAC;IAE5G;;;;;;OAMG;IACI,cAAc;IAIrB,4EAA4E;IAC5E,IAAW,iBAAiB,IAAI,OAAO,CAAyC;IAEhF,oGAAoG;IACpG,IAAW,cAAc,IAAI,OAAO,CAA4C;IAEhF,2EAA2E;IAC3E,IAAW,cAAc,IAAI,OAAO,CAA4C;IAEhF;;OAEG;IACI,aAAa,IAAI,MAAM;IAE9B;;OAEG;IACI,aAAa,IAAI,MAAM;IAE9B;;;;;OAKG;IACI,sBAAsB,IAAI,QAAQ;IAEzC,gCAAgC;IACzB,oBAAoB,IAAI,QAAQ;IAEvC,kFAAkF;IAC3E,yBAAyB,IAAI,MAAM;IAE1C;;;;;;;;OAQG;IACI,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY;IAMvD;;OAEG;IACI,gBAAgB,IAAI,YAAY;IAIvC;;OAEG;IACI,UAAU,IAAI,YAAY;IAIjC;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,WAAW,GAAG,YAAY;IAIlD;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,YAAY;IAIjD;;;;;;;;;;;;;;;;OAgBG;IACU,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1F;;;;;;;;;;;;;OAaG;IACU,qBAAqB,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxE;;;;;;;;;;;OAWG;IACU,mBAAmB,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;;;;;;;;;;;OAYG;IACU,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxF;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;YAYzE,mBAAmB;IAYjC;;;;;;;OAOG;IACI,YAAY,IAAI,YAAY;IAenC;;;;;;;;;;OAUG;IACU,iBAAiB,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BtE;OACG;IACI,eAAe,IAAI,WAAW;IAErC,+CAA+C;IACxC,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAEtD,iDAAiD;IAC1C,kBAAkB,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAE1D,oDAAoD;IAC7C,eAAe,IAAI,WAAW;IAErC;;;OAGG;IACI,mBAAmB,IAAI,MAAM;IAEpC,sFAAsF;IAC/E,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAEpD,+BAA+B;IACxB,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAEhD;;OAEG;IACH,IAAW,cAAc,IAAI,OAAO,CAA4C;IAEhF;;;OAGG;IACH,IAAW,iBAAiB,IAAI,OAAO,CAA+C;IAEtF;;;OAGG;IACH,IAAW,uBAAuB,IAAI,OAAO,CAAqD;IAElG;;;;OAIG;IACH,IAAW,eAAe,IAAI,OAAO,CAA0D;IAE/F;;;;OAIG;IACI,aAAa,IAAI,IAAI;IAI5B;;MAEE;IACK,iBAAiB,CAAC,IAAI,CAAC,EAAE,qBAAqB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAOnF;;OAEG;IACI,2BAA2B,IAAI,MAAM;IAI5C;;;;OAIG;IACI,OAAO,IAAI,OAAO;IAIzB;;;;OAIG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAetD;;;;OAIG;IACU,wBAAwB,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAcpF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC;IACxC;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC"}

package/lib/esm/TxnManager.js

@@ -194,7 +194,7 @@ class ChangedEntitiesProc {
     }
 }
 /**
- * Manages the process of merging and rebasing local changes (transactions) in a [[BriefcaseDb]] or [[StandaloneDb]].
+ * Manages the process of merging and rebasing local changes (transactions) in a [[BriefcaseDb]].
  *
  * The `RebaseManager` coordinates the rebase of local transactions when pulling and merging changes from other sources,
  * such as remote repositories or other users. It provides mechanisms to handle transaction conflicts, register custom conflict
@@ -563,7 +563,7 @@ export class RebaseManager {
             this._aborting = true;
             try {
                 if (this._iModel.txns.hasUnsavedChanges) {
-                    this._iModel.abandonChanges();
+                    this._iModel[_nativeDb].abandonChanges();
                 }
                 await BriefcaseManager.restorePoint(this._iModel, BriefcaseManager.PULL_MERGE_RESTORE_POINT_NAME);
             }
@@ -694,7 +694,7 @@ export class RebaseManager {
         }
     }
 }
-/** Manages local changes to a [[BriefcaseDb]] or [[StandaloneDb]] via [Txns]($docs/learning/InteractiveEditing.md)
+/** Manages local changes to a [[BriefcaseDb]] via [Txns]($docs/learning/InteractiveEditing.md)
  * @public @preview
  */
 export class TxnManager {
@@ -737,19 +737,33 @@ export class TxnManager {
     }
     /** @internal */
     _onBeforeOutputsHandled(elClassName, elId) {
-        this._getElementClass(elClassName).onBeforeOutputsHandled(elId, this._iModel);
+        // as any necessary to access protected static method on Element and subclasses).
+        const iModel = this._iModel;
+        const indirectEditTxn = iModel.getIndirectTxn();
+        assert(undefined !== indirectEditTxn);
+        this._getElementClass(elClassName).onBeforeOutputsHandledArg({ elId, iModel, indirectEditTxn });
     }
     /** @internal */
     _onAllInputsHandled(elClassName, elId) {
-        this._getElementClass(elClassName).onAllInputsHandled(elId, this._iModel);
+        // as any necessary to access protected static method on Element and subclasses).
+        const iModel = this._iModel;
+        const indirectEditTxn = iModel.getIndirectTxn();
+        assert(undefined !== indirectEditTxn);
+        this._getElementClass(elClassName).onAllInputsHandledArg({ elId, iModel, indirectEditTxn });
     }
     /** @internal */
     _onRootChanged(props) {
-        this._getRelationshipClass(props.classFullName).onRootChanged(props, this._iModel);
+        const iModel = this._iModel;
+        const indirectEditTxn = iModel.getIndirectTxn();
+        assert(undefined !== indirectEditTxn);
+        this._getRelationshipClass(props.classFullName).onRootChangedArg({ props, iModel, indirectEditTxn });
     }
     /** @internal */
     _onDeletedDependency(props) {
-        this._getRelationshipClass(props.classFullName).onDeletedDependency(props, this._iModel);
+        const iModel = this._iModel;
+        const indirectEditTxn = iModel.getIndirectTxn();
+        assert(undefined !== indirectEditTxn);
+        this._getRelationshipClass(props.classFullName).onDeletedDependencyArg({ props, iModel, indirectEditTxn });
     }
     /** @internal */
     _onBeginValidate() { this.validationErrors.length = 0; }
@@ -1022,6 +1036,7 @@ export class TxnManager {
     /** Return the depth of the multi-Txn stack. Generally for diagnostic use only. */
     getMultiTxnOperationDepth() { return this._nativeDb.getMultiTxnOperationDepth(); }
     /** Reverse (undo) the most recent operation(s) to this IModelDb.
+     * @note Consider using [[reverseTxnsAsync]] instead.
      * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
      *  be reinstated together when/if ReinstateTxn is called.
      * @note If there are any outstanding uncommitted changes, they are reversed.
@@ -1030,29 +1045,193 @@ export class TxnManager {
      * @note If numOperations is too large only the operations are reversible are reversed.
      */
     reverseTxns(numOperations) {
+        if (this._nativeDb.hasUnsavedChanges())
+            this._nativeDb.abandonChanges();
         return this._nativeDb.reverseTxns(numOperations);
     }
-    /** Reverse the most recent operation. */
-    reverseSingleTxn() { return this.reverseTxns(1); }
-    /** Reverse all changes back to the beginning of the session. */
-    reverseAll() { return this._nativeDb.reverseAll(); }
+    /** Reverse the most recent operation.
+     * @note Consider using [[reverseSingleTxnAsync]] instead.
+     */
+    reverseSingleTxn() {
+        return this.reverseTxns(1);
+    }
+    /** Reverse all changes back to the beginning of the session.
+     * @note Consider using [[reverseAllTxnsAsync]] instead.
+     */
+    reverseAll() {
+        return this._nativeDb.reverseAll();
+    }
     /** Reverse all changes back to a previously saved TxnId.
+     * @note Consider using [[reverseToTxnAsync]] instead.
      * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
      * @returns Success if the transactions were reversed, error status otherwise.
      * @see  [[getCurrentTxnId]] [[cancelTo]]
      */
-    reverseTo(txnId) { return this._nativeDb.reverseTo(txnId); }
+    reverseTo(txnId) {
+        return this._nativeDb.reverseTo(txnId);
+    }
     /** Reverse and then cancel (make non-reinstatable) all changes back to a previous TxnId.
+     * @note Consider using [[cancelToTxnAsync]] instead.
      * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
      * @returns Success if the transactions were reversed and cleared, error status otherwise.
      */
-    cancelTo(txnId) { return this._nativeDb.cancelTo(txnId); }
+    cancelTo(txnId) {
+        return this._nativeDb.cancelTo(txnId);
+    }
+    /** Reverse (undo) the most recent operation(s) to this IModelDb. By default, this method also
+     * abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If you do not want to abandon any locks, set [ReverseTxnArgs.retainLocks]($common) to true.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
+     * even if numOperations is 1, multiple Txns may be reversed if they were grouped together when they were made.
+     * @note If numOperations is too large only the operations are reversible are reversed.
+     * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
+     *  be reinstated together when/if ReinstateTxn is called.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     */
+    async reverseTxnsAsync(numOperations, args) {
+        await this.withLockAbandonment(args, () => this._nativeDb.reverseTxns(numOperations));
+    }
+    /** Reverse (undo) the most recent operation to this IModelDb. By default, this method also
+     * abandons the locks that were acquired for that operation.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
+     * even though this method reverses only one operation, multiple Txns may be reversed if they were grouped together when they were made.
+     * @note If there are no reversible operations, this method does nothing and returns Success.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     */
+    async reverseSingleTxnAsync(args) {
+        await this.reverseTxnsAsync(1, args);
+    }
+    /** Reverse (undo) all operations back to the beginning of the session. By default, this method also
+     * abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @note If there are no reversible operations, this method does nothing and returns Success.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to retain locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     */
+    async reverseAllTxnsAsync(args) {
+        await this.withLockAbandonment(args, () => this._nativeDb.reverseAll());
+    }
+    /** Reverse (undo) all operations back to a previously saved TxnId. By default, this method also
+     * abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to abandon locks.
+     * @returns A Promise that resolves to success if the transactions were reversed, or rejects with an IModelError otherwise.
+     * @see  [[getCurrentTxnId]] [[cancelTo]]
+     */
+    async reverseToTxnAsync(txnId, args) {
+        await this.withLockAbandonment(args, () => this._nativeDb.reverseTo(txnId));
+    }
+    /** Reverse and then cancel (make non-reinstatable) all operations back to a previous TxnId. By default, this
+     * method also abandons the locks that were acquired for those operations.
+     * @beta
+     * @note This method will also abandon locks associated with any later, reversed Txns, if they have not
+     * already been abandoned. For example, if a call to [[reverseTxns]] reverses Txn 2 without abandoning
+     * its locks, and then this method is called to reverse Txn 1, it will abandon the locks associated
+     * with _both_ Txn 1 and Txn 2.
+     * @note If there are any outstanding uncommitted changes, they are reversed.
+     * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
+     * @param args Optional arguments to control the behavior of the reverse operation, such as whether to abandon locks.
+     * @returns A promise that resolves to success if the transactions were reversed and cleared, or rejects with an IModelError otherwise.
+     */
+    async cancelToTxnAsync(txnId, args) {
+        // First reverse and abandon locks. Only cancel if that succeeds.
+        // This is important because the locks would become unabandonable if we canceled first and
+        // _then_ the abandonment failed. We expect the call to cancelTo to return "NothingToUndo",
+        // but that's ok - it will still clear the already-reversed txns.
+        await this.withLockAbandonment(args, () => this._nativeDb.reverseTo(txnId));
+        const status = this._nativeDb.cancelTo(txnId);
+        if (status !== IModelStatus.Success && status !== IModelStatus.NothingToUndo)
+            throw new IModelError(status, IModelError.getErrorKey(status));
+        this._iModel.locks.clearTxnLockRecords(txnId);
+    }
+    async withLockAbandonment(args, doReverseCallback) {
+        const result = doReverseCallback();
+        if (result === IModelStatus.Success) {
+            if (!args?.retainLocks) {
+                // Abandon locks for the earliest txn, which abandons locks for the later ones, too.
+                await this._iModel.locks.abandonLocksForReversedTxn(this.getCurrentTxnId());
+            }
+        }
+        else {
+            throw new IModelError(result, IModelError.getErrorKey(result));
+        }
+    }
     /** Reinstate the most recently reversed transaction. Since at any time multiple transactions can be reversed, it
      * may take multiple calls to this method to reinstate all reversed operations.
      * @returns Success if a reversed transaction was reinstated, error status otherwise.
      * @note If there are any outstanding uncommitted changes, they are canceled before the Txn is reinstated.
+     * @note This method will return [[IModelStatus.LockNotHeld]] and will not reinstate the Txn if the locks
+     * originally acquired by the Txn have been abandoned. Use [[reinstateTxnAsync]] to re-acquire the locks
+     * and reinstate the Txn in a single operation.
+     */
+    reinstateTxn() {
+        // Verify that the locks required by this txn have not been abandoned.
+        // If so, this method has no way to re-acquire them because it is synchronous. This
+        // is basically a developer error, mixing reverseTxnAsync with reinstateTxn (non-Async).
+        const reinstateRange = this._nativeDb.getNextReinstateTxnRange();
+        if (this.isTxnIdValid(reinstateRange.firstTxnId) &&
+            !this._iModel.locks.holdsNecessaryLocksForReinstatingTxn(this.queryPreviousTxnId(reinstateRange.lastTxnId))) {
+            return IModelStatus.LockNotHeld;
+        }
+        return this._iModel.reinstateTxn();
+    }
+    /** Reinstate the most recently reversed transaction. This method will first attempt
+     * to re-acquire the required locks, if they were abandoned after the operation was reversed.
+     * Since at any time multiple transactions can be reversed, it may take multiple calls to this
+     * method to reinstate all reversed operations.
+     * @beta
+     * @note If there are any outstanding unsaved changes, they are canceled before the Txn is reinstated. Unless
+     * [ReinstateTxnArgs.retainLocks]($common) is true, the locks associated with the unsaved changes are also abandoned.
+     * @param args Optional arguments to control the behavior of the reinstate operation, such as whether to retain
+     * locks when abandoning unsaved changes.
+     * @returns A Promise that resolves to success if a reversed transaction was reinstated, or rejects with an IModelError otherwise.
      */
-    reinstateTxn() { return this._iModel.reinstateTxn(); }
+    async reinstateTxnAsync(args) {
+        // We must abandon any unsaved changes here because it will be too late
+        // when reinstateTxn does it.
+        if (this.hasUnsavedChanges) {
+            this._iModel.clearCaches({ instanceCachesOnly: true });
+            this._iModel[_nativeDb].abandonChanges();
+        }
+        if (!args?.retainLocks) {
+            await this._iModel.locks.abandonLocksForCurrentUnsavedTxn();
+        }
+        const reinstateRange = this._nativeDb.getNextReinstateTxnRange();
+        if (!this.isTxnIdValid(reinstateRange.firstTxnId)) {
+            throw new IModelError(IModelStatus.NothingToRedo, IModelError.getErrorKey(IModelStatus.NothingToRedo));
+        }
+        // Reacquire locks for the latest txn in the range, which will reacquire locks for all earlier txns, too.
+        await this._iModel.locks.acquireLocksForReinstatingTxn(this.queryPreviousTxnId(reinstateRange.lastTxnId));
+        const status = this.reinstateTxn();
+        if (status !== IModelStatus.Success) {
+            throw new IModelError(status, IModelError.getErrorKey(status));
+        }
+    }
     /** Get the Id of the first transaction, if any.
      */
     queryFirstTxnId() { return this._nativeDb.queryFirstTxnId(); }
@@ -1093,7 +1272,7 @@ export class TxnManager {
     get hasLocalChanges() { return this.hasUnsavedChanges || this.hasPendingTxns; }
     /** Destroy the record of all local changes that have yet to be saved and/or pushed.
      * This permanently eradicates your changes - use with caution!
-     * Typically, callers will want to subsequently use [[LockControl.releaseAllLocks]].
+     * Typically, callers will want to subsequently use [[LockControl.abandonAllLocks]].
      * After calling this function, [[hasLocalChanges]], [[hasPendingTxns]], and [[hasUnsavedChanges]] will all be `false`.
      */
     deleteAllTxns() {