@itwin/core-backend 5.8.0-dev.1 → 5.8.0-dev.11

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

@@ -0,0 +1,109 @@
+/** @packageDocumentation
+ * @module Workspace
+ */
+import { Setting, SettingName, SettingsContainer, SettingsPriority } from "./Settings";
+import { CloudSqliteContainer, WorkspaceContainerId, WorkspaceDbName } from "./Workspace";
+import { _implementationProhibited } from "../internal/Symbols";
+/** Metadata stored inside a [[SettingsDb]] describing the database's contents, to help users understand
+ * the purpose of the [[SettingsDb]] and who to contact with questions about it.
+ * @note Only the `settingsName` field is required, and users may add additional fields for their own purposes.
+ * @note Since the information is stored inside the [[SettingsDb]], it is versioned along with the rest of the contents.
+ * @beta
+ */
+export interface SettingsDbManifest {
+    /** The name of the [[SettingsDb]] to be shown in user interfaces. Organizations should attempt to make this name
+     * informative enough so that users may refer to it in conversations.
+     */
+    readonly settingsName: string;
+    /** A description of the contents of this [[SettingsDb]] to help users understand its purpose and appropriate usage. */
+    readonly description?: string;
+    /** The name of the person to contact with questions about this [[SettingsDb]]. */
+    readonly contactName?: string;
+    /** The name of the person who last modified this [[SettingsDb]]. */
+    readonly lastEditedBy?: string;
+}
+/** Properties that specify how to load a [[SettingsDb]] within a [[CloudSqliteContainer]].
+ * @beta
+ */
+export interface SettingsDbProps {
+    /** The base name of the [[SettingsDb]], without any version information. Default: `"settings-db"`. */
+    readonly dbName?: WorkspaceDbName;
+    /** The [semver](https://github.com/npm/node-semver) version string or range for the desired [[SettingsDb]].
+     * If not specified, the latest available version is used.
+     */
+    readonly version?: string;
+}
+/** Arguments for obtaining a [[SettingsDb]] from a previously-loaded container.
+ * @beta
+ */
+export interface GetSettingsDbArgs {
+    /** The [[WorkspaceContainerId]] of the cloud container that holds the [[SettingsDb]].
+     * This is an opaque GUID assigned by the BlobContainer service when the container is created — it is
+     * **not** the same as an iTwinId or iModelId.
+     */
+    readonly containerId: WorkspaceContainerId;
+    /** The priority to assign to dictionaries loaded from this [[SettingsDb]]. */
+    readonly priority: SettingsPriority;
+    /** The name of the [[SettingsDb]] to retrieve. Default: `"settings-db"`. */
+    readonly dbName?: WorkspaceDbName;
+    /** The semantic version string or range for the desired [[SettingsDb]].
+     * If not specified, the latest available version is used.
+     */
+    readonly version?: string;
+}
+/** A CloudSQLite database dedicated to storing settings as key-value pairs. Unlike a general-purpose [[WorkspaceDb]],
+ * a `SettingsDb` restricts its API surface to settings-only operations, providing a focused interface
+ * for reading settings by name.
+ *
+ * Internally, all settings are stored in a single JSON blob. Each setting is a named entry in a [[SettingsContainer]].
+ *
+ * A `SettingsDb` resides in a [[CloudSqliteContainer]] and can be published to the cloud. Once published,
+ * the `SettingsDb` becomes immutable; however, multiple versions may be created to allow settings to evolve over time.
+ * @beta
+ */
+export interface SettingsDb {
+    /** @internal */
+    [_implementationProhibited]: unknown;
+    /** The [[CloudSqliteContainer]] in which this database resides. */
+    readonly container: CloudSqliteContainer;
+    /** The base name of this SettingsDb, without version. */
+    readonly dbName: string;
+    /** The resolved [semver](https://github.com/npm/node-semver) version of this SettingsDb.
+     * @note For local (non-cloud) containers, this property returns `"0.0.0"`.
+     */
+    readonly version: string;
+    /** The priority assigned to dictionaries loaded from this SettingsDb. */
+    readonly priority: SettingsPriority;
+    /** Whether the underlying database is currently open. */
+    readonly isOpen: boolean;
+    /** The manifest describing the contents of this SettingsDb. */
+    readonly manifest: SettingsDbManifest;
+    /** Open the underlying database for querying. When performing significant activity against a SettingsDb,
+     * open it before the operations and [[close]] it afterwards.
+     * @note Explicit open/close is a performance optimization for batches of operations. Individual methods like
+     * [[getSetting]] and [[getSettings]] will auto-open and auto-close the database if it is not already open.
+     */
+    open(): void;
+    /** Close the underlying database. You should call this after [[open]]ing the database and completing your queries.
+     * @note For [[EditableSettingsDb]] instances, if the container's write lock is currently held, closing persists
+     * any pending changes and updates the manifest's `lastEditedBy` field with the current write lock holder.
+     */
+    close(): void;
+    /** Return a copy of the value of the setting named `settingName`, or `undefined` if not found.
+     * The returned value is always cloned using [[Setting.clone]].
+     * @param settingName The name of the setting to retrieve.
+     */
+    getSetting<T extends Setting>(settingName: SettingName): T | undefined;
+    /** Return a deep copy of all settings stored in this SettingsDb as a [[SettingsContainer]].
+     * @note The returned object is a fresh copy — mutating it will not affect the stored settings.
+     */
+    getSettings(): SettingsContainer;
+}
+/** The default resource name used to store settings in a [[SettingsDb]].
+ * 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 = "settings";
+//# sourceMappingURL=SettingsDb.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsDb.d.ts","sourceRoot":"","sources":["../../../src/workspace/SettingsDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACvF,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC1F,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,uHAAuH;IACvH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,kFAAkF;IAClF,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,oEAAoE;IACpE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sGAAsG;IACtG,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC;IAC3C,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAU;IACzB,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACrC,mEAAmE;IACnE,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IACzC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IAEtC;;;;OAIG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,CAAC,SAAS,OAAO,EAAE,WAAW,EAAE,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC;IAEvE;;OAEG;IACH,WAAW,IAAI,iBAAiB,CAAC;CAClC;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,aAAa,CAAC"}

package/lib/esm/workspace/SettingsDb.js

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { _implementationProhibited } from "../internal/Symbols";
+/** The default resource name used to store settings in a [[SettingsDb]].
+ * 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 = "settings";
+//# sourceMappingURL=SettingsDb.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsDb.js","sourceRoot":"","sources":["../../../src/workspace/SettingsDb.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAyGhE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,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/** @packageDocumentation\r\n * @module Workspace\r\n */\r\n\r\nimport { Setting, SettingName, SettingsContainer, SettingsPriority } from \"./Settings\";\r\nimport { CloudSqliteContainer, WorkspaceContainerId, WorkspaceDbName } from \"./Workspace\";\r\nimport { _implementationProhibited } from \"../internal/Symbols\";\r\n\r\n/** Metadata stored inside a [[SettingsDb]] describing the database's contents, to help users understand\r\n * the purpose of the [[SettingsDb]] and who to contact with questions about it.\r\n * @note Only the `settingsName` field is required, and users may add additional fields for their own purposes.\r\n * @note Since the information is stored inside the [[SettingsDb]], it is versioned along with the rest of the contents.\r\n * @beta\r\n */\r\nexport interface SettingsDbManifest {\r\n  /** The name of the [[SettingsDb]] to be shown in user interfaces. Organizations should attempt to make this name\r\n   * informative enough so that users may refer to it in conversations.\r\n   */\r\n  readonly settingsName: string;\r\n  /** A description of the contents of this [[SettingsDb]] to help users understand its purpose and appropriate usage. */\r\n  readonly description?: string;\r\n  /** The name of the person to contact with questions about this [[SettingsDb]]. */\r\n  readonly contactName?: string;\r\n  /** The name of the person who last modified this [[SettingsDb]]. */\r\n  readonly lastEditedBy?: string;\r\n}\r\n\r\n/** Properties that specify how to load a [[SettingsDb]] within a [[CloudSqliteContainer]].\r\n * @beta\r\n */\r\nexport interface SettingsDbProps {\r\n  /** The base name of the [[SettingsDb]], without any version information. Default: `\"settings-db\"`. */\r\n  readonly dbName?: WorkspaceDbName;\r\n  /** The [semver](https://github.com/npm/node-semver) version string or range for the desired [[SettingsDb]].\r\n   * If not specified, the latest available version is used.\r\n   */\r\n  readonly version?: string;\r\n}\r\n\r\n/** Arguments for obtaining a [[SettingsDb]] from a previously-loaded container.\r\n * @beta\r\n */\r\nexport interface GetSettingsDbArgs {\r\n  /** The [[WorkspaceContainerId]] of the cloud container that holds the [[SettingsDb]].\r\n   * This is an opaque GUID assigned by the BlobContainer service when the container is created — it is\r\n   * **not** the same as an iTwinId or iModelId.\r\n   */\r\n  readonly containerId: WorkspaceContainerId;\r\n  /** The priority to assign to dictionaries loaded from this [[SettingsDb]]. */\r\n  readonly priority: SettingsPriority;\r\n  /** The name of the [[SettingsDb]] to retrieve. Default: `\"settings-db\"`. */\r\n  readonly dbName?: WorkspaceDbName;\r\n  /** The semantic version string or range for the desired [[SettingsDb]].\r\n   * If not specified, the latest available version is used.\r\n   */\r\n  readonly version?: string;\r\n}\r\n\r\n/** A CloudSQLite database dedicated to storing settings as key-value pairs. Unlike a general-purpose [[WorkspaceDb]],\r\n * a `SettingsDb` restricts its API surface to settings-only operations, providing a focused interface\r\n * for reading settings by name.\r\n *\r\n * Internally, all settings are stored in a single JSON blob. Each setting is a named entry in a [[SettingsContainer]].\r\n *\r\n * A `SettingsDb` resides in a [[CloudSqliteContainer]] and can be published to the cloud. Once published,\r\n * the `SettingsDb` becomes immutable; however, multiple versions may be created to allow settings to evolve over time.\r\n * @beta\r\n */\r\nexport interface SettingsDb {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n  /** The [[CloudSqliteContainer]] in which this database resides. */\r\n  readonly container: CloudSqliteContainer;\r\n  /** The base name of this SettingsDb, without version. */\r\n  readonly dbName: string;\r\n  /** The resolved [semver](https://github.com/npm/node-semver) version of this SettingsDb.\r\n   * @note For local (non-cloud) containers, this property returns `\"0.0.0\"`.\r\n   */\r\n  readonly version: string;\r\n  /** The priority assigned to dictionaries loaded from this SettingsDb. */\r\n  readonly priority: SettingsPriority;\r\n  /** Whether the underlying database is currently open. */\r\n  readonly isOpen: boolean;\r\n  /** The manifest describing the contents of this SettingsDb. */\r\n  readonly manifest: SettingsDbManifest;\r\n\r\n  /** Open the underlying database for querying. When performing significant activity against a SettingsDb,\r\n   * open it before the operations and [[close]] it afterwards.\r\n   * @note Explicit open/close is a performance optimization for batches of operations. Individual methods like\r\n   * [[getSetting]] and [[getSettings]] will auto-open and auto-close the database if it is not already open.\r\n   */\r\n  open(): void;\r\n\r\n  /** Close the underlying database. You should call this after [[open]]ing the database and completing your queries.\r\n   * @note For [[EditableSettingsDb]] instances, if the container's write lock is currently held, closing persists\r\n   * any pending changes and updates the manifest's `lastEditedBy` field with the current write lock holder.\r\n   */\r\n  close(): void;\r\n\r\n  /** Return a copy of the value of the setting named `settingName`, or `undefined` if not found.\r\n   * The returned value is always cloned using [[Setting.clone]].\r\n   * @param settingName The name of the setting to retrieve.\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName): T | undefined;\r\n\r\n  /** Return a deep copy of all settings stored in this SettingsDb as a [[SettingsContainer]].\r\n   * @note The returned object is a fresh copy — mutating it will not affect the stored settings.\r\n   */\r\n  getSettings(): SettingsContainer;\r\n}\r\n\r\n/** The default resource name used to store settings in a [[SettingsDb]].\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 = \"settings\";\r\n"]}

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

@@ -0,0 +1,246 @@
+/** @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 */
+export declare namespace SettingsEditor {
+    /**
+     * 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;
+    /**
+     * Create a new, empty, [[SettingsDb]] file on the local filesystem for importing settings dictionaries.
+     */
+    function createEmptyDb(args: {
+        localFileName: LocalFileName;
+        manifest: SettingsDbManifest;
+    }): void;
+    /** Arguments for [[SettingsEditor.queryContainers]] and [[SettingsEditor.findContainers]]. */
+    interface QuerySettingsContainersArgs {
+        /** 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.
+     */
+    readonly cloudProps: WorkspaceContainerProps | undefined;
+    /**
+     * Get an editable [[SettingsDb]] to add, delete, or update settings *within a newly created version* of a SettingsDb.
+     * @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 {
+    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.
+     * @note Requires [[IModelHost.authorizationClient]] 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;
+}
+//# sourceMappingURL=SettingsEditor.d.ts.map

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

@@ -0,0 +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;;OAEG;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,CAKlH;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;;;;;OAKG;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,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"}

package/lib/esm/workspace/SettingsEditor.js

@@ -0,0 +1,48 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { BlobContainer } from "../BlobContainerService";
+import { SettingsSqliteDb } from "../internal/workspace/SettingsSqliteDb";
+import { constructSettingsEditor } from "../internal/workspace/SettingsImpl";
+import { _implementationProhibited } from "../internal/Symbols";
+import { IModelHost } from "../IModelHost";
+/** @beta */
+export var SettingsEditor;
+(function (SettingsEditor) {
+    /**
+     * 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();
+    }
+    SettingsEditor.construct = construct;
+    /**
+     * Create a new, empty, [[SettingsDb]] file on the local filesystem for importing settings dictionaries.
+     */
+    function createEmptyDb(args) {
+        SettingsSqliteDb.createNewDb(args.localFileName, args);
+    }
+    SettingsEditor.createEmptyDb = createEmptyDb;
+    /**
+     * 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.
+     */
+    async function queryContainers(args) {
+        if (undefined === BlobContainer.service)
+            throw new Error("BlobContainer.service is not available. Ensure IModelHost is initialized with a valid configuration.");
+        const userToken = await IModelHost.getAccessToken();
+        return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: "settings" });
+    }
+    SettingsEditor.queryContainers = queryContainers;
+})(SettingsEditor || (SettingsEditor = {}));
+//# sourceMappingURL=SettingsEditor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsEditor.js","sourceRoot":"","sources":["../../../src/workspace/SettingsEditor.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,YAAY;AACZ,MAAM,KAAW,cAAc,CAyC9B;AAzCD,WAAiB,cAAc;IAC7B;;;;OAIG;IACH,SAAgB,SAAS;QACvB,OAAO,uBAAuB,EAAE,CAAC;IACnC,CAAC;IAFe,wBAAS,YAExB,CAAA;IAED;;OAEG;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;YACrC,MAAM,IAAI,KAAK,CAAC,sGAAsG,CAAC,CAAC;QAC1H,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;IALqB,8BAAe,kBAKpC,CAAA;AACH,CAAC,EAzCgB,cAAc,KAAd,cAAc,QAyC9B","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 { LocalFileName } from \"@itwin/core-common\";\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { Setting, SettingName, SettingsContainer } from \"./Settings\";\r\nimport { BlobContainer } from \"../BlobContainerService\";\r\nimport { CloudSqliteContainer, GetWorkspaceContainerArgs, Workspace, WorkspaceContainerProps, WorkspaceDbName, WorkspaceDbNameAndVersion, WorkspaceDbVersion } from \"./Workspace\";\r\nimport { SettingsDb, SettingsDbManifest, SettingsDbProps } from \"./SettingsDb\";\r\nimport { SettingsSqliteDb } from \"../internal/workspace/SettingsSqliteDb\";\r\nimport { constructSettingsEditor } from \"../internal/workspace/SettingsImpl\";\r\nimport { _implementationProhibited } from \"../internal/Symbols\";\r\nimport { CloudSqlite } from \"../CloudSqlite\";\r\nimport { IModelHost } from \"../IModelHost\";\r\n\r\n/** @beta */\r\nexport namespace SettingsEditor {\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 function construct(): SettingsEditor {\r\n    return constructSettingsEditor();\r\n  }\r\n\r\n  /**\r\n   * Create a new, empty, [[SettingsDb]] file on the local filesystem for importing settings dictionaries.\r\n   */\r\n  export function createEmptyDb(args: { localFileName: LocalFileName; manifest: SettingsDbManifest }): void {\r\n    SettingsSqliteDb.createNewDb(args.localFileName, args);\r\n  }\r\n\r\n  /** Arguments for [[SettingsEditor.queryContainers]] and [[SettingsEditor.findContainers]]. */\r\n  export interface QuerySettingsContainersArgs {\r\n    /** The iTwinId whose settings containers should be queried. */\r\n    iTwinId: GuidString;\r\n    /** Optional iModelId to further scope the query to containers associated with a specific iModel. */\r\n    iModelId?: GuidString;\r\n    /** Optional label filter. */\r\n    label?: string;\r\n  }\r\n\r\n  /**\r\n   * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.\r\n   * This is a convenience wrapper around `BlobContainer.service.queryContainersMetadata` that\r\n   * automatically filters by `containerType: \"settings\"`.\r\n   * @param args - The query arguments including the iTwinId.\r\n   * @returns A promise that resolves to the matching container metadata entries.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  export async function queryContainers(args: QuerySettingsContainersArgs): Promise<BlobContainer.MetadataResponse[]> {\r\n    if (undefined === BlobContainer.service)\r\n      throw new Error(\"BlobContainer.service is not available. Ensure IModelHost is initialized with a valid configuration.\");\r\n    const userToken = await IModelHost.getAccessToken();\r\n    return BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: \"settings\" });\r\n  }\r\n}\r\n\r\n/** Arguments supplied to [[SettingsEditor.createNewCloudContainer]] to create a new [[EditableSettingsCloudContainer]].\r\n * The created container will automatically have `containerType: \"settings\"` in its metadata, enabling discovery\r\n * via `BlobContainer.service.queryContainersMetadata({ containerType: \"settings\" })`.\r\n * @beta\r\n */\r\nexport interface CreateNewSettingsContainerArgs {\r\n  /**\r\n   * The scope of the container. This determines the ownership of the container, how RBAC rights are assigned,\r\n   * and the location of the datacenter.\r\n   */\r\n  scope: BlobContainer.Scope;\r\n  /** The manifest to be stored in the default SettingsDb in the new container. */\r\n  manifest: SettingsDbManifest;\r\n  /** Metadata stored by the BlobContainer service. The `containerType` field is omitted here because it is\r\n   * automatically set to `\"settings\"` when the container is created (mirroring the `\"workspace\"` convention for WorkspaceDb containers).\r\n   */\r\n  metadata: Omit<BlobContainer.Metadata, \"containerType\">;\r\n  /** The name of the default [[SettingsDb]] created inside the new container.\r\n   * Default: \"settings-db\";\r\n   */\r\n  dbName?: WorkspaceDbName;\r\n}\r\n\r\n/** Arguments supplied to [[EditableSettingsCloudContainer.createNewSettingsDbVersion]].\r\n * @beta\r\n */\r\nexport interface CreateNewSettingsDbVersionArgs {\r\n  /**\r\n   * The properties that determine the source [[SettingsDb]] to serve as the basis for the new version.\r\n   * This is usually the latest version, but it is possible to create patches to older versions.\r\n   */\r\n  fromProps?: SettingsDbProps;\r\n  /** The type of version increment to apply to the source version. */\r\n  versionType: CloudSqlite.SemverIncrement;\r\n  /** For prerelease versions, a string that becomes part of the version name. */\r\n  identifier?: string;\r\n}\r\n\r\n/** The result of creating a new version of a [[SettingsDb]].\r\n * @beta\r\n */\r\nexport interface SettingsDbVersionResult {\r\n  /** The name and version of the source SettingsDb. */\r\n  oldDb: WorkspaceDbNameAndVersion;\r\n  /** The name and version of the newly-created SettingsDb. */\r\n  newDb: WorkspaceDbNameAndVersion;\r\n}\r\n\r\n/** Arguments supplied to [[EditableSettingsCloudContainer.createDb]] to create a new [[SettingsDb]] in a container.\r\n * @beta\r\n */\r\nexport interface CreateSettingsDbArgs {\r\n  /** The name of the new SettingsDb. Default: `\"settings-db\"`. */\r\n  dbName?: WorkspaceDbName;\r\n  /** The initial version of the new SettingsDb. Default: `\"0.0.0\"`. */\r\n  version?: WorkspaceDbVersion;\r\n  /** The manifest for the new SettingsDb. */\r\n  manifest: SettingsDbManifest;\r\n}\r\n\r\n/** Arguments supplied to [[EditableSettingsDb.updateSetting]] to add or update a single [[Setting]].\r\n * @beta\r\n */\r\nexport interface UpdateSettingArgs {\r\n  /** The [[SettingName]] of the setting to add or update. */\r\n  readonly settingName: SettingName;\r\n  /** The new value for the setting. */\r\n  readonly value: Setting;\r\n}\r\n\r\n/**\r\n * A [[CloudSqliteContainer]] opened for editing settings by a [[SettingsEditor]].\r\n * You can create new [[SettingsDb]]s or new versions of existing [[SettingsDb]]s inside it.\r\n * Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via\r\n * [[acquireWriteLock]]. Only one user can hold the write lock at any given time. When you have finished making changes,\r\n * you can use [[releaseWriteLock]] to publish your changes, or [[abandonChanges]] to discard them.\r\n * @note Settings containers are separate from workspace containers, providing independent write locks.\r\n * Editing settings does not block workspace resource editing, and vice versa.\r\n * @beta\r\n */\r\nexport interface EditableSettingsCloudContainer extends CloudSqliteContainer {\r\n  /**\r\n   * Create a copy of an existing [[SettingsDb]] in this container with a new [[WorkspaceDbVersion]].\r\n   * The copy should be modified with new content before the write lock is released,\r\n   * and thereafter may never be modified again.\r\n   * @param args - The properties that determine the source SettingsDb and the version increment to apply.\r\n   * @returns A promise that resolves to an object containing the old and new SettingsDb names and versions.\r\n   */\r\n  createNewSettingsDbVersion(args: CreateNewSettingsDbVersionArgs): Promise<SettingsDbVersionResult>;\r\n\r\n  /**\r\n   * Create a new, empty [[SettingsDb]].\r\n   * @param args - The arguments for creating the new SettingsDb.\r\n   * @returns A promise that resolves to an EditableSettingsDb.\r\n   */\r\n  createDb(args: CreateSettingsDbArgs): Promise<EditableSettingsDb>;\r\n\r\n  /**\r\n   * Get the cloud properties of this container.\r\n   */\r\n  readonly cloudProps: WorkspaceContainerProps | undefined;\r\n\r\n  /**\r\n   * Get an editable [[SettingsDb]] to add, delete, or update settings *within a newly created version* of a SettingsDb.\r\n   * @param props - The properties of the SettingsDb.\r\n   * @returns An EditableSettingsDb for modifying settings.\r\n   * @throws if the targeted SettingsDb has already been published and is immutable. Use [[createNewSettingsDbVersion]] first to create an editable version.\r\n   */\r\n  getEditableDb(props?: SettingsDbProps): EditableSettingsDb;\r\n\r\n  /**\r\n   * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or\r\n   * [[abandonChanges]] to release the lock and discard your changes.\r\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\r\n   * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].\r\n   * @param user - The name of the user acquiring the write lock.\r\n   * @throws if the write lock is already held by another user.\r\n   */\r\n  acquireWriteLock(user: string): void;\r\n\r\n  /**\r\n   * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It\r\n   * publishes and uploads the changes made to any [[SettingsDb]]s while the lock was held, after which those dbs become immutable.\r\n   */\r\n  releaseWriteLock(): void;\r\n\r\n  /**\r\n   * Abandon any changes made to the container and release the write lock. Any newly created versions of SettingsDbs are discarded.\r\n   */\r\n  abandonChanges(): void;\r\n}\r\n\r\n/**\r\n * An editable [[SettingsDb]]. This is used only by tools to allow administrators to create and modify SettingsDbs.\r\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.\r\n * Normally, only admins will have write access.\r\n * Only one admin at a time may be editing a settings container.\r\n * @note Unlike [[EditableWorkspaceDb]], this interface only supports settings operations — no blob, file, or string resource methods.\r\n * @beta\r\n */\r\nexport interface EditableSettingsDb extends SettingsDb {\r\n  readonly container: EditableSettingsCloudContainer;\r\n\r\n  /**\r\n   * Update the contents of the manifest in this SettingsDb.\r\n   * @note This replaces the stored manifest entirely; omitted fields are lost.\r\n   * @param manifest - The updated manifest.\r\n   */\r\n  updateManifest(manifest: SettingsDbManifest): void;\r\n\r\n  /**\r\n   * Replace all settings in this SettingsDb with the given container.\r\n   * @param settings - The settings object to store.\r\n   */\r\n  updateSettings(settings: SettingsContainer): void;\r\n\r\n  /**\r\n   * Add or update a single [[Setting]] by name.\r\n   * If a setting with the given name already exists, its value is replaced.\r\n   * If it does not exist, it is added. Other settings are preserved.\r\n   * @param args - The arguments specifying the setting name and value.\r\n   */\r\n  updateSetting(args: UpdateSettingArgs): void;\r\n\r\n  /**\r\n   * Remove a single [[Setting]] by name. Other settings are preserved.\r\n   * @param settingName - The name of the setting to remove.\r\n   */\r\n  removeSetting(settingName: SettingName): void;\r\n}\r\n\r\n/** An object that permits administrators to modify the contents of settings containers.\r\n * Use [[SettingsEditor.construct]] to obtain a SettingsEditor, and [[close]] when finished using it.\r\n * Only one SettingsEditor may be in use at any given time.\r\n * Use [[getContainer]] to edit an existing container, or [[createNewCloudContainer]] to create a new container.\r\n * @beta\r\n */\r\nexport interface SettingsEditor {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /**\r\n   * The workspace dedicated to this editor.\r\n   * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s.\r\n   */\r\n  readonly workspace: Workspace;\r\n\r\n  /**\r\n   * Retrieves a container for the editor with the specified properties and access token.\r\n   */\r\n  getContainer(args: GetWorkspaceContainerArgs): EditableSettingsCloudContainer;\r\n\r\n  /**\r\n   * Asynchronously retrieves a container for the editor with the specified properties.\r\n   */\r\n  getContainerAsync(props: WorkspaceContainerProps): Promise<EditableSettingsCloudContainer>;\r\n\r\n  /**\r\n   * Creates a new cloud container for holding SettingsDbs, from the [[BlobContainer]] service.\r\n   * The container is automatically assigned `containerType: \"settings\"` in its metadata and\r\n   * initialized with a default [[SettingsDb]].\r\n   * @param args - The arguments for creating the container, including scope, metadata, and manifest.\r\n   * @returns A promise that resolves to the new EditableSettingsCloudContainer.\r\n   * @note The current user must have administrator rights for the iTwin for the container.\r\n   * @note Requires [[IModelHost.authorizationClient]] to be configured.\r\n   */\r\n  createNewCloudContainer(args: CreateNewSettingsContainerArgs): Promise<EditableSettingsCloudContainer>;\r\n\r\n  /**\r\n   * Find and open existing settings containers by querying the [[BlobContainer]] service.\r\n   * This is a convenience method that queries for all settings containers matching the given iTwinId\r\n   * (and optionally iModelId), requests write access tokens, and opens each matching container.\r\n   * @param args - The query arguments including iTwinId and optionally iModelId and label.\r\n   * @returns A promise that resolves to an array of opened [[EditableSettingsCloudContainer]]s.\r\n   * @note Requires [[IModelHost.authorizationClient]] and [[BlobContainer.service]] to be configured.\r\n   */\r\n  findContainers(args: SettingsEditor.QuerySettingsContainersArgs): Promise<EditableSettingsCloudContainer[]>;\r\n\r\n  /**\r\n   * Closes this editor. All settings containers are dropped.\r\n   */\r\n  close(): void;\r\n}\r\n"]}

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

@@ -2,10 +2,11 @@
  * @module Workspace
  */
 import { AccessToken, BeEvent, ITwinError, Optional } from "@itwin/core-bentley";
-import { LocalDirName, LocalFileName } from "@itwin/core-common";
+import { DbCloudContainerInfo, LocalDirName, LocalFileName } from "@itwin/core-common";
 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.
@@ -71,7 +72,8 @@ export interface WorkspaceDbProps extends WorkspaceDbNameAndVersion {
 /** Properties describing a [[WorkspaceDb]] and the [[WorkspaceContainer]] containing it.
  * @beta
  */
-export type WorkspaceDbCloudProps = WorkspaceDbProps & WorkspaceContainerProps;
+export interface WorkspaceDbCloudProps extends WorkspaceDbProps, WorkspaceContainerProps, DbCloudContainerInfo {
+}
 /** A function supplied as [[WorkspaceDbQueryResourcesArgs.callback]] to be invoked to process the requested resources.
  * @beta
  */
@@ -141,8 +143,12 @@ export interface WorkspaceDbLoadErrors extends ITwinError {
   * @beta
   */
 export interface WorkspaceDbSettingsProps extends WorkspaceDbCloudProps {
-    /** The name of the resource holding the stringified JSON of the [[SettingsDictionary]]. */
-    resourceName: string;
+    /** 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
+     * field unless you need to load settings stored under a non-standard key.
+     */
+    resourceName?: string;
     /** The priority to assign to the [[SettingsDictionary]]. */
     priority: SettingsPriority;
 }
@@ -318,6 +324,13 @@ 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]].
@@ -347,37 +360,45 @@ export interface Workspace {
     }): Promise<WorkspaceDb[]>;
 }
 /**
- * A WorkspaceContainer is a type of [[CloudSqlite.CloudContainer]] that holds one or more [[WorkspaceDb]]s. Normally a WorkspaceContainer will hold (many versions of) a single WorkspaceDb.
- * Each version of a WorkspaceDb is treated as immutable after it is created and is stored in the WorkspaceContainer indefinitely. That means that
- * older versions of the WorkspaceDb may continue to be used, for example by archived projects. For programmers familiar with [NPM](https://www.npmjs.com/), this is conceptually
- * similar and versioning follows the same rules as NPM using [Semantic Versioning](https://semver.org/).
- * @note It is possible to store more than one WorkspaceDb in the same WorkspaceContainer, but access rights are administered per WorkspaceContainer.
- * That is, if a user has rights to access a WorkspaceContainer, that right applies to all WorkspaceDbs in the WorkspaceContainer.
- * @note Not every WorkspaceContainer is associated with a [[CloudSqlite.CloudContainer]] - WorkspaceContainers may also be loaded from the local file system.
+ * Base interface for containers backed by [[CloudSqlite]] that hold versioned databases (e.g. [[WorkspaceDb]]s or [[SettingsDb]]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`.
- * @see [[Workspace.getContainer]] and [[Workspace.getContainerAsync]] to load a container.
+ * @see [[WorkspaceContainer]] for workspace-specific containers.
  * @beta
  */
-export interface WorkspaceContainer {
+export interface CloudSqliteContainer {
     /** @internal */
     [_implementationProhibited]: unknown;
-    /** the local directory where this WorkspaceContainer will store temporary files extracted for file-resources.
+    /** the local directory where this container will store temporary files extracted for file-resources.
      * @internal
      */
     readonly filesDir: LocalDirName;
     /** The workspace into which this container was loaded. */
     readonly workspace: Workspace;
-    /** Cloud container for this WorkspaceContainer, or `undefined` if this is a local WorkspaceContainer. */
+    /** Cloud container for this container, or `undefined` if this is a local container. */
     readonly cloudContainer?: CloudSqlite.CloudContainer;
     /** Properties supplied when this container was loaded */
     readonly fromProps: WorkspaceContainerProps;
-    /** @internal */
-    addWorkspaceDb(toAdd: WorkspaceDb): void;
     /**
-     * Find the fully-qualified name of a [[WorkspaceDb]] satisfying the name and version criteria specified by `props`.
+     * Find the fully-qualified name of a database satisfying the name and version criteria specified by `props`.
      * @throws Error if no version satisfying the criteria exists.
      */
     resolveDbFileName(props: WorkspaceDbProps): WorkspaceDbFullName;
+}
+/**
+ * A [[CloudSqliteContainer]] that holds one or more [[WorkspaceDb]]s. Normally a WorkspaceContainer will hold (many versions of) a single WorkspaceDb.
+ * Each version of a WorkspaceDb is treated as immutable after it is created and is stored in the WorkspaceContainer indefinitely. That means that
+ * older versions of the WorkspaceDb may continue to be used, for example by archived projects. For programmers familiar with [NPM](https://www.npmjs.com/), this is conceptually
+ * similar and versioning follows the same rules as NPM using [Semantic Versioning](https://semver.org/).
+ * @note It is possible to store more than one WorkspaceDb in the same WorkspaceContainer, but access rights are administered per WorkspaceContainer.
+ * That is, if a user has rights to access a WorkspaceContainer, that right applies to all WorkspaceDbs in the WorkspaceContainer.
+ * @see [[Workspace.getContainer]] and [[Workspace.getContainerAsync]] to load a container.
+ * @beta
+ */
+export interface WorkspaceContainer extends CloudSqliteContainer {
+    /** @internal */
+    addWorkspaceDb(toAdd: WorkspaceDb): void;
     /** Obtain a [[WorkspaceDb]] satisfying the name and version criteria specified by `props`. */
     getWorkspaceDb(props?: WorkspaceDbProps): WorkspaceDb;
     /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace.