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

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

@@ -1,250 +1,64 @@
 /** @packageDocumentation
  * @module Workspace
  */
-import { LocalFileName } from "@itwin/core-common";
 import { GuidString } from "@itwin/core-bentley";
-import { Setting, SettingName, SettingsContainer } from "./Settings";
-import { BlobContainer } from "../BlobContainerService";
-import { CloudSqliteContainer, GetWorkspaceContainerArgs, Workspace, WorkspaceContainerProps, WorkspaceDbName, WorkspaceDbNameAndVersion, WorkspaceDbVersion } from "./Workspace";
-import { SettingsDb, SettingsDbManifest, SettingsDbProps } from "./SettingsDb";
-import { _implementationProhibited } from "../internal/Symbols";
-import { CloudSqlite } from "../CloudSqlite";
-/** @beta */
+import { WorkspaceContainerId, WorkspaceDbSettingsProps } from "./Workspace";
+import { EditableWorkspaceContainer, WorkspaceEditor } from "./WorkspaceEditor";
+/** The default resource name used to store settings in a [[WorkspaceDb]].
+ * This is the key under which all settings are stored in the SQLite `strings` table.
+ * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults
+ * to this value, ensuring the read and write paths always agree on which key to use.
+ * @internal
+ */
+export declare const settingsResourceName = "settingsDictionary";
+/** @internal */
 export declare namespace SettingsEditor {
+    /** The type of workspace container used to store settings. */
+    const containerType = "settings";
     /**
      * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.
      * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.
      * @note It is illegal to have more than one SettingsEditor active in a single session.
      */
-    function construct(): SettingsEditor;
+    function constructForITwin(iTwinId: GuidString): Promise<{
+        editor: WorkspaceEditor;
+        container: EditableWorkspaceContainer;
+    }>;
     /**
-     * Create a new, empty, [[SettingsDb]] file on the local filesystem for importing settings dictionaries.
-     * @note Do not pass an untrusted or unintended path in `localFileName`.
-     * This helper creates or overwrites the file at that location; callers that need fail-if-exists behavior should check first.
+     * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.
+     * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.
+     * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.
+     * @note It is illegal to have more than one SettingsEditor active in a single session.
      */
-    function createEmptyDb(args: {
-        localFileName: LocalFileName;
-        manifest: SettingsDbManifest;
-    }): void;
-    /** Arguments for [[SettingsEditor.queryContainers]] and [[SettingsEditor.findContainers]]. */
-    interface QuerySettingsContainersArgs {
+    function getForITwin(iTwinId: GuidString): Promise<{
+        editor: WorkspaceEditor;
+        container: EditableWorkspaceContainer;
+    } | undefined>;
+}
+/**
+ * Help locate and obtain access to known containers with type "settings".
+ * @internal
+ */
+export declare namespace SettingsContainers {
+    /** Arguments for [[SettingsContainers.queryContainers]]. */
+    interface QueryArgs {
         /** The iTwinId whose settings containers should be queried. */
         iTwinId: GuidString;
-        /** Optional iModelId to further scope the query to containers associated with a specific iModel. */
-        iModelId?: GuidString;
         /** Optional label filter. */
         label?: string;
     }
     /**
-     * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.
-     * This is a convenience wrapper around `BlobContainer.service.queryContainersMetadata` that
-     * automatically filters by `containerType: "settings"`.
-     * @param args - The query arguments including the iTwinId.
-     * @returns A promise that resolves to the matching container metadata entries.
-     * @note Requires [[IModelHost.authorizationClient]] to be configured.
-     */
-    function queryContainers(args: QuerySettingsContainersArgs): Promise<BlobContainer.MetadataResponse[]>;
-}
-/** Arguments supplied to [[SettingsEditor.createNewCloudContainer]] to create a new [[EditableSettingsCloudContainer]].
- * The created container will automatically have `containerType: "settings"` in its metadata, enabling discovery
- * via `BlobContainer.service.queryContainersMetadata({ containerType: "settings" })`.
- * @beta
- */
-export interface CreateNewSettingsContainerArgs {
-    /**
-     * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,
-     * and the location of the datacenter.
-     */
-    scope: BlobContainer.Scope;
-    /** The manifest to be stored in the default SettingsDb in the new container. */
-    manifest: SettingsDbManifest;
-    /** Metadata stored by the BlobContainer service. The `containerType` field is omitted here because it is
-     * automatically set to `"settings"` when the container is created (mirroring the `"workspace"` convention for WorkspaceDb containers).
-     */
-    metadata: Omit<BlobContainer.Metadata, "containerType">;
-    /** The name of the default [[SettingsDb]] created inside the new container.
-     * Default: "settings-db";
-     */
-    dbName?: WorkspaceDbName;
-}
-/** Arguments supplied to [[EditableSettingsCloudContainer.createNewSettingsDbVersion]].
- * @beta
- */
-export interface CreateNewSettingsDbVersionArgs {
-    /**
-     * The properties that determine the source [[SettingsDb]] to serve as the basis for the new version.
-     * This is usually the latest version, but it is possible to create patches to older versions.
-     */
-    fromProps?: SettingsDbProps;
-    /** The type of version increment to apply to the source version. */
-    versionType: CloudSqlite.SemverIncrement;
-    /** For prerelease versions, a string that becomes part of the version name. */
-    identifier?: string;
-}
-/** The result of creating a new version of a [[SettingsDb]].
- * @beta
- */
-export interface SettingsDbVersionResult {
-    /** The name and version of the source SettingsDb. */
-    oldDb: WorkspaceDbNameAndVersion;
-    /** The name and version of the newly-created SettingsDb. */
-    newDb: WorkspaceDbNameAndVersion;
-}
-/** Arguments supplied to [[EditableSettingsCloudContainer.createDb]] to create a new [[SettingsDb]] in a container.
- * @beta
- */
-export interface CreateSettingsDbArgs {
-    /** The name of the new SettingsDb. Default: `"settings-db"`. */
-    dbName?: WorkspaceDbName;
-    /** The initial version of the new SettingsDb. Default: `"0.0.0"`. */
-    version?: WorkspaceDbVersion;
-    /** The manifest for the new SettingsDb. */
-    manifest: SettingsDbManifest;
-}
-/** Arguments supplied to [[EditableSettingsDb.updateSetting]] to add or update a single [[Setting]].
- * @beta
- */
-export interface UpdateSettingArgs {
-    /** The [[SettingName]] of the setting to add or update. */
-    readonly settingName: SettingName;
-    /** The new value for the setting. */
-    readonly value: Setting;
-}
-/**
- * A [[CloudSqliteContainer]] opened for editing settings by a [[SettingsEditor]].
- * You can create new [[SettingsDb]]s or new versions of existing [[SettingsDb]]s inside it.
- * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via
- * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,
- * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.
- * @note Settings containers are separate from workspace containers, providing independent write locks.
- * Editing settings does not block workspace resource editing, and vice versa.
- * @beta
- */
-export interface EditableSettingsCloudContainer extends CloudSqliteContainer {
-    /**
-     * Create a copy of an existing [[SettingsDb]] in this container with a new [[WorkspaceDbVersion]].
-     * The copy should be modified with new content before the write lock is released,
-     * and thereafter may never be modified again.
-     * @param args - The properties that determine the source SettingsDb and the version increment to apply.
-     * @returns A promise that resolves to an object containing the old and new SettingsDb names and versions.
-     */
-    createNewSettingsDbVersion(args: CreateNewSettingsDbVersionArgs): Promise<SettingsDbVersionResult>;
-    /**
-     * Create a new, empty [[SettingsDb]].
-     * @param args - The arguments for creating the new SettingsDb.
-     * @returns A promise that resolves to an EditableSettingsDb.
-     */
-    createDb(args: CreateSettingsDbArgs): Promise<EditableSettingsDb>;
-    /**
-     * Get the cloud properties of this container.
+     * 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.
      */
-    readonly cloudProps: WorkspaceContainerProps | undefined;
+    function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined>;
     /**
-     * Get an editable [[SettingsDb]] to add, delete, or update settings *within a newly created version* of a SettingsDb.
-     * Repeated calls that resolve to the same SettingsDb return the same cached instance.
-     * @param props - The properties of the SettingsDb.
-     * @returns An EditableSettingsDb for modifying settings.
-     * @throws if the targeted SettingsDb has already been published and is immutable. Use [[createNewSettingsDbVersion]] first to create an editable version.
-     */
-    getEditableDb(props?: SettingsDbProps): EditableSettingsDb;
-    /**
-     * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or
-     * [[abandonChanges]] to release the lock and discard your changes.
-     * Only one user can hold the write lock at any given time. However, readers can continue to read the published contents of the container while
-     * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].
-     * @param user - The name of the user acquiring the write lock.
-     * @throws if the write lock is already held by another user.
-     */
-    acquireWriteLock(user: string): void;
-    /**
-     * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It
-     * publishes and uploads the changes made to any [[SettingsDb]]s while the lock was held, after which those dbs become immutable.
-     */
-    releaseWriteLock(): void;
-    /**
-     * Abandon any changes made to the container and release the write lock. Any newly created versions of SettingsDbs are discarded.
-     */
-    abandonChanges(): void;
-}
-/**
- * An editable [[SettingsDb]]. This is used only by tools to allow administrators to create and modify SettingsDbs.
- * For cloud-based SettingsDbs, the container's write token must be obtained via [[EditableSettingsCloudContainer.acquireWriteLock]] before the methods in this interface may be used.
- * Normally, only admins will have write access.
- * Only one admin at a time may be editing a settings container.
- * @note Unlike [[EditableWorkspaceDb]], this interface only supports settings operations — no blob, file, or string resource methods.
- * @beta
- */
-export interface EditableSettingsDb extends SettingsDb {
-    /** The editable container that owns this SettingsDb. */
-    readonly container: EditableSettingsCloudContainer;
-    /**
-     * Update the contents of the manifest in this SettingsDb.
-     * @note This replaces the stored manifest entirely; omitted fields are lost.
-     * @param manifest - The updated manifest.
-     */
-    updateManifest(manifest: SettingsDbManifest): void;
-    /**
-     * Replace all settings in this SettingsDb with the given container.
-     * @param settings - The settings object to store.
-     */
-    updateSettings(settings: SettingsContainer): void;
-    /**
-     * Add or update a single [[Setting]] by name.
-     * If a setting with the given name already exists, its value is replaced.
-     * If it does not exist, it is added. Other settings are preserved.
-     * @param args - The arguments specifying the setting name and value.
-     */
-    updateSetting(args: UpdateSettingArgs): void;
-    /**
-     * Remove a single [[Setting]] by name. Other settings are preserved.
-     * @param settingName - The name of the setting to remove.
-     */
-    removeSetting(settingName: SettingName): void;
-}
-/** An object that permits administrators to modify the contents of settings containers.
- * Use [[SettingsEditor.construct]] to obtain a SettingsEditor, and [[close]] when finished using it.
- * Only one SettingsEditor may be in use at any given time.
- * Use [[getContainer]] to edit an existing container, or [[createNewCloudContainer]] to create a new container.
- * @beta
- */
-export interface SettingsEditor {
-    /** @internal */
-    [_implementationProhibited]: unknown;
-    /**
-     * The workspace dedicated to this editor.
-     * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s.
-     */
-    readonly workspace: Workspace;
-    /**
-     * Retrieves a container for the editor with the specified properties and access token.
-     */
-    getContainer(args: GetWorkspaceContainerArgs): EditableSettingsCloudContainer;
-    /**
-     * Asynchronously retrieves a container for the editor with the specified properties.
-     */
-    getContainerAsync(props: WorkspaceContainerProps): Promise<EditableSettingsCloudContainer>;
-    /**
-     * Creates a new cloud container for holding SettingsDbs, from the [[BlobContainer]] service.
-     * The container is automatically assigned `containerType: "settings"` in its metadata and
-     * initialized with a default [[SettingsDb]].
-     * @param args - The arguments for creating the container, including scope, metadata, and manifest.
-     * @returns A promise that resolves to the new EditableSettingsCloudContainer.
-     * @note The current user must have administrator rights for the iTwin for the container.
+     * Look up the settings container for an iTwin and obtain a read-only access token.
+     * @returns container props needed by [[IModelHost.getITwinWorkspace]].
      * @note Requires [[IModelHost.authorizationClient]] to be configured.
+     * @note Requires [[BlobContainer.service]] to be configured.
      */
-    createNewCloudContainer(args: CreateNewSettingsContainerArgs): Promise<EditableSettingsCloudContainer>;
-    /**
-     * Find and open existing settings containers by querying the [[BlobContainer]] service.
-     * This is a convenience method that queries for all settings containers matching the given iTwinId
-     * (and optionally iModelId), requests write access tokens, and opens each matching container.
-     * @param args - The query arguments including iTwinId and optionally iModelId and label.
-     * @returns A promise that resolves to an array of opened [[EditableSettingsCloudContainer]]s.
-     * @note Requires [[IModelHost.authorizationClient]] and [[BlobContainer.service]] to be configured.
-     */
-    findContainers(args: SettingsEditor.QuerySettingsContainersArgs): Promise<EditableSettingsCloudContainer[]>;
-    /**
-     * Closes this editor. All settings containers are dropped.
-     */
-    close(): void;
+    function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined>;
 }
 //# sourceMappingURL=SettingsEditor.d.ts.map

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;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAClL,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,YAAY;AACZ,yBAAiB,cAAc,CAAC;IAC9B;;;;OAIG;IACH,SAAgB,SAAS,IAAI,cAAc,CAE1C;IAED;;;;OAIG;IACH,SAAgB,aAAa,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,QAAQ,EAAE,kBAAkB,CAAA;KAAE,GAAG,IAAI,CAExG;IAED,8FAA8F;IAC9F,UAAiB,2BAA2B;QAC1C,+DAA+D;QAC/D,OAAO,EAAE,UAAU,CAAC;QACpB,oGAAoG;QACpG,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,6BAA6B;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;;;;OAOG;IACH,SAAsB,eAAe,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAE,CAAC,CAIlH;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAC3B,gFAAgF;IAChF,QAAQ,EAAE,kBAAkB,CAAC;IAC7B;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,oEAAoE;IACpE,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC;IACzC,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,KAAK,EAAE,yBAAyB,CAAC;IACjC,4DAA4D;IAC5D,KAAK,EAAE,yBAAyB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,qEAAqE;IACrE,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,2CAA2C;IAC3C,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,qCAAqC;IACrC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IAC1E;;;;;;OAMG;IACH,0BAA0B,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEnG;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAEzD;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,CAAC,EAAE,eAAe,GAAG,kBAAkB,CAAC;IAE3D;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,IAAI,IAAI,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;IAEnD;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAElD;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,yBAAyB,GAAG,8BAA8B,CAAC;IAE9E;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3F;;;;;;;;OAQG;IACH,uBAAuB,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAEvG;;;;;;;OAOG;IACH,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,2BAA2B,GAAG,OAAO,CAAC,8BAA8B,EAAE,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;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,4DAA4D;IAC5D,UAAiB,SAAS;QACxB,+DAA+D;QAC/D,OAAO,EAAE,UAAU,CAAC;QACpB,6BAA6B;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAeD;;;;OAIG;IACH,SAAsB,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CASxG;IAED;;;;;OAKG;IACH,SAAsB,uBAAuB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,wBAAwB,EAAE,GAAG,SAAS,CAAC,CAwBlH;CACF"}

package/lib/esm/workspace/SettingsEditor.js

@@ -1,50 +1,111 @@
 /*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
 /** @packageDocumentation
  * @module Workspace
  */
+import { ITwinSettingsError } from "@itwin/core-common";
 import { BlobContainer } from "../BlobContainerService";
-import { SettingsSqliteDb } from "../internal/workspace/SettingsSqliteDb";
-import { constructSettingsEditor } from "../internal/workspace/SettingsEditorImpl";
-import { _implementationProhibited } from "../internal/Symbols";
 import { IModelHost } from "../IModelHost";
-/** @beta */
+import { constructSettingsEditorForITwin, getSettingsEditorForITwin } from "../internal/workspace/SettingsEditorImpl";
+import { SettingsPriority } from "./Settings";
+import { settingsWorkspaceDbName } from "./SettingsDb";
+/** The default resource name used to store settings in a [[WorkspaceDb]].
+ * This is the key under which all settings are stored in the SQLite `strings` table.
+ * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults
+ * to this value, ensuring the read and write paths always agree on which key to use.
+ * @internal
+ */
+export const settingsResourceName = "settingsDictionary";
+/** @internal */
 export var SettingsEditor;
 (function (SettingsEditor) {
+    /** The type of workspace container used to store settings. */
+    SettingsEditor.containerType = "settings";
     /**
      * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.
      * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.
      * @note It is illegal to have more than one SettingsEditor active in a single session.
      */
-    function construct() {
-        return constructSettingsEditor();
+    async function constructForITwin(iTwinId) {
+        return constructSettingsEditorForITwin(iTwinId);
     }
-    SettingsEditor.construct = construct;
+    SettingsEditor.constructForITwin = constructForITwin;
     /**
-     * Create a new, empty, [[SettingsDb]] file on the local filesystem for importing settings dictionaries.
-     * @note Do not pass an untrusted or unintended path in `localFileName`.
-     * This helper creates or overwrites the file at that location; callers that need fail-if-exists behavior should check first.
+     * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.
+     * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.
+     * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.
+     * @note It is illegal to have more than one SettingsEditor active in a single session.
      */
-    function createEmptyDb(args) {
-        SettingsSqliteDb.createNewDb(args.localFileName, args);
+    async function getForITwin(iTwinId) {
+        return getSettingsEditorForITwin(iTwinId);
     }
-    SettingsEditor.createEmptyDb = createEmptyDb;
+    SettingsEditor.getForITwin = getForITwin;
+})(SettingsEditor || (SettingsEditor = {}));
+/**
+ * Help locate and obtain access to known containers with type "settings".
+ * @internal
+ */
+export var SettingsContainers;
+(function (SettingsContainers) {
     /**
      * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.
-     * This is a convenience wrapper around `BlobContainer.service.queryContainersMetadata` that
-     * automatically filters by `containerType: "settings"`.
-     * @param args - The query arguments including the iTwinId.
-     * @returns A promise that resolves to the matching container metadata entries.
+     * Automatically filters by `containerType: "settings"`.
      * @note Requires [[IModelHost.authorizationClient]] to be configured.
      */
     async function queryContainers(args) {
         if (undefined === BlobContainer.service)
-            throw new Error("BlobContainer.service is not available. Ensure IModelHost is initialized with a valid configuration.");
+            ITwinSettingsError.throwError("blob-service-unavailable", { message: "BlobContainer.service is not available." });
         const userToken = await IModelHost.getAccessToken();
-        return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: "settings" });
+        return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });
     }
-    SettingsEditor.queryContainers = queryContainers;
-})(SettingsEditor || (SettingsEditor = {}));
+    /**
+     * 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.
+     */
+    async function getITwinContainerId(iTwinId) {
+        const containers = await queryContainers({ iTwinId });
+        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.`,
+                iTwinId,
+            });
+        }
+        return containers[0]?.containerId;
+    }
+    SettingsContainers.getITwinContainerId = getITwinContainerId;
+    /**
+     * Look up the settings container for an iTwin and obtain a read-only access token.
+     * @returns container props needed by [[IModelHost.getITwinWorkspace]].
+     * @note Requires [[IModelHost.authorizationClient]] to be configured.
+     * @note Requires [[BlobContainer.service]] to be configured.
+     */
+    async function getITwinSettingsSources(iTwinId) {
+        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 });
+        if (!containers || containers.length === 0)
+            return undefined;
+        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.`,
+                iTwinId,
+            });
+        }
+        const tokenProps = await BlobContainer.service.requestToken({ containerId: containers[0].containerId, accessLevel: "read", userToken });
+        return [{
+                baseUri: tokenProps.baseUri,
+                containerId: containers[0].containerId,
+                storageType: tokenProps.provider,
+                accessToken: tokenProps.token,
+                priority: SettingsPriority.iTwin,
+                dbName: settingsWorkspaceDbName,
+                includePrerelease: true,
+            }];
+    }
+    SettingsContainers.getITwinSettingsSources = getITwinSettingsSources;
+})(SettingsContainers || (SettingsContainers = {}));
 //# sourceMappingURL=SettingsEditor.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"SettingsEditor.js","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAKH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,YAAY;AACZ,MAAM,KAAW,cAAc,CA0C9B;AA1CD,WAAiB,cAAc;IAC7B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,uBAAuB,EAAE,CAAC;IACnC,CAAC;IAFe,wBAAS,YAExB,CAAA;IAED;;;;OAIG;IACH,SAAgB,aAAa,CAAC,IAAoE;QAChG,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAFe,4BAAa,gBAE5B,CAAA;IAYD;;;;;;;OAOG;IACI,KAAK,UAAU,eAAe,CAAC,IAAiC;QACrE,IAAI,SAAS,KAAK,aAAa,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,sGAAsG,CAAC,CAAC;QACjK,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,UAAU,EAAE,CAAC,CAAC;IAC1G,CAAC;IAJqB,8BAAe,kBAIpC,CAAA;AACH,CAAC,EA1CgB,cAAc,KAAd,cAAc,QA0C9B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport { LocalFileName } from \"@itwin/core-common\";\nimport { GuidString } from \"@itwin/core-bentley\";\nimport { Setting, SettingName, SettingsContainer } from \"./Settings\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport { CloudSqliteContainer, GetWorkspaceContainerArgs, Workspace, WorkspaceContainerProps, WorkspaceDbName, WorkspaceDbNameAndVersion, WorkspaceDbVersion } from \"./Workspace\";\nimport { SettingsDb, SettingsDbManifest, SettingsDbProps } from \"./SettingsDb\";\nimport { SettingsSqliteDb } from \"../internal/workspace/SettingsSqliteDb\";\nimport { constructSettingsEditor } from \"../internal/workspace/SettingsEditorImpl\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\nimport { CloudSqlite } from \"../CloudSqlite\";\nimport { IModelHost } from \"../IModelHost\";\n\n/** @beta */\nexport namespace SettingsEditor {\n  /**\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export function construct(): SettingsEditor {\n    return constructSettingsEditor();\n  }\n\n  /**\n   * Create a new, empty, [[SettingsDb]] file on the local filesystem for importing settings dictionaries.\n   * @note Do not pass an untrusted or unintended path in `localFileName`.\n   * This helper creates or overwrites the file at that location; callers that need fail-if-exists behavior should check first.\n   */\n  export function createEmptyDb(args: { localFileName: LocalFileName; manifest: SettingsDbManifest }): void {\n    SettingsSqliteDb.createNewDb(args.localFileName, args);\n  }\n\n  /** Arguments for [[SettingsEditor.queryContainers]] and [[SettingsEditor.findContainers]]. */\n  export interface QuerySettingsContainersArgs {\n    /** The iTwinId whose settings containers should be queried. */\n    iTwinId: GuidString;\n    /** Optional iModelId to further scope the query to containers associated with a specific iModel. */\n    iModelId?: GuidString;\n    /** Optional label filter. */\n    label?: string;\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\n   * This is a convenience wrapper around `BlobContainer.service.queryContainersMetadata` that\n   * automatically filters by `containerType: \"settings\"`.\n   * @param args - The query arguments including the iTwinId.\n   * @returns A promise that resolves to the matching container metadata entries.\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   */\n  export async function queryContainers(args: QuerySettingsContainersArgs): Promise<BlobContainer.MetadataResponse[]> {\n    if (undefined === BlobContainer.service) throw new Error(\"BlobContainer.service is not available. Ensure IModelHost is initialized with a valid configuration.\");\n    const userToken = await IModelHost.getAccessToken();\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: \"settings\" });\n  }\n}\n\n/** Arguments supplied to [[SettingsEditor.createNewCloudContainer]] to create a new [[EditableSettingsCloudContainer]].\n * The created container will automatically have `containerType: \"settings\"` in its metadata, enabling discovery\n * via `BlobContainer.service.queryContainersMetadata({ containerType: \"settings\" })`.\n * @beta\n */\nexport interface CreateNewSettingsContainerArgs {\n  /**\n   * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,\n   * and the location of the datacenter.\n   */\n  scope: BlobContainer.Scope;\n  /** The manifest to be stored in the default SettingsDb in the new container. */\n  manifest: SettingsDbManifest;\n  /** Metadata stored by the BlobContainer service. The `containerType` field is omitted here because it is\n   * automatically set to `\"settings\"` when the container is created (mirroring the `\"workspace\"` convention for WorkspaceDb containers).\n   */\n  metadata: Omit<BlobContainer.Metadata, \"containerType\">;\n  /** The name of the default [[SettingsDb]] created inside the new container.\n   * Default: \"settings-db\";\n   */\n  dbName?: WorkspaceDbName;\n}\n\n/** Arguments supplied to [[EditableSettingsCloudContainer.createNewSettingsDbVersion]].\n * @beta\n */\nexport interface CreateNewSettingsDbVersionArgs {\n  /**\n   * The properties that determine the source [[SettingsDb]] to serve as the basis for the new version.\n   * This is usually the latest version, but it is possible to create patches to older versions.\n   */\n  fromProps?: SettingsDbProps;\n  /** The type of version increment to apply to the source version. */\n  versionType: CloudSqlite.SemverIncrement;\n  /** For prerelease versions, a string that becomes part of the version name. */\n  identifier?: string;\n}\n\n/** The result of creating a new version of a [[SettingsDb]].\n * @beta\n */\nexport interface SettingsDbVersionResult {\n  /** The name and version of the source SettingsDb. */\n  oldDb: WorkspaceDbNameAndVersion;\n  /** The name and version of the newly-created SettingsDb. */\n  newDb: WorkspaceDbNameAndVersion;\n}\n\n/** Arguments supplied to [[EditableSettingsCloudContainer.createDb]] to create a new [[SettingsDb]] in a container.\n * @beta\n */\nexport interface CreateSettingsDbArgs {\n  /** The name of the new SettingsDb. Default: `\"settings-db\"`. */\n  dbName?: WorkspaceDbName;\n  /** The initial version of the new SettingsDb. Default: `\"0.0.0\"`. */\n  version?: WorkspaceDbVersion;\n  /** The manifest for the new SettingsDb. */\n  manifest: SettingsDbManifest;\n}\n\n/** Arguments supplied to [[EditableSettingsDb.updateSetting]] to add or update a single [[Setting]].\n * @beta\n */\nexport interface UpdateSettingArgs {\n  /** The [[SettingName]] of the setting to add or update. */\n  readonly settingName: SettingName;\n  /** The new value for the setting. */\n  readonly value: Setting;\n}\n\n/**\n * A [[CloudSqliteContainer]] opened for editing settings by a [[SettingsEditor]].\n * You can create new [[SettingsDb]]s or new versions of existing [[SettingsDb]]s inside it.\n * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via\n * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,\n * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.\n * @note Settings containers are separate from workspace containers, providing independent write locks.\n * Editing settings does not block workspace resource editing, and vice versa.\n * @beta\n */\nexport interface EditableSettingsCloudContainer extends CloudSqliteContainer {\n  /**\n   * Create a copy of an existing [[SettingsDb]] in this container with a new [[WorkspaceDbVersion]].\n   * The copy should be modified with new content before the write lock is released,\n   * and thereafter may never be modified again.\n   * @param args - The properties that determine the source SettingsDb and the version increment to apply.\n   * @returns A promise that resolves to an object containing the old and new SettingsDb names and versions.\n   */\n  createNewSettingsDbVersion(args: CreateNewSettingsDbVersionArgs): Promise<SettingsDbVersionResult>;\n\n  /**\n   * Create a new, empty [[SettingsDb]].\n   * @param args - The arguments for creating the new SettingsDb.\n   * @returns A promise that resolves to an EditableSettingsDb.\n   */\n  createDb(args: CreateSettingsDbArgs): Promise<EditableSettingsDb>;\n\n  /**\n   * Get the cloud properties of this container.\n   */\n  readonly cloudProps: WorkspaceContainerProps | undefined;\n\n  /**\n   * Get an editable [[SettingsDb]] to add, delete, or update settings *within a newly created version* of a SettingsDb.\n   * Repeated calls that resolve to the same SettingsDb return the same cached instance.\n   * @param props - The properties of the SettingsDb.\n   * @returns An EditableSettingsDb for modifying settings.\n   * @throws if the targeted SettingsDb has already been published and is immutable. Use [[createNewSettingsDbVersion]] first to create an editable version.\n   */\n  getEditableDb(props?: SettingsDbProps): EditableSettingsDb;\n\n  /**\n   * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or\n   * [[abandonChanges]] to release the lock and discard your changes.\n   * Only one user can hold the write lock at any given time. However, readers can continue to read the published contents of the container while\n   * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].\n   * @param user - The name of the user acquiring the write lock.\n   * @throws if the write lock is already held by another user.\n   */\n  acquireWriteLock(user: string): void;\n\n  /**\n   * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It\n   * publishes and uploads the changes made to any [[SettingsDb]]s while the lock was held, after which those dbs become immutable.\n   */\n  releaseWriteLock(): void;\n\n  /**\n   * Abandon any changes made to the container and release the write lock. Any newly created versions of SettingsDbs are discarded.\n   */\n  abandonChanges(): void;\n}\n\n/**\n * An editable [[SettingsDb]]. This is used only by tools to allow administrators to create and modify SettingsDbs.\n * For cloud-based SettingsDbs, the container's write token must be obtained via [[EditableSettingsCloudContainer.acquireWriteLock]] before the methods in this interface may be used.\n * Normally, only admins will have write access.\n * Only one admin at a time may be editing a settings container.\n * @note Unlike [[EditableWorkspaceDb]], this interface only supports settings operations — no blob, file, or string resource methods.\n * @beta\n */\nexport interface EditableSettingsDb extends SettingsDb {\n  /** The editable container that owns this SettingsDb. */\n  readonly container: EditableSettingsCloudContainer;\n\n  /**\n   * Update the contents of the manifest in this SettingsDb.\n   * @note This replaces the stored manifest entirely; omitted fields are lost.\n   * @param manifest - The updated manifest.\n   */\n  updateManifest(manifest: SettingsDbManifest): void;\n\n  /**\n   * Replace all settings in this SettingsDb with the given container.\n   * @param settings - The settings object to store.\n   */\n  updateSettings(settings: SettingsContainer): void;\n\n  /**\n   * Add or update a single [[Setting]] by name.\n   * If a setting with the given name already exists, its value is replaced.\n   * If it does not exist, it is added. Other settings are preserved.\n   * @param args - The arguments specifying the setting name and value.\n   */\n  updateSetting(args: UpdateSettingArgs): void;\n\n  /**\n   * Remove a single [[Setting]] by name. Other settings are preserved.\n   * @param settingName - The name of the setting to remove.\n   */\n  removeSetting(settingName: SettingName): void;\n}\n\n/** An object that permits administrators to modify the contents of settings containers.\n * Use [[SettingsEditor.construct]] to obtain a SettingsEditor, and [[close]] when finished using it.\n * Only one SettingsEditor may be in use at any given time.\n * Use [[getContainer]] to edit an existing container, or [[createNewCloudContainer]] to create a new container.\n * @beta\n */\nexport interface SettingsEditor {\n  /** @internal */\n  [_implementationProhibited]: unknown;\n\n  /**\n   * The workspace dedicated to this editor.\n   * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s.\n   */\n  readonly workspace: Workspace;\n\n  /**\n   * Retrieves a container for the editor with the specified properties and access token.\n   */\n  getContainer(args: GetWorkspaceContainerArgs): EditableSettingsCloudContainer;\n\n  /**\n   * Asynchronously retrieves a container for the editor with the specified properties.\n   */\n  getContainerAsync(props: WorkspaceContainerProps): Promise<EditableSettingsCloudContainer>;\n\n  /**\n   * Creates a new cloud container for holding SettingsDbs, from the [[BlobContainer]] service.\n   * The container is automatically assigned `containerType: \"settings\"` in its metadata and\n   * initialized with a default [[SettingsDb]].\n   * @param args - The arguments for creating the container, including scope, metadata, and manifest.\n   * @returns A promise that resolves to the new EditableSettingsCloudContainer.\n   * @note The current user must have administrator rights for the iTwin for the container.\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   */\n  createNewCloudContainer(args: CreateNewSettingsContainerArgs): Promise<EditableSettingsCloudContainer>;\n\n  /**\n   * Find and open existing settings containers by querying the [[BlobContainer]] service.\n   * This is a convenience method that queries for all settings containers matching the given iTwinId\n   * (and optionally iModelId), requests write access tokens, and opens each matching container.\n   * @param args - The query arguments including iTwinId and optionally iModelId and label.\n   * @returns A promise that resolves to an array of opened [[EditableSettingsCloudContainer]]s.\n   * @note Requires [[IModelHost.authorizationClient]] and [[BlobContainer.service]] to be configured.\n   */\n  findContainers(args: SettingsEditor.QuerySettingsContainersArgs): Promise<EditableSettingsCloudContainer[]>;\n\n  /**\n   * Closes this editor. All settings containers are dropped.\n   */\n  close(): void;\n}\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,CAqElC;AArED,WAAiB,kBAAkB;IASjC;;;;OAIG;IACH,KAAK,UAAU,eAAe,CAAC,IAAe;QAC5C,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;;;;;OAKG;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,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAC7D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,kBAAkB,CAAC,UAAU,CAAC,oCAAoC,EAAE;gBAClE,OAAO,EAAE,sDAAsD,OAAO,qDAAqD;gBAC3H,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACxI,OAAO,CAAC;gBACN,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW;gBACtC,WAAW,EAAE,UAAU,CAAC,QAAQ;gBAChC,WAAW,EAAE,UAAU,CAAC,KAAK;gBAC7B,QAAQ,EAAE,gBAAgB,CAAC,KAAK;gBAChC,MAAM,EAAE,uBAAuB;gBAC/B,iBAAiB,EAAE,IAAI;aACxB,CAAC,CAAC;IACL,CAAC;IAxBqB,0CAAuB,0BAwB5C,CAAA;AACH,CAAC,EArEgB,kBAAkB,KAAlB,kBAAkB,QAqElC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport { ITwinSettingsError } from \"@itwin/core-common\";\nimport { GuidString } from \"@itwin/core-bentley\";\nimport { WorkspaceContainerId, WorkspaceDbSettingsProps } from \"./Workspace\";\nimport { BlobContainer } from \"../BlobContainerService\";\nimport { IModelHost } from \"../IModelHost\";\nimport { constructSettingsEditorForITwin, getSettingsEditorForITwin } from \"../internal/workspace/SettingsEditorImpl\";\nimport { EditableWorkspaceContainer, WorkspaceEditor } from \"./WorkspaceEditor\";\nimport { SettingsPriority } from \"./Settings\";\nimport { settingsWorkspaceDbName } from \"./SettingsDb\";\n\n/** The default resource name used to store settings in a [[WorkspaceDb]].\n * This is the key under which all settings are stored in the SQLite `strings` table.\n * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults\n * to this value, ensuring the read and write paths always agree on which key to use.\n * @internal\n */\nexport const settingsResourceName = \"settingsDictionary\";\n\n/** @internal */\nexport namespace SettingsEditor {\n  /** The type of workspace container used to store settings. */\n  export const containerType = \"settings\";\n\n  /**\n   * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export async function constructForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer }> {\n    return constructSettingsEditorForITwin(iTwinId);\n  }\n\n  /**\n   * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.\n   * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.\n   * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.\n   * @note It is illegal to have more than one SettingsEditor active in a single session.\n   */\n  export async function getForITwin(iTwinId: GuidString): Promise<{ editor: WorkspaceEditor; container: EditableWorkspaceContainer } | undefined> {\n    return getSettingsEditorForITwin(iTwinId);\n  }\n}\n\n/**\n * Help locate and obtain access to known containers with type \"settings\".\n * @internal\n */\nexport namespace SettingsContainers {\n  /** Arguments for [[SettingsContainers.queryContainers]]. */\n  export interface QueryArgs {\n    /** The iTwinId whose settings containers should be queried. */\n    iTwinId: GuidString;\n    /** Optional label filter. */\n    label?: string;\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\n   * Automatically filters by `containerType: \"settings\"`.\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   */\n  async function queryContainers(args: QueryArgs): Promise<BlobContainer.MetadataResponse[]> {\n    if (undefined === BlobContainer.service)\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\n\n    const userToken = await IModelHost.getAccessToken();\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });\n  }\n\n  /**\n   * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.\n   * @returns The containerId, or `undefined` if no container exists.\n   * @throws if more than one settings container is found.\n   */\n  export async function getITwinContainerId(iTwinId: GuidString): Promise<WorkspaceContainerId | undefined> {\n    const containers = await queryContainers({ iTwinId });\n    if (containers.length > 1) {\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\n        iTwinId,\n      });\n    }\n    return containers[0]?.containerId;\n  }\n\n  /**\n   * Look up the settings container for an iTwin and obtain a read-only access token.\n   * @returns container props needed by [[IModelHost.getITwinWorkspace]].\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\n   * @note Requires [[BlobContainer.service]] to be configured.\n   */\n  export async function getITwinSettingsSources(iTwinId: GuidString): Promise<WorkspaceDbSettingsProps[] | undefined> {\n    if (undefined === BlobContainer.service)\n      ITwinSettingsError.throwError(\"blob-service-unavailable\", { message: \"BlobContainer.service is not available.\" });\n\n    const userToken = await IModelHost.getAccessToken();\n    const containers = await queryContainers({ iTwinId });\n    if (!containers || containers.length === 0) return undefined;\n    if (containers.length > 1) {\n      ITwinSettingsError.throwError(\"multiple-itwin-settings-containers\", {\n        message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,\n        iTwinId,\n      });\n    }\n\n    const tokenProps = await BlobContainer.service.requestToken({ containerId: containers[0].containerId, accessLevel: \"read\", userToken });\n    return [{\n      baseUri: tokenProps.baseUri,\n      containerId: containers[0].containerId,\n      storageType: tokenProps.provider,\n      accessToken: tokenProps.token,\n      priority: SettingsPriority.iTwin,\n      dbName: settingsWorkspaceDbName,\n      includePrerelease: true,\n    }];\n  }\n}\n"]}

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

@@ -6,7 +6,6 @@ import { DbCloudContainerInfo, LocalDirName, LocalFileName } from "@itwin/core-c
 import { CloudSqlite } from "../CloudSqlite";
 import { SQLiteDb } from "../SQLiteDb";
 import { SettingName, Settings, SettingsDictionary, SettingsPriority } from "./Settings";
-import { GetSettingsDbArgs, SettingsDb } from "./SettingsDb";
 import type { IModelJsNative } from "@bentley/imodeljs-native";
 import { _implementationProhibited } from "../internal/Symbols";
 /** The unique identifier of a [[WorkspaceContainer]]. This becomes the base name for a local file directory holding the container's [[WorkspaceDb]]s.
@@ -144,8 +143,8 @@ export interface WorkspaceDbLoadErrors extends ITwinError {
   */
 export interface WorkspaceDbSettingsProps extends WorkspaceDbCloudProps {
     /** The name of the resource holding the stringified JSON of the [[SettingsDictionary]].
-     * Defaults to `"settings"`, which matches the key used by
-     * [[EditableSettingsDb.updateSettings]] to write settings. You should generally omit this
+     * Defaults to `"settingsDictionary"`, which matches the key used by
+     * [[EditableWorkspaceDb.updateSettingsResource]] to write settings. You should generally omit this
      * field unless you need to load settings stored under a non-standard key.
      */
     resourceName?: string;
@@ -283,6 +282,10 @@ export interface GetWorkspaceContainerArgs extends WorkspaceContainerProps {
 export interface Workspace {
     /** @internal */
     [_implementationProhibited]: unknown;
+    /** The settings db sources used to populate this workspace, if available.
+     * Useful for reloading the same workspace data later without querying container discovery services.
+     */
+    settingsSources?: WorkspaceDbSettingsProps | WorkspaceDbSettingsProps[];
     /** The directory for local WorkspaceDb files with the name `${containerId}/${dbId}.itwin-workspace`.
      * @internal
      */
@@ -324,13 +327,6 @@ export interface Workspace {
     problems?: WorkspaceDbLoadError[]): Promise<void>;
     /** Get a single [[WorkspaceDb]].  */
     getWorkspaceDb(props: WorkspaceDbCloudProps): Promise<WorkspaceDb>;
-    /** Get a [[SettingsDb]] from a previously-loaded settings container in this workspace.
-     * @param args The arguments identifying which SettingsDb to retrieve.
-     * @returns The SettingsDb from the matching container.
-     * @throws if no container matching [[GetSettingsDbArgs.containerId]] has been loaded into this workspace, or if the container does not hold a SettingsDb.
-     * @note The container must already be loaded via [[getContainer]] or [[getContainerAsync]] before calling this method.
-     */
-    getSettingsDb(args: GetSettingsDbArgs): SettingsDb;
     /**
      * Resolve the value of all [[Setting]]s from this workspace with the supplied `settingName` into an array of [[WorkspaceDbCloudProps]]
      * that can be used to query or load workspace resources. The settings must each be an array of type [[WorkspaceDbSettingsProps]].
@@ -360,7 +356,7 @@ export interface Workspace {
     }): Promise<WorkspaceDb[]>;
 }
 /**
- * Base interface for containers backed by [[CloudSqlite]] that hold versioned databases (e.g. [[WorkspaceDb]]s or [[SettingsDb]]s).
+ * Base interface for containers backed by [[CloudSqlite]] that hold versioned databases (e.g. [[WorkspaceDb]]s).
  * Provides the shared infrastructure for cloud access, local file caching, and semver-based database resolution.
  * @note Not every container is associated with a [[CloudSqlite.CloudContainer]] — containers may also be loaded from the local file system.
  * In this case, [[cloudContainer]] will be `undefined`.

package/lib/esm/workspace/Workspace.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAU,QAAQ,EAAoB,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACzF,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,QAAQ,CAAC,WAAW,CAAC,oBAAoB,EAAE,aAAa,CAAC;IACxG;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,+DAA+D;IAC/D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,sFAAsF;IACtF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,SAAS,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC,cAAc,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAAC,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,yBAAyB;IACjE;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACrC,sJAAsJ;IACtJ,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB,EAAE,uBAAuB,EAAE,oBAAoB;CAAG;AAEjH;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAE1F;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,qCAAqC;IACrC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC1E,kFAAkF;IAClF,QAAQ,EAAE,iCAAiC,CAAC;CAC7C;AAED;;;;;IAKI;AACJ,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,wHAAwH;IACxH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,mFAAmF;IACnF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,qEAAqE;IACrE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,8HAA8H;IAC9H,SAAS,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC9D,qEAAqE;IACrE,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACvC;AAED;;;IAGI;AACJ,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACrC,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IACtC,4JAA4J;IAC5J,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACvC,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;IAErC;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb,wHAAwH;IACxH,KAAK,IAAI,IAAI,CAAC;IAEd,wDAAwD;IACxD,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,MAAM,GAAG,SAAS,CAAC;IAE9D,wDAAwD;IACxD,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,GAAG,SAAS,CAAC;IAEhE;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE/D;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,cAAc,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;IAEnG;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAAC;IAEtE;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE1D,gBAAgB;IAChB,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,GAAG;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;KAAE,GAAG,SAAS,CAAC;CACtI;AAED;;IAEI;AACJ,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,kIAAkI;IAClI,aAAa,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,8CAA8C;IAC9C,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,mEAAmE;IACnE,aAAa,IAAI,WAAW,CAAC,UAAU,CAAC;IAExC;;;;OAIG;IACH,aAAa,CAAC,WAAW,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAEjF;;;;;;MAME;IACF,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,yBAAyB,GAAG,kBAAkB,CAAC;IAEnE;;;;OAIG;IACH,sBAAsB;IACpB,8IAA8I;IAC9I,KAAK,EAAE,wBAAwB,GAAG,wBAAwB,EAAE;IAC5D,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,oBAAoB,EAAE,GAChC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,qCAAqC;IACrC,cAAc,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnE;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,UAAU,CAAC;IAEnD;;;;;;;;OAQG;IACH,yBAAyB;IACvB,+BAA+B;IAC/B,WAAW,EAAE,WAAW;IACxB,0KAA0K;IAC1K,MAAM,CAAC,EAAE,SAAS,CAAC,YAAY,GAAG,qBAAqB,EAAE,CAAC;IAE5D;;;;;;OAMG;IACH,eAAe,CACb,IAAI,EAAE,SAAS,CAAC,mBAAmB,GAAG;QACpC,+HAA+H;QAC/H,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAClC,qHAAqH;QACrH,MAAM,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;KACjC,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;IACrD,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,uBAAuB,CAAC;IAE5C;;;OAGG;IACH,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;CACjE;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,gBAAgB;IAChB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,cAAc,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,WAAW,CAAC;IAEtD;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;CAChD;AAMD;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC;;;;OAIG;IACI,MAAM,kBAAkB,QAAwC,CAAC;CACzE;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,WAAW,CAAA;CAAE,CAAC,KAAK,IAAI,CAAC;AAE/G;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,GAAG,EAAE,WAAW,EAAE,CAAC;IACnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC1E,iFAAiF;IACjF,QAAQ,EAAE,+BAA+B,CAAC;CAC3C;AAaD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,GAAG,EAAE,WAAW,EAAE,CAAC;IACnB,wCAAwC;IACxC,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,SAAS,CAAC;IACzB;;;OAGG;IACI,IAAI,qBAAqB,MAAO,qBAAqB,SAK3D,CAAC;IAEF,+IAA+I;IAC/I,UAAiB,wBAAwB;QACvC,qCAAqC;QACrC,IAAI,EAAE,kBAAkB,CAAC;QACzB,4DAA4D;QAC5D,IAAI,EAAE,WAAW,CAAC;KACnB;IAED;;;OAGG;IACI,IAAI,4BAA4B,WAAY,wBAAwB,SAE1E,CAAC;IAEF;;OAEG;IACH,KAAY,mBAAmB,GAAG;QAAE,QAAQ,CAAC,GAAG,EAAE,qBAAqB,EAAE,CAAC;QAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;QAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC;IAExK;;OAEG;IACH,KAAY,YAAY,GAAG;IACzB,uDAAuD;IACvD,MAAM,EAAE,qBAAqB;IAC7B;;OAEG;IACH,IAAI,EAAE,kBAAkB,KACrB,OAAO,CAAC;IAEb;;;;;OAKG;IACH,SAAgB,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,GAAG,MAAM,GAAG,SAAS,CAEpF;IAED;;;;;OAKG;IACH,SAAgB,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,UAAU,GAAG,SAAS,CAEtF;IAED;;;OAGG;IACH,SAAgB,cAAc,CAAC,IAAI,EAAE,2BAA2B,GAAG,IAAI,CAgBtE;CACF"}
+{"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAU,QAAQ,EAAoB,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACzF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,QAAQ,CAAC,WAAW,CAAC,oBAAoB,EAAE,aAAa,CAAC;IACxG;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,+DAA+D;IAC/D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,sFAAsF;IACtF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC,SAAS,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC,cAAc,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAAC,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,yBAAyB;IACjE;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACrC,sJAAsJ;IACtJ,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB,EAAE,uBAAuB,EAAE,oBAAoB;CAAI;AAElH;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAE1F;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,qCAAqC;IACrC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC1E,kFAAkF;IAClF,QAAQ,EAAE,iCAAiC,CAAC;CAC7C;AAED;;;;;IAKI;AACJ,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,wHAAwH;IACxH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,mFAAmF;IACnF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,qEAAqE;IACrE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,8HAA8H;IAC9H,SAAS,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC9D,qEAAqE;IACrE,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACvC;AAED;;;IAGI;AACJ,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACrC,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IACtC,4JAA4J;IAC5J,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACvC,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAC;IAErC;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb,wHAAwH;IACxH,KAAK,IAAI,IAAI,CAAC;IAEd,wDAAwD;IACxD,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,MAAM,GAAG,SAAS,CAAC;IAE9D,wDAAwD;IACxD,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,UAAU,GAAG,SAAS,CAAC;IAEhE;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE/D;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAO,EAAE,qBAAqB,EAAE,cAAc,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;IAEnG;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAAC;IAEtE;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE1D,gBAAgB;IAChB,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,GAAG;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;KAAE,GAAG,SAAS,CAAC;CACtI;AAED;;IAEI;AACJ,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,kIAAkI;IAClI,aAAa,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE,8CAA8C;IAC9C,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,eAAe,CAAC,EAAE,wBAAwB,GAAG,wBAAwB,EAAE,CAAC;IAExE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,mEAAmE;IACnE,aAAa,IAAI,WAAW,CAAC,UAAU,CAAC;IAExC;;;;OAIG;IACH,aAAa,CAAC,WAAW,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAEjF;;;;;;MAME;IACF,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE/E;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,yBAAyB,GAAG,kBAAkB,CAAC;IAEnE;;;;OAIG;IACH,sBAAsB;IACpB,8IAA8I;IAC9I,KAAK,EAAE,wBAAwB,GAAG,wBAAwB,EAAE;IAC5D,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,oBAAoB,EAAE,GAChC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,qCAAqC;IACrC,cAAc,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnE;;;;;;;;OAQG;IACH,yBAAyB;IACvB,+BAA+B;IAC/B,WAAW,EAAE,WAAW;IACxB,0KAA0K;IAC1K,MAAM,CAAC,EAAE,SAAS,CAAC,YAAY,GAAG,qBAAqB,EAAE,CAAC;IAE5D;;;;;;OAMG;IACH,eAAe,CACb,IAAI,EAAE,SAAS,CAAC,mBAAmB,GAAG;QACpC,+HAA+H;QAC/H,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAClC,qHAAqH;QACrH,MAAM,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;KACjC,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;IACrD,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,uBAAuB,CAAC;IAE5C;;;OAGG;IACH,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,mBAAmB,CAAC;CACjE;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,gBAAgB;IAChB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,cAAc,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,WAAW,CAAC;IAEtD;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;CAChD;AAMD;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC;;;;OAIG;IACI,MAAM,kBAAkB,QAAwC,CAAC;CACzE;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,WAAW,CAAA;CAAE,CAAC,KAAK,IAAI,CAAC;AAE/G;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,GAAG,EAAE,WAAW,EAAE,CAAC;IACnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC1E,iFAAiF;IACjF,QAAQ,EAAE,+BAA+B,CAAC;CAC3C;AAaD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,GAAG,EAAE,WAAW,EAAE,CAAC;IACnB,wCAAwC;IACxC,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,SAAS,CAAC;IACzB;;;OAGG;IACI,IAAI,qBAAqB,MAAO,qBAAqB,SAK3D,CAAC;IAEF,+IAA+I;IAC/I,UAAiB,wBAAwB;QACvC,qCAAqC;QACrC,IAAI,EAAE,kBAAkB,CAAC;QACzB,4DAA4D;QAC5D,IAAI,EAAE,WAAW,CAAC;KACnB;IAED;;;OAGG;IACI,IAAI,4BAA4B,WAAY,wBAAwB,SAE1E,CAAC;IAEF;;OAEG;IACH,KAAY,mBAAmB,GAAG;QAAE,QAAQ,CAAC,GAAG,EAAE,qBAAqB,EAAE,CAAC;QAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;QAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC;IAExK;;OAEG;IACH,KAAY,YAAY,GAAG;IACzB,uDAAuD;IACvD,MAAM,EAAE,qBAAqB;IAC7B;;OAEG;IACH,IAAI,EAAE,kBAAkB,KACrB,OAAO,CAAC;IAEb;;;;;OAKG;IACH,SAAgB,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,GAAG,MAAM,GAAG,SAAS,CAEpF;IAED;;;;;OAKG;IACH,SAAgB,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,UAAU,GAAG,SAAS,CAEtF;IAED;;;OAGG;IACH,SAAgB,cAAc,CAAC,IAAI,EAAE,2BAA2B,GAAG,IAAI,CAgBtE;CACF"}