@itwin/core-backend 5.9.0-dev.7 → 5.9.0-dev.9

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

@@ -1 +1 @@
-{"version":3,"file":"ServerBasedLocks.js","sourceRoot":"","sources":["../../../src/internal/ServerBasedLocks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AA8N/F,wDAEC;AA9ND;;GAEG;AAEH,sDAAkG;AAClG,oDAAoE;AAIpE,8CAA2C;AAC3C,0CAAuC;AACvC,uCAA2H;AAmB3H,MAAa,gBAAgB;IACX,CAAC,mCAAyB,CAAC,GAAG,SAAS,CAAC;IAExD,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACxB,MAAM,GAAG,IAAI,mBAAQ,EAAE,CAAC;IACxB,SAAS,CAAc;IAE1C,YAAmB,MAAmB;QACpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAS,CAAC,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QAClE,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,2FAA2F,CAAC,CAAC;YACpH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAEM,CAAC,gBAAM,CAAC;QACb,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,EAAc;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YAChH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,aAAa,KAAK,EAAE;gBAC/B,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YAEvD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,EAAe;QAClC,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClJ,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,OAAO,CAAC,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,qBAAqB;IACd,YAAY,CAAC,KAAgB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1F,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,CAAC,0BAAgB,CAAC;QAC7B,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB;QACvF,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;QACzF,CAAC;QAED,OAAO,IAAI,CAAC,0BAAgB,CAAC,EAAE,CAAC;IAClC,CAAC;IAEO,UAAU,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QACrE,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,6HAA6H,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9K,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,iCAAiC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,EAA0B;QACxD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,oBAAM,CAAC,aAAa;YACjD,OAAO,KAAK,CAAC,CAAC,gBAAgB;QAEhC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,uBAAS,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,uBAAS,CAAC,SAAS;YAC3G,OAAO,IAAI,CAAC;QAEd,wIAAwI;QACxI,IAAI,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QAE9E,yIAAyI;QACzI,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAS,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,+DAA+D;IACjM,CAAC;IAED,mGAAmG;IAC5F,kBAAkB,CAAC,EAAc;QACtC,2GAA2G;QAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,uBAAS,CAAC,SAAS,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,eAAe,CAAC,EAAc;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACpC,gKAAgK;QAChK,OAAO,CAAC,KAAK,KAAK,uBAAS,CAAC,MAAM,IAAI,KAAK,KAAK,uBAAS,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,sIAAsI;IAC9H,aAAa,CAAC,EAA0B,EAAE,KAAsB;QACtE,gHAAgH;QAChH,0GAA0G;QAC1G,IAAI,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACpF,OAAO;QAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC;QACnD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,iCAAiC;IACxE,CAAC;IAED,sGAAsG;IAC9F,mBAAmB,CAAC,EAAc,EAAE,KAAsB;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gCAAgC;QACxE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB;IAC3D,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,eAAe,CAAC,KAAc;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,yBAAyB;YAC7C,OAAO;QAET,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,8CAA8C;gBACpE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,uBAAS,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;QAC3F,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAAsB,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAA8C;QACtE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,uBAAS,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,wGAAwG;IACjG,CAAC,4BAAkB,CAAC,CAAC,EAAc;QACxC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,yDAAyD;IACzD,IAAY,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACvE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,8BAA8B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACtH,CAAC;IAED,kGAAkG;IAC3F,eAAe,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACpE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,2BAA2B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnH,CAAC;CAEF;AA5LD,4CA4LC;AAED,SAAgB,sBAAsB,CAAC,MAAmB;IACxD,OAAO,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;AACtC,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\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { DbResult, Id64, Id64Arg, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\nimport { IModel, IModelError, LockState } from \"@itwin/core-common\";\nimport { LockMap } from \"../BackendHubAccess\";\nimport { BriefcaseDb } from \"../IModelDb\";\nimport { LockControl } from \"../LockControl\";\nimport { IModelHost } from \"../IModelHost\";\nimport { SQLiteDb } from \"../SQLiteDb\";\nimport { _close, _elementWasCreated, _hubAccess, _implementationProhibited, _nativeDb, _releaseAllLocks } from \"./Symbols\";\n\n/**\n * Both the Model and Parent of an element are considered \"owners\" of their member elements. That means:\n * 1) they must hold at least a shared lock before an exclusive lock can be acquired for their members\n * 2) if they hold an exclusive lock, then all of their members are exclusively locked implicitly.\n */\ninterface ElementOwners {\n  readonly modelId: Id64String;\n  readonly parentId: Id64String | undefined;\n}\n\n// eslint-disable-next-line no-restricted-syntax\nconst enum LockOrigin {\n  Acquired = 0,\n  NewElement = 1,\n  Discovered = 2,\n}\n\nexport class ServerBasedLocks implements LockControl {\n  public readonly [_implementationProhibited] = undefined;\n\n  public get isServerBased() { return true; }\n  protected readonly lockDb = new SQLiteDb();\n  protected readonly briefcase: BriefcaseDb;\n\n  public constructor(iModel: BriefcaseDb) {\n    this.briefcase = iModel;\n    const dbName = `${iModel[_nativeDb].getTempFileBaseName()}-locks`;\n    try {\n      this.lockDb.openDb(dbName, OpenMode.ReadWrite);\n    } catch {\n      this.lockDb.createDb(dbName);\n      this.lockDb.executeSQL(\"CREATE TABLE locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)\");\n      this.lockDb.saveChanges();\n    }\n  }\n\n  public [_close]() {\n    if (this.lockDb.isOpen)\n      this.lockDb.closeDb();\n  }\n\n  private getOwners(id: Id64String): ElementOwners {\n    return this.briefcase.withPreparedSqliteStatement(\"SELECT ModelId,ParentId FROM bis_Element WHERE id=?\", (stmt) => {\n      stmt.bindId(1, id);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_ROW !== rc)\n        throw new IModelError(rc, `element ${id} not found`);\n\n      return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };\n    });\n  }\n\n  private getLockState(id?: Id64String): LockState | undefined {\n    return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement(\"SELECT state FROM locks WHERE id=?\", (stmt) => {\n      stmt.bindId(1, id);\n      return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;\n    });\n  }\n\n  /** Clear the cache of locally held locks.\n   * Note: does *not* release locks from server.\n   */\n  private clearAllLocks() {\n    this.lockDb.executeSQL(\"DELETE FROM locks\");\n    this.lockDb.saveChanges();\n  }\n\n  /** only for tests */\n  public getLockCount(state: LockState): number {\n    return this.lockDb.withSqliteStatement(\"SELECT count(*) FROM locks WHERE state=?\", (stmt) => {\n      stmt.bindInteger(1, state);\n      stmt.step();\n      return stmt.getValueInteger(0);\n    });\n  }\n\n  public async [_releaseAllLocks](): Promise<void> {\n    await IModelHost[_hubAccess].releaseAllLocks(this.briefcase); // throws if unsuccessful\n    this.clearAllLocks();\n  }\n\n  public async releaseAllLocks(): Promise<void> {\n    if (this.briefcase.txns.hasLocalChanges) {\n      throw new Error(\"Locks cannot be released while the briefcase contains local changes\");\n    }\n\n    return this[_releaseAllLocks]();\n  }\n\n  private insertLock(id: Id64String, state: LockState, origin: LockOrigin): true {\n    this.lockDb.withPreparedSqliteStatement(\"INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin\", (stmt) => {\n      stmt.bindId(1, id);\n      stmt.bindInteger(2, state);\n      stmt.bindInteger(3, origin);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_DONE !== rc)\n        throw new IModelError(rc, \"can't insert lock into database\");\n    });\n    return true;\n  }\n\n  private ownerHoldsExclusiveLock(id: Id64String | undefined): boolean {\n    if (id === undefined || id === IModel.rootSubjectId)\n      return false; // has no owners\n\n    const { modelId, parentId } = this.getOwners(id);\n    if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)\n      return true;\n\n    // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.\n    if (this.ownerHoldsExclusiveLock(modelId))\n      return this.insertLock(modelId, LockState.Exclusive, LockOrigin.Discovered);\n\n    // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.\n    return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId!, LockState.Exclusive, LockOrigin.Discovered) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n  }\n\n  /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */\n  public holdsExclusiveLock(id: Id64String): boolean {\n    // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)\n    return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);\n  }\n\n  public holdsSharedLock(id: Id64String): boolean {\n    const state = this.getLockState(id);\n    // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.\n    return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);\n  }\n\n  /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */\n  private addSharedLock(id: Id64String | undefined, locks: Set<Id64String>) {\n    // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done\n    // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.\n    if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))\n      return;\n\n    locks.add(id); // add to set of needed shared locks\n    this.addOwnerSharedLocks(id, locks); // check parent models and groups\n  }\n\n  /** add owners (recursively) of an element to a list of required shared locks, if not already held. */\n  private addOwnerSharedLocks(id: Id64String, locks: Set<Id64String>) {\n    const el = this.getOwners(id);\n    this.addSharedLock(el.parentId, locks); // if this element is in a group\n    this.addSharedLock(el.modelId, locks); // check its model\n  }\n\n  /** attempt to acquire all necessary locks for a set of elements */\n  private async acquireAllLocks(locks: LockMap) {\n    if (locks.size === 0) // no locks are required.\n      return;\n\n    const sharedLocks = new Set<Id64String>();\n    for (const lock of locks)\n      this.addOwnerSharedLocks(lock[0], sharedLocks);\n\n    for (const shared of sharedLocks) {\n      if (!locks.has(shared)) // we may already be asking for exclusive lock\n        locks.set(shared, LockState.Shared);\n    }\n\n    await IModelHost[_hubAccess].acquireLocks(this.briefcase, locks); // throws if unsuccessful\n    for (const lock of locks)\n      this.insertLock(lock[0], lock[1], LockOrigin.Acquired);\n    this.lockDb.saveChanges();\n  }\n\n  public async acquireLocks(arg: { shared?: Id64Arg, exclusive?: Id64Arg }): Promise<void> {\n    const locks = new Map<Id64String, LockState>();\n    if (arg.shared) {\n      for (const id of Id64.iterable(arg.shared)) {\n        if (!this.holdsSharedLock(id))\n          locks.set(id, LockState.Shared);\n      }\n    }\n    if (arg.exclusive) {\n      for (const id of Id64.iterable(arg.exclusive)) {\n        if (!this.holdsExclusiveLock(id))\n          locks.set(id, LockState.Exclusive);\n      }\n    }\n    return this.acquireAllLocks(locks);\n  }\n\n  /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */\n  public [_elementWasCreated](id: Id64String) {\n    this.insertLock(id, LockState.Exclusive, LockOrigin.NewElement);\n    this.lockDb.saveChanges();\n  }\n\n  /** locks are not necessary during change propagation. */\n  private get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }\n\n  /** throw if locks are currently required and the exclusive lock is not held on the supplied element */\n  public checkExclusiveLock(id: Id64String, type: string, operation: string) {\n    if (this._locksAreRequired && !this.holdsExclusiveLock(id))\n      throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);\n  }\n\n  /** throw if locks are currently required and a shared lock is not held on the supplied element */\n  public checkSharedLock(id: Id64String, type: string, operation: string) {\n    if (this._locksAreRequired && !this.holdsSharedLock(id))\n      throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);\n  }\n\n}\n\nexport function createServerBasedLocks(iModel: BriefcaseDb): LockControl {\n  return new ServerBasedLocks(iModel);\n}\n"]}
+{"version":3,"file":"ServerBasedLocks.js","sourceRoot":"","sources":["../../../src/internal/ServerBasedLocks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAqiB/F,wDAEC;AAriBD;;GAEG;AAEH,sDAAkG;AAClG,oDAA2F;AAI3F,8CAA2C;AAC3C,0CAAuC;AACvC,uCAA2H;AAmB3H,MAAa,gBAAgB;IACX,CAAC,mCAAyB,CAAC,GAAG,SAAS,CAAC;IAExD,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACxB,MAAM,GAAG,IAAI,mBAAQ,EAAE,CAAC;IACxB,SAAS,CAAc;IAClC,uBAAuB,CAAa;IAC3B,oBAAoB,GAAG,oBAAoB,CAAC,CAAC,qEAAqE;IAEnI,YAAmB,MAAmB;QACpC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAS,CAAC,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QAElE,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAED,2CAA2C;QAC3C,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,yGAAyG,CAAC,CAAC;QAClI,yFAAyF;QACzF,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;;;;;;;wCAOa,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAE1B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE;YAC3E,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAA;YAEpG,yGAAyG;YACzG,6FAA6F;YAC7F,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;YAEzC,6FAA6F;YAC7F,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,4CAA4C,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC7F,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;gBAC/B,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;gBAC1C,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;oBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,0FAA0F,EAAE,GAAG,CAAC,CAAC;YAC/J,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,CAAC,gBAAM,CAAC;QACb,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE/B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,EAAc;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YAChH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,aAAa,KAAK,EAAE;gBAC/B,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YAEvD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,EAAe;QAClC,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClJ,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,OAAO,CAAC,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,qBAAqB;IACd,YAAY,CAAC,KAAgB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1F,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,CAAC,0BAAgB,CAAC;QAC7B,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB;QACvF,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxC,mCAAqB,CAAC,UAAU,CAAC,qBAAqB,EAAE,qEAAqE,CAAC,CAAC;QACjI,CAAC;QAED,OAAO,IAAI,CAAC,0BAAgB,CAAC,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YACxC,mCAAqB,CAAC,UAAU,CAAC,qBAAqB,EAAE,sEAAsE,CAAC,CAAC;QAClI,CAAC;QAED,IAAI,uBAAU,CAAC,oBAAU,CAAC,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzD,wGAAwG;YACxG,0FAA0F;YAC1F,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,eAAe,CAAC;gBAC3C,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ;gBACjC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW;gBACvC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;aAChC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,UAAU,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QACrE,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,6HAA6H,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9K,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,iCAAiC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,mBAAmB,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QAC9E,6FAA6F;QAC7F,sFAAsF;QACtF,wIAAwI;QACxI,kDAAkD;QAClD,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC;;;;;;;uCAOL,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5C,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,0DAA0D,EAAE,GAAG,CAAC,CAAC;QAC/H,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,EAA0B;QACxD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,oBAAM,CAAC,aAAa;YACjD,OAAO,KAAK,CAAC,CAAC,gBAAgB;QAEhC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,uBAAS,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,uBAAS,CAAC,SAAS;YAC3G,OAAO,IAAI,CAAC;QAEd,wIAAwI;QACxI,IAAI,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QAE9E,yIAAyI;QACzI,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAS,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,+DAA+D;IACjM,CAAC;IAED,mGAAmG;IAC5F,kBAAkB,CAAC,EAAc;QACtC,2GAA2G;QAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,uBAAS,CAAC,SAAS,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,eAAe,CAAC,EAAc;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACpC,gKAAgK;QAChK,OAAO,CAAC,KAAK,KAAK,uBAAS,CAAC,MAAM,IAAI,KAAK,KAAK,uBAAS,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,sIAAsI;IAC9H,aAAa,CAAC,EAA0B,EAAE,KAAsB;QACtE,gHAAgH;QAChH,0GAA0G;QAC1G,IAAI,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACpF,OAAO;QAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC;QACnD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,iCAAiC;IACxE,CAAC;IAED,sGAAsG;IAC9F,mBAAmB,CAAC,EAAc,EAAE,KAAsB;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gCAAgC;QACxE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB;IAC3D,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,eAAe,CAAC,KAAc;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,yBAAyB;YAC7C,OAAO;QAET,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,8CAA8C;gBACpE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,uBAAS,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;QAC3F,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAAsB,CAAC;YACvD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,8BAAsB,CAAC;QAClE,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAA8C;QACtE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,uBAAS,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAClB,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,KAAc;QACvC,IAAI,uBAAU,CAAC,oBAAU,CAAC,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACtD,6GAA6G;YAC7G,0FAA0F;YAC1F,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,YAAY,CAAC;gBACxC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ;gBACjC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW;gBACvC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;aAChC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,gCAAgC;QAC3C,OAAO,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,0BAA0B,CAAC,KAAiB;QACvD,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB;YACvC,mCAAqB,CAAC,UAAU,CAAC,qBAAqB,EAAE,gCAAgC,KAAK,8CAA8C,CAAC,CAAC;QAE/I,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,uHAAuH;YACvH,yDAAyD;YACzD,2EAA2E;YAC3E,2EAA2E;YAC3E,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,KAAK,KAAK,IAAI,CAAC,oBAAoB;gBACxF,mCAAqB,CAAC,UAAU,CAAC,kBAAkB,EAAE,gCAAgC,KAAK,4BAA4B,CAAC,CAAC;QAC5H,CAAC;aAAM,CAAC;YACN,+FAA+F;YAC/F,IAAI,CAAC,QAAQ,CAAC,QAAQ;gBACpB,mCAAqB,CAAC,UAAU,CAAC,kBAAkB,EAAE,gCAAgC,KAAK,mCAAmC,CAAC,CAAC;QACnI,CAAC;QAED,IAAI,aAAa,GAAG,KAAK,CAAC;QAE1B,yDAAyD;QACzD,IAAI,KAAK,KAAK,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACxC,aAAa,GAAG,MAAM,IAAI,CAAC,gCAAgC,EAAE,CAAC;QAChE,CAAC;QAED,0BAA0B;QAC1B,iFAAiF;QACjF,yGAAyG;QAEzG,qHAAqH;QACrH,0EAA0E;QAE1E,2DAA2D;QAC3D,uGAAuG;QACvG,wGAAwG;QACxG,oGAAoG;QACpG,qDAAqD;QACrD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,2BAA2B,CACrC;;;;;;;;;;;;;;;;;;;OAmBC,EACD,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,uBAAS,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAEtB,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACrC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;gBAC9C,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;gBAC1C,IAAI,MAAM,kCAA0B;oBAClC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACjD,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,mCAAmC;QACnC,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC;YACzB,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QAE1C,mCAAmC;QACnC,IAAI,KAAK,KAAK,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACxC,kHAAkH;YAClH,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,qCAAqC,EAAE,CAAC,IAAI,EAAE,EAAE;gBACtF,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;gBAC1C,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;oBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,sEAAsE,EAAE,GAAG,CAAC,CAAC;YAC3I,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oDAAoD,EAAE,CAAC,IAAI,EAAE,EAAE;gBACrG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACtB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;oBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,6DAA6D,EAAE,GAAG,CAAC,CAAC;YAClI,CAAC,CAAC,CAAC;QACL,CAAC;QAED,uGAAuG;QACvG,KAAK,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,WAAW,EAAE,CAAC;YACrD,IAAI,aAAa,KAAK,uBAAS,CAAC,IAAI,EAAE,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,8BAA8B,EAAE,CAAC,IAAI,EAAE,EAAE;oBAC/E,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;oBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;oBACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;wBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,+CAA+C,EAAE,GAAG,CAAC,CAAC;gBACpH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,qCAAqC,EAAE,CAAC,IAAI,EAAE,EAAE;oBACtF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;oBACnC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;oBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;oBACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;wBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,6CAA6C,EAAE,GAAG,CAAC,CAAC;gBAClH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,4FAA4F;QAC5F,6EAA6E;QAC7E,4FAA4F;QAC5F,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAE1B,OAAO,aAAa,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC;IAC/C,CAAC;IAEO,uBAAuB,CAAC,KAAiB;QAI/C,MAAM,eAAe,GAAG,IAAI,GAAG,EAAyB,CAAC;QACzD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,2BAA2B,CACrC,kFAAkF,EAClF,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAEtB,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACrC,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;gBACvC,IAAI,MAAM,kCAA0B;oBAClC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;;oBAEtC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACzC,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,6BAA6B,CAAC,KAAiB;QAC1D,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB;YACvC,mCAAqB,CAAC,UAAU,CAAC,qBAAqB,EAAE,4CAA4C,KAAK,8CAA8C,CAAC,CAAC;QAE3J,mGAAmG;QACnG,uGAAuG;QACvG,8FAA8F;QAC9F,2FAA2F;QAC3F,mGAAmG;QACnG,mCAAmC;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,mCAAqB,CAAC,UAAU,CAAC,kBAAkB,EAAE,gCAAgC,KAAK,kDAAkD,CAAC,CAAC;QAChJ,CAAC;QAED,kDAAkD;QAClD,MAAM,EAAE,eAAe,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAEhF,kGAAkG;QAClG,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC;YACzB,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,yBAAyB;QAEtG,6CAA6C;QAC7C,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YACtG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACtB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,uEAAuE,EAAE,GAAG,CAAC,CAAC;QAC5I,CAAC,CAAC,CAAC;QAEH,wHAAwH;QACxH,2DAA2D;QAC3D,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,cAAc,EAAE,CAAC;YAChD,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,8BAAsB,CAAC;QACzD,CAAC;QACD,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,eAAe,EAAE,CAAC;YACjD,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,gCAAwB,CAAC;QAC3D,CAAC;QAED,4FAA4F;QAC5F,6EAA6E;QAC7E,4FAA4F;QAC5F,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAE1B,OAAO,cAAc,CAAC,IAAI,GAAG,CAAC,IAAI,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC;IAC7D,CAAC;IAEM,oCAAoC,CAAC,KAAiB;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAClD,OAAO,KAAK,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,CAAC;IAC7E,CAAC;IAEM,mBAAmB,CAAC,KAAiB;QAC1C,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,mDAAmD,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACtB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,2DAA2D,EAAE,GAAG,CAAC,CAAC;QAChI,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,wGAAwG;IACjG,CAAC,4BAAkB,CAAC,CAAC,EAAc;QACxC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QAChE,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,uBAAS,CAAC,SAAS,gCAAwB,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,kCAAkC,EAAE,CAAC,IAAI,EAAE,EAAE;YACnF,IAAI,CAAC,WAAW,CAAC,CAAC,gCAAwB,CAAC;YAC3C,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,mCAAqB,CAAC,UAAU,CAAC,uBAAuB,EAAE,2DAA2D,EAAE,GAAG,CAAC,CAAC;QAChI,CAAC,CAAC,CAAC;IACL,CAAC;IAED,yDAAyD;IACzD,IAAY,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACvE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,8BAA8B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACtH,CAAC;IAED,kGAAkG;IAC3F,eAAe,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACpE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,2BAA2B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnH,CAAC;CAEF;AAngBD,4CAmgBC;AAED,SAAgB,sBAAsB,CAAC,MAAmB;IACxD,OAAO,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;AACtC,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\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { DbResult, Id64, Id64Arg, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\nimport { IModel, IModelError, LockState, ServerBasedLocksError } from \"@itwin/core-common\";\nimport { LockMap } from \"../BackendHubAccess\";\nimport { BriefcaseDb } from \"../IModelDb\";\nimport { LockControl } from \"../LockControl\";\nimport { IModelHost } from \"../IModelHost\";\nimport { SQLiteDb } from \"../SQLiteDb\";\nimport { _close, _elementWasCreated, _hubAccess, _implementationProhibited, _nativeDb, _releaseAllLocks } from \"./Symbols\";\n\n/**\n * Both the Model and Parent of an element are considered \"owners\" of their member elements. That means:\n * 1) they must hold at least a shared lock before an exclusive lock can be acquired for their members\n * 2) if they hold an exclusive lock, then all of their members are exclusively locked implicitly.\n */\ninterface ElementOwners {\n  readonly modelId: Id64String;\n  readonly parentId: Id64String | undefined;\n}\n\n// eslint-disable-next-line no-restricted-syntax\nconst enum LockOrigin {\n  Acquired = 0,\n  NewElement = 1,\n  Discovered = 2,\n}\n\nexport class ServerBasedLocks implements LockControl {\n  public readonly [_implementationProhibited] = undefined;\n\n  public get isServerBased() { return true; }\n  protected readonly lockDb = new SQLiteDb();\n  protected readonly briefcase: BriefcaseDb;\n  private _removeOnCommitListener: () => void;\n  private readonly _unsavedChangesTxnId = \"0x7FFFFFFFFFFFFFFF\"; // a placeholder txn id for locks acquired in the current unsaved Txn\n\n  public constructor(iModel: BriefcaseDb) {\n    this.briefcase = iModel;\n    const dbName = `${iModel[_nativeDb].getTempFileBaseName()}-locks`;\n\n    try {\n      this.lockDb.openDb(dbName, OpenMode.ReadWrite);\n    } catch {\n      this.lockDb.createDb(dbName);\n    }\n\n    // Tracks the locks that are actively held.\n    this.lockDb.executeSQL(\"CREATE TABLE IF NOT EXISTS locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)\");\n    // Tracks the locks that are required by each Txn. They may or may not currently be held.\n    this.lockDb.executeSQL(`\n      CREATE TABLE IF NOT EXISTS txn_locks(\n        txnId INTEGER NOT NULL,\n        elementId INTEGER NOT NULL,\n        state INTEGER NOT NULL,\n        origin INTEGER NOT NULL,\n        abandoned BOOLEAN NOT NULL,\n        PRIMARY KEY (txnId, elementId))`);\n    this.lockDb.saveChanges();\n\n    this._removeOnCommitListener = this.briefcase.txns.onCommit.addListener(() => {\n      const committedTxnId = this.briefcase.txns.queryPreviousTxnId(this.briefcase.txns.getCurrentTxnId())\n\n      // With this commit, any reversed txns with the committed txn's ID or greater are no longer reinstatable,\n      // so clear out the record of their locks. If the locks are still held, sorry, it's too late!\n      this.clearTxnLockRecords(committedTxnId);\n\n      // All of the \"current\" changes are now part of a real txn, so update the txn id accordingly.\n      this.lockDb.withPreparedSqliteStatement(\"UPDATE txn_locks SET txnId=? WHERE txnId=?\", (stmt) => {\n        stmt.bindId(1, committedTxnId);\n        stmt.bindId(2, this._unsavedChangesTxnId);\n        const rc = stmt.step();\n        if (DbResult.BE_SQLITE_DONE !== rc)\n          ServerBasedLocksError.throwError(\"lock-database-problem\", `can't update locks database with txn ID of unsaved changes txn upon saving (error code ${rc})`);\n      });\n\n      this.lockDb.saveChanges();\n    });\n  }\n\n  public [_close]() {\n    this._removeOnCommitListener();\n\n    if (this.lockDb.isOpen)\n      this.lockDb.closeDb();\n  }\n\n  private getOwners(id: Id64String): ElementOwners {\n    return this.briefcase.withPreparedSqliteStatement(\"SELECT ModelId,ParentId FROM bis_Element WHERE id=?\", (stmt) => {\n      stmt.bindId(1, id);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_ROW !== rc)\n        throw new IModelError(rc, `element ${id} not found`);\n\n      return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };\n    });\n  }\n\n  private getLockState(id?: Id64String): LockState | undefined {\n    return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement(\"SELECT state FROM locks WHERE id=?\", (stmt) => {\n      stmt.bindId(1, id);\n      return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;\n    });\n  }\n\n  /** Clear the cache of locally held locks.\n   * Note: does *not* release locks from server.\n   */\n  private clearAllLocks() {\n    this.lockDb.executeSQL(\"DELETE FROM locks\");\n    this.lockDb.executeSQL(\"DELETE FROM txn_locks\");\n    this.lockDb.saveChanges();\n  }\n\n  /** only for tests */\n  public getLockCount(state: LockState): number {\n    return this.lockDb.withSqliteStatement(\"SELECT count(*) FROM locks WHERE state=?\", (stmt) => {\n      stmt.bindInteger(1, state);\n      stmt.step();\n      return stmt.getValueInteger(0);\n    });\n  }\n\n  public async [_releaseAllLocks](): Promise<void> {\n    await IModelHost[_hubAccess].releaseAllLocks(this.briefcase); // throws if unsuccessful\n    this.clearAllLocks();\n  }\n\n  public async releaseAllLocks(): Promise<void> {\n    if (this.briefcase.txns.hasLocalChanges) {\n      ServerBasedLocksError.throwError(\"has-unsaved-changes\", \"Locks cannot be released while the briefcase contains local changes\");\n    }\n\n    return this[_releaseAllLocks]();\n  }\n\n  public async abandonAllLocks(): Promise<void> {\n    if (this.briefcase.txns.hasLocalChanges) {\n      ServerBasedLocksError.throwError(\"has-unsaved-changes\", \"Locks cannot be abandoned while the briefcase contains local changes\");\n    }\n\n    if (IModelHost[_hubAccess].abandonAllLocks === undefined) {\n      // If the IModelHub doesn't support an explicit abandon, call release with a blank changeset to indicate\n      // that locks should be released without updating the changeset associated with the locks.\n      await IModelHost[_hubAccess].releaseAllLocks({\n        iModelId: this.briefcase.iModelId,\n        briefcaseId: this.briefcase.briefcaseId,\n        changeset: { id: \"\", index: 0 }\n      });\n    } else {\n      await IModelHost[_hubAccess].abandonAllLocks(this.briefcase);\n    }\n\n    this.clearAllLocks();\n  }\n\n  private insertLock(id: Id64String, state: LockState, origin: LockOrigin): true {\n    this.lockDb.withPreparedSqliteStatement(\"INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin\", (stmt) => {\n      stmt.bindId(1, id);\n      stmt.bindInteger(2, state);\n      stmt.bindInteger(3, origin);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_DONE !== rc)\n        throw new IModelError(rc, \"can't insert lock into database\");\n    });\n\n    return true;\n  }\n\n  private insertTxnLockRecord(id: Id64String, state: LockState, origin: LockOrigin): void {\n    // Locks are always acquired in the current txn, which isn't a real txn until it's committed.\n    // So use a placeholder txn id for now, and we'll update to the real txn id on commit.\n    // This is important to distinguish new locks acquired in the current txn from locks acquired in previous reversed txns, which will only\n    // be cleared (no longer reinstateable) on commit.\n    this.lockDb.withPreparedSqliteStatement(`\n      INSERT INTO txn_locks(txnId,elementId,state,origin,abandoned)\n      VALUES (?,?,?,?,FALSE)\n      ON CONFLICT(txnId,elementId)\n        DO UPDATE SET\n          state=excluded.state,\n          origin=excluded.origin,\n          abandoned=excluded.abandoned`, (stmt) => {\n      stmt.bindId(1, this._unsavedChangesTxnId);\n      stmt.bindId(2, id);\n      stmt.bindInteger(3, state);\n      stmt.bindInteger(4, origin);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_DONE !== rc)\n        ServerBasedLocksError.throwError(\"lock-database-problem\", `can't insert txn lock record into database (error code ${rc})`);\n    });\n  }\n\n  private ownerHoldsExclusiveLock(id: Id64String | undefined): boolean {\n    if (id === undefined || id === IModel.rootSubjectId)\n      return false; // has no owners\n\n    const { modelId, parentId } = this.getOwners(id);\n    if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)\n      return true;\n\n    // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.\n    if (this.ownerHoldsExclusiveLock(modelId))\n      return this.insertLock(modelId, LockState.Exclusive, LockOrigin.Discovered);\n\n    // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.\n    return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId!, LockState.Exclusive, LockOrigin.Discovered) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n  }\n\n  /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */\n  public holdsExclusiveLock(id: Id64String): boolean {\n    // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)\n    return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);\n  }\n\n  public holdsSharedLock(id: Id64String): boolean {\n    const state = this.getLockState(id);\n    // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.\n    return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);\n  }\n\n  /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */\n  private addSharedLock(id: Id64String | undefined, locks: Set<Id64String>) {\n    // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done\n    // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.\n    if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))\n      return;\n\n    locks.add(id); // add to set of needed shared locks\n    this.addOwnerSharedLocks(id, locks); // check parent models and groups\n  }\n\n  /** add owners (recursively) of an element to a list of required shared locks, if not already held. */\n  private addOwnerSharedLocks(id: Id64String, locks: Set<Id64String>) {\n    const el = this.getOwners(id);\n    this.addSharedLock(el.parentId, locks); // if this element is in a group\n    this.addSharedLock(el.modelId, locks); // check its model\n  }\n\n  /** attempt to acquire all necessary locks for a set of elements */\n  private async acquireAllLocks(locks: LockMap) {\n    if (locks.size === 0) // no locks are required.\n      return;\n\n    const sharedLocks = new Set<Id64String>();\n    for (const lock of locks)\n      this.addOwnerSharedLocks(lock[0], sharedLocks);\n\n    for (const shared of sharedLocks) {\n      if (!locks.has(shared)) // we may already be asking for exclusive lock\n        locks.set(shared, LockState.Shared);\n    }\n\n    await IModelHost[_hubAccess].acquireLocks(this.briefcase, locks); // throws if unsuccessful\n    for (const lock of locks) {\n      this.insertLock(lock[0], lock[1], LockOrigin.Acquired);\n      this.insertTxnLockRecord(lock[0], lock[1], LockOrigin.Acquired);\n    }\n    this.lockDb.saveChanges();\n  }\n\n  public async acquireLocks(arg: { shared?: Id64Arg, exclusive?: Id64Arg }): Promise<void> {\n    const locks = new Map<Id64String, LockState>();\n    if (arg.shared) {\n      for (const id of Id64.iterable(arg.shared)) {\n        if (!this.holdsSharedLock(id))\n          locks.set(id, LockState.Shared);\n      }\n    }\n    if (arg.exclusive) {\n      for (const id of Id64.iterable(arg.exclusive)) {\n        if (!this.holdsExclusiveLock(id))\n          locks.set(id, LockState.Exclusive);\n      }\n    }\n    return this.acquireAllLocks(locks);\n  }\n\n  private async abandonLocks(locks: LockMap): Promise<void> {\n    if (IModelHost[_hubAccess].abandonLocks === undefined) {\n      // If the IModelHub doesn't support an explicit abandon, call acquireLocks with a blank changeset to indicate\n      // that locks should be released without updating the changeset associated with the locks.\n      await IModelHost[_hubAccess].acquireLocks({\n        iModelId: this.briefcase.iModelId,\n        briefcaseId: this.briefcase.briefcaseId,\n        changeset: { id: \"\", index: 0 }\n      }, locks);\n    } else {\n      await IModelHost[_hubAccess].abandonLocks(this.briefcase, locks);\n    }\n  }\n\n  public async abandonLocksForCurrentUnsavedTxn(): Promise<boolean> {\n    return this.abandonLocksForReversedTxn(this._unsavedChangesTxnId);\n  }\n\n  public async abandonLocksForReversedTxn(txnId: Id64String): Promise<boolean> {\n    if (this.briefcase.txns.hasUnsavedChanges)\n      ServerBasedLocksError.throwError(\"has-unsaved-changes\", `cannot abandon locks for txn ${txnId} because the current txn has unsaved changes`);\n\n    const txnProps = this.briefcase.txns.getTxnProps(txnId);\n    if (txnProps === undefined) {\n      // The current txn commonly won't exist on the TxnManager yet. It's often just a placeholder for not-yet-saved changes.\n      // (Sometimes it will exist and refer to a reversed Txn).\n      // The unsavedChangesTxnId won't exist on the TxnManager either, of course.\n      // But all other txn ids must be known to the TxnManager or it is an error.\n      if (txnId !== this.briefcase.txns.getCurrentTxnId() && txnId !== this._unsavedChangesTxnId)\n        ServerBasedLocksError.throwError(\"txn-id-not-found\", `cannot abandon locks for txn ${txnId} because it does not exist`);\n    } else {\n      // If the txn id is known to the TxnManager, then we require that it has already been reversed.\n      if (!txnProps.reversed)\n        ServerBasedLocksError.throwError(\"txn-not-reversed\", `cannot abandon locks for txn ${txnId} because it has not been reversed`);\n    }\n\n    let locksReleased = false;\n\n    // Abandon locks for unsaved (and now abandoned) changes.\n    if (txnId !== this._unsavedChangesTxnId) {\n      locksReleased = await this.abandonLocksForCurrentUnsavedTxn();\n    }\n\n    // At this point, we know:\n    // 1. There are no unsaved changes, and the associated locks have been abandoned.\n    // 2. The given txn ID has been reversed, which means any later txns are sure to have been reversed, too.\n\n    // So we simply have to find all non-abandoned locks associated with the given txn or later, abandon them (or restore\n    // them to their previous state), and mark them as abandoned in txn_locks.\n\n    // Find all locks associated with the given txnId or later.\n    // For each elementId, find the previous state of the lock before this Txn (if any), or None otherwise.\n    // This is the state that we will restore the element's lock to. The reason we do this is to account for\n    // lock upgrades. If an earlier Txn acquired a Shared lock on this element, and this Txn acquired an\n    // Exclusive lock, we should restore the Shared lock.\n    const allTxnLocks = new Map<Id64String, LockState>();\n    const locksToRelease = new Map<Id64String, LockState>();\n    this.lockDb.withPreparedSqliteStatement(\n      `\n        SELECT\n          current.elementId,\n          current.origin,\n          IFNULL(\n            (SELECT previous.state\n              FROM txn_locks previous\n              WHERE previous.elementId = current.elementId\n                AND previous.txnId < ?2\n                AND previous.abandoned=FALSE\n              ORDER BY previous.txnId DESC\n              LIMIT 1\n            ),\n            ?1\n          ) AS previousState\n        FROM txn_locks current\n        WHERE current.txnId>=?2\n          AND current.abandoned=FALSE\n        ORDER BY current.txnId DESC\n      `,\n      (stmt) => {\n        stmt.bindInteger(1, LockState.None);\n        stmt.bindId(2, txnId);\n\n        while (DbResult.BE_SQLITE_ROW === stmt.step()) {\n          const elementId = stmt.getValueId(0);\n          const origin = stmt.getValueInteger(1);\n          const previousState = stmt.getValueInteger(2);\n          allTxnLocks.set(elementId, previousState);\n          if (origin !== LockOrigin.NewElement)\n            locksToRelease.set(elementId, previousState);\n        }\n      });\n\n    // Release the locks on the server.\n    if (locksToRelease.size > 0)\n      await this.abandonLocks(locksToRelease);\n\n    // Mark the txn locks as abandoned.\n    if (txnId === this._unsavedChangesTxnId) {\n      // After abandoning locks held for the \"unsaved\" txn, we clear them completely because they are not reinstateable.\n      this.lockDb.withPreparedSqliteStatement(\"DELETE FROM txn_locks WHERE txnId=?\", (stmt) => {\n        stmt.bindId(1, this._unsavedChangesTxnId);\n        const rc = stmt.step();\n        if (DbResult.BE_SQLITE_DONE !== rc)\n          ServerBasedLocksError.throwError(\"lock-database-problem\", `can't delete txn locks for unsaved changes in database (error code ${rc})`);\n      });\n    } else {\n      this.lockDb.withPreparedSqliteStatement(\"UPDATE txn_locks SET abandoned=TRUE WHERE txnId>=?\", (stmt) => {\n        stmt.bindId(1, txnId);\n        const rc = stmt.step();\n        if (DbResult.BE_SQLITE_DONE !== rc)\n          ServerBasedLocksError.throwError(\"lock-database-problem\", `can't mark txn locks as abandoned in database (error code ${rc})`);\n      });\n    }\n\n    // Restore each lock to its previous state (if any) in the local cache. Usually this means deleting it.\n    for (const [elementId, previousState] of allTxnLocks) {\n      if (previousState === LockState.None) {\n        this.lockDb.withPreparedSqliteStatement(\"DELETE FROM locks WHERE id=?\", (stmt) => {\n          stmt.bindId(1, elementId);\n          const rc = stmt.step();\n          if (DbResult.BE_SQLITE_DONE !== rc)\n            ServerBasedLocksError.throwError(\"lock-database-problem\", `can't delete lock from database (error code ${rc})`);\n        });\n      } else {\n        this.lockDb.withPreparedSqliteStatement(\"UPDATE locks SET state=? WHERE id=?\", (stmt) => {\n          stmt.bindInteger(1, previousState);\n          stmt.bindId(2, elementId);\n          const rc = stmt.step();\n          if (DbResult.BE_SQLITE_DONE !== rc)\n            ServerBasedLocksError.throwError(\"lock-database-problem\", `can't update lock in database (error code ${rc})`);\n        });\n      }\n    }\n\n    // Ideally we'd only invalidate \"Discovered\" locks that are related to this Txn's Shared and\n    // Exclusive locks. But that is a lot of added complexity for little benefit.\n    // Clearing them all will have no impact on correctness and a minimal impact on performance.\n    this.clearDiscoveredLocks();\n\n    this.lockDb.saveChanges();\n\n    return locksReleased || allTxnLocks.size > 0;\n  }\n\n  private getAbandonedLocksForTxn(txnId: Id64String): {\n    newElementLocks: Map<Id64String, LockState>,\n    locksToAcquire: Map<Id64String, LockState>\n  } {\n    const newElementLocks = new Map<Id64String, LockState>();\n    const locksToAcquire = new Map<Id64String, LockState>();\n    this.lockDb.withPreparedSqliteStatement(\n      \"SELECT elementId, state, origin FROM txn_locks WHERE txnId<=? AND abandoned=TRUE\",\n      (stmt) => {\n        stmt.bindId(1, txnId);\n\n        while (DbResult.BE_SQLITE_ROW === stmt.step()) {\n          const elementId = stmt.getValueId(0);\n          const state = stmt.getValueInteger(1);\n          const origin = stmt.getValueInteger(2);\n          if (origin === LockOrigin.NewElement)\n            newElementLocks.set(elementId, state);\n          else\n            locksToAcquire.set(elementId, state);\n        }\n      });\n\n    return { newElementLocks, locksToAcquire };\n  }\n\n  public async acquireLocksForReinstatingTxn(txnId: Id64String): Promise<boolean> {\n    if (this.briefcase.txns.hasUnsavedChanges)\n      ServerBasedLocksError.throwError(\"has-unsaved-changes\", `cannot acquire locks for reinstating txn ${txnId} because the current txn has unsaved changes`);\n\n    // If the Txn is known to the TxnManager, we can proceed. We don't need to check if it is currently\n    // reversed, because if it isn't, then abandonLocksForReversedTxn couldn't have been called, and so the\n    // locks are still held. Proceeding with this method will be a no-op, but it will be harmless.\n    // However, if the Txn Id is unknown, it may have been canceled or refer to the current Txn\n    // whose unsaved changes were just abandoned. Or it's just plain-old invalid. In any case, we can't\n    // re-acquire the associated locks.\n    const txnProps = this.briefcase.txns.getTxnProps(txnId);\n    if (txnProps === undefined) {\n      ServerBasedLocksError.throwError(\"txn-id-not-found\", `cannot acquire locks for txn ${txnId} because it does not exist or has not been saved`);\n    }\n\n    // Find all locks associated with the given txnId.\n    const { newElementLocks, locksToAcquire } = this.getAbandonedLocksForTxn(txnId);\n\n    // Attempt to acquire the locks on the server. This may fail if the locks are no longer available!\n    if (locksToAcquire.size > 0)\n      await IModelHost[_hubAccess].acquireLocks(this.briefcase, locksToAcquire); // throws if unsuccessful\n\n    // Mark the txn locks as no longer abandoned.\n    this.lockDb.withPreparedSqliteStatement(\"UPDATE txn_locks SET abandoned=FALSE WHERE txnId<=?\", (stmt) => {\n      stmt.bindId(1, txnId);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_DONE !== rc)\n        ServerBasedLocksError.throwError(\"lock-database-problem\", `can't mark txn locks as no longer abandoned in database (error code ${rc})`);\n    });\n\n    // Insert the newly-acquired locks in the local cache. Note that we don't need to insert entries in the txn_locks table,\n    // because these locks are already associated with the Txn.\n    for (const [elementId, state] of locksToAcquire) {\n      this.insertLock(elementId, state, LockOrigin.Acquired);\n    }\n    for (const [elementId, state] of newElementLocks) {\n      this.insertLock(elementId, state, LockOrigin.NewElement);\n    }\n\n    // Ideally we'd only invalidate \"Discovered\" locks that are related to this Txn's Shared and\n    // Exclusive locks. But that is a lot of added complexity for little benefit.\n    // Clearing them all will have no impact on correctness and a minimal impact on performance.\n    this.clearDiscoveredLocks();\n\n    this.lockDb.saveChanges();\n\n    return locksToAcquire.size > 0 || newElementLocks.size > 0;\n  }\n\n  public holdsNecessaryLocksForReinstatingTxn(txnId: Id64String): boolean {\n    const locks = this.getAbandonedLocksForTxn(txnId);\n    return locks.locksToAcquire.size === 0 && locks.newElementLocks.size === 0;\n  }\n\n  public clearTxnLockRecords(txnId: Id64String) {\n    this.lockDb.withPreparedSqliteStatement(\"DELETE FROM txn_locks WHERE txnId!=? AND txnId>=?\", (stmt) => {\n      stmt.bindId(1, this._unsavedChangesTxnId);\n      stmt.bindId(2, txnId);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_DONE !== rc)\n        ServerBasedLocksError.throwError(\"lock-database-problem\", `can't delete txn lock records from database (error code ${rc})`);\n    });\n\n    this.lockDb.saveChanges();\n  }\n\n  /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */\n  public [_elementWasCreated](id: Id64String) {\n    this.insertLock(id, LockState.Exclusive, LockOrigin.NewElement);\n    this.insertTxnLockRecord(id, LockState.Exclusive, LockOrigin.NewElement);\n    this.lockDb.saveChanges();\n  }\n\n  private clearDiscoveredLocks() {\n    this.lockDb.withPreparedSqliteStatement(\"DELETE FROM locks WHERE origin=?\", (stmt) => {\n      stmt.bindInteger(1, LockOrigin.Discovered);\n      const rc = stmt.step();\n      if (DbResult.BE_SQLITE_DONE !== rc)\n        ServerBasedLocksError.throwError(\"lock-database-problem\", `can't delete discovered locks from database (error code ${rc})`);\n    });\n  }\n\n  /** locks are not necessary during change propagation. */\n  private get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }\n\n  /** throw if locks are currently required and the exclusive lock is not held on the supplied element */\n  public checkExclusiveLock(id: Id64String, type: string, operation: string) {\n    if (this._locksAreRequired && !this.holdsExclusiveLock(id))\n      throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);\n  }\n\n  /** throw if locks are currently required and a shared lock is not held on the supplied element */\n  public checkSharedLock(id: Id64String, type: string, operation: string) {\n    if (this._locksAreRequired && !this.holdsSharedLock(id))\n      throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);\n  }\n\n}\n\nexport function createServerBasedLocks(iModel: BriefcaseDb): LockControl {\n  return new ServerBasedLocks(iModel);\n}\n"]}

package/lib/esm/BackendHubAccess.d.ts

@@ -197,10 +197,48 @@ export interface BackendHubAccess {
      * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.
      */
     acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;
+    /**
+     * Abandons the specified locks when none of the associated elements have
+     * been or will be modified. Depending on the {@link LockState} specified for the lock,
+     * it may be returned to the {@link LockState.Shared} state or released entirely. It is only
+     * valid to call this method when none of the elements protected by the locks have been edited, or if all edits
+     * have been reversed or abandoned without pushing them.
+     *
+     * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
+     *
+     * It is an error to specify {@link LockState.Exclusive} for any element, to specify {@link LockState.Shared}
+     * for an element where the Exclusive lock is not currently held, or to include any element for which no lock
+     * is currently held.
+     *
+     * This method is optional, so not all IModelHubs will implement it. If this method is not implemented
+     * explicitly by an IModelHub, it will be implemented implicitly by calling
+     * {@link BackendHubAccess.acquireLocks} with the same locks and passing `changeset.id=""` and
+     * `changeset.index=0` in the first argument to indicate that the lock state should change without updating
+     * the changeset associated with the locks.
+     *
+     * @beta
+     */
+    abandonLocks?: (arg: BriefcaseIdArg, locks: LockMap) => Promise<void>;
     /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */
     queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;
     /** Release all currently held locks */
     releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;
+    /**
+     * Abandons all currently held locks when none of the associated elements have been or will be modified.
+     * It is only valid to call this method when none of the elements protected by the locks have been edited,
+     * or if all edits have been reversed or abandoned without pushing them.
+     *
+     * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.
+     *
+     * This method is optional, so not all IModelHubs will implement it. If this method is not implemented
+     * explicitly by an IModelHub, it will be implemented implicitly by calling
+     * {@link BackendHubAccess.releaseAllLocks}, passing `changeset.id=""` and `changeset.index=0` in the
+     * first argument to indicate that the lock state should change without updating the changeset associated
+     * with the locks.
+     *
+     * @beta
+     */
+    abandonAllLocks?: (arg: BriefcaseIdArg) => Promise<void>;
     /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */
     queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;
     /** create a new iModel. Returns the Guid of the newly created iModel */

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

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EACzH,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE,8FAA8F;IAC9F,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,uHAAuH;IACvH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D,uCAAuC;IACvC,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}
+{"version":3,"file":"BackendHubAccess.d.ts","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EACL,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EACzH,SAAS,IAAI,eAAe,EAAE,WAAW,EAAE,aAAa,EACxD,YAAY,EAAE,aAAa,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;EAEE;AACF,qBAAa,YAAa,SAAQ,WAAW;IAEzC,mCAAmC;aACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;aACtB,cAAc,EAAE,MAAM;;IAHtC,mCAAmC;IACnB,WAAW,EAAE,WAAW;IACxC,sCAAsC;IACtB,cAAc,EAAE,MAAM,EACtC,GAAG,EAAE,qBAAqB,GAAG,gCAAgC;CAIhE;AAED;;;GAGG;AACH,oBAAY,SAAS;IACnB,gCAAgC;IAChC,IAAI,IAAI;IACR,mJAAmJ;IACnJ,MAAM,IAAI;IACV;;OAEG;IACH,SAAS,IAAI;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,6EAA6E;IAC7E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,kIAAkI;IAClI,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,UAAU;IACzD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY,EAAE,mBAAmB;IAC7E,0DAA0D;IAC1D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAAE,mBAAmB;IACvF,2DAA2D;IAC3D,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtF,mCAAmC;IACnC,iBAAiB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,6DAA6D;IAC7D,cAAc,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,gFAAgF;IAChF,eAAe,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,gFAAgF;IAChF,aAAa,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACtG,0DAA0D;IAC1D,kBAAkB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,kDAAkD;IAClD,uBAAuB,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,iDAAiD;IACjD,4BAA4B,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtG;;SAEK;IACL,qBAAqB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,gHAAgH;IAChH,gBAAgB,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,yDAAyD;IACzD,iBAAiB,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE,8FAA8F;IAC9F,iBAAiB,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAE1F;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE,uHAAuH;IACvH,aAAa,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAE7D,uCAAuC;IACvC,eAAe,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,4FAA4F;IAC5F,iBAAiB,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAE3E,wEAAwE;IACxE,eAAe,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpE,uBAAuB;IACvB,YAAY,EAAE,CAAC,GAAG,EAAE,WAAW,GAAG,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE"}

package/lib/esm/BackendHubAccess.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAuC,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAEyB,WAAW,GAE1C,MAAM,oBAAoB,CAAC;AAI5B;;EAEE;AACF,MAAM,OAAO,YAAa,SAAQ,WAAW;IAGzB;IAEA;IAJlB;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB","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 HubAccess\n */\n\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, ProgressFunction } from \"./CheckpointManager\";\nimport type { TokenArg } from \"./IModelDb\";\n\n/** Exception thrown if lock cannot be acquired.\n * @beta\n*/\nexport class LockConflict extends IModelError {\n  public constructor(\n    /** Id of Briefcase holding lock */\n    public readonly briefcaseId: BriefcaseId,\n    /** Alias of Briefcase holding lock */\n    public readonly briefcaseAlias: string,\n    msg: \"shared lock is held\" | \"exclusive lock is already held\",\n  ) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/**\n * The properties to access a V2 checkpoint through a daemon.\n * @public\n */\nexport interface V2CheckpointAccessProps {\n  /** blob store account name. */\n  readonly accountName: string;\n  /** AccessToken that grants access to the container. */\n  readonly sasToken: AccessToken;\n  /** The name of the iModel's blob store container holding all checkpoints. */\n  readonly containerId: string;\n  /** The name of the virtual file within the container, used for the checkpoint */\n  readonly dbName: string;\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\n  readonly storageType: string;\n}\n\n/**\n * Maps element Ids to their corresponding [LockState]($common)s.\n * @public\n */\nexport type LockMap = Map<Id64String, CommonLockState>;\n\n/**\n * The properties of a lock that may be obtained from a lock server.\n * @public\n */\nexport interface LockProps {\n  /** The elementId for the lock */\n  readonly id: Id64String;\n  /** the lock state */\n  readonly state: CommonLockState;\n}\n\n/**\n * Argument for cancelling and tracking download progress.\n * @public\n */\nexport interface DownloadProgressArg {\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\n  progressCallback?: ProgressFunction;\n}\n\n/**\n * Argument for methods that must supply an iTwinId\n * @public\n */\nexport interface ITwinIdArg {\n  readonly iTwinId: GuidString;\n}\n\n/**\n * Argument for methods that must supply an IModelId\n * @public\n */\nexport interface IModelIdArg extends TokenArg {\n  readonly iModelId: GuidString;\n}\n\n/**\n * Argument for acquiring a new BriefcaseId\n * @public\n */\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\n  readonly briefcaseAlias?: string;\n  /** A string to represent the device that holds the briefcase. */\n  readonly deviceName?: string;\n}\n\n/** Argument for methods that must supply an IModel name and iTwinId\n * @public\n */\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\n  readonly iModelName: string;\n}\n\n/** Argument for methods that must supply an IModelId and a BriefcaseId\n * @public\n */\nexport interface BriefcaseIdArg extends IModelIdArg {\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Argument for methods that must supply a briefcaseId and a changeset\n * @public\n */\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a changeset\n * @public\n */\nexport interface ChangesetArg extends IModelIdArg {\n  readonly changeset: ChangesetIndexOrId;\n}\n\n/** Argument for downloading a changeset.\n * @public\n */\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\n  /** Directory where the changeset should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/** @internal */\nexport interface ChangesetIndexArg extends IModelIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a range of Changesets.\n * @public\n */\nexport interface ChangesetRangeArg extends IModelIdArg {\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\n  readonly range?: ChangesetRange;\n}\n\n/** Argument for downloading a changeset range.\n * @public\n */\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\n  /** Directory where the changesets should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/**\n * Arguments to create a new iModel in iModelHub\n *  @public\n */\nexport interface CreateNewIModelProps extends IModelNameArg {\n  readonly description?: string;\n  readonly version0?: LocalFileName;\n  readonly noLocks?: true;\n}\n\n/**\n * Methods for accessing services of IModelHub from an iTwin.js backend.\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\n * @public\n */\nexport interface BackendHubAccess {\n  /** Download all the changesets in the specified range. */\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\n  /** Download a single changeset. */\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\n  /** Query the changeset properties given a ChangesetIndex  */\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\n  /** Get the ChangesetProps of the most recent changeset */\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for an IModelVersion */\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for a named version */\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\n\n  /** Acquire a new briefcaseId for the supplied iModelId\n     * @note usually there should only be one briefcase per iModel per user.\n     */\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** get an array of the briefcases assigned to a user. */\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\n\n  /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\n\n  /**\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\n   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\n   */\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\n\n  /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\n\n  /** Release all currently held locks */\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\n\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\n\n  /** create a new iModel. Returns the Guid of the newly created iModel */\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\n\n  /** delete an iModel */\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\n}\n"]}
+{"version":3,"file":"BackendHubAccess.js","sourceRoot":"","sources":["../../src/BackendHubAccess.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAuC,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAEyB,WAAW,GAE1C,MAAM,oBAAoB,CAAC;AAI5B;;EAEE;AACF,MAAM,OAAO,YAAa,SAAQ,WAAW;IAGzB;IAEA;IAJlB;IACE,mCAAmC;IACnB,WAAwB;IACxC,sCAAsC;IACtB,cAAsB,EACtC,GAA6D;QAE7D,KAAK,CAAC,eAAe,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;QALxC,gBAAW,GAAX,WAAW,CAAa;QAExB,mBAAc,GAAd,cAAc,CAAQ;IAIxC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAgC;IAChC,yCAAQ,CAAA;IACR,mJAAmJ;IACnJ,6CAAU,CAAA;IACV;;OAEG;IACH,mDAAa,CAAA;AACf,CAAC,EATW,SAAS,KAAT,SAAS,QASpB","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 HubAccess\n */\n\nimport { AccessToken, GuidString, Id64String, IModelHubStatus } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseId, ChangesetFileProps, ChangesetIdWithIndex, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, ProgressFunction } from \"./CheckpointManager\";\nimport type { TokenArg } from \"./IModelDb\";\n\n/** Exception thrown if lock cannot be acquired.\n * @beta\n*/\nexport class LockConflict extends IModelError {\n  public constructor(\n    /** Id of Briefcase holding lock */\n    public readonly briefcaseId: BriefcaseId,\n    /** Alias of Briefcase holding lock */\n    public readonly briefcaseAlias: string,\n    msg: \"shared lock is held\" | \"exclusive lock is already held\",\n  ) {\n    super(IModelHubStatus.LockOwnedByAnotherBriefcase, msg);\n  }\n}\n\n/** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).\n * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)\n * @public\n */\nexport enum LockState {\n  /** The element is not locked */\n  None = 0,\n  /** Holding a shared lock on an element blocks other users from acquiring the Exclusive lock it. More than one user may acquire the shared lock. */\n  Shared = 1,\n  /** A Lock that permits modifications to an element and blocks other users from making modifications to it.\n   * Holding an exclusive lock on an \"owner\" (a model or a parent element), implicitly exclusively locks all its members.\n   */\n  Exclusive = 2,\n}\n\n/**\n * The properties to access a V2 checkpoint through a daemon.\n * @public\n */\nexport interface V2CheckpointAccessProps {\n  /** blob store account name. */\n  readonly accountName: string;\n  /** AccessToken that grants access to the container. */\n  readonly sasToken: AccessToken;\n  /** The name of the iModel's blob store container holding all checkpoints. */\n  readonly containerId: string;\n  /** The name of the virtual file within the container, used for the checkpoint */\n  readonly dbName: string;\n  /** blob storage module: e.g. \"azure\", \"google\", \"aws\". May also include URI style parameters. */\n  readonly storageType: string;\n}\n\n/**\n * Maps element Ids to their corresponding [LockState]($common)s.\n * @public\n */\nexport type LockMap = Map<Id64String, CommonLockState>;\n\n/**\n * The properties of a lock that may be obtained from a lock server.\n * @public\n */\nexport interface LockProps {\n  /** The elementId for the lock */\n  readonly id: Id64String;\n  /** the lock state */\n  readonly state: CommonLockState;\n}\n\n/**\n * Argument for cancelling and tracking download progress.\n * @public\n */\nexport interface DownloadProgressArg {\n  /** Called to show progress during a download. If this function returns non-zero, the download is aborted. */\n  progressCallback?: ProgressFunction;\n}\n\n/**\n * Argument for methods that must supply an iTwinId\n * @public\n */\nexport interface ITwinIdArg {\n  readonly iTwinId: GuidString;\n}\n\n/**\n * Argument for methods that must supply an IModelId\n * @public\n */\nexport interface IModelIdArg extends TokenArg {\n  readonly iModelId: GuidString;\n}\n\n/**\n * Argument for acquiring a new BriefcaseId\n * @public\n */\nexport interface AcquireNewBriefcaseIdArg extends IModelIdArg {\n  /** A string to be reported to other users to identify this briefcase, for example in the case of conflicts or lock collisions. */\n  readonly briefcaseAlias?: string;\n  /** A string to represent the device that holds the briefcase. */\n  readonly deviceName?: string;\n}\n\n/** Argument for methods that must supply an IModel name and iTwinId\n * @public\n */\nexport interface IModelNameArg extends TokenArg, ITwinIdArg {\n  readonly iModelName: string;\n}\n\n/** Argument for methods that must supply an IModelId and a BriefcaseId\n * @public\n */\nexport interface BriefcaseIdArg extends IModelIdArg {\n  readonly briefcaseId: BriefcaseId;\n}\n\n/** Argument for methods that must supply a briefcaseId and a changeset\n * @public\n */\nexport interface BriefcaseDbArg extends BriefcaseIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a changeset\n * @public\n */\nexport interface ChangesetArg extends IModelIdArg {\n  readonly changeset: ChangesetIndexOrId;\n}\n\n/** Argument for downloading a changeset.\n * @public\n */\nexport interface DownloadChangesetArg extends ChangesetArg, DownloadProgressArg {\n  /** Directory where the changeset should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/** @internal */\nexport interface ChangesetIndexArg extends IModelIdArg {\n  readonly changeset: ChangesetIdWithIndex;\n}\n\n/** Argument for methods that must supply an IModelId and a range of Changesets.\n * @public\n */\nexport interface ChangesetRangeArg extends IModelIdArg {\n  /** the range of changesets desired. If is undefined, *all* changesets are returned. */\n  readonly range?: ChangesetRange;\n}\n\n/** Argument for downloading a changeset range.\n * @public\n */\nexport interface DownloadChangesetRangeArg extends ChangesetRangeArg, DownloadProgressArg {\n  /** Directory where the changesets should be downloaded. */\n  targetDir: LocalDirName;\n}\n\n/**\n * Arguments to create a new iModel in iModelHub\n *  @public\n */\nexport interface CreateNewIModelProps extends IModelNameArg {\n  readonly description?: string;\n  readonly version0?: LocalFileName;\n  readonly noLocks?: true;\n}\n\n/**\n * Methods for accessing services of IModelHub from an iTwin.js backend.\n * Generally direct access to these methods should not be required, since higher-level apis are provided.\n * @public\n */\nexport interface BackendHubAccess {\n  /** Download all the changesets in the specified range. */\n  downloadChangesets: (arg: DownloadChangesetRangeArg) => Promise<ChangesetFileProps[]>;\n  /** Download a single changeset. */\n  downloadChangeset: (arg: DownloadChangesetArg) => Promise<ChangesetFileProps>;\n  /** Query the changeset properties given a ChangesetIndex  */\n  queryChangeset: (arg: ChangesetArg) => Promise<ChangesetProps>;\n  /** Query an array of changeset properties given a range of ChangesetIndexes  */\n  queryChangesets: (arg: ChangesetRangeArg) => Promise<ChangesetProps[]>;\n  /** Push a changeset to iModelHub. Returns the newly pushed changeset's index */\n  pushChangeset: (arg: IModelIdArg & { changesetProps: ChangesetFileProps }) => Promise<ChangesetIndex>;\n  /** Get the ChangesetProps of the most recent changeset */\n  getLatestChangeset: (arg: IModelIdArg) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for an IModelVersion */\n  getChangesetFromVersion: (arg: IModelIdArg & { version: IModelVersion }) => Promise<ChangesetProps>;\n  /** Get the ChangesetProps for a named version */\n  getChangesetFromNamedVersion: (arg: IModelIdArg & { versionName: string }) => Promise<ChangesetProps>;\n\n  /** Acquire a new briefcaseId for the supplied iModelId\n     * @note usually there should only be one briefcase per iModel per user.\n     */\n  acquireNewBriefcaseId: (arg: AcquireNewBriefcaseIdArg) => Promise<BriefcaseId>;\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  releaseBriefcase: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** get an array of the briefcases assigned to a user. */\n  getMyBriefcaseIds: (arg: IModelIdArg) => Promise<BriefcaseId[]>;\n\n  /** Get the access props for a V2 checkpoint. Returns undefined if no V2 checkpoint exists. */\n  queryV2Checkpoint: (arg: CheckpointProps) => Promise<V2CheckpointAccessProps | undefined>;\n\n  /**\n   * acquire one or more locks. Throws if unsuccessful. If *any* lock cannot be obtained, no locks are acquired\n   * @throws ConflictingLocksError if one or more requested locks are held by other briefcases.\n   */\n  acquireLocks: (arg: BriefcaseDbArg, locks: LockMap) => Promise<void>;\n\n  /**\n   * Abandons the specified locks when none of the associated elements have\n   * been or will be modified. Depending on the {@link LockState} specified for the lock,\n   * it may be returned to the {@link LockState.Shared} state or released entirely. It is only\n   * valid to call this method when none of the elements protected by the locks have been edited, or if all edits\n   * have been reversed or abandoned without pushing them.\n   *\n   * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.\n   *\n   * It is an error to specify {@link LockState.Exclusive} for any element, to specify {@link LockState.Shared}\n   * for an element where the Exclusive lock is not currently held, or to include any element for which no lock\n   * is currently held.\n   *\n   * This method is optional, so not all IModelHubs will implement it. If this method is not implemented\n   * explicitly by an IModelHub, it will be implemented implicitly by calling\n   * {@link BackendHubAccess.acquireLocks} with the same locks and passing `changeset.id=\"\"` and\n   * `changeset.index=0` in the first argument to indicate that the lock state should change without updating\n   * the changeset associated with the locks.\n   *\n   * @beta\n   */\n  abandonLocks?: (arg: BriefcaseIdArg, locks: LockMap) => Promise<void>;\n\n  /** Get the list of all held locks for a briefcase. This can be very expensive and is currently used only for tests. */\n  queryAllLocks: (arg: BriefcaseDbArg) => Promise<LockProps[]>;\n\n  /** Release all currently held locks */\n  releaseAllLocks: (arg: BriefcaseDbArg) => Promise<void>;\n\n  /**\n   * Abandons all currently held locks when none of the associated elements have been or will be modified.\n   * It is only valid to call this method when none of the elements protected by the locks have been edited,\n   * or if all edits have been reversed or abandoned without pushing them.\n   *\n   * The locks are released on the IModelHub, but the changeset associated with the locks is not updated.\n   *\n   * This method is optional, so not all IModelHubs will implement it. If this method is not implemented\n   * explicitly by an IModelHub, it will be implemented implicitly by calling\n   * {@link BackendHubAccess.releaseAllLocks}, passing `changeset.id=\"\"` and `changeset.index=0` in the\n   * first argument to indicate that the lock state should change without updating the changeset associated\n   * with the locks.\n   *\n   * @beta\n   */\n  abandonAllLocks?: (arg: BriefcaseIdArg) => Promise<void>;\n\n  /** Get the iModelId of an iModel by name. Undefined if no iModel with that name exists.  */\n  queryIModelByName: (arg: IModelNameArg) => Promise<GuidString | undefined>;\n\n  /** create a new iModel. Returns the Guid of the newly created iModel */\n  createNewIModel: (arg: CreateNewIModelProps) => Promise<GuidString>;\n\n  /** delete an iModel */\n  deleteIModel: (arg: IModelIdArg & ITwinIdArg) => Promise<void>;\n}\n"]}

package/lib/esm/IModelDb.js

@@ -2927,7 +2927,7 @@ export class BriefcaseDb extends IModelDb {
         }
         // attempt to release locks must happen after changes are undone successfully
         Logger.logInfo(loggerCategory, "Releasing locks after discarding changes");
-        await this.locks.releaseAllLocks();
+        await this.locks.abandonAllLocks();
     }
     /**
      * The Guid that identifies the *context* that owns this iModel.