@itwin/core-backend 5.15.0-dev.18 → 5.15.0-dev.19

package/lib/cjs/BlobContainerService.d.ts

@@ -60,6 +60,8 @@ export declare namespace BlobContainer {
         containerId: string;
         /** The iTwinId that owns this container. */
         iTwinId?: GuidString;
+        /** The iModelId that owns this container. */
+        iModelId?: GuidString;
         /** The account iTwinId of the owning iTwin. */
         accountITwinId?: GuidString;
     }

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

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

@@ -41,9 +41,10 @@ export declare namespace SettingsEditor {
  */
 export declare namespace SettingsContainers {
     /**
-     * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.
-     * @returns The containerId, or `undefined` if no container exists.
-     * @throws if more than one settings container is found.
+     * Query the [[BlobContainer]] service for the iTwin-root settings container associated with a given iTwin.
+     * Only containers without an iModelId in their query metadata are considered.
+     * @returns The containerId, or `undefined` if no matching container is found.
+     * @throws if more than one matching container is found.
      */
     function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined>;
     /**

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;;;;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"}
+{"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;;;;;OAKG;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,CAyClH;CACF"}

package/lib/cjs/workspace/SettingsEditor.js

@@ -64,12 +64,13 @@ var SettingsContainers;
         return BlobContainerService_1.BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });
     }
     /**
-     * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.
-     * @returns The containerId, or `undefined` if no container exists.
-     * @throws if more than one settings container is found.
+     * Query the [[BlobContainer]] service for the iTwin-root settings container associated with a given iTwin.
+     * Only containers without an iModelId in their query metadata are considered.
+     * @returns The containerId, or `undefined` if no matching container is found.
+     * @throws if more than one matching container is found.
      */
     async function getITwinContainerId(iTwinId) {
-        const containers = await queryContainers({ iTwinId });
+        const containers = (await queryContainers({ iTwinId })).filter((container) => undefined === container.iModelId);
         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.`,
@@ -91,7 +92,8 @@ 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, includeParentITwins: { filter: "accountOnly" } });
+        const containers = (await queryContainers({ iTwinId, includeParentITwins: { filter: "accountOnly" } }))
+            .filter((container) => undefined === container.iModelId);
         if (containers.length === 0)
             return undefined;
         const seenITwins = new Set();

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,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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Workspace\r\n */\r\n\r\nimport { ITwinSettingsError } from \"@itwin/core-common\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\r\nimport { BlobContainer } from \"../BlobContainerService\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\r\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\r\nimport { SettingsPriority } from \"./Settings\";\r\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\r\n\r\n/** The default resource name used to store settings in a [[WorkspaceDb]].\r\n * This is the key under which all settings are stored in the SQLite `strings` table.\r\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\r\n * to this value, ensuring the read and write paths always agree on which key to use.\r\n * @internal\r\n */\r\nexport const settingsResourceName = \"settingsDictionary\";\r\n\r\n/** @internal */\r\nexport namespace SettingsEditor {\r\n  /** The type of workspace container used to store settings. */\r\n  export const containerType = \"settings\";\r\n\r\n  /**\r\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\r\n    return constructSettingsEditorForITwin(iTwinId);\r\n  }\r\n\r\n  /**\r\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\r\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\r\n    return getSettingsEditorForITwin(iTwinId);\r\n  }\r\n}\r\n\r\n/**\r\n * Help locate and obtain access to known containers with type \"settings\".\r\n * @internal\r\n */\r\nexport namespace SettingsContainers {\r\n  /**\r\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\r\n   * Automatically filters by `containerType: \"settings\"`.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  async function queryContainers(args: BlobContainer.QueryContainerProps): Promise<BlobContainer.MetadataResponse[]> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\r\n  }\r\n\r\n  /**\r\n   * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.\r\n   * @returns The containerId, or `undefined` if no container exists.\r\n   * @throws if more than one settings container is found.\r\n   */\r\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\r\n    const containers = await queryContainers({ iTwinId });\r\n    if (containers.length > 1) {\r\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\r\n        iTwinId,\r\n      });\r\n    }\r\n    return containers[0]?.containerId;\r\n  }\r\n\r\n  /**\r\n   * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.\r\n   * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings\r\n   * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at\r\n   * [[SettingsPriority.organization]].\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   * @note Requires [[BlobContainer.service]] to be configured.\r\n   */\r\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    const containers = await queryContainers({ iTwinId, includeParentITwins: { filter: \"accountOnly\" } });\r\n    if (containers.length === 0) return undefined;\r\n\r\n    const seenITwins = new Set<string>();\r\n    const results: WorkspaceDbSettingsProps[] = [];\r\n    for (const container of containers) {\r\n      const ownerITwinId = container.iTwinId;\r\n      if (undefined === ownerITwinId) {\r\n        ITwinSettingsError.throwError(\"missing-container-itwinid\", {\r\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.`,\r\n          iTwinId,\r\n        });\r\n      }\r\n      if (seenITwins.has(ownerITwinId)) {\r\n        ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n          message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,\r\n          iTwinId: ownerITwinId,\r\n        });\r\n      }\r\n      seenITwins.add(ownerITwinId);\r\n\r\n      const priority = container.accountITwinId === ownerITwinId ? SettingsPriority.organization : SettingsPriority.iTwin;\r\n      const tokenProps = await BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: \"read\", userToken });\r\n      results.push({\r\n        baseUri: tokenProps.baseUri,\r\n        containerId: container.containerId,\r\n        storageType: tokenProps.provider,\r\n        accessToken: tokenProps.token,\r\n        priority,\r\n        dbName: settingsWorkspaceDbName,\r\n        includePrerelease: true,\r\n      });\r\n    }\r\n\r\n    return results;\r\n  }\r\n}\r\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,CAiFlC;AAjFD,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;;;;;OAKG;IACI,KAAK,UAAU,mBAAmB,CAAC,OAAmB;QAC3D,MAAM,UAAU,GAAG,CAAC,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC;QAChH,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,CAAC,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;aACpG,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3D,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;IAzCqB,0CAAuB,0BAyC5C,CAAA;AACH,CAAC,EAjFgB,kBAAkB,kCAAlB,kBAAkB,QAiFlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Workspace\r\n */\r\n\r\nimport { ITwinSettingsError } from \"@itwin/core-common\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\r\nimport { BlobContainer } from \"../BlobContainerService\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\r\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\r\nimport { SettingsPriority } from \"./Settings\";\r\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\r\n\r\n/** The default resource name used to store settings in a [[WorkspaceDb]].\r\n * This is the key under which all settings are stored in the SQLite `strings` table.\r\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\r\n * to this value, ensuring the read and write paths always agree on which key to use.\r\n * @internal\r\n */\r\nexport const settingsResourceName = \"settingsDictionary\";\r\n\r\n/** @internal */\r\nexport namespace SettingsEditor {\r\n  /** The type of workspace container used to store settings. */\r\n  export const containerType = \"settings\";\r\n\r\n  /**\r\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\r\n    return constructSettingsEditorForITwin(iTwinId);\r\n  }\r\n\r\n  /**\r\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\r\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\r\n    return getSettingsEditorForITwin(iTwinId);\r\n  }\r\n}\r\n\r\n/**\r\n * Help locate and obtain access to known containers with type \"settings\".\r\n * @internal\r\n */\r\nexport namespace SettingsContainers {\r\n  /**\r\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\r\n   * Automatically filters by `containerType: \"settings\"`.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  async function queryContainers(args: BlobContainer.QueryContainerProps): Promise<BlobContainer.MetadataResponse[]> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\r\n  }\r\n\r\n  /**\r\n   * Query the [[BlobContainer]] service for the iTwin-root settings container associated with a given iTwin.\r\n   * Only containers without an iModelId in their query metadata are considered.\r\n   * @returns The containerId, or `undefined` if no matching container is found.\r\n   * @throws if more than one matching container is found.\r\n   */\r\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\r\n    const containers = (await queryContainers({ iTwinId })).filter((container) => undefined === container.iModelId);\r\n    if (containers.length > 1) {\r\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\r\n        iTwinId,\r\n      });\r\n    }\r\n    return containers[0]?.containerId;\r\n  }\r\n\r\n  /**\r\n   * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.\r\n   * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings\r\n   * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at\r\n   * [[SettingsPriority.organization]].\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   * @note Requires [[BlobContainer.service]] to be configured.\r\n   */\r\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    const containers = (await queryContainers({ iTwinId, includeParentITwins: { filter: \"accountOnly\" } }))\r\n      .filter((container) => undefined === container.iModelId);\r\n    if (containers.length === 0) return undefined;\r\n\r\n    const seenITwins = new Set<string>();\r\n    const results: WorkspaceDbSettingsProps[] = [];\r\n    for (const container of containers) {\r\n      const ownerITwinId = container.iTwinId;\r\n      if (undefined === ownerITwinId) {\r\n        ITwinSettingsError.throwError(\"missing-container-itwinid\", {\r\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.`,\r\n          iTwinId,\r\n        });\r\n      }\r\n      if (seenITwins.has(ownerITwinId)) {\r\n        ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n          message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,\r\n          iTwinId: ownerITwinId,\r\n        });\r\n      }\r\n      seenITwins.add(ownerITwinId);\r\n\r\n      const priority = container.accountITwinId === ownerITwinId ? SettingsPriority.organization : SettingsPriority.iTwin;\r\n      const tokenProps = await BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: \"read\", userToken });\r\n      results.push({\r\n        baseUri: tokenProps.baseUri,\r\n        containerId: container.containerId,\r\n        storageType: tokenProps.provider,\r\n        accessToken: tokenProps.token,\r\n        priority,\r\n        dbName: settingsWorkspaceDbName,\r\n        includePrerelease: true,\r\n      });\r\n    }\r\n\r\n    return results;\r\n  }\r\n}\r\n"]}

package/lib/esm/BlobContainerService.d.ts

@@ -60,6 +60,8 @@ export declare namespace BlobContainer {
         containerId: string;
         /** The iTwinId that owns this container. */
         iTwinId?: GuidString;
+        /** The iModelId that owns this container. */
+        iModelId?: GuidString;
         /** The account iTwinId of the owning iTwin. */
         accountITwinId?: GuidString;
     }

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,+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"}
+{"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,6CAA6C;QAC7C,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,+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,CAsL7B;AAtLD,WAAiB,aAAa;AAsL9B,CAAC,EAtLgB,aAAa,KAAb,aAAa,QAsL7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingsContainer } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\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.*/\r\n    label: string;\r\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. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingsContainer;\r\n  }\r\n\r\n  /**\r\n   * Properties returned by queryContainersMetadata\r\n   */\r\n  export interface MetadataResponse extends Metadata {\r\n    /** The id of the container. */\r\n    containerId: string;\r\n    /** The iTwinId that owns this container. */\r\n    iTwinId?: GuidString;\r\n    /** The account iTwinId of the owning iTwin. */\r\n    accountITwinId?: GuidString;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** Scope of the container. */\r\n    scope: Scope;\r\n    /** Name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n    /** Base URI of the storage account that hosts the container */\r\n    baseUri: string;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\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.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /**\r\n   * Query Parameters for querying containers\r\n   */\r\n  export interface QueryContainerProps {\r\n    /** the iTwinId of the containers to query */\r\n    iTwinId: GuidString;\r\n    /** optional iModelId of the containers to query */\r\n    iModelId?: GuidString;\r\n    /** optional containerType of the containers to query */\r\n    containerType?: GuidString;\r\n    /** optional label of the containers to query */\r\n    label?: GuidString;\r\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`. */\r\n    includeParentITwins?: boolean | { filter: \"accountOnly\" };\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a specific container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** Returns all containers and their metadata associated with a given iTwinId.\r\n     * Pass `includeParentITwins: { filter: \"accountOnly\" }` to also include the account iTwin container,\r\n     * without traversing any higher parent chain.\r\n     * Results can be further queried by label and containerType.\r\n     */\r\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\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,CAwL7B;AAxLD,WAAiB,aAAa;AAwL9B,CAAC,EAxLgB,aAAa,KAAb,aAAa,QAwL7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingsContainer } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\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.*/\r\n    label: string;\r\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. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingsContainer;\r\n  }\r\n\r\n  /**\r\n   * Properties returned by queryContainersMetadata\r\n   */\r\n  export interface MetadataResponse extends Metadata {\r\n    /** The id of the container. */\r\n    containerId: string;\r\n    /** The iTwinId that owns this container. */\r\n    iTwinId?: GuidString;\r\n    /** The iModelId that owns this container. */\r\n    iModelId?: GuidString;\r\n    /** The account iTwinId of the owning iTwin. */\r\n    accountITwinId?: GuidString;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** Scope of the container. */\r\n    scope: Scope;\r\n    /** Name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n    /** Base URI of the storage account that hosts the container */\r\n    baseUri: string;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\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.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /**\r\n   * Query Parameters for querying containers\r\n   */\r\n  export interface QueryContainerProps {\r\n    /** the iTwinId of the containers to query */\r\n    iTwinId: GuidString;\r\n    /** optional iModelId of the containers to query */\r\n    iModelId?: GuidString;\r\n    /** optional containerType of the containers to query */\r\n    containerType?: GuidString;\r\n    /** optional label of the containers to query */\r\n    label?: GuidString;\r\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`. */\r\n    includeParentITwins?: boolean | { filter: \"accountOnly\" };\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a specific container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** Returns all containers and their metadata associated with a given iTwinId.\r\n     * Pass `includeParentITwins: { filter: \"accountOnly\" }` to also include the account iTwin container,\r\n     * without traversing any higher parent chain.\r\n     * Results can be further queried by label and containerType.\r\n     */\r\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\n"]}

package/lib/esm/test/workspace/SettingsContainers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SettingsContainers.test.d.ts.map

package/lib/esm/test/workspace/SettingsContainers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsContainers.test.d.ts","sourceRoot":"","sources":["../../../../src/test/workspace/SettingsContainers.test.ts"],"names":[],"mappings":""}

package/lib/esm/test/workspace/SettingsContainers.test.js

@@ -0,0 +1,95 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { expect } from "chai";
+import * as sinon from "sinon";
+import { BlobContainer } from "../../BlobContainerService";
+import { IModelHost } from "../../IModelHost";
+import { SettingsPriority } from "../../workspace/Settings";
+import { SettingsContainers } from "../../workspace/SettingsEditor";
+const projectId = "11111111-1111-4111-8111-111111111111";
+const accountId = "22222222-2222-4222-8222-222222222222";
+const metadata = (containerId, iTwinId = projectId, iModelId) => ({
+    containerId, iTwinId, iModelId, accountITwinId: accountId, containerType: "settings", label: containerId,
+});
+const projectRoot = metadata("project-root");
+const accountRoot = metadata("account-root", accountId);
+const iModels = [metadata("iModel-a", projectId, "iModel-a-id"), metadata("iModel-b", projectId, "iModel-b-id")];
+describe("SettingsContainers root discovery", () => {
+    let savedService;
+    let query;
+    let requestToken;
+    beforeEach(() => {
+        savedService = BlobContainer.service;
+        sinon.stub(IModelHost, "getAccessToken").resolves("test-token");
+        query = sinon.stub();
+        requestToken = sinon.stub().callsFake(async ({ containerId }) => ({
+            token: "read-token", baseUri: "https://example.test", provider: "azure", containerId,
+        }));
+        BlobContainer.service = {
+            create: sinon.stub(), delete: sinon.stub(), queryScope: sinon.stub(), queryMetadata: sinon.stub(),
+            queryContainersMetadata: query, updateJson: sinon.stub(), requestToken,
+        };
+    });
+    afterEach(() => {
+        BlobContainer.service = savedService;
+        sinon.restore();
+    });
+    for (const { name, containers, expected } of [
+        { name: "project root and iModel containers", containers: [projectRoot, ...iModels], expected: "project-root" },
+        { name: "a sole iModel container without a project root", containers: iModels.slice(0, 1), expected: undefined },
+        { name: "iModel containers without a project root", containers: iModels, expected: undefined },
+    ]) {
+        it(`selects only the project root for write lookup with ${name}`, async () => {
+            query.resolves(containers);
+            expect(await SettingsContainers.getITwinContainerId(projectId)).to.equal(expected);
+            expect(query.calledOnceWithExactly("test-token", { iTwinId: projectId, containerType: "settings" })).to.be.true;
+            expect(requestToken.called).to.be.false;
+        });
+    }
+    for (const { name, containers, expected } of [
+        { name: "project root and iModel containers", containers: [projectRoot, ...iModels], expected: ["project-root"] },
+        { name: "a sole iModel container without a project root", containers: iModels.slice(0, 1), expected: [] },
+        { name: "iModel containers without a project root", containers: iModels, expected: [] },
+        {
+            name: "organization root, project root and iModel containers",
+            containers: [projectRoot, ...iModels, accountRoot, metadata("account-iModel", accountId, "account-iModel-id")],
+            expected: ["project-root", "account-root"],
+        },
+    ]) {
+        it(`selects only roots for read discovery with ${name}`, async () => {
+            query.resolves(containers);
+            const sources = await SettingsContainers.getITwinSettingsSources(projectId);
+            expect(sources?.map((source) => source.containerId) ?? []).to.deep.equal(expected);
+            expect(requestToken.getCalls().map((call) => call.args[0].containerId)).to.deep.equal(expected);
+            if (expected.length === 0)
+                expect(sources).to.be.undefined;
+            else
+                expect(sources?.map((source) => source.priority)).to.deep.equal(expected.map((id) => id === "account-root" ? SettingsPriority.organization : SettingsPriority.iTwin));
+        });
+    }
+    it("still rejects duplicate project roots for write lookup and read discovery", async () => {
+        query.resolves([projectRoot, ...iModels, metadata("duplicate-root")]);
+        for (const discover of [SettingsContainers.getITwinContainerId, SettingsContainers.getITwinSettingsSources]) {
+            try {
+                await discover(projectId);
+                expect.fail("Duplicate roots must be rejected");
+            }
+            catch (error) {
+                expect(error.message).to.include("Multiple iTwin settings containers");
+            }
+        }
+    });
+    it("still rejects duplicate organization roots for read discovery", async () => {
+        query.resolves([accountRoot, metadata("duplicate-account-root", accountId), ...iModels]);
+        try {
+            await SettingsContainers.getITwinSettingsSources(projectId);
+            expect.fail("Duplicate organization roots must be rejected");
+        }
+        catch (error) {
+            expect(error.message).to.include("Multiple iTwin settings containers");
+        }
+    });
+});
+//# sourceMappingURL=SettingsContainers.test.js.map

package/lib/esm/test/workspace/SettingsContainers.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsContainers.test.js","sourceRoot":"","sources":["../../../../src/test/workspace/SettingsContainers.test.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,MAAM,SAAS,GAAG,sCAAsC,CAAC;AACzD,MAAM,SAAS,GAAG,sCAAsC,CAAC;AACzD,MAAM,QAAQ,GAAG,CAAC,WAAmB,EAAE,OAAO,GAAG,SAAS,EAAE,QAAiB,EAAE,EAAE,CAAC,CAAC;IACjF,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW;CACzG,CAAC,CAAC;AACH,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AAC7C,MAAM,WAAW,GAAG,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;AACxD,MAAM,OAAO,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;AAEjH,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,IAAI,YAAwD,CAAC;IAC7D,IAAI,KAAsB,CAAC;IAC3B,IAAI,YAA6B,CAAC;IAElC,UAAU,CAAC,GAAG,EAAE;QACd,YAAY,GAAG,aAAa,CAAC,OAAO,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAChE,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QACrB,YAAY,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;YAChE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW;SACrF,CAAC,CAAC,CAAC;QACJ,aAAa,CAAC,OAAO,GAAG;YACtB,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,KAAK,CAAC,IAAI,EAAE;YACjG,uBAAuB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,YAAY;SACvE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,aAAa,CAAC,OAAO,GAAG,YAAY,CAAC;QACrC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI;QAC3C,EAAE,IAAI,EAAE,oCAAoC,EAAE,UAAU,EAAE,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE;QAC/G,EAAE,IAAI,EAAE,gDAAgD,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE;QAChH,EAAE,IAAI,EAAE,0CAA0C,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE;KAC/F,EAAE,CAAC;QACF,EAAE,CAAC,uDAAuD,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE;YAC3E,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC3B,MAAM,CAAC,MAAM,kBAAkB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnF,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAChH,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI;QAC3C,EAAE,IAAI,EAAE,oCAAoC,EAAE,UAAU,EAAE,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC,EAAE;QACjH,EAAE,IAAI,EAAE,gDAAgD,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QACzG,EAAE,IAAI,EAAE,0CAA0C,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QACvF;YACE,IAAI,EAAE,uDAAuD;YAC7D,UAAU,EAAE,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,gBAAgB,EAAE,SAAS,EAAE,mBAAmB,CAAC,CAAC;YAC9G,QAAQ,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC;SAC3C;KACF,EAAE,CAAC;QACF,EAAE,CAAC,8CAA8C,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE;YAClE,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC3B,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;YAC5E,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnF,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAChG,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBACvB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;;gBAEhC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,cAAc,CAAC,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1K,CAAC,CAAC,CAAC;IACL,CAAC;IAED,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;QACzF,KAAK,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACtE,KAAK,MAAM,QAAQ,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,EAAE,CAAC;YAC5G,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;YAClD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;YACpF,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,KAAK,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,wBAAwB,EAAE,SAAS,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;QACzF,IAAI,CAAC;YACH,MAAM,kBAAkB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;YAC5D,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAC/D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QACpF,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n\r\nimport { expect } from \"chai\";\r\nimport * as sinon from \"sinon\";\r\nimport { BlobContainer } from \"../../BlobContainerService\";\r\nimport { IModelHost } from \"../../IModelHost\";\r\nimport { SettingsPriority } from \"../../workspace/Settings\";\r\nimport { SettingsContainers } from \"../../workspace/SettingsEditor\";\r\n\r\nconst projectId = \"11111111-1111-4111-8111-111111111111\";\r\nconst accountId = \"22222222-2222-4222-8222-222222222222\";\r\nconst metadata = (containerId: string, iTwinId = projectId, iModelId?: string) => ({\r\n  containerId, iTwinId, iModelId, accountITwinId: accountId, containerType: \"settings\", label: containerId,\r\n});\r\nconst projectRoot = metadata(\"project-root\");\r\nconst accountRoot = metadata(\"account-root\", accountId);\r\nconst iModels = [metadata(\"iModel-a\", projectId, \"iModel-a-id\"), metadata(\"iModel-b\", projectId, \"iModel-b-id\")];\r\n\r\ndescribe(\"SettingsContainers root discovery\", () => {\r\n  let savedService: BlobContainer.ContainerService | undefined;\r\n  let query: sinon.SinonStub;\r\n  let requestToken: sinon.SinonStub;\r\n\r\n  beforeEach(() => {\r\n    savedService = BlobContainer.service;\r\n    sinon.stub(IModelHost, \"getAccessToken\").resolves(\"test-token\");\r\n    query = sinon.stub();\r\n    requestToken = sinon.stub().callsFake(async ({ containerId }) => ({\r\n      token: \"read-token\", baseUri: \"https://example.test\", provider: \"azure\", containerId,\r\n    }));\r\n    BlobContainer.service = {\r\n      create: sinon.stub(), delete: sinon.stub(), queryScope: sinon.stub(), queryMetadata: sinon.stub(),\r\n      queryContainersMetadata: query, updateJson: sinon.stub(), requestToken,\r\n    };\r\n  });\r\n\r\n  afterEach(() => {\r\n    BlobContainer.service = savedService;\r\n    sinon.restore();\r\n  });\r\n\r\n  for (const { name, containers, expected } of [\r\n    { name: \"project root and iModel containers\", containers: [projectRoot, ...iModels], expected: \"project-root\" },\r\n    { name: \"a sole iModel container without a project root\", containers: iModels.slice(0, 1), expected: undefined },\r\n    { name: \"iModel containers without a project root\", containers: iModels, expected: undefined },\r\n  ]) {\r\n    it(`selects only the project root for write lookup with ${name}`, async () => {\r\n      query.resolves(containers);\r\n      expect(await SettingsContainers.getITwinContainerId(projectId)).to.equal(expected);\r\n      expect(query.calledOnceWithExactly(\"test-token\", { iTwinId: projectId, containerType: \"settings\" })).to.be.true;\r\n      expect(requestToken.called).to.be.false;\r\n    });\r\n  }\r\n\r\n  for (const { name, containers, expected } of [\r\n    { name: \"project root and iModel containers\", containers: [projectRoot, ...iModels], expected: [\"project-root\"] },\r\n    { name: \"a sole iModel container without a project root\", containers: iModels.slice(0, 1), expected: [] },\r\n    { name: \"iModel containers without a project root\", containers: iModels, expected: [] },\r\n    {\r\n      name: \"organization root, project root and iModel containers\",\r\n      containers: [projectRoot, ...iModels, accountRoot, metadata(\"account-iModel\", accountId, \"account-iModel-id\")],\r\n      expected: [\"project-root\", \"account-root\"],\r\n    },\r\n  ]) {\r\n    it(`selects only roots for read discovery with ${name}`, async () => {\r\n      query.resolves(containers);\r\n      const sources = await SettingsContainers.getITwinSettingsSources(projectId);\r\n      expect(sources?.map((source) => source.containerId) ?? []).to.deep.equal(expected);\r\n      expect(requestToken.getCalls().map((call) => call.args[0].containerId)).to.deep.equal(expected);\r\n      if (expected.length === 0)\r\n        expect(sources).to.be.undefined;\r\n      else\r\n        expect(sources?.map((source) => source.priority)).to.deep.equal(expected.map((id) => id === \"account-root\" ? SettingsPriority.organization : SettingsPriority.iTwin));\r\n    });\r\n  }\r\n\r\n  it(\"still rejects duplicate project roots for write lookup and read discovery\", async () => {\r\n    query.resolves([projectRoot, ...iModels, metadata(\"duplicate-root\")]);\r\n    for (const discover of [SettingsContainers.getITwinContainerId, SettingsContainers.getITwinSettingsSources]) {\r\n      try {\r\n        await discover(projectId);\r\n        expect.fail(\"Duplicate roots must be rejected\");\r\n      } catch (error) {\r\n        expect((error as Error).message).to.include(\"Multiple iTwin settings containers\");\r\n      }\r\n    }\r\n  });\r\n\r\n  it(\"still rejects duplicate organization roots for read discovery\", async () => {\r\n    query.resolves([accountRoot, metadata(\"duplicate-account-root\", accountId), ...iModels]);\r\n    try {\r\n      await SettingsContainers.getITwinSettingsSources(projectId);\r\n      expect.fail(\"Duplicate organization roots must be rejected\");\r\n    } catch (error) {\r\n      expect((error as Error).message).to.include(\"Multiple iTwin settings containers\");\r\n    }\r\n  });\r\n});\r\n"]}

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

@@ -41,9 +41,10 @@ export declare namespace SettingsEditor {
  */
 export declare namespace SettingsContainers {
     /**
-     * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.
-     * @returns The containerId, or `undefined` if no container exists.
-     * @throws if more than one settings container is found.
+     * Query the [[BlobContainer]] service for the iTwin-root settings container associated with a given iTwin.
+     * Only containers without an iModelId in their query metadata are considered.
+     * @returns The containerId, or `undefined` if no matching container is found.
+     * @throws if more than one matching container is found.
      */
     function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined>;
     /**

package/lib/esm/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;;;;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"}
+{"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;;;;;OAKG;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,CAyClH;CACF"}

package/lib/esm/workspace/SettingsEditor.js

@@ -61,12 +61,13 @@ export var SettingsContainers;
         return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });
     }
     /**
-     * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.
-     * @returns The containerId, or `undefined` if no container exists.
-     * @throws if more than one settings container is found.
+     * Query the [[BlobContainer]] service for the iTwin-root settings container associated with a given iTwin.
+     * Only containers without an iModelId in their query metadata are considered.
+     * @returns The containerId, or `undefined` if no matching container is found.
+     * @throws if more than one matching container is found.
      */
     async function getITwinContainerId(iTwinId) {
-        const containers = await queryContainers({ iTwinId });
+        const containers = (await queryContainers({ iTwinId })).filter((container) => undefined === container.iModelId);
         if (containers.length > 1) {
             ITwinSettingsError.throwError("multiple-itwin-settings-containers", {
                 message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,
@@ -88,7 +89,8 @@ export var SettingsContainers;
         if (undefined === BlobContainer.service)
             ITwinSettingsError.throwError("blob-service-unavailable", { message: "BlobContainer.service is not available." });
         const userToken = await IModelHost.getAccessToken();
-        const containers = await queryContainers({ iTwinId, includeParentITwins: { filter: "accountOnly" } });
+        const containers = (await queryContainers({ iTwinId, includeParentITwins: { filter: "accountOnly" } }))
+            .filter((container) => undefined === container.iModelId);
         if (containers.length === 0)
             return undefined;
         const seenITwins = new Set();

package/lib/esm/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,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAGxD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,+BAA+B,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAEtH,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAEzD,gBAAgB;AAChB,MAAM,KAAW,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAC7B,8DAA8D;IACjD,4BAAa,GAAG,UAAU,CAAC;IAExC;;;;OAIG;IACI,KAAK,UAAU,iBAAiB,CAAC,OAAmB;QACzD,OAAO,+BAA+B,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAFqB,gCAAiB,oBAEtC,CAAA;IAED;;;;;OAKG;IACI,KAAK,UAAU,WAAW,CAAC,OAAmB;QACnD,OAAO,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAFqB,0BAAW,cAEhC,CAAA;AACH,CAAC,EAtBgB,cAAc,KAAd,cAAc,QAsB9B;AAED;;;GAGG;AACH,MAAM,KAAW,kBAAkB,CA+ElC;AA/ED,WAAiB,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,UAAU,eAAe,CAAC,IAAuC;QACpE,IAAI,SAAS,KAAK,aAAa,CAAC,OAAO;YACrC,kBAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO,aAAa,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,kBAAkB,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,aAAa,CAAC,OAAO;YACrC,kBAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,UAAU,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,kBAAkB,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,kBAAkB,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,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC;YACpH,MAAM,UAAU,GAAG,MAAM,aAAa,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,uBAAuB;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,KAAlB,kBAAkB,QA+ElC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Workspace\r\n */\r\n\r\nimport { ITwinSettingsError } from \"@itwin/core-common\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\r\nimport { BlobContainer } from \"../BlobContainerService\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\r\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\r\nimport { SettingsPriority } from \"./Settings\";\r\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\r\n\r\n/** The default resource name used to store settings in a [[WorkspaceDb]].\r\n * This is the key under which all settings are stored in the SQLite `strings` table.\r\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\r\n * to this value, ensuring the read and write paths always agree on which key to use.\r\n * @internal\r\n */\r\nexport const settingsResourceName = \"settingsDictionary\";\r\n\r\n/** @internal */\r\nexport namespace SettingsEditor {\r\n  /** The type of workspace container used to store settings. */\r\n  export const containerType = \"settings\";\r\n\r\n  /**\r\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\r\n    return constructSettingsEditorForITwin(iTwinId);\r\n  }\r\n\r\n  /**\r\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\r\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\r\n    return getSettingsEditorForITwin(iTwinId);\r\n  }\r\n}\r\n\r\n/**\r\n * Help locate and obtain access to known containers with type \"settings\".\r\n * @internal\r\n */\r\nexport namespace SettingsContainers {\r\n  /**\r\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\r\n   * Automatically filters by `containerType: \"settings\"`.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  async function queryContainers(args: BlobContainer.QueryContainerProps): Promise<BlobContainer.MetadataResponse[]> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\r\n  }\r\n\r\n  /**\r\n   * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.\r\n   * @returns The containerId, or `undefined` if no container exists.\r\n   * @throws if more than one settings container is found.\r\n   */\r\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\r\n    const containers = await queryContainers({ iTwinId });\r\n    if (containers.length > 1) {\r\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\r\n        iTwinId,\r\n      });\r\n    }\r\n    return containers[0]?.containerId;\r\n  }\r\n\r\n  /**\r\n   * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.\r\n   * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings\r\n   * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at\r\n   * [[SettingsPriority.organization]].\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   * @note Requires [[BlobContainer.service]] to be configured.\r\n   */\r\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    const containers = await queryContainers({ iTwinId, includeParentITwins: { filter: \"accountOnly\" } });\r\n    if (containers.length === 0) return undefined;\r\n\r\n    const seenITwins = new Set<string>();\r\n    const results: WorkspaceDbSettingsProps[] = [];\r\n    for (const container of containers) {\r\n      const ownerITwinId = container.iTwinId;\r\n      if (undefined === ownerITwinId) {\r\n        ITwinSettingsError.throwError(\"missing-container-itwinid\", {\r\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.`,\r\n          iTwinId,\r\n        });\r\n      }\r\n      if (seenITwins.has(ownerITwinId)) {\r\n        ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n          message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,\r\n          iTwinId: ownerITwinId,\r\n        });\r\n      }\r\n      seenITwins.add(ownerITwinId);\r\n\r\n      const priority = container.accountITwinId === ownerITwinId ? SettingsPriority.organization : SettingsPriority.iTwin;\r\n      const tokenProps = await BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: \"read\", userToken });\r\n      results.push({\r\n        baseUri: tokenProps.baseUri,\r\n        containerId: container.containerId,\r\n        storageType: tokenProps.provider,\r\n        accessToken: tokenProps.token,\r\n        priority,\r\n        dbName: settingsWorkspaceDbName,\r\n        includePrerelease: true,\r\n      });\r\n    }\r\n\r\n    return results;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SettingsEditor.js","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAGxD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,+BAA+B,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAEtH,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAEzD,gBAAgB;AAChB,MAAM,KAAW,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAC7B,8DAA8D;IACjD,4BAAa,GAAG,UAAU,CAAC;IAExC;;;;OAIG;IACI,KAAK,UAAU,iBAAiB,CAAC,OAAmB;QACzD,OAAO,+BAA+B,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAFqB,gCAAiB,oBAEtC,CAAA;IAED;;;;;OAKG;IACI,KAAK,UAAU,WAAW,CAAC,OAAmB;QACnD,OAAO,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAFqB,0BAAW,cAEhC,CAAA;AACH,CAAC,EAtBgB,cAAc,KAAd,cAAc,QAsB9B;AAED;;;GAGG;AACH,MAAM,KAAW,kBAAkB,CAiFlC;AAjFD,WAAiB,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,UAAU,eAAe,CAAC,IAAuC;QACpE,IAAI,SAAS,KAAK,aAAa,CAAC,OAAO;YACrC,kBAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,OAAO,aAAa,CAAC,OAAO,CAAC,uBAAuB,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,cAAc,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5H,CAAC;IAED;;;;;OAKG;IACI,KAAK,UAAU,mBAAmB,CAAC,OAAmB;QAC3D,MAAM,UAAU,GAAG,CAAC,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC;QAChH,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,kBAAkB,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,aAAa,CAAC,OAAO;YACrC,kBAAkB,CAAC,UAAU,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC,CAAC;QAEpH,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,CAAC,MAAM,eAAe,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;aACpG,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3D,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,kBAAkB,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,kBAAkB,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,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC;YACpH,MAAM,UAAU,GAAG,MAAM,aAAa,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,uBAAuB;gBAC/B,iBAAiB,EAAE,IAAI;aACxB,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAzCqB,0CAAuB,0BAyC5C,CAAA;AACH,CAAC,EAjFgB,kBAAkB,KAAlB,kBAAkB,QAiFlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Workspace\r\n */\r\n\r\nimport { ITwinSettingsError } from \"@itwin/core-common\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\r\nimport { BlobContainer } from \"../BlobContainerService\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\r\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\r\nimport { SettingsPriority } from \"./Settings\";\r\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\r\n\r\n/** The default resource name used to store settings in a [[WorkspaceDb]].\r\n * This is the key under which all settings are stored in the SQLite `strings` table.\r\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\r\n * to this value, ensuring the read and write paths always agree on which key to use.\r\n * @internal\r\n */\r\nexport const settingsResourceName = \"settingsDictionary\";\r\n\r\n/** @internal */\r\nexport namespace SettingsEditor {\r\n  /** The type of workspace container used to store settings. */\r\n  export const containerType = \"settings\";\r\n\r\n  /**\r\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\r\n    return constructSettingsEditorForITwin(iTwinId);\r\n  }\r\n\r\n  /**\r\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\r\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\r\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\r\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\r\n   */\r\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\r\n    return getSettingsEditorForITwin(iTwinId);\r\n  }\r\n}\r\n\r\n/**\r\n * Help locate and obtain access to known containers with type \"settings\".\r\n * @internal\r\n */\r\nexport namespace SettingsContainers {\r\n  /**\r\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\r\n   * Automatically filters by `containerType: \"settings\"`.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  async function queryContainers(args: BlobContainer.QueryContainerProps): Promise<BlobContainer.MetadataResponse[]> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\r\n  }\r\n\r\n  /**\r\n   * Query the [[BlobContainer]] service for the iTwin-root settings container associated with a given iTwin.\r\n   * Only containers without an iModelId in their query metadata are considered.\r\n   * @returns The containerId, or `undefined` if no matching container is found.\r\n   * @throws if more than one matching container is found.\r\n   */\r\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\r\n    const containers = (await queryContainers({ iTwinId })).filter((container) => undefined === container.iModelId);\r\n    if (containers.length > 1) {\r\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\r\n        iTwinId,\r\n      });\r\n    }\r\n    return containers[0]?.containerId;\r\n  }\r\n\r\n  /**\r\n   * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.\r\n   * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings\r\n   * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at\r\n   * [[SettingsPriority.organization]].\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   * @note Requires [[BlobContainer.service]] to be configured.\r\n   */\r\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\r\n    if (undefined === BlobContainer.service)\r\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\r\n\r\n    const userToken = await IModelHost.getAccessToken();\r\n    const containers = (await queryContainers({ iTwinId, includeParentITwins: { filter: \"accountOnly\" } }))\r\n      .filter((container) => undefined === container.iModelId);\r\n    if (containers.length === 0) return undefined;\r\n\r\n    const seenITwins = new Set<string>();\r\n    const results: WorkspaceDbSettingsProps[] = [];\r\n    for (const container of containers) {\r\n      const ownerITwinId = container.iTwinId;\r\n      if (undefined === ownerITwinId) {\r\n        ITwinSettingsError.throwError(\"missing-container-itwinid\", {\r\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.`,\r\n          iTwinId,\r\n        });\r\n      }\r\n      if (seenITwins.has(ownerITwinId)) {\r\n        ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\r\n          message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,\r\n          iTwinId: ownerITwinId,\r\n        });\r\n      }\r\n      seenITwins.add(ownerITwinId);\r\n\r\n      const priority = container.accountITwinId === ownerITwinId ? SettingsPriority.organization : SettingsPriority.iTwin;\r\n      const tokenProps = await BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: \"read\", userToken });\r\n      results.push({\r\n        baseUri: tokenProps.baseUri,\r\n        containerId: container.containerId,\r\n        storageType: tokenProps.provider,\r\n        accessToken: tokenProps.token,\r\n        priority,\r\n        dbName: settingsWorkspaceDbName,\r\n        includePrerelease: true,\r\n      });\r\n    }\r\n\r\n    return results;\r\n  }\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "5.15.0-dev.18",
+  "version": "5.15.0-dev.19",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "module": "lib/esm/core-backend.js",
@@ -27,11 +27,11 @@
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.4",
-    "@itwin/core-bentley": "5.15.0-dev.18",
-    "@itwin/core-quantity": "5.15.0-dev.18",
-    "@itwin/core-common": "5.15.0-dev.18",
-    "@itwin/core-geometry": "5.15.0-dev.18",
-    "@itwin/ecschema-metadata": "5.15.0-dev.18"
+    "@itwin/core-quantity": "5.15.0-dev.19",
+    "@itwin/core-bentley": "5.15.0-dev.19",
+    "@itwin/core-common": "5.15.0-dev.19",
+    "@itwin/ecschema-metadata": "5.15.0-dev.19",
+    "@itwin/core-geometry": "5.15.0-dev.19"
   },
   "peerDependenciesMeta": {
     "@opentelemetry/api": {
@@ -72,18 +72,18 @@
     "marked": "^14.1.3",
     "sql-formatter": "^15.4.6",
     "vite": "^6.4.4",
-    "@itwin/core-geometry": "5.15.0-dev.18",
-    "@itwin/core-common": "5.15.0-dev.18",
-    "@itwin/build-tools": "5.15.0-dev.18",
-    "@itwin/ecschema-locaters": "5.15.0-dev.18",
-    "@itwin/core-bentley": "5.15.0-dev.18",
-    "@itwin/core-quantity": "5.15.0-dev.18",
-    "@itwin/ecsql-common": "5.15.0-dev.18",
-    "internal-tools": "3.0.0-dev.69",
-    "@itwin/ecschema-metadata": "5.15.0-dev.18"
+    "@itwin/build-tools": "5.15.0-dev.19",
+    "@itwin/core-bentley": "5.15.0-dev.19",
+    "@itwin/core-geometry": "5.15.0-dev.19",
+    "@itwin/core-common": "5.15.0-dev.19",
+    "@itwin/ecschema-locaters": "5.15.0-dev.19",
+    "@itwin/core-quantity": "5.15.0-dev.19",
+    "@itwin/ecschema-metadata": "5.15.0-dev.19",
+    "@itwin/ecsql-common": "5.15.0-dev.19",
+    "internal-tools": "3.0.0-dev.69"
   },
   "dependencies": {
-    "@bentley/imodeljs-native": "5.15.32",
+    "@bentley/imodeljs-native": "5.15.37",
     "@itwin/object-storage-azure": "^3.0.4",
     "@azure/storage-blob": "^12.28.0",
     "form-data": "^4.0.6",