@itwin/core-backend 5.11.0-dev.9 → 5.11.1

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4F;AAC5F,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAAyD;AACzD,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAC3C,iDAAiD;AAEjD,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IACtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;QACvD,CAAC;aAAM,CAAC;YACN,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;oBACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACpC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;4BAC9B,IAAI,WAAW,CAAC,aAAa,EAAE,EAAE,CAAC;gCAChC,OAAO,WAAW,CAAC;4BACrB,CAAC;iCAAM,CAAC;gCACN,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,wCAAwC,CAAC,CAAC;4BAC5F,CAAC;wBACH,CAAC;wBACD,IAAI,CAAC;4BACH,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC;gCACjD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK;oCACzC,CAAC,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACzJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;4BAC9E,CAAC;4BACD,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAAC,OAAO,KAAU,EAAE,CAAC;4BACpB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;wBACvE,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,kBAAkB,GAAsC,IAAI,GAAG,EAAE,CAAC;IACzE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChI,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YACf,OAAO,aAAa,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO,MAAM,gBAAgB,CAAC;QAChC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,oCAAoC;QAC5E,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,sJAAsJ;QACtJ,MAAM,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE,CAAC;YACxE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,0DAA0D;YAC5F,CAAC;YACD,qFAAqF;YACrF,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YACtE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,wBAAwB;QACxB,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,UAAU,CAAC,CAAC;YAC3E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,wBAAwB;QACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACxD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;QAEnE,OAAO,EAAE,CAAC;IACZ,CAAC;IAOM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,IAAI,UAAU,CAAC,QAAQ;YACrB,MAAM,uBAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChE,4DAA4D;QAC5D,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;;AA1JH,kDA4JC","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 RpcInterface\n */\n\nimport { AccessToken, assert, BeDuration, IModelStatus, Logger } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\n} from \"@itwin/core-common\";\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\nimport { CheckpointManager } from \"../CheckpointManager\";\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\nimport { IModelJsFs } from \"../IModelJsFs\";\nimport { _hubAccess } from \"../internal/Symbols\";\n\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\n\n/** @internal */\nexport interface DownloadAndOpenArgs {\n  activity: RpcActivity;\n  tokenProps: IModelRpcOpenProps;\n  syncMode: SyncMode;\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\n  timeout?: number;\n  forceDownload?: boolean;\n}\n/**\n * Utility to open the iModel for RPC interfaces\n * @internal\n */\nexport class RpcBriefcaseUtility {\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const { activity, tokenProps } = args;\n    const accessToken = activity.accessToken;\n    assert(undefined !== tokenProps.iModelId);\n\n    const iModelId = tokenProps.iModelId;\n    let myBriefcaseIds: number[];\n    if (args.syncMode === SyncMode.PullOnly) {\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\n    } else {\n      // check with iModelHub and see if we already have acquired any briefcaseIds\n      myBriefcaseIds = await IModelHost[_hubAccess].getMyBriefcaseIds({ accessToken, iModelId });\n    }\n\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\n\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\n    if (resolvers) {\n      for (const resolver of resolvers) {\n        for (const briefcaseId of myBriefcaseIds) {\n          const fileName = resolver({ briefcaseId, iModelId });\n          if (IModelJsFs.existsSync(fileName)) {\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\n            if (briefcaseDb !== undefined) {\n              if (briefcaseDb.isBriefcaseDb()) {\n                return briefcaseDb;\n              } else {\n                throw new IModelError(IModelStatus.AlreadyOpen, \"iModel is already open as a SnapshotDb\");\n              }\n            }\n            try {\n              if (args.forceDownload)\n                throw new Error(); // causes delete below\n              const db = await BriefcaseDb.open({ fileName });\n              if (db.changeset.id !== tokenProps.changeset?.id) {\n                assert(undefined !== tokenProps.changeset);\n                const toIndex = tokenProps.changeset?.index ??\n                  (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\n              }\n              return db;\n            } catch (error: any) {\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\n            }\n          }\n        }\n      }\n    }\n\n    // no local briefcase available. Download one and open it.\n    assert(undefined !== tokenProps.iTwinId);\n    const request: RequestNewBriefcaseArg = {\n      accessToken,\n      iTwinId: tokenProps.iTwinId,\n      iModelId,\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\n    };\n\n    const props = await BriefcaseManager.downloadBriefcase(request);\n    return BriefcaseDb.open(props);\n  }\n\n  private static _briefcasePromises: Map<string, Promise<BriefcaseDb>> = new Map();\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const key = `${args.tokenProps.iModelId}:${args.tokenProps.changeset?.id}:${args.tokenProps.changeset?.index}:${args.syncMode}`;\n    const cachedPromise = this._briefcasePromises.get(key);\n    if (cachedPromise)\n      return cachedPromise;\n\n    try {\n      const briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\n      this._briefcasePromises.set(key, briefcasePromise);\n      return await briefcasePromise;\n    } finally {\n      this._briefcasePromises.delete(key);  // the download and open is now done\n    }\n  }\n\n  /** find a previously opened iModel for RPC.\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\n   * to refresh the daemon, even though it will be used for all authorized users.\n   * @param the IModelRpcProps to locate the opened iModel.\n   */\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\n    const iModelDb = IModelDb.findByKey(iModel.key);\n\n    // call refreshContainer, just in case this is a V2 checkpoint whose sasToken is about to expire, or its default transaction is about to be restarted.\n    await iModelDb.refreshContainerForRpc(accessToken);\n    return iModelDb;\n  }\n\n  public static async open(args: DownloadAndOpenArgs & { syncMode: SyncMode.FixedVersion }): Promise<IModelDb>;\n  /**\n   * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  public static async open(args: DownloadAndOpenArgs & { syncMode: Exclude<SyncMode, \"FixedVersion\"> }): Promise<IModelDb>;\n  /**\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\n   * a RpcPendingResponse exception is thrown\n   */\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\n    const { activity, tokenProps, syncMode } = args;\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", tokenProps);\n\n    const timeout = args.timeout ?? 1000;\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\n\n      if (briefcaseDb === undefined) {\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", tokenProps);\n        throw new RpcPendingResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n      }\n      // note: usage is logged in the function BriefcaseManager.downloadNewBriefcaseAndOpen\n      return briefcaseDb;\n    }\n    if (!tokenProps.iModelId || !tokenProps.iTwinId || !tokenProps.changeset)\n      throw new IModelError(IModelStatus.BadArg, \"invalid arguments\");\n\n    const checkpoint = {\n      iModelId: tokenProps.iModelId,\n      iTwinId: tokenProps.iTwinId,\n      changeset: tokenProps.changeset,\n      accessToken: activity.accessToken,\n    };\n\n    // opening a checkpoint.\n    let db: SnapshotDb | void;\n    // first check if it's already open\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\n    if (db) {\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", tokenProps);\n      return db;\n    }\n\n    // now try V2 checkpoint\n    db = await SnapshotDb.openCheckpointFromRpc(checkpoint);\n    Logger.logTrace(loggerCategory, \"using V2 checkpoint\", tokenProps);\n\n    return db;\n  }\n\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;\n  /**\n   * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, \"FixedVersion\">, timeout?: number): Promise<IModelConnectionProps>;\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> {\n    if (tokenProps.iModelId)\n      await IModelHost.tileStorage?.initialize(tokenProps.iModelId);\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\n  }\n\n}\n"]}
+{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4F;AAC5F,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAAyD;AACzD,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAC3C,iDAAiD;AAEjD,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IACtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;QACvD,CAAC;aAAM,CAAC;YACN,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;oBACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACpC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;4BAC9B,IAAI,WAAW,CAAC,aAAa,EAAE,EAAE,CAAC;gCAChC,OAAO,WAAW,CAAC;4BACrB,CAAC;iCAAM,CAAC;gCACN,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,wCAAwC,CAAC,CAAC;4BAC5F,CAAC;wBACH,CAAC;wBACD,IAAI,CAAC;4BACH,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC;gCACjD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK;oCACzC,CAAC,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACzJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;4BAC9E,CAAC;4BACD,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAAC,OAAO,KAAU,EAAE,CAAC;4BACpB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;wBACvE,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,kBAAkB,GAAsC,IAAI,GAAG,EAAE,CAAC;IACzE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChI,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YACf,OAAO,aAAa,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO,MAAM,gBAAgB,CAAC;QAChC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,oCAAoC;QAC5E,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,sJAAsJ;QACtJ,MAAM,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE,CAAC;YACxE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,0DAA0D;YAC5F,CAAC;YACD,qFAAqF;YACrF,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YACtE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,wBAAwB;QACxB,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,UAAU,CAAC,CAAC;YAC3E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,wBAAwB;QACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACxD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;QAEnE,OAAO,EAAE,CAAC;IACZ,CAAC;IAOM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,IAAI,UAAU,CAAC,QAAQ;YACrB,MAAM,uBAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChE,4DAA4D;QAC5D,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;;AA1JH,kDA4JC","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 RpcInterface\n */\n\nimport { AccessToken, assert, BeDuration, IModelStatus, Logger } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\n} from \"@itwin/core-common\";\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\nimport { CheckpointManager } from \"../CheckpointManager\";\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\nimport { IModelJsFs } from \"../IModelJsFs\";\nimport { _hubAccess } from \"../internal/Symbols\";\n\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\n\n/** @internal */\nexport interface DownloadAndOpenArgs {\n  activity: RpcActivity;\n  tokenProps: IModelRpcOpenProps;\n  syncMode: SyncMode;\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\n  timeout?: number;\n  forceDownload?: boolean;\n}\n/**\n * Utility to open the iModel for RPC interfaces\n * @internal\n */\nexport class RpcBriefcaseUtility {\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const { activity, tokenProps } = args;\n    const accessToken = activity.accessToken;\n    assert(undefined !== tokenProps.iModelId);\n\n    const iModelId = tokenProps.iModelId;\n    let myBriefcaseIds: number[];\n    if (args.syncMode === SyncMode.PullOnly) {\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\n    } else {\n      // check with iModelHub and see if we already have acquired any briefcaseIds\n      myBriefcaseIds = await IModelHost[_hubAccess].getMyBriefcaseIds({ accessToken, iModelId });\n    }\n\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\n\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\n    if (resolvers) {\n      for (const resolver of resolvers) {\n        for (const briefcaseId of myBriefcaseIds) {\n          const fileName = resolver({ briefcaseId, iModelId });\n          if (IModelJsFs.existsSync(fileName)) {\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\n            if (briefcaseDb !== undefined) {\n              if (briefcaseDb.isBriefcaseDb()) {\n                return briefcaseDb;\n              } else {\n                throw new IModelError(IModelStatus.AlreadyOpen, \"iModel is already open as a SnapshotDb\");\n              }\n            }\n            try {\n              if (args.forceDownload)\n                throw new Error(); // causes delete below\n              const db = await BriefcaseDb.open({ fileName });\n              if (db.changeset.id !== tokenProps.changeset?.id) {\n                assert(undefined !== tokenProps.changeset);\n                const toIndex = tokenProps.changeset?.index ??\n                  (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\n              }\n              return db;\n            } catch (error: any) {\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\n            }\n          }\n        }\n      }\n    }\n\n    // no local briefcase available. Download one and open it.\n    assert(undefined !== tokenProps.iTwinId);\n    const request: RequestNewBriefcaseArg = {\n      accessToken,\n      iTwinId: tokenProps.iTwinId,\n      iModelId,\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\n    };\n\n    const props = await BriefcaseManager.downloadBriefcase(request);\n    return BriefcaseDb.open(props);\n  }\n\n  private static _briefcasePromises: Map<string, Promise<BriefcaseDb>> = new Map();\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const key = `${args.tokenProps.iModelId}:${args.tokenProps.changeset?.id}:${args.tokenProps.changeset?.index}:${args.syncMode}`;\n    const cachedPromise = this._briefcasePromises.get(key);\n    if (cachedPromise)\n      return cachedPromise;\n\n    try {\n      const briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\n      this._briefcasePromises.set(key, briefcasePromise);\n      return await briefcasePromise;\n    } finally {\n      this._briefcasePromises.delete(key);  // the download and open is now done\n    }\n  }\n\n  /** find a previously opened iModel for RPC.\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\n   * to refresh the daemon, even though it will be used for all authorized users.\n   * @param the IModelRpcProps to locate the opened iModel.\n   */\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\n    const iModelDb = IModelDb.findByKey(iModel.key);\n\n    // call refreshContainer, just in case this is a V2 checkpoint whose sasToken is about to expire, or its default transaction is about to be restarted.\n    await iModelDb.refreshContainerForRpc(accessToken);\n    return iModelDb;\n  }\n\n  public static async open(args: DownloadAndOpenArgs & { syncMode: SyncMode.FixedVersion }): Promise<IModelDb>;\n  /**\n   * @deprecated in 4.4.0 - might be removed in next major version. Only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  public static async open(args: DownloadAndOpenArgs & { syncMode: Exclude<SyncMode, \"FixedVersion\"> }): Promise<IModelDb>;\n  /**\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\n   * a RpcPendingResponse exception is thrown\n   */\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\n    const { activity, tokenProps, syncMode } = args;\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", tokenProps);\n\n    const timeout = args.timeout ?? 1000;\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\n\n      if (briefcaseDb === undefined) {\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", tokenProps);\n        throw new RpcPendingResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n      }\n      // note: usage is logged in the function BriefcaseManager.downloadNewBriefcaseAndOpen\n      return briefcaseDb;\n    }\n    if (!tokenProps.iModelId || !tokenProps.iTwinId || !tokenProps.changeset)\n      throw new IModelError(IModelStatus.BadArg, \"invalid arguments\");\n\n    const checkpoint = {\n      iModelId: tokenProps.iModelId,\n      iTwinId: tokenProps.iTwinId,\n      changeset: tokenProps.changeset,\n      accessToken: activity.accessToken,\n    };\n\n    // opening a checkpoint.\n    let db: SnapshotDb | void;\n    // first check if it's already open\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\n    if (db) {\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", tokenProps);\n      return db;\n    }\n\n    // now try V2 checkpoint\n    db = await SnapshotDb.openCheckpointFromRpc(checkpoint);\n    Logger.logTrace(loggerCategory, \"using V2 checkpoint\", tokenProps);\n\n    return db;\n  }\n\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;\n  /**\n   * @deprecated in 4.4.0 - might be removed in next major version. Only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, \"FixedVersion\">, timeout?: number): Promise<IModelConnectionProps>;\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> {\n    if (tokenProps.iModelId)\n      await IModelHost.tileStorage?.initialize(tokenProps.iModelId);\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\n  }\n\n}\n"]}

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts

@@ -4,7 +4,7 @@
 import { IModelConnectionProps, IModelRpcProps, RpcInterface, SnapshotIModelRpcInterface, SnapshotOpenOptions } from "@itwin/core-common";
 /** The backend implementation of SnapshotIModelRpcInterface.
  * @internal
- * @deprecated in 5.0 - will not be removed until after 2026-06-13. Check [[IpcAppFunctions]] for replacements.
+ * @deprecated in 5.0 - might be removed in next major version. Check [[IpcAppFunctions]] for replacements.
  */
 export declare class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface {
     static register(): void;

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js

@@ -14,7 +14,7 @@ const IModelHost_1 = require("../IModelHost");
 /* eslint-disable @typescript-eslint/no-deprecated */
 /** The backend implementation of SnapshotIModelRpcInterface.
  * @internal
- * @deprecated in 5.0 - will not be removed until after 2026-06-13. Check [[IpcAppFunctions]] for replacements.
+ * @deprecated in 5.0 - might be removed in next major version. Check [[IpcAppFunctions]] for replacements.
  */
 class SnapshotIModelRpcImpl extends core_common_1.RpcInterface {
     static register() { core_common_1.RpcManager.registerImpl(core_common_1.SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"SnapshotIModelRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/SnapshotIModelRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAE4B;AAC5B,0CAAyC;AACzC,8CAA2C;AAE3C,qDAAqD;AAErD;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,0BAAY;IAC9C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,wCAA0B,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExG,kGAAkG;IAC3F,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAA0B;QAChE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,uBAAU,CAAC,wBAAwB,EAAE,CAAC;YACxC,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACpF,IAAI,SAAS,KAAK,gBAAgB;gBAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAClG,CAAC;QACD,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAA0B;QACjE,MAAM,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAEhG,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC/F,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,KAAK,CAAC,UAA0B;QAC3C,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,sDA4BC","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 RpcInterface\n */\n\nimport {\n  IModelConnectionProps, IModelNotFoundResponse, IModelRpcProps, RpcInterface, RpcManager, SnapshotIModelRpcInterface, SnapshotOpenOptions,\n} from \"@itwin/core-common\";\nimport { SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\n/** The backend implementation of SnapshotIModelRpcInterface.\n * @internal\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Check [[IpcAppFunctions]] for replacements.\n */\nexport class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface {\n  public static register() { RpcManager.registerImpl(SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }\n\n  /** Ask the backend to open a snapshot iModel from a file name that is resolved by the backend. */\n  public async openFile(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    let resolvedFileName: string | undefined = filePath;\n    if (IModelHost.snapshotFileNameResolver) {\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath);\n      if (undefined === resolvedFileName)\n        throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\n  }\n\n  /** Ask the backend to open a snapshot iModel from a key that is resolved by the backend. */\n  public async openRemote(fileKey: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    const resolvedFileName = IModelHost.snapshotFileNameResolver?.resolveKey(fileKey);\n    if (undefined === resolvedFileName)\n      throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n\n    return SnapshotDb.openFile(resolvedFileName, { key: fileKey, ...opts }).getConnectionProps();\n  }\n\n  /** Ask the backend to close a snapshot iModel. */\n  public async close(tokenProps: IModelRpcProps): Promise<boolean> {\n    SnapshotDb.findByKey(tokenProps.key).close();\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"SnapshotIModelRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/SnapshotIModelRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAE4B;AAC5B,0CAAyC;AACzC,8CAA2C;AAE3C,qDAAqD;AAErD;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,0BAAY;IAC9C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,wCAA0B,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExG,kGAAkG;IAC3F,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAA0B;QAChE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,uBAAU,CAAC,wBAAwB,EAAE,CAAC;YACxC,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACpF,IAAI,SAAS,KAAK,gBAAgB;gBAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAClG,CAAC;QACD,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAA0B;QACjE,MAAM,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAEhG,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC/F,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,KAAK,CAAC,UAA0B;QAC3C,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,sDA4BC","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 RpcInterface\n */\n\nimport {\n  IModelConnectionProps, IModelNotFoundResponse, IModelRpcProps, RpcInterface, RpcManager, SnapshotIModelRpcInterface, SnapshotOpenOptions,\n} from \"@itwin/core-common\";\nimport { SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\n/** The backend implementation of SnapshotIModelRpcInterface.\n * @internal\n * @deprecated in 5.0 - might be removed in next major version. Check [[IpcAppFunctions]] for replacements.\n */\nexport class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface {\n  public static register() { RpcManager.registerImpl(SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }\n\n  /** Ask the backend to open a snapshot iModel from a file name that is resolved by the backend. */\n  public async openFile(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    let resolvedFileName: string | undefined = filePath;\n    if (IModelHost.snapshotFileNameResolver) {\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath);\n      if (undefined === resolvedFileName)\n        throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\n  }\n\n  /** Ask the backend to open a snapshot iModel from a key that is resolved by the backend. */\n  public async openRemote(fileKey: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    const resolvedFileName = IModelHost.snapshotFileNameResolver?.resolveKey(fileKey);\n    if (undefined === resolvedFileName)\n      throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n\n    return SnapshotDb.openFile(resolvedFileName, { key: fileKey, ...opts }).getConnectionProps();\n  }\n\n  /** Ask the backend to close a snapshot iModel. */\n  public async close(tokenProps: IModelRpcProps): Promise<boolean> {\n    SnapshotDb.findByKey(tokenProps.key).close();\n    return true;\n  }\n}\n"]}

package/lib/cjs/workspace/SettingsEditor.d.ts

@@ -40,13 +40,6 @@ export declare namespace SettingsEditor {
  * @internal
  */
 export declare namespace SettingsContainers {
-    /** Arguments for [[SettingsContainers.queryContainers]]. */
-    interface QueryArgs {
-        /** The iTwinId whose settings containers should be queried. */
-        iTwinId: GuidString;
-        /** Optional label filter. */
-        label?: string;
-    }
     /**
      * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.
      * @returns The containerId, or `undefined` if no container exists.
@@ -54,8 +47,10 @@ export declare namespace SettingsContainers {
      */
     function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined>;
     /**
-     * Look up the settings container for an iTwin and obtain a read-only access token.
-     * @returns container props needed by [[IModelHost.getITwinWorkspace]].
+     * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.
+     * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings
+     * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at
+     * [[SettingsPriority.organization]].
      * @note Requires [[IModelHost.authorizationClient]] to be configured.
      * @note Requires [[BlobContainer.service]] to be configured.
      */

package/lib/cjs/workspace/SettingsEditor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsEditor.d.ts","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAI7E,OAAO,EAAE,0BAA0B,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIhF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AAEzD,gBAAgB;AAChB,yBAAiB,cAAc,CAAC;IAC9B,8DAA8D;IACvD,MAAM,aAAa,aAAa,CAAC;IAExC;;;;OAIG;IACH,SAAsB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,SAAS,EAAE,0BAA0B,CAAA;KAAE,CAAC,CAExI;IAED;;;;;OAKG;IACH,SAAsB,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,SAAS,EAAE,0BAA0B,CAAA;KAAE,GAAG,SAAS,CAAC,CAE9I;CACF;AAED;;;GAGG;AACH,yBAAiB,kBAAkB,CAAC;IAClC,4DAA4D;IAC5D,UAAiB,SAAS;QACxB,+DAA+D;QAC/D,OAAO,EAAE,UAAU,CAAC;QACpB,6BAA6B;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAeD;;;;OAIG;IACH,SAAsB,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CASxG;IAED;;;;;OAKG;IACH,SAAsB,uBAAuB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,wBAAwB,EAAE,GAAG,SAAS,CAAC,CAwBlH;CACF"}
+{"version":3,"file":"SettingsEditor.d.ts","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAI7E,OAAO,EAAE,0BAA0B,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIhF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AAEzD,gBAAgB;AAChB,yBAAiB,cAAc,CAAC;IAC9B,8DAA8D;IACvD,MAAM,aAAa,aAAa,CAAC;IAExC;;;;OAIG;IACH,SAAsB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,SAAS,EAAE,0BAA0B,CAAA;KAAE,CAAC,CAExI;IAED;;;;;OAKG;IACH,SAAsB,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,SAAS,EAAE,0BAA0B,CAAA;KAAE,GAAG,SAAS,CAAC,CAE9I;CACF;AAED;;;GAGG;AACH,yBAAiB,kBAAkB,CAAC;IAclC;;;;OAIG;IACH,SAAsB,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CASxG;IAED;;;;;;;OAOG;IACH,SAAsB,uBAAuB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,wBAAwB,EAAE,GAAG,SAAS,CAAC,CAwClH;CACF"}

package/lib/cjs/workspace/SettingsEditor.js

@@ -80,8 +80,10 @@ var SettingsContainers;
     }
     SettingsContainers.getITwinContainerId = getITwinContainerId;
     /**
-     * Look up the settings container for an iTwin and obtain a read-only access token.
-     * @returns container props needed by [[IModelHost.getITwinWorkspace]].
+     * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.
+     * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings
+     * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at
+     * [[SettingsPriority.organization]].
      * @note Requires [[IModelHost.authorizationClient]] to be configured.
      * @note Requires [[BlobContainer.service]] to be configured.
      */
@@ -89,25 +91,39 @@ var SettingsContainers;
         if (undefined === BlobContainerService_1.BlobContainer.service)
             core_common_1.ITwinSettingsError.throwError("blob-service-unavailable", { message: "BlobContainer.service is not available." });
         const userToken = await IModelHost_1.IModelHost.getAccessToken();
-        const containers = await queryContainers({ iTwinId });
-        if (!containers || containers.length === 0)
+        const containers = await queryContainers({ iTwinId, includeParentITwins: { filter: "accountOnly" } });
+        if (containers.length === 0)
             return undefined;
-        if (containers.length > 1) {
-            core_common_1.ITwinSettingsError.throwError("multiple-itwin-settings-containers", {
-                message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,
-                iTwinId,
-            });
-        }
-        const tokenProps = await BlobContainerService_1.BlobContainer.service.requestToken({ containerId: containers[0].containerId, accessLevel: "read", userToken });
-        return [{
+        const seenITwins = new Set();
+        const results = [];
+        for (const container of containers) {
+            const ownerITwinId = container.iTwinId;
+            if (undefined === ownerITwinId) {
+                core_common_1.ITwinSettingsError.throwError("missing-container-itwinid", {
+                    message: `Settings container '${container.containerId}' has no iTwinId. Please upgrade to a newer version of the BlobContainer service that populates iTwinId in query results.`,
+                    iTwinId,
+                });
+            }
+            if (seenITwins.has(ownerITwinId)) {
+                core_common_1.ITwinSettingsError.throwError("multiple-itwin-settings-containers", {
+                    message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,
+                    iTwinId: ownerITwinId,
+                });
+            }
+            seenITwins.add(ownerITwinId);
+            const priority = container.accountITwinId === ownerITwinId ? Settings_1.SettingsPriority.organization : Settings_1.SettingsPriority.iTwin;
+            const tokenProps = await BlobContainerService_1.BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: "read", userToken });
+            results.push({
                 baseUri: tokenProps.baseUri,
-                containerId: containers[0].containerId,
+                containerId: container.containerId,
                 storageType: tokenProps.provider,
                 accessToken: tokenProps.token,
-                priority: Settings_1.SettingsPriority.iTwin,
+                priority,
                 dbName: SettingsDb_1.settingsWorkspaceDbName,
                 includePrerelease: true,
-            }];
+            });
+        }
+        return results;
     }
     SettingsContainers.getITwinSettingsSources = getITwinSettingsSources;
 })(SettingsContainers || (exports.SettingsContainers = SettingsContainers = {}));

package/lib/cjs/workspace/SettingsEditor.js.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsEditor.js","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAwD;AAGxD,kEAAwD;AACxD,8CAA2C;AAC3C,iFAAsH;AAEtH,yCAA8C;AAC9C,6CAAuD;AAEvD;;;;;GAKG;AACU,QAAA,oBAAoB,GAAG,oBAAoB,CAAC;AAEzD,gBAAgB;AAChB,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAC7B,8DAA8D;IACjD,4BAAa,GAAG,UAAU,CAAC;IAExC;;;;OAIG;IACI,KAAK,UAAU,iBAAiB,CAAC,OAAmB;QACzD,OAAO,IAAA,oDAA+B,EAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAFqB,gCAAiB,oBAEtC,CAAA;IAED;;;;;OAKG;IACI,KAAK,UAAU,WAAW,CAAC,OAAmB;QACnD,OAAO,IAAA,8CAAyB,EAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAFqB,0BAAW,cAEhC,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAED;;;GAGG;AACH,IAAiB,kBAAkB,CAqElC;AArED,WAAiB,kBAAkB;IASjC;;;;OAIG;IACH,KAAK,UAAU,eAAe,CAAC,IAAe;QAC5C,IAAI,SAAS,KAAK,oCAAa,CAAC,OAAO;YACrC,gCAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO,oCAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,cAAc,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5H,CAAC;IAED;;;;OAIG;IACI,KAAK,UAAU,mBAAmB,CAAC,OAAmB;QAC3D,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,gCAAkB,CAAC,UAAU,CAAC,oCAAoC,EAAE;gBAClE,OAAO,EAAE,sDAAsD,OAAO,qDAAqD;gBAC3H,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC;IACpC,CAAC;IATqB,sCAAmB,sBASxC,CAAA;IAED;;;;;OAKG;IACI,KAAK,UAAU,uBAAuB,CAAC,OAAmB;QAC/D,IAAI,SAAS,KAAK,oCAAa,CAAC,OAAO;YACrC,gCAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,gCAAkB,CAAC,UAAU,CAAC,oCAAoC,EAAE;gBAClE,OAAO,EAAE,sDAAsD,OAAO,qDAAqD;gBAC3H,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,oCAAa,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACxI,OAAO,CAAC;gBACN,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW;gBACtC,WAAW,EAAE,UAAU,CAAC,QAAQ;gBAChC,WAAW,EAAE,UAAU,CAAC,KAAK;gBAC7B,QAAQ,EAAE,2BAAgB,CAAC,KAAK;gBAChC,MAAM,EAAE,oCAAuB;gBAC/B,iBAAiB,EAAE,IAAI;aACxB,CAAC,CAAC;IACL,CAAC;IAxBqB,0CAAuB,0BAwB5C,CAAA;AACH,CAAC,EArEgB,kBAAkB,kCAAlB,kBAAkB,QAqElC","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 Workspace\n */\n\nimport { ITwinSettingsError } from \"@itwin/core-common\";\nimport { GuidString } from \"@itwin/core-bentley\";\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport { IModelHost } from \"../IModelHost\";\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\nimport { SettingsPriority } from \"./Settings\";\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\n\n/** The default resource name used to store settings in a [[WorkspaceDb]].\n * This is the key under which all settings are stored in the SQLite `strings` table.\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\n * to this value, ensuring the read and write paths always agree on which key to use.\n * @internal\n */\nexport const settingsResourceName = \"settingsDictionary\";\n\n/** @internal */\nexport namespace SettingsEditor {\n  /** The type of workspace container used to store settings. */\n  export const containerType = \"settings\";\n\n  /**\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\n    return constructSettingsEditorForITwin(iTwinId);\n  }\n\n  /**\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\n    return getSettingsEditorForITwin(iTwinId);\n  }\n}\n\n/**\n * Help locate and obtain access to known containers with type \"settings\".\n * @internal\n */\nexport namespace SettingsContainers {\n  /** Arguments for [[SettingsContainers.queryContainers]]. */\n  export interface QueryArgs {\n    /** The iTwinId whose settings containers should be queried. */\n    iTwinId: GuidString;\n    /** Optional label filter. */\n    label?: string;\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\n   * Automatically filters by `containerType: \"settings\"`.\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   */\n  async function queryContainers(args: QueryArgs): Promise<BlobContainer.MetadataResponse[]> {\n    if (undefined === BlobContainer.service)\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\n\n    const userToken = await IModelHost.getAccessToken();\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.\n   * @returns The containerId, or `undefined` if no container exists.\n   * @throws if more than one settings container is found.\n   */\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\n    const containers = await queryContainers({ iTwinId });\n    if (containers.length > 1) {\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\n        iTwinId,\n      });\n    }\n    return containers[0]?.containerId;\n  }\n\n  /**\n   * Look up the settings container for an iTwin and obtain a read-only access token.\n   * @returns container props needed by [[IModelHost.getITwinWorkspace]].\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   * @note Requires [[BlobContainer.service]] to be configured.\n   */\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\n    if (undefined === BlobContainer.service)\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\n\n    const userToken = await IModelHost.getAccessToken();\n    const containers = await queryContainers({ iTwinId });\n    if (!containers || containers.length === 0) return undefined;\n    if (containers.length > 1) {\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\n        iTwinId,\n      });\n    }\n\n    const tokenProps = await BlobContainer.service.requestToken({ containerId: containers[0].containerId, accessLevel: \"read\", userToken });\n    return [{\n      baseUri: tokenProps.baseUri,\n      containerId: containers[0].containerId,\n      storageType: tokenProps.provider,\n      accessToken: tokenProps.token,\n      priority: SettingsPriority.iTwin,\n      dbName: settingsWorkspaceDbName,\n      includePrerelease: true,\n    }];\n  }\n}\n"]}
+{"version":3,"file":"SettingsEditor.js","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAwD;AAGxD,kEAAwD;AACxD,8CAA2C;AAC3C,iFAAsH;AAEtH,yCAA8C;AAC9C,6CAAuD;AAEvD;;;;;GAKG;AACU,QAAA,oBAAoB,GAAG,oBAAoB,CAAC;AAEzD,gBAAgB;AAChB,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAC7B,8DAA8D;IACjD,4BAAa,GAAG,UAAU,CAAC;IAExC;;;;OAIG;IACI,KAAK,UAAU,iBAAiB,CAAC,OAAmB;QACzD,OAAO,IAAA,oDAA+B,EAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAFqB,gCAAiB,oBAEtC,CAAA;IAED;;;;;OAKG;IACI,KAAK,UAAU,WAAW,CAAC,OAAmB;QACnD,OAAO,IAAA,8CAAyB,EAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAFqB,0BAAW,cAEhC,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAED;;;GAGG;AACH,IAAiB,kBAAkB,CA+ElC;AA/ED,WAAiB,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,UAAU,eAAe,CAAC,IAAuC;QACpE,IAAI,SAAS,KAAK,oCAAa,CAAC,OAAO;YACrC,gCAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO,oCAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,cAAc,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5H,CAAC;IAED;;;;OAIG;IACI,KAAK,UAAU,mBAAmB,CAAC,OAAmB;QAC3D,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,gCAAkB,CAAC,UAAU,CAAC,oCAAoC,EAAE;gBAClE,OAAO,EAAE,sDAAsD,OAAO,qDAAqD;gBAC3H,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC;IACpC,CAAC;IATqB,sCAAmB,sBASxC,CAAA;IAED;;;;;;;OAOG;IACI,KAAK,UAAU,uBAAuB,CAAC,OAAmB;QAC/D,IAAI,SAAS,KAAK,oCAAa,CAAC,OAAO;YACrC,gCAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;QACtG,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAE9C,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;QACrC,MAAM,OAAO,GAA+B,EAAE,CAAC;QAC/C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC;YACvC,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;gBAC/B,gCAAkB,CAAC,UAAU,CAAC,2BAA2B,EAAE;oBACzD,OAAO,EAAE,uBAAuB,SAAS,CAAC,WAAW,2HAA2H;oBAChL,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;YACD,IAAI,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBACjC,gCAAkB,CAAC,UAAU,CAAC,oCAAoC,EAAE;oBAClE,OAAO,EAAE,sDAAsD,YAAY,qDAAqD;oBAChI,OAAO,EAAE,YAAY;iBACtB,CAAC,CAAC;YACL,CAAC;YACD,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAE7B,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,KAAK,YAAY,CAAC,CAAC,CAAC,2BAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,2BAAgB,CAAC,KAAK,CAAC;YACpH,MAAM,UAAU,GAAG,MAAM,oCAAa,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YACpI,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,WAAW,EAAE,SAAS,CAAC,WAAW;gBAClC,WAAW,EAAE,UAAU,CAAC,QAAQ;gBAChC,WAAW,EAAE,UAAU,CAAC,KAAK;gBAC7B,QAAQ;gBACR,MAAM,EAAE,oCAAuB;gBAC/B,iBAAiB,EAAE,IAAI;aACxB,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAxCqB,0CAAuB,0BAwC5C,CAAA;AACH,CAAC,EA/EgB,kBAAkB,kCAAlB,kBAAkB,QA+ElC","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 Workspace\n */\n\nimport { ITwinSettingsError } from \"@itwin/core-common\";\nimport { GuidString } from \"@itwin/core-bentley\";\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport { IModelHost } from \"../IModelHost\";\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\nimport { SettingsPriority } from \"./Settings\";\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\n\n/** The default resource name used to store settings in a [[WorkspaceDb]].\n * This is the key under which all settings are stored in the SQLite `strings` table.\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\n * to this value, ensuring the read and write paths always agree on which key to use.\n * @internal\n */\nexport const settingsResourceName = \"settingsDictionary\";\n\n/** @internal */\nexport namespace SettingsEditor {\n  /** The type of workspace container used to store settings. */\n  export const containerType = \"settings\";\n\n  /**\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\n    return constructSettingsEditorForITwin(iTwinId);\n  }\n\n  /**\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\n    return getSettingsEditorForITwin(iTwinId);\n  }\n}\n\n/**\n * Help locate and obtain access to known containers with type \"settings\".\n * @internal\n */\nexport namespace SettingsContainers {\n  /**\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\n   * Automatically filters by `containerType: \"settings\"`.\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   */\n  async function queryContainers(args: BlobContainer.QueryContainerProps): Promise<BlobContainer.MetadataResponse[]> {\n    if (undefined === BlobContainer.service)\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\n\n    const userToken = await IModelHost.getAccessToken();\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.\n   * @returns The containerId, or `undefined` if no container exists.\n   * @throws if more than one settings container is found.\n   */\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\n    const containers = await queryContainers({ iTwinId });\n    if (containers.length > 1) {\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\n        iTwinId,\n      });\n    }\n    return containers[0]?.containerId;\n  }\n\n  /**\n   * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.\n   * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings\n   * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at\n   * [[SettingsPriority.organization]].\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   * @note Requires [[BlobContainer.service]] to be configured.\n   */\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\n    if (undefined === BlobContainer.service)\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\n\n    const userToken = await IModelHost.getAccessToken();\n    const containers = await queryContainers({ iTwinId, includeParentITwins: { filter: \"accountOnly\" } });\n    if (containers.length === 0) return undefined;\n\n    const seenITwins = new Set<string>();\n    const results: WorkspaceDbSettingsProps[] = [];\n    for (const container of containers) {\n      const ownerITwinId = container.iTwinId;\n      if (undefined === ownerITwinId) {\n        ITwinSettingsError.throwError(\"missing-container-itwinid\", {\n          message: `Settings container '${container.containerId}' has no iTwinId. Please upgrade to a newer version of the BlobContainer service that populates iTwinId in query results.`,\n          iTwinId,\n        });\n      }\n      if (seenITwins.has(ownerITwinId)) {\n        ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\n          message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,\n          iTwinId: ownerITwinId,\n        });\n      }\n      seenITwins.add(ownerITwinId);\n\n      const priority = container.accountITwinId === ownerITwinId ? SettingsPriority.organization : SettingsPriority.iTwin;\n      const tokenProps = await BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: \"read\", userToken });\n      results.push({\n        baseUri: tokenProps.baseUri,\n        containerId: container.containerId,\n        storageType: tokenProps.provider,\n        accessToken: tokenProps.token,\n        priority,\n        dbName: settingsWorkspaceDbName,\n        includePrerelease: true,\n      });\n    }\n\n    return results;\n  }\n}\n"]}

package/lib/cjs/workspace/SettingsSchemas.d.ts

@@ -79,6 +79,21 @@ export interface SettingGroupSchema {
     /** A description of this group suitable for displaying to a user. */
     readonly description: string;
 }
+/** Options controlling how [[SettingsSchemas.getResolvedSettingDef]] resolves a [[SettingSchema]].
+ * @beta
+ */
+export interface GetResolvedSettingDefOptions {
+    /** When `true`, the `extends` property is retained on resolved schemas that originally
+     * declared it. By default (`false`) it is stripped after resolution, because the inherited
+     * properties have already been merged into the output schema.
+     *
+     * Set to `true` when the caller needs to inspect schema inheritance - for example, when
+     * building a schema editor that shows which base type a setting definition inherits from.
+     *
+     * @defaultValue false
+     */
+    readonly preserveExtends?: boolean;
+}
 /**
  * The registry of available [[SettingGroupSchema]]s.
  * The registry is used for editing Settings files and for finding default values for settings.
@@ -140,13 +155,24 @@ export interface SettingsSchemas {
     /**
      * Looks up a setting schema in [[settingDefs]] and returns its resolved form.
      * Resolution uses the [[typeDefs]] currently registered with this [[SettingsSchemas]] instance.
+     * By default, `extends` metadata is removed from the resolved schema. Pass [[GetResolvedSettingDefOptions.preserveExtends]]
+     * to preserve `extends` members on resolved schemas that originally declared them.
      * @returns The resolved schema for `settingName`, or `undefined` if no schema has been registered for that setting.
      * @throws Error if a registered setting schema cannot be resolved because a referenced type definition is missing or circular.
-     * @example
+     * @example Default - `extends` is stripped after resolution:
      * ```ts
      * const resolved = IModelHost.settingsSchemas.getResolvedSettingDef("app/font");
+     * // resolved.extends === undefined
+     * ```
+     * @example Preserving `extends` for tooling (e.g. a schema editor):
+     * ```ts
+     * const resolved = IModelHost.settingsSchemas.getResolvedSettingDef(
+     *   "app/font",
+     *   { preserveExtends: true },
+     * );
+     * // resolved.extends === "app/baseFont"  (if originally declared)
      * ```
      */
-    getResolvedSettingDef(settingName: SettingName): SettingSchema | undefined;
+    getResolvedSettingDef(settingName: SettingName, options?: GetResolvedSettingDefOptions): SettingSchema | undefined;
 }
 //# sourceMappingURL=SettingsSchemas.d.ts.map

package/lib/cjs/workspace/SettingsSchemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsSchemas.d.ts","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;;;;;;;IAQI;AACJ,MAAM,WAAW,aAAc,SAAQ,QAAQ,CAAC,UAAU,CAAC;IACzD,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IAC/B,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,kFAAkF;IAClF,QAAQ,CAAC,UAAU,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,WAAW,GAAG,aAAa,CAAA;KAAE,CAAC;IAC7D;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;IAoBI;AACJ,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,WAAW,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IACrE,mGAAmG;IACnG,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IAClE,sJAAsJ;IACtJ,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,qEAAqE;IACrE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AAEH;;;;;;;;;;;;;;IAcI;AACJ,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,CAAC,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAE9C,8GAA8G;IAC9G,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAEzD;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAE3D,6DAA6D;IAC7D,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,CAAC;IAE1D;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;IAEzE,uFAAuF;IACvF,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,kFAAkF;IAClF,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAEvC,oFAAoF;IACpF,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAC;IAE1C,+GAA+G;IAC/G,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;;;;OASG;IACH,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,aAAa,GAAG,SAAS,CAAC;CAE5E"}
+{"version":3,"file":"SettingsSchemas.d.ts","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;;;;;;;IAQI;AACJ,MAAM,WAAW,aAAc,SAAQ,QAAQ,CAAC,UAAU,CAAC;IACzD,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IAC/B,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,kFAAkF;IAClF,QAAQ,CAAC,UAAU,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,WAAW,GAAG,aAAa,CAAA;KAAE,CAAC;IAC7D;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;IAoBI;AACJ,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,WAAW,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IACrE,mGAAmG;IACnG,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IAClE,sJAAsJ;IACtJ,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,qEAAqE;IACrE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACpC;AAED;;;;GAIG;AAEH;;;;;;;;;;;;;;IAcI;AACJ,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,CAAC,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAE9C,8GAA8G;IAC9G,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAEzD;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAE3D,6DAA6D;IAC7D,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,CAAC;IAE1D;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;IAEzE,uFAAuF;IACvF,OAAO,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC,kFAAkF;IAClF,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAEvC,oFAAoF;IACpF,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAC;IAE1C,+GAA+G;IAC/G,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,qBAAqB,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,4BAA4B,GAAG,aAAa,GAAG,SAAS,CAAC;CAEpH"}

package/lib/cjs/workspace/SettingsSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAIH,iDAAgE","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 Workspace\n */\n\nimport { BeEvent, JSONSchema, JSONSchemaTypeName } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\nimport { SettingName } from \"./Settings\";\n\n/** Metadata describing a single [[Setting]] as part of a [[SettingGroupSchema]].\n  * Every setting has a [[type]], which can be one of the following:\n  * - A primitive type like `string` or `number`;\n  * - An object containing any number of named properties, each with their own types; or\n  * - An array of elements, all of the same type.\n  * This metadata is used to validate setting values against the schema, and to enable user interfaces by which\n  * users can view and modify their settings.\n  * @beta\n  */\nexport interface SettingSchema extends Readonly<JSONSchema> {\n  /** For arrays only, the metadata describing every element in the array. */\n  readonly items?: SettingSchema;\n  /** The name of the [[Setting]]'s data type. */\n  readonly type: JSONSchemaTypeName;\n  /** For objects and arrays only, the name of a [[SettingSchema]] that provides a base definition for this type.\n   * The name is expected to refer to a type definition registered with [[SettingsSchema.typeDefs]].\n   * Therefore, it must be the full name, including the [[SettingGroupSchema.schemaPrefix]].\n   */\n  readonly extends?: string;\n  /** For objects only, the name and metadata of each of the object's properties. */\n  readonly properties?: { [name: SettingName]: SettingSchema };\n  /** For arrays only, specifies how [[SettingsDictionary.getArray]] resolves the value of the setting.\n   * By default, like other types of settings, the setting uses the value of the setting from the highest-priority dictionary.\n   * If `combineArray` is `true`, then the value of the setting is computed by combining the elements of every array from every dictionary,\n   * ordered by priority and eliminating duplicate elements.\n   * Two elements are considered duplicates of one another if [[Setting.areEqual]] returns `true`.\n   */\n  readonly combineArray?: boolean;\n}\n\n/** Metadata describing a group of related [[SettingSchema]]s. You can register setting schema groups via [[SettingsSchemas.addGroup]] and\n  * remove them via [[SettingsSchemas.removeGroup]].\n  *\n  * All of the settings share the same [[schemaPrefix]], which must be unique amongst all other groups.\n  * The prefix is a stable identifier combined with the name of each [[SettingSchema]] in the group to form the fully-qualified name used to refer\n  * to the setting outside of the group, e.g., when accessing [[SettingsSchemas.settingDefs]] or in [[SettingSchema.extends]].\n  * In the following example, the fully-qualified name of the setting named \"metric\" is \"format/units/metric\".\n  *\n  * ```json\n  *  {\n  *    \"schemaPrefix\": \"format/units\",\n  *    \"settingDefs\": {\n  *      \"metric\": { \"type\": \"boolean\" }\n  *    }\n  *  }\n  * ```\n  *\n  * A group can also define [[SettingSchema]]s that, rather than describing actual [[Setting]]s, instead describe types that can be extended by [[Setting]]s via\n  * [[SettingSchema.extends]]. A [[SettingSchema]] can refer to type definitions defined in its own group or any other group.\n  * @beta\n  */\nexport interface SettingGroupSchema {\n  /** Uniquely identifies this group amongst all other groups.\n   * The prefix can use forward-slashes to define logical subgroups - for example, two related groups with the prefixes \"units/metric\" and \"units/imperial\".\n   *\n   * @note Schema prefixes beginning with \"itwin\" are reserved for use by iTwin.js.\n   */\n  readonly schemaPrefix: string;\n  /** A title of this group suitable for displaying to a user. */\n  readonly title?: string;\n  /** Metadata for each [[Setting]] in this group. */\n  readonly settingDefs?: { [name: string]: SettingSchema | undefined };\n  /** Metadata for types that can be extended by other [[Setting]]s via [[SettingSchema.extends]]. */\n  readonly typeDefs?: { [name: string]: SettingSchema | undefined };\n  /** An integer used when displaying a list of schemas in a user interface, to sort schemas with a lower `order` before those with a `higher` order. */\n  readonly order?: number;\n  /** A description of this group suitable for displaying to a user. */\n  readonly description: string;\n}\n\n/**\n * The registry of available [[SettingGroupSchema]]s.\n * The registry is used for editing Settings files and for finding default values for settings.\n * @beta\n */\n\n/** The registry of metadata describing groups of [[SettingSchema]]s available to the current session.\n  * The schemas are used to look up the default values of [[Setting]]s, validate that their values are of the type dictated by the schema, and\n  * query metadata like [[SettingsSchema.combineArray]] that modify their behavior.\n  * They can also be used to drive a user interface that enables end users to edit [[Settings]].\n  *\n  * When [[IModelHost.startup]] is invoked at the beginning of a session, schemas delivered with the application - like those describing\n  * [[Workspace]]s - are automatically loaded.\n  * The application can manually register additional schemas using methods like [[addGroup]], [[addFile]], [[addDirectory]], and [[addJson]].\n  * When [[IModelHost.shutdown]] is invoked at the end of a session, all registered schemas are unregistered.\n  *\n  * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.\n  *\n  * @see [[IModelHost.settingsSchemas]] to access the registry for the current session.\n  * @beta\n  */\nexport interface SettingsSchemas {\n  /** @internal */\n  readonly [_implementationProhibited]: unknown;\n\n  /** The map of each registered [[SettingGroupSchema]], accessed by its [[SettingGroupSchema.schemaPrefix]]. */\n  readonly groups: ReadonlyMap<string, SettingGroupSchema>;\n\n  /** The map of each individual registered [[SettingSchema]] defining a [[Setting]], accessed by its fully-qualified name (including its [[SettingGroupSchema.schemaPrefix]]).\n   * Schemas in this map may include an [[SettingSchema.extends]] property referring to a registered type definition.\n   * Use [[resolveSchema]] to obtain the fully expanded schema.\n   */\n  readonly settingDefs: ReadonlyMap<SettingName, SettingSchema>;\n\n  /** The map of each individual registered [[SettingSchema]] defining a type that can be extended by other [[SettingSchema]]s via [[SettingSchema.extends]],\n   * accessed by its fully-qualified name (including its [[SettingGroupSchema.schemaPrefix]]).\n   */\n  readonly typeDefs: ReadonlyMap<SettingName, SettingSchema>;\n\n  /** An event raised whenever schemas are added or removed. */\n  readonly onSchemaChanged: BeEvent<() => void>;\n\n  /**\n   * Ensure that the setting value supplied is valid according to its [[SettingSchema]].\n   * If no schema has been registered for the setting, no validation is performed.\n   * @param value The value of the setting to validate against the schema.\n   * @param settingName The fully-qualified setting name.\n   * @returns `value` if `value` matches the schema corresponding to `settingName`, or if no such schema has been registered.\n   * @throws Error if `value` is invalid according to the schema.\n   */\n  validateSetting<T>(value: T, settingName: SettingName): T;\n\n  /** Register one or more [[SettingGroupSchema]]s.\n   * If a group with the same [[SettingGroupSchema.prefix]] was previously registered, it will be replaced.\n   * Each [[SettingSchema]] in the group will be added to [[settingDefs]] or [[typeDefs]].\n   */\n  addGroup(settingsGroup: SettingGroupSchema | SettingGroupSchema[]): void;\n\n  /** Invokes [[addGroup]] for a [[SettingGroupSchema]] supplied as stringified json5. */\n  addJson(settingSchema: string): void;\n\n  /** Invokes [[addGroup]] for a json5 file containiner a [[SettingGroupSchema]]. */\n  addFile(fileName: LocalFileName): void;\n\n  /** Invokes [[addFile]] for every json and json5 file in the specified directory. */\n  addDirectory(dirName: LocalDirName): void;\n\n  /** Unregisters all [[settingDefs]] and [[typeDefs]] with the specified [[SettingGroupSchema.schemaPrefix]]. */\n  removeGroup(schemaPrefix: string): void;\n\n  /**\n   * Looks up a setting schema in [[settingDefs]] and returns its resolved form.\n   * Resolution uses the [[typeDefs]] currently registered with this [[SettingsSchemas]] instance.\n   * @returns The resolved schema for `settingName`, or `undefined` if no schema has been registered for that setting.\n   * @throws Error if a registered setting schema cannot be resolved because a referenced type definition is missing or circular.\n   * @example\n   * ```ts\n   * const resolved = IModelHost.settingsSchemas.getResolvedSettingDef(\"app/font\");\n   * ```\n   */\n  getResolvedSettingDef(settingName: SettingName): SettingSchema | undefined;\n\n}\n"]}
+{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAIH,iDAAgE","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 Workspace\n */\n\nimport { BeEvent, JSONSchema, JSONSchemaTypeName } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\nimport { SettingName } from \"./Settings\";\n\n/** Metadata describing a single [[Setting]] as part of a [[SettingGroupSchema]].\n  * Every setting has a [[type]], which can be one of the following:\n  * - A primitive type like `string` or `number`;\n  * - An object containing any number of named properties, each with their own types; or\n  * - An array of elements, all of the same type.\n  * This metadata is used to validate setting values against the schema, and to enable user interfaces by which\n  * users can view and modify their settings.\n  * @beta\n  */\nexport interface SettingSchema extends Readonly<JSONSchema> {\n  /** For arrays only, the metadata describing every element in the array. */\n  readonly items?: SettingSchema;\n  /** The name of the [[Setting]]'s data type. */\n  readonly type: JSONSchemaTypeName;\n  /** For objects and arrays only, the name of a [[SettingSchema]] that provides a base definition for this type.\n   * The name is expected to refer to a type definition registered with [[SettingsSchema.typeDefs]].\n   * Therefore, it must be the full name, including the [[SettingGroupSchema.schemaPrefix]].\n   */\n  readonly extends?: string;\n  /** For objects only, the name and metadata of each of the object's properties. */\n  readonly properties?: { [name: SettingName]: SettingSchema };\n  /** For arrays only, specifies how [[SettingsDictionary.getArray]] resolves the value of the setting.\n   * By default, like other types of settings, the setting uses the value of the setting from the highest-priority dictionary.\n   * If `combineArray` is `true`, then the value of the setting is computed by combining the elements of every array from every dictionary,\n   * ordered by priority and eliminating duplicate elements.\n   * Two elements are considered duplicates of one another if [[Setting.areEqual]] returns `true`.\n   */\n  readonly combineArray?: boolean;\n}\n\n/** Metadata describing a group of related [[SettingSchema]]s. You can register setting schema groups via [[SettingsSchemas.addGroup]] and\n  * remove them via [[SettingsSchemas.removeGroup]].\n  *\n  * All of the settings share the same [[schemaPrefix]], which must be unique amongst all other groups.\n  * The prefix is a stable identifier combined with the name of each [[SettingSchema]] in the group to form the fully-qualified name used to refer\n  * to the setting outside of the group, e.g., when accessing [[SettingsSchemas.settingDefs]] or in [[SettingSchema.extends]].\n  * In the following example, the fully-qualified name of the setting named \"metric\" is \"format/units/metric\".\n  *\n  * ```json\n  *  {\n  *    \"schemaPrefix\": \"format/units\",\n  *    \"settingDefs\": {\n  *      \"metric\": { \"type\": \"boolean\" }\n  *    }\n  *  }\n  * ```\n  *\n  * A group can also define [[SettingSchema]]s that, rather than describing actual [[Setting]]s, instead describe types that can be extended by [[Setting]]s via\n  * [[SettingSchema.extends]]. A [[SettingSchema]] can refer to type definitions defined in its own group or any other group.\n  * @beta\n  */\nexport interface SettingGroupSchema {\n  /** Uniquely identifies this group amongst all other groups.\n   * The prefix can use forward-slashes to define logical subgroups - for example, two related groups with the prefixes \"units/metric\" and \"units/imperial\".\n   *\n   * @note Schema prefixes beginning with \"itwin\" are reserved for use by iTwin.js.\n   */\n  readonly schemaPrefix: string;\n  /** A title of this group suitable for displaying to a user. */\n  readonly title?: string;\n  /** Metadata for each [[Setting]] in this group. */\n  readonly settingDefs?: { [name: string]: SettingSchema | undefined };\n  /** Metadata for types that can be extended by other [[Setting]]s via [[SettingSchema.extends]]. */\n  readonly typeDefs?: { [name: string]: SettingSchema | undefined };\n  /** An integer used when displaying a list of schemas in a user interface, to sort schemas with a lower `order` before those with a `higher` order. */\n  readonly order?: number;\n  /** A description of this group suitable for displaying to a user. */\n  readonly description: string;\n}\n\n/** Options controlling how [[SettingsSchemas.getResolvedSettingDef]] resolves a [[SettingSchema]].\n * @beta\n */\nexport interface GetResolvedSettingDefOptions {\n  /** When `true`, the `extends` property is retained on resolved schemas that originally\n   * declared it. By default (`false`) it is stripped after resolution, because the inherited\n   * properties have already been merged into the output schema.\n   *\n   * Set to `true` when the caller needs to inspect schema inheritance - for example, when\n   * building a schema editor that shows which base type a setting definition inherits from.\n   *\n   * @defaultValue false\n   */\n  readonly preserveExtends?: boolean;\n}\n\n/**\n * The registry of available [[SettingGroupSchema]]s.\n * The registry is used for editing Settings files and for finding default values for settings.\n * @beta\n */\n\n/** The registry of metadata describing groups of [[SettingSchema]]s available to the current session.\n  * The schemas are used to look up the default values of [[Setting]]s, validate that their values are of the type dictated by the schema, and\n  * query metadata like [[SettingsSchema.combineArray]] that modify their behavior.\n  * They can also be used to drive a user interface that enables end users to edit [[Settings]].\n  *\n  * When [[IModelHost.startup]] is invoked at the beginning of a session, schemas delivered with the application - like those describing\n  * [[Workspace]]s - are automatically loaded.\n  * The application can manually register additional schemas using methods like [[addGroup]], [[addFile]], [[addDirectory]], and [[addJson]].\n  * When [[IModelHost.shutdown]] is invoked at the end of a session, all registered schemas are unregistered.\n  *\n  * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.\n  *\n  * @see [[IModelHost.settingsSchemas]] to access the registry for the current session.\n  * @beta\n  */\nexport interface SettingsSchemas {\n  /** @internal */\n  readonly [_implementationProhibited]: unknown;\n\n  /** The map of each registered [[SettingGroupSchema]], accessed by its [[SettingGroupSchema.schemaPrefix]]. */\n  readonly groups: ReadonlyMap<string, SettingGroupSchema>;\n\n  /** The map of each individual registered [[SettingSchema]] defining a [[Setting]], accessed by its fully-qualified name (including its [[SettingGroupSchema.schemaPrefix]]).\n   * Schemas in this map may include an [[SettingSchema.extends]] property referring to a registered type definition.\n   * Use [[resolveSchema]] to obtain the fully expanded schema.\n   */\n  readonly settingDefs: ReadonlyMap<SettingName, SettingSchema>;\n\n  /** The map of each individual registered [[SettingSchema]] defining a type that can be extended by other [[SettingSchema]]s via [[SettingSchema.extends]],\n   * accessed by its fully-qualified name (including its [[SettingGroupSchema.schemaPrefix]]).\n   */\n  readonly typeDefs: ReadonlyMap<SettingName, SettingSchema>;\n\n  /** An event raised whenever schemas are added or removed. */\n  readonly onSchemaChanged: BeEvent<() => void>;\n\n  /**\n   * Ensure that the setting value supplied is valid according to its [[SettingSchema]].\n   * If no schema has been registered for the setting, no validation is performed.\n   * @param value The value of the setting to validate against the schema.\n   * @param settingName The fully-qualified setting name.\n   * @returns `value` if `value` matches the schema corresponding to `settingName`, or if no such schema has been registered.\n   * @throws Error if `value` is invalid according to the schema.\n   */\n  validateSetting<T>(value: T, settingName: SettingName): T;\n\n  /** Register one or more [[SettingGroupSchema]]s.\n   * If a group with the same [[SettingGroupSchema.prefix]] was previously registered, it will be replaced.\n   * Each [[SettingSchema]] in the group will be added to [[settingDefs]] or [[typeDefs]].\n   */\n  addGroup(settingsGroup: SettingGroupSchema | SettingGroupSchema[]): void;\n\n  /** Invokes [[addGroup]] for a [[SettingGroupSchema]] supplied as stringified json5. */\n  addJson(settingSchema: string): void;\n\n  /** Invokes [[addGroup]] for a json5 file containiner a [[SettingGroupSchema]]. */\n  addFile(fileName: LocalFileName): void;\n\n  /** Invokes [[addFile]] for every json and json5 file in the specified directory. */\n  addDirectory(dirName: LocalDirName): void;\n\n  /** Unregisters all [[settingDefs]] and [[typeDefs]] with the specified [[SettingGroupSchema.schemaPrefix]]. */\n  removeGroup(schemaPrefix: string): void;\n\n  /**\n   * Looks up a setting schema in [[settingDefs]] and returns its resolved form.\n   * Resolution uses the [[typeDefs]] currently registered with this [[SettingsSchemas]] instance.\n   * By default, `extends` metadata is removed from the resolved schema. Pass [[GetResolvedSettingDefOptions.preserveExtends]]\n   * to preserve `extends` members on resolved schemas that originally declared them.\n   * @returns The resolved schema for `settingName`, or `undefined` if no schema has been registered for that setting.\n   * @throws Error if a registered setting schema cannot be resolved because a referenced type definition is missing or circular.\n   * @example Default - `extends` is stripped after resolution:\n   * ```ts\n   * const resolved = IModelHost.settingsSchemas.getResolvedSettingDef(\"app/font\");\n   * // resolved.extends === undefined\n   * ```\n   * @example Preserving `extends` for tooling (e.g. a schema editor):\n   * ```ts\n   * const resolved = IModelHost.settingsSchemas.getResolvedSettingDef(\n   *   \"app/font\",\n   *   { preserveExtends: true },\n   * );\n   * // resolved.extends === \"app/baseFont\"  (if originally declared)\n   * ```\n   */\n  getResolvedSettingDef(settingName: SettingName, options?: GetResolvedSettingDefOptions): SettingSchema | undefined;\n\n}\n"]}

package/lib/esm/BackendHubAccess.d.ts

@@ -20,7 +20,7 @@ export declare class LockConflict extends IModelError {
     briefcaseAlias: string, msg: "shared lock is held" | "exclusive lock is already held");
 }
 /** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).
- * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)
+ * @deprecated in 4.7 - might be removed in next major version. Use [LockState]($common)
  * @public
  */
 export declare enum LockState {

package/lib/esm/BackendHubAccess.js

@@ -24,7 +24,7 @@ export class LockConflict extends IModelError {
     }
 }
 /** The state of a lock. See [Acquiring locks on elements.]($docs/learning/backend/ConcurrencyControl.md#acquiring-locks-on-elements).
- * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)
+ * @deprecated in 4.7 - might be removed in next major version. Use [LockState]($common)
  * @public
  */
 export var LockState;

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  /**\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"]}
+{"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 - might be removed in next major version. 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/BlobContainerService.d.ts

@@ -56,7 +56,12 @@ export declare namespace BlobContainer {
      * Properties returned by queryContainersMetadata
      */
     interface MetadataResponse extends Metadata {
+        /** The id of the container. */
         containerId: string;
+        /** The iTwinId that owns this container. */
+        iTwinId?: GuidString;
+        /** The account iTwinId of the owning iTwin. */
+        accountITwinId?: GuidString;
     }
     /** Properties returned by `Service.requestToken` */
     interface TokenProps {
@@ -134,6 +139,10 @@ export declare namespace BlobContainer {
         containerType?: GuidString;
         /** optional label of the containers to query */
         label?: GuidString;
+        /** Whether to include parent iTwins in the query. Pass `true` to traverse the full parent chain, or `{ filter: "accountOnly" }` to include only the account iTwin. Defaults to `false`. */
+        includeParentITwins?: boolean | {
+            filter: "accountOnly";
+        };
     }
     /** Methods to create, delete, and access blob containers. */
     interface ContainerService {
@@ -148,7 +157,11 @@ export declare namespace BlobContainer {
         queryScope(container: AccessContainerProps): Promise<Scope>;
         /** query the Metadata for a specific container */
         queryMetadata(container: AccessContainerProps): Promise<Metadata>;
-        /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */
+        /** Returns all containers and their metadata associated with a given iTwinId.
+         * Pass `includeParentITwins: { filter: "accountOnly" }` to also include the account iTwin container,
+         * without traversing any higher parent chain.
+         * Results can be further queried by label and containerType.
+         */
         queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;
         /** update the json properties of this container */
         updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE1C,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,iEAAiE;QACjE,SAAS,CAAC,EAAE,UAAU,CAAC;KACxB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yIAAyI;QACzI,aAAa,EAAE,MAAM,CAAC;QACtB,qJAAqJ;QACrJ,KAAK,EAAE,MAAM,CAAC;QACd,kKAAkK;QAClK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,iBAAiB,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,QAAQ;QAChD,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;QACnB,+DAA+D;QAC/D,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED,4DAA4D;IAC5D,UAAiB,oBAAqB,SAAQ,QAAQ;QACpD,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,mDAAmD;IACnD,UAAiB,qBAAsB,SAAQ,QAAQ;QACrD,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED;;;;;;;OAOG;IACH,KAAY,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAEhF,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;QAC9E,wFAAwF;QACxF,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,6CAA6C;QAC7C,OAAO,EAAE,UAAU,CAAC;QACpB,mDAAmD;QACnD,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,wDAAwD;QACxD,aAAa,CAAC,EAAE,UAAU,CAAC;QAC3B,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B,wGAAwG;QACxG,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvE;;;WAGG;QACH,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvD,sCAAsC;QACtC,UAAU,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,kDAAkD;QAClD,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAElE,oIAAoI;QACpI,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEtG,mDAAmD;QACnD,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpF,qEAAqE;QACrE,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}
+{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE1C,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,iEAAiE;QACjE,SAAS,CAAC,EAAE,UAAU,CAAC;KACxB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yIAAyI;QACzI,aAAa,EAAE,MAAM,CAAC;QACtB,qJAAqJ;QACrJ,KAAK,EAAE,MAAM,CAAC;QACd,kKAAkK;QAClK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,iBAAiB,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,QAAQ;QAChD,+BAA+B;QAC/B,WAAW,EAAE,MAAM,CAAC;QACpB,4CAA4C;QAC5C,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,+CAA+C;QAC/C,cAAc,CAAC,EAAE,UAAU,CAAC;KAC7B;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;QACnB,+DAA+D;QAC/D,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED,4DAA4D;IAC5D,UAAiB,oBAAqB,SAAQ,QAAQ;QACpD,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,mDAAmD;IACnD,UAAiB,qBAAsB,SAAQ,QAAQ;QACrD,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED;;;;;;;OAOG;IACH,KAAY,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAEhF,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;QAC9E,wFAAwF;QACxF,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,6CAA6C;QAC7C,OAAO,EAAE,UAAU,CAAC;QACpB,mDAAmD;QACnD,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,wDAAwD;QACxD,aAAa,CAAC,EAAE,UAAU,CAAC;QAC3B,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,2LAA2L;QAC3L,mBAAmB,CAAC,EAAE,OAAO,GAAG;YAAE,MAAM,EAAE,aAAa,CAAA;SAAE,CAAC;KAC3D;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B,wGAAwG;QACxG,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvE;;;WAGG;QACH,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvD,sCAAsC;QACtC,UAAU,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,kDAAkD;QAClD,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAElE;;;;WAIG;QACH,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEtG,mDAAmD;QACnD,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpF,qEAAqE;QACrE,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}

package/lib/esm/BlobContainerService.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,KAAW,aAAa,CA2K7B;AA3KD,WAAiB,aAAa;AA2K9B,CAAC,EA3KgB,aAAa,KAAb,aAAa,QA2K7B","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 BlobContainers\n */\n\n// spell:ignore datacenter\n\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { SettingsContainer } from \"./workspace/Settings\";\n\n/**\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\n * @beta\n */\nexport namespace BlobContainer {\n\n  /** Object that implements the methods to create, delete, and request access to a container. */\n  export let service: BlobContainer.ContainerService | undefined;\n\n  /** name of cloud provider for a container. */\n  export type Provider = \"azure\" | \"google\";\n\n  /** the name of the container within its `Scope` */\n  export type ContainerId = string;\n\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\n  export type UserToken = AccessToken;\n\n  /** token that authenticates access to a container for either read or write. */\n  export type ContainerToken = AccessToken;\n\n  /**\n   * The scope for a container. This determines:\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\n   *  - the administrators who may configure RBAC permissions\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\n   * determines the region for data residency requirements.\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\n   */\n  export interface Scope {\n    /** iTwinId of the owner of this container. */\n    iTwinId: Id64String;\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\n    iModelId?: Id64String;\n    /** the user GUID an individual, if this container is private. */\n    ownerGuid?: GuidString;\n  }\n\n  /**\n   * Metadata about the use of a container so that:\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\n   *  - usage reports can aggregate types of containers\n   *  - applications can identify their containers\n   *  - applications can store properties about their containers\n   */\n  export interface Metadata {\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\n    containerType: string;\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\n    label: string;\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n    description?: string;\n    /** optional properties for the container */\n    json?: SettingsContainer;\n  }\n\n  /**\n   * Properties returned by queryContainersMetadata\n   */\n  export interface MetadataResponse extends Metadata {\n    containerId: string;\n  }\n\n  /** Properties returned by `Service.requestToken` */\n  export interface TokenProps {\n    /**\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\n     * and must be refreshed before it expires\n     */\n    token: ContainerToken;\n    /** Scope of the container. */\n    scope: Scope;\n    /** Name of the blob storage provider. */\n    provider: Provider;\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\n    expiration: Date;\n    /** Metadata of the container. */\n    metadata: Metadata;\n    /** Base URI of the storage account that hosts the container */\n    baseUri: string;\n  }\n\n  /** The URI and Id of the container. */\n  export interface UriAndId {\n    baseUri: string;\n    containerId: ContainerId;\n  }\n\n  /** Information required to access an existing container. */\n  export interface AccessContainerProps extends UriAndId {\n    userToken: UserToken;\n  }\n\n  /** Information about a newly created container. */\n  export interface CreatedContainerProps extends UriAndId {\n    /** name of the blob storage provider. */\n    provider: Provider;\n  }\n\n  /**\n   * Access level to request for token.\n   * - `\"write\"`: request a writeable AccessToken.\n   * - `\"read\"`:  request a read-only AccessToken.\n   * - `\"admin\"`:  request a admin AccessToken.\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\n   * If the user is not authorized for the level requested, an exception is thrown.\n   */\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\n\n  /** Information required to request an access token for a container. */\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\n    accessLevel?: RequestAccessLevel;\n    /** the number of seconds before the token should expire.\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\n     */\n    durationSeconds?: number;\n  }\n\n  /** Information required to create a new container. */\n  export interface CreateNewContainerProps {\n    /** the scope of the new container */\n    scope: Scope;\n    /** metadata to be stored on the new container */\n    metadata: Metadata;\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\n    userToken: UserToken;\n    /**\n     * the id for the container. Useful for tests.\n     * @internal\n     */\n    containerId?: ContainerId;\n  }\n\n  /**\n   * Query Parameters for querying containers\n   */\n  export interface QueryContainerProps {\n    /** the iTwinId of the containers to query */\n    iTwinId: GuidString;\n    /** optional iModelId of the containers to query */\n    iModelId?: GuidString;\n    /** optional containerType of the containers to query */\n    containerType?: GuidString;\n    /** optional label of the containers to query */\n    label?: GuidString;\n  }\n\n  /** Methods to create, delete, and access blob containers. */\n  export interface ContainerService {\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\n\n    /**\n     * Delete an existing blob container.\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\n     */\n    delete(container: AccessContainerProps): Promise<void>;\n\n    /** query the Scope for a container */\n    queryScope(container: AccessContainerProps): Promise<Scope>;\n\n    /** query the Metadata for a specific container */\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\n\n    /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\n\n    /** update the json properties of this container */\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\n\n    /** Request a `ContainerToken` for a container. Throws on failure. */\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\n  }\n}\n"]}
+{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,KAAW,aAAa,CAsL7B;AAtLD,WAAiB,aAAa;AAsL9B,CAAC,EAtLgB,aAAa,KAAb,aAAa,QAsL7B","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 BlobContainers\n */\n\n// spell:ignore datacenter\n\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { SettingsContainer } from \"./workspace/Settings\";\n\n/**\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\n * @beta\n */\nexport namespace BlobContainer {\n\n  /** Object that implements the methods to create, delete, and request access to a container. */\n  export let service: BlobContainer.ContainerService | undefined;\n\n  /** name of cloud provider for a container. */\n  export type Provider = \"azure\" | \"google\";\n\n  /** the name of the container within its `Scope` */\n  export type ContainerId = string;\n\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\n  export type UserToken = AccessToken;\n\n  /** token that authenticates access to a container for either read or write. */\n  export type ContainerToken = AccessToken;\n\n  /**\n   * The scope for a container. This determines:\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\n   *  - the administrators who may configure RBAC permissions\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\n   * determines the region for data residency requirements.\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\n   */\n  export interface Scope {\n    /** iTwinId of the owner of this container. */\n    iTwinId: Id64String;\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\n    iModelId?: Id64String;\n    /** the user GUID an individual, if this container is private. */\n    ownerGuid?: GuidString;\n  }\n\n  /**\n   * Metadata about the use of a container so that:\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\n   *  - usage reports can aggregate types of containers\n   *  - applications can identify their containers\n   *  - applications can store properties about their containers\n   */\n  export interface Metadata {\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\n    containerType: string;\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\n    label: string;\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n    description?: string;\n    /** optional properties for the container */\n    json?: SettingsContainer;\n  }\n\n  /**\n   * Properties returned by queryContainersMetadata\n   */\n  export interface MetadataResponse extends Metadata {\n    /** The id of the container. */\n    containerId: string;\n    /** The iTwinId that owns this container. */\n    iTwinId?: GuidString;\n    /** The account iTwinId of the owning iTwin. */\n    accountITwinId?: GuidString;\n  }\n\n  /** Properties returned by `Service.requestToken` */\n  export interface TokenProps {\n    /**\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\n     * and must be refreshed before it expires\n     */\n    token: ContainerToken;\n    /** Scope of the container. */\n    scope: Scope;\n    /** Name of the blob storage provider. */\n    provider: Provider;\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\n    expiration: Date;\n    /** Metadata of the container. */\n    metadata: Metadata;\n    /** Base URI of the storage account that hosts the container */\n    baseUri: string;\n  }\n\n  /** The URI and Id of the container. */\n  export interface UriAndId {\n    baseUri: string;\n    containerId: ContainerId;\n  }\n\n  /** Information required to access an existing container. */\n  export interface AccessContainerProps extends UriAndId {\n    userToken: UserToken;\n  }\n\n  /** Information about a newly created container. */\n  export interface CreatedContainerProps extends UriAndId {\n    /** name of the blob storage provider. */\n    provider: Provider;\n  }\n\n  /**\n   * Access level to request for token.\n   * - `\"write\"`: request a writeable AccessToken.\n   * - `\"read\"`:  request a read-only AccessToken.\n   * - `\"admin\"`:  request a admin AccessToken.\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\n   * If the user is not authorized for the level requested, an exception is thrown.\n   */\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\n\n  /** Information required to request an access token for a container. */\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\n    accessLevel?: RequestAccessLevel;\n    /** the number of seconds before the token should expire.\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\n     */\n    durationSeconds?: number;\n  }\n\n  /** Information required to create a new container. */\n  export interface CreateNewContainerProps {\n    /** the scope of the new container */\n    scope: Scope;\n    /** metadata to be stored on the new container */\n    metadata: Metadata;\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\n    userToken: UserToken;\n    /**\n     * the id for the container. Useful for tests.\n     * @internal\n     */\n    containerId?: ContainerId;\n  }\n\n  /**\n   * Query Parameters for querying containers\n   */\n  export interface QueryContainerProps {\n    /** the iTwinId of the containers to query */\n    iTwinId: GuidString;\n    /** optional iModelId of the containers to query */\n    iModelId?: GuidString;\n    /** optional containerType of the containers to query */\n    containerType?: GuidString;\n    /** optional label of the containers to query */\n    label?: GuidString;\n    /** Whether to include parent iTwins in the query. Pass `true` to traverse the full parent chain, or `{ filter: \"accountOnly\" }` to include only the account iTwin. Defaults to `false`. */\n    includeParentITwins?: boolean | { filter: \"accountOnly\" };\n  }\n\n  /** Methods to create, delete, and access blob containers. */\n  export interface ContainerService {\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\n\n    /**\n     * Delete an existing blob container.\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\n     */\n    delete(container: AccessContainerProps): Promise<void>;\n\n    /** query the Scope for a container */\n    queryScope(container: AccessContainerProps): Promise<Scope>;\n\n    /** query the Metadata for a specific container */\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\n\n    /** Returns all containers and their metadata associated with a given iTwinId.\n     * Pass `includeParentITwins: { filter: \"accountOnly\" }` to also include the account iTwin container,\n     * without traversing any higher parent chain.\n     * Results can be further queried by label and containerType.\n     */\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\n\n    /** update the json properties of this container */\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\n\n    /** Request a `ContainerToken` for a container. Throws on failure. */\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\n  }\n}\n"]}

package/lib/esm/BriefcaseManager.d.ts

@@ -243,7 +243,9 @@ export declare class BriefcaseManager {
      * @throws IModelError If the briefcase is not open in read-write mode, if there are pending transactions when reversing, or if applying a changeset fails.
      * @returns A promise that resolves when all required changesets have been applied.
      */
-    static pullAndApplyChangesets(db: IModelDb, arg: PullChangesArgs): Promise<void>;
+    static pullAndApplyChangesets(db: IModelDb, arg: PullChangesArgs & {
+        noUpdateLoop?: boolean;
+    }): Promise<void>;
     /**
      * @internal
      * Creates a restore point for the specified briefcase database.