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

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/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.

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

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EACL,WAAW,EAAE,UAAU,EAA6B,UAAU,EAAmD,QAAQ,EAC1H,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,WAAW,EAAoB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EAEtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE9H,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D,OAAO,EAAgB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAIpE;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC;IAClE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,OAAO,GAAG,kBAAkB,CAAC,CAAC;CAC9D;AAED;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,qKAAqK;IACrK,OAAO,EAAE,cAAc,CAAC;IACxB,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,IAAI,CAAC;IACzB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAgB;IAChB,gBAAuB,6BAA6B,+BAA+B;IAEnF,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gGAAgG;WAClF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA8B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+DhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC;;OAEG;WACiB,kBAAkB,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAIrG;;OAEG;WACiB,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI7F,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;WACiB,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI1F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD9F;;;;;;;;;;;;;;OAcG;WACiB,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAuI7F;;;;;;;OAOG;WACiB,kBAAkB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAW1F;;;;;;OAMG;WACW,gBAAgB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAanE;;;;;;;OAOG;WACW,oBAAoB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAiB1E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAOlC;;;;;;OAMG;WACiB,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9E,4EAA4E;mBACvD,WAAW;IAuDhC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAe;IACtD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAQ;IACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAa;IACnD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAU;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAe;IAErD;;;;;;OAMG;WACW,sCAAsC,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,CAAC,cAAc,CAAC,GAAG,IAAI;IAuC7I;;;;;OAKG;WACW,sCAAsC,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM;IAI7E;;;;;;OAMG;WACW,6BAA6B,CAAC,CAAC,SAAS,aAAa,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,GAAG,IAAI;IAwB3I;;;;;;OAMG;WACW,gBAAgB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;IAMxE;;;;;;OAMG;WACkB,6BAA6B,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,aAAa,CAAC;IAWjH;;;;;;OAMG;WACW,gCAAgC,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAMvF;;;;;;OAMG;WACW,8BAA8B,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAMrF;;;;;OAKG;WACW,qBAAqB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAazE;;;;;MAKE;WACY,mBAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAavE;;;;;OAKG;WACW,mBAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,GAAE,OAAe,GAAG,IAAI;IAiBvF;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAapC"}
+{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EACL,WAAW,EAAE,UAAU,EAA6B,UAAU,EAAmD,QAAQ,EAC1H,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,WAAW,EAAoB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EAEtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE9H,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D,OAAO,EAAgB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAIpE;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC;IAClE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,OAAO,GAAG,kBAAkB,CAAC,CAAC;CAC9D;AAED;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,qKAAqK;IACrK,OAAO,EAAE,cAAc,CAAC;IACxB,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,IAAI,CAAC;IACzB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAgB;IAChB,gBAAuB,6BAA6B,+BAA+B;IAEnF,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gGAAgG;WAClF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA8B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+DhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC;;OAEG;WACiB,kBAAkB,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAIrG;;OAEG;WACiB,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI7F,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;WACiB,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI1F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD9F;;;;;;;;;;;;;;OAcG;WACiB,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG;QAAmB,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAuI3I;;;;;;;OAOG;WACiB,kBAAkB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAW1F;;;;;;OAMG;WACW,gBAAgB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAanE;;;;;;;OAOG;WACW,oBAAoB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAiB1E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAOlC;;;;;;OAMG;WACiB,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9E,4EAA4E;mBACvD,WAAW;IAuDhC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAe;IACtD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAQ;IACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAa;IACnD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAU;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAe;IAErD;;;;;;OAMG;WACW,sCAAsC,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,CAAC,cAAc,CAAC,GAAG,IAAI;IAuC7I;;;;;OAKG;WACW,sCAAsC,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM;IAI7E;;;;;;OAMG;WACW,6BAA6B,CAAC,CAAC,SAAS,aAAa,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,GAAG,IAAI;IAwB3I;;;;;;OAMG;WACW,gBAAgB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;IAMxE;;;;;;OAMG;WACkB,6BAA6B,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,aAAa,CAAC;IAWjH;;;;;;OAMG;WACW,gCAAgC,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAMvF;;;;;;OAMG;WACW,8BAA8B,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAMrF;;;;;OAKG;WACW,qBAAqB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAazE;;;;;MAKE;WACY,mBAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAavE;;;;;OAKG;WACW,mBAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,GAAE,OAAe,GAAG,IAAI;IAiBvF;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAapC"}

package/lib/esm/BriefcaseManager.js

@@ -351,10 +351,10 @@ export class BriefcaseManager {
         status = BriefcaseManager.deleteFolderIfEmpty(folderPathname);
         return status;
     }
-    static async applySingleChangeset(db, changesetFile, fastForward) {
+    static async applySingleChangeset(db, changesetFile, fastForward, noUpdateLoop) {
         if (changesetFile.changesType === ChangesetType.Schema || changesetFile.changesType === ChangesetType.SchemaSync)
             db.clearCaches(); // for schema changesets, statement caches may become invalid. Do this *before* applying, in case db needs to be closed (open statements hold db open.)
-        db[_nativeDb].applyChangeset(changesetFile, fastForward);
+        db[_nativeDb].applyChangeset(changesetFile, fastForward, noUpdateLoop);
         db.changeset = db[_nativeDb].getCurrentChangeset();
         // we're done with this changeset, delete it
         IModelJsFs.removeSync(changesetFile.pathname);
@@ -495,7 +495,7 @@ export class BriefcaseManager {
             const stopwatch = new StopWatch(`[${changeset.id}]`, true);
             Logger.logInfo(loggerCategory, `Starting application of changeset with id ${stopwatch.description}`);
             try {
-                await this.applySingleChangeset(db, changeset, false);
+                await this.applySingleChangeset(db, changeset, false, arg.noUpdateLoop);
                 Logger.logInfo(loggerCategory, `Applied changeset with id ${stopwatch.description} (${stopwatch.elapsedSeconds} seconds)`);
             }
             catch (err) {