@itwin/core-backend 4.8.0-dev.3 → 4.8.0-dev.32

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

@@ -5,369 +5,503 @@ import { AccessToken, BeEvent, Optional } from "@itwin/core-bentley";
 import { LocalDirName, LocalFileName } from "@itwin/core-common";
 import { CloudSqlite } from "../CloudSqlite";
 import { SQLiteDb } from "../SQLiteDb";
-import { Settings, SettingsPriority } from "./Settings";
+import { SettingName, Settings, SettingsDictionary, SettingsPriority } from "./Settings";
 import type { IModelJsNative } from "@bentley/imodeljs-native";
-/** The Settings used by Workspace api
+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.
+ * A valid `WorkspaceContainerId` must conform to the following constraints:
+ *  - Consist solely of a combination of lower case letters, numbers, and dashes.
+ *  - May not start or end with a dash.
+ *  - Must be at least 3 characters long and no longer than 63 characters.
  * @beta
  */
-export declare const WorkspaceSetting: {
-    Containers: string;
-    Databases: string;
-};
-/** @beta */
-export declare namespace WorkspaceContainer {
-    /** The name of a WorkspaceContainer in a "cloud/containers" setting. */
-    type Name = string;
-    /** The unique identifier of a WorkspaceContainer. This becomes the base name for the local directory holding the WorkspaceDbs from a WorkspaceContainer.
-     * Usually supplied via the `containerId` member of a "cloud/containers" setting.
-     * `WorkspaceContainer.Id`s may:
-     *  - only contain lower case letters, numbers or dashes
-     *  - not start or end with a dash
-     *  - not be shorter than 3 or longer than 63 characters
-     */
-    type Id = string;
-    /** A member named `containerName` that specifies by an entry in a "cloud/containers" setting */
-    interface Alias {
-        containerName: string;
-    }
-    /** Properties that specify a WorkspaceContainer. */
-    interface Props extends Optional<CloudSqlite.ContainerAccessProps, "accessToken"> {
-        /** attempt to synchronize (i.e. call `checkForChanges`) this cloud container whenever it is connected to a cloud cache. Default=true */
-        syncOnConnect?: boolean;
-    }
-    /** A function to supply an [AccessToken]($bentley) for a `WorkspaceContainer`.
-     * @param props The properties of the WorkspaceContainer necessary to obtain the access token
-     * @returns a Promise that resolves to the AccessToken for the container.
+export type WorkspaceContainerId = string;
+/** Properties describing a [[WorkspaceContainer]] for methods like [[Workspace.getContainerAsync]].
+ * @beta
+ */
+export interface WorkspaceContainerProps extends Optional<CloudSqlite.ContainerAccessProps, "accessToken"> {
+    /** Whether to synchronize the container via [[CloudSqlite.CloudContainer.checkForChanges]] whenever it is connected to a [[CloudSqlite.CloudCache]].
+     * @note This property defaults to `true`.
      */
-    type TokenFunc = (props: Props) => Promise<AccessToken>;
-    function validateDbName(dbName: WorkspaceDb.DbName): void;
-    /**
-     * Validate that a WorkspaceContainer.Id is valid.
-     * The rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata):
-     *  - may only contain lower case letters, numbers or dashes
-     *  - may not start or end with with a dash nor have more than one dash in a row
-     *  - may not be shorter than 3 or longer than 63 characters
+    readonly syncOnConnect?: boolean;
+    /** A user-friendly description of the container's contents. */
+    readonly description?: string;
+    /** A message to display to the user if problems occur while loading the container. */
+    readonly loadingHelp?: string;
+}
+/** The base name of a [[WorkspaceDb]], without any version information.
+ * The name must conform to the following constraints:
+ * - Case-insensitively unique among all [[WorkspaceDb]]s in the same [[WorkspaceContainer]].
+ * - Between 1 and 255 characters in length.
+ * - A legal filename on both [Windows](https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions) and UNIX.
+ * - Contain none of the following characters: forward or backward slash, period, single or double quote, backtick, and "#".
+ * - Begin or end with a whitespace character.
+ * @see [[WorkspaceDbFullName]] for the fully-specified name, including version information.
+ * @beta
+ */
+export type WorkspaceDbName = string;
+/** The fully-specified name of a [[WorkspaceDb]], combining its [[WorkspaceDbName]] and [[WorkspaceDbVersion]] in the format "name:version".
+ * @beta
+ */
+export type WorkspaceDbFullName = string;
+/** A [semver](https://github.com/npm/node-semver) string describing the version of a [[WorkspaceDb]], e.g., "4.2.11".
+ * @beta
+ */
+export type WorkspaceDbVersion = string;
+/** A [semver string](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) describing a range of acceptable [[WorkspaceDbVersion]]s,
+ * e.g., ">=1.2.7 <1.3.0".
+ * @beta
+ */
+export type WorkspaceDbVersionRange = string;
+/** Specifies the name and version of a [[WorkspaceDb]].
+ * @beta
+ */
+export interface WorkspaceDbNameAndVersion {
+    /** The name of the [[WorkspaceDb]]. If omitted, it defaults to "workspace-db". */
+    readonly dbName?: WorkspaceDbName;
+    /** The range of acceptable versions of the [[WorkspaceDb]] of the specified [[dbName]].
+     * If omitted, it defaults to the newest available version.
      */
-    function validateContainerId(id: WorkspaceContainer.Id): void;
-    /** @internal */
-    function validateVersion(version?: WorkspaceDb.Version): string;
-    /**
-     * Parse the name stored in a WorkspaceContainer into the dbName and version number. A single WorkspaceContainer may hold
-     * many versions of the same WorkspaceDb. The name of the Db in the WorkspaceContainer is in the format "name:version". This
-     * function splits them into separate strings.
+    readonly version?: WorkspaceDbVersionRange;
+}
+/** Properties that specify how to load a [[WorkspaceDb]] within a [[WorkspaceContainer]].
+ * @beta
+ */
+export interface WorkspaceDbProps extends WorkspaceDbNameAndVersion {
+    /** If true, allow semver [prerelease versions](https://github.com/npm/node-semver?tab=readme-ov-file#prerelease-tags), e.g., "1.4.2-beta.0".
+     * By default, only released version are allowed.
      */
-    function parseDbFileName(dbFileName: WorkspaceDb.DbFullName): {
-        dbName: WorkspaceDb.DbName;
-        version: WorkspaceDb.Version;
-    };
-    /** Create a dbName for a WorkspaceDb from its base name and version. This will be in the format "name:version" */
-    function makeDbFileName(dbName: WorkspaceDb.DbName, version?: WorkspaceDb.Version): WorkspaceDb.DbName;
+    readonly includePrerelease?: boolean;
+    /** If true, start a prefetch operation whenever this [[WorkspaceDb]] is opened, to begin downloading pages of the database before they are needed. */
+    readonly prefetch?: boolean;
 }
-/** @beta */
-export declare namespace WorkspaceDb {
-    /** The name of a WorkspaceDb in a "workspace/databases" setting. */
-    type Name = string;
-    /** The base name of a WorkspaceDb within a WorkspaceContainer (without any version identifier) */
-    type DbName = string;
-    /** The  name of a WorkspaceDb within a WorkspaceContainer, including the version identifier */
-    type DbFullName = string;
-    /** The semver-format version identifier for a WorkspaceDb. */
-    type Version = string;
-    /** The [semver range format](https://github.com/npm/node-semver) identifier for a range of acceptable versions. */
-    type VersionRange = string;
-    /** Properties that specify how to load a WorkspaceDb within a [[WorkspaceContainer]]. */
-    interface Props extends CloudSqlite.DbNameProp {
-        /** a semver version range specifier that determines the acceptable range of versions to load. If not present, use the newest version. */
-        version?: VersionRange;
-        /** if true, allow semver *prerelease* versions. By default only released version are allowed. */
-        includePrerelease?: boolean;
-    }
-    /** Scope to increment for a version number.
-     * @see semver.ReleaseType
+/** Properties describing a [[WorkspaceDb]] and the [[WorkspaceContainer]] containing it.
+ * @beta
+ */
+export type WorkspaceDbCloudProps = WorkspaceDbProps & WorkspaceContainerProps;
+/** A function supplied as [[WorkspaceDbQueryResourcesArgs.callback]] to be invoked to process the requested resources.
+ * @beta
+ */
+export type WorkspaceDbQueryResourcesCallback = (resourceNames: Iterable<string>) => void;
+/** Arguments supplied to [[WorkspaceDb.queryResources]].
+ * @beta
+ */
+export interface WorkspaceDbQueryResourcesArgs {
+    /** The type of resource to query. */
+    type?: "string" | "blob";
+    /** A pattern against which to compare the name of each resource, using [[nameCompare]] as the comparison operator.
+     * Only resources whose names match the pattern will be included in the query results.
      */
-    type VersionIncrement = "major" | "minor" | "patch";
-    /** file extension for local WorkspaceDbs
-     * @internal
+    namePattern?: string;
+    /** The comparison operator by which to compare the name of each resource to [[namePattern]].
+     * Only resources whose names match the pattern will be included in the query results.
+     * Ignored if [[namePattern]] is undefined.
      */
-    const fileExt = "itwin-workspace";
-    /** construct a new instance of a WorkspaceDb */
-    function construct(props: WorkspaceDb.Props, container: WorkspaceContainer): WorkspaceDb;
+    nameCompare?: "GLOB" | "LIKE" | "NOT GLOB" | "NOT LIKE" | "=" | "<" | ">";
+    /** A function invoked to process the resources that match the query criterion. */
+    callback: WorkspaceDbQueryResourcesCallback;
 }
-/** Types used to identify Workspace resources
- *  @beta
- */
-export declare namespace WorkspaceResource {
-    /**
-     * The name for identifying WorkspaceResources in a [[WorkspaceDb]].
-     * * `WorkspaceResource.Name`s may not:
-     *  - be blank or start or end with a space
-     *  - be longer than 1024 characters
-     * @note a single WorkspaceDb may hold WorkspaceResources of type 'blob', 'string' and 'file', all with the same WorkspaceResource.Name.
-     */
-    type Name = string;
-    /** Properties that specify an individual WorkspaceResource within a [[WorkspaceDb]]. */
-    interface Props {
-        /** the name of the resource within the WorkspaceDb */
-        rscName: Name;
-    }
+/** Metadata stored inside a [[WorkspaceDb]] describing the database's contents, to help users understand the purpose of the [[WorkspaceDb]], who to
+  * contact with questions about it, and so on.
+  * @note Only the [[workspaceName]] field is required, and users may add additional fields for their own purposes.
+  * @note Since the information is stored inside of the [[WorkspaceDb]], it is versioned along with the rest of the contents.
+  * @beta
+  */
+export interface WorkspaceDbManifest {
+    /** The name of the [[WorkspaceDb]] to be shown in user interfaces. Organizations should attempt to make this name informative enough
+     * so that uses may refer to this name in conversations. It should also be unique enough that there's no confusion when it appears in
+     * lists of WorkspaceDbs.
+     * @note it is possible and valid to change the workspaceName between new version of a WorkspaceDb (e.g. incorporating a date).
+     */
+    readonly workspaceName: string;
+    /** A description of the contents of this [[WorkspaceDb]] to help users understand its purpose and appropriate usage. */
+    readonly description?: string;
+    /** The name of the person to contact with questions about this [[WorkspaceDb]]. */
+    readonly contactName?: string;
+    /** The name of the person who last modified this [[WorkspaceDb]]. */
+    readonly lastEditedBy?: string;
 }
 /**
- * A WorkspaceDb holds workspace resources. `WorkspaceDb`s may just be local files, or they may be stored
- * in cloud WorkspaceContainers. Each `WorkspaceResource` in a WorkspaceDb is identified by a [[WorkspaceResource.Name]].
- * Resources of type `string` and `blob` may be loaded directly from the `WorkspaceDb`. Resources of type `file` are
- * copied from the WorkspaceDb into a temporary local file so they can be accessed by programs directly from disk.
+ * An exception thrown when attempting to load a [[WorkspaceDb]] or some of its data; for example, if the [[WorkspaceDb]] could not be found or the user
+ * is not authorized to access its [[WorkspaceContainer]].
+ * @beta
+ */
+export interface WorkspaceDbLoadError extends Error {
+    /** The properties of the [[WorkspaceDb]] that was attempted to load, including the identity of its [[WorkspaceContainer]]. */
+    wsDbProps?: WorkspaceDbProps & Partial<WorkspaceDbCloudProps>;
+    /** The [[WorkspaceDb]] in which the error occurred, if available. */
+    wsDb?: WorkspaceDb;
+}
+/** An exception that may occur while opening an [[IModelDb]] if any problems are detected while loading its [[IModelDb.workspace]].
+ * This exception is never actually thrown; instead, after the iModel is opened, the exception is forwarded to [[Workspace.exceptionDiagnosticFn]]
+ * so that the user can be notified of the problems.
+ * @beta
+ */
+export interface WorkspaceDbLoadErrors extends Error {
+    /** An array of problems that were encountered attempting to load [[WorkspaceDb]]s for an [[IModelDb]]. The most common problem
+     * is that the user doesn't have read access to one or more [[WorkspaceContainer]]s used by the iModel's [[Workspace]]..
+     */
+    wsLoadErrors?: WorkspaceDbLoadError[];
+}
+/** Specifies a resource inside a [[WorkspaceDb]] that holds a [[SettingsDictionary]] to load into [[Workspace.settings]].
+  * Settings of this type named [[WorkspaceSettingNames.settingsWorkspaces]] are automatically loaded by [[Workspace.loadSettingsDictionary]].
+  * @beta
+  */
+export interface WorkspaceDbSettingsProps extends WorkspaceDbCloudProps {
+    /** The name of the resource holding the stringified JSON of the [[SettingsDictionary]]. */
+    resourceName: string;
+    /** The priority to assign to the [[SettingsDictionary]]. */
+    priority: SettingsPriority;
+}
+/** The name of a blob, string, or file resource stored in a [[WorkspaceDb]].
+ * Resource names must conform to the following constraints:
+ * - At least 1 character and no more than 1024 characters in length.
+ * - No leading or trailing whitespace characters.
+ * Each resource of a given type must has a unique name within the [[WorkspaceDb]]. It is technically possible, but discouraged, to define
+ * resources with the same name but different types.
+ * @beta
+ */
+export type WorkspaceResourceName = string;
+/** A SQLite database in a [[Workspace]] containing named resources that the application is configured to use.
+ * Resources are referred to by their [[WorkspaceResourceName]]s and can represent any number of things, including:
+ * - Fonts and [TextStyle]($common)s used when placing [TextAnnotation]($common)s.
+ * - [GeographicCRS]($common)es used to define the coordinate reference system of an iTwin.
+ * - [[SettingsDictionary]]'s that contribute to the [[Workspace.settings]].
+ * - Files that can be extracted temporarily to the local file system to be accessed by programs directly from disk.
+ *
+ * Ultimately, each resource is stored in one of the following formats:
+ * - A `string`, which is often a stringified `JSON` representation of the resource;
+ * - A binary `blob`; or
+ * - An embedded file.
+ *
+ * Strings and blobs can be accessed directly using [[getString]] and [[getBlob]]. Files must first be copied to the local file system using [[getFile]], and should be avoided unless the software
+ * that uses them is written to access them from disk.
+ *
+ * A `WorkspaceDb` resides in a [[WorkspaceContainer]] that can be published to the cloud. Once published, the `WorkspaceDb` becomes immutable.
+ * However, multiple versions of a single `WorkspaceDb` can be created, allowing the [[Workspace]] contents to evolve over time.
+ * `WorkspaceDb`s use [semantic versioning](https://github.com/npm/node-semver).
+ *
+ * The set of available `WorkspaceDb`s available for use for specific purposes are defined in the [[Workspace]]'s [[Settings]]. You can obtain
+ * a single `WorkspaceDb` using [[WorkspaceContainer.getWorkspaceDb]], but more commonly you will use [[Workspace.getWorkspaceDbs]] to obtain
+ * a list of all of the `WorkspaceDb`s, sorted by priority, that correspond to a given [[SettingName]].
+ *
+ * You can create new `WorkspaceDb`s (or new versions of existing `WorkspaceDb`s) using [[WorkspaceEditor]].
  * @beta
  */
 export interface WorkspaceDb {
-    /** The WorkspaceContainer holding this WorkspaceDb. */
+    /** @internal */
+    [_implementationProhibited]: unknown;
+    /** The [[WorkspaceContainer]] in which this db resides. */
     readonly container: WorkspaceContainer;
     /** The base name of this WorkspaceDb, without version */
-    readonly dbName: WorkspaceDb.DbName;
-    /** event raised before this WorkspaceDb is closed. */
+    readonly dbName: WorkspaceDbName;
+    /** An event raised before this WorkspaceDb is [[close]]d. */
     readonly onClose: BeEvent<() => void>;
-    /** Name by which a WorkspaceDb may be opened. This will be either a local file name or the name of a database in a cloud container */
+    /** The name by which the WorkspaceDb can be opened. This will be either a local file name or the name of a database in a [[CloudSqlite.CloudContainer]]. */
     readonly dbFileName: string;
-    /** the SQLiteDb for this WorkspaceDb*/
+    /** The underlying SQLite database that stores this WorkspaceDb's resources. */
     readonly sqliteDb: SQLiteDb;
+    /** Whether the underlying [[sqliteDb]] is currently [[open]]ed. */
+    readonly isOpen: boolean;
+    /** The manifest that describes the contents and context of this WorkspaceDb. */
+    readonly manifest: WorkspaceDbManifest;
+    /** The version of this WorkspaceDb */
+    readonly version: WorkspaceDbVersion;
+    /** Open the underlying [[sqliteDb]] to perform a query. Generally WorkspaceDbs are left closed and opened/closed as they're used. However,
+     * when there will be significant activity against a WorkspaceDb, it may be useful to open it before the operations and close it afterwards.
+     * Methods like [[queryResources]] open the SQLite database automatically and [[close]] it before they return.
+     */
     open(): void;
+    /** Close the underlying [[sqliteDb]]. You should call this after [[open]]ing the database and completing your query. */
     close(): void;
-    /** Get a string resource from this WorkspaceDb, if present. */
-    getString(rscName: WorkspaceResource.Name): string | undefined;
-    /** Get a blob resource from this WorkspaceDb, if present. */
-    getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;
+    /** Look up a string resource by name, if one exists. */
+    getString(rscName: WorkspaceResourceName): string | undefined;
+    /** Look up a binary resource by name, if one exists. */
+    getBlob(rscName: WorkspaceResourceName): Uint8Array | undefined;
     /** Get a BlobIO reader for a blob WorkspaceResource.
      * @note when finished, caller *must* call `close` on the BlobIO.
      * @internal
      */
-    getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;
+    getBlobReader(rscName: WorkspaceResourceName): SQLiteDb.BlobIO;
     /**
      * Extract a local copy of a file resource from this WorkspaceDb, if present.
      * @param rscName The name of the file resource in the WorkspaceDb
      * @param targetFileName optional name for extracted file. Some applications require files in specific locations or filenames. If
      * you know the full path to use for the extracted file, you can supply it. Generally, it is best to *not* supply the filename and
-     * keep the extracted files in the  filesDir.
-     * @returns the full path to a file on the local filesystem.
-     * @note The file is copied from the file into the local filesystem so it may be accessed directly. This happens only
+     * keep the extracted files in the directory specified by [[WorkspaceContainer.filesDir]].
+     * @returns the full path to a file on the local file system, or undefined if the no file named `rscName` exists.
+     * @note The file is copied from the file into the local file system so it may be accessed directly. This happens only
      * as necessary, if the local file doesn't exist, or if it is out-of-date because it was updated in the file.
      * For this reason, you should not save the local file name, and instead call this method every time you access it, so its
      * content is always holds the correct version.
      * @note The filename will be a hash value, not the resource name.
-     * @note Workspace resource files are set readonly as they are copied from the file.
+     * @note Workspace resource files are set as read-only as they are copied from the file.
      * To edit them, you must first copy them to another location.
      */
-    getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined;
+    getFile(rscName: WorkspaceResourceName, targetFileName?: LocalFileName): LocalFileName | undefined;
     /**
-     * Ensure that the contents of a `WorkspaceDb` are downloaded into the local cache so that it may be accessed offline.
-     * Until the promise is resolved, the `WorkspaceDb` is not fully downloaded, but it *may* be safely accessed during the download.
+     * Ensure that the contents of this `WorkspaceDb` are downloaded into the local cache so that it may be accessed offline.
+     * Until the promise resolves, the `WorkspaceDb` is not fully downloaded, but it *may* be safely accessed during the download.
      * To determine the progress of the download, use the `localBlocks` and `totalBlocks` values returned by `CloudContainer.queryDatabase`.
-     * @returns a `CloudSqlite.CloudPrefetch` object that can be used to await and/or cancel the prefetch.
-     * @throws if this WorkspaceDb is not from a `CloudContainer`.
+     * @returns a [[CloudSqlite.CloudPrefetch]] object that can be used to await and/or cancel the prefetch.
+     * @throws if this WorkspaceDb is not from a [[CloudSqlite.CloudContainer]].
      */
     prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch;
+    /** Find resources of a particular type with names matching a specified pattern.
+     * The matching resources will be supplied to [[WorkspaceDbQueryResourcesArgs.callbackk]].
+     * @see [[Workspace.queryResources]] to query resources within multiple `WorkspaceDb`s.
+     */
+    queryResources(args: WorkspaceDbQueryResourcesArgs): void;
     /** @internal */
-    queryFileResource(rscName: WorkspaceResource.Name): {
+    queryFileResource(rscName: WorkspaceResourceName): {
         localFileName: LocalFileName;
         info: IModelJsNative.EmbedFileQuery;
     } | undefined;
 }
-/** The properties of the CloudCache used for Workspaces.
- * @beta
- */
-export interface WorkspaceCloudCacheProps extends Optional<CloudSqlite.CacheProps, "name" | "rootDir"> {
-    /** if true, empty the cache before using it. */
-    clearContents?: boolean;
-}
-/**
- * Options for constructing a [[Workspace]].
- * @beta
- */
+/** Options supplied to [[IModelHost.startup]] via [[IModelHostOptions.workspace]] to customize the initialization of [[IModelHost.appWorkspace]].
+  * @beta
+  */
 export interface WorkspaceOpts {
-    /** The local directory for non-cloud-based WorkspaceDb files. The workspace api will look in this directory
+    /** The local directory for non-cloud-based [[WorkspaceDb]] files. The [[Workspace]] API will look in this directory
      * for files named `${containerId}/${dbId}.itwin-workspace`.
-     * @note if not supplied, defaults to `iTwin/Workspace` in the user-local folder.
+     * @note if not supplied, defaults to "iTwin/Workspace" in the user-local folder.
      */
     containerDir?: LocalDirName;
-    /** the local fileName(s) of one or more settings files to load after the Workspace is first created. */
-    settingsFiles?: LocalFileName | [LocalFileName];
-    /**
-     * only for tests
-     * @internal */
-    testCloudCache?: CloudSqlite.CloudCache;
+    /** The name(s) of one or more local JSON files containing [[SettingsDictionary]]s to load when initializing the [[Workspace]]. */
+    settingsFiles?: LocalFileName | LocalFileName[];
+}
+/** Arguments supplied to [[Workspace.getContainer]] and [[WorkspaceEditor.getContainer]].
+ * @beta
+ */
+export interface GetWorkspaceContainerArgs extends WorkspaceContainerProps {
+    /** Token required to access the container. */
+    accessToken: AccessToken;
 }
 /**
  * Settings and resources that customize an application for the current session.
- * See [Workspaces]($docs/learning/backend/Workspace)
+ * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.
  * @beta
  */
 export interface Workspace {
-    /** The directory for local WorkspaceDb files with the name `${containerId}/${dbId}.itwin-workspace`. */
+    /** @internal */
+    [_implementationProhibited]: unknown;
+    /** The directory for local WorkspaceDb files with the name `${containerId}/${dbId}.itwin-workspace`.
+     * @internal
+     */
     readonly containerDir: LocalDirName;
-    /** The [[Settings]] for this Workspace */
+    /** The current [[Settings]] for this Workspace */
     readonly settings: Settings;
-    /** Get The CloudCache for cloud-based WorkspaceContainers */
+    /** Get the cloud cache for cloud-based [[WorkspaceContainer]]s. */
     getCloudCache(): CloudSqlite.CloudCache;
-    /** search for a previously opened container.
-     * @param containerId the id of the container
-     * @returns the [[WorkspaceContainer]] for `containerId` if it was not previously opened with [[getContainer]]
+    /** Search for a container previously opened by [[getContainer]] or [[getContainerAsync]].
+     * @param containerId The id of the container
+     * @returns the [[WorkspaceContainer]] for `containerId`, or `undefined` if no such container has been opened.
+     * @internal
      */
-    findContainer(containerId: WorkspaceContainer.Id): WorkspaceContainer | undefined;
-    /** get a [[WorkspaceContainer]] by [[WorkspaceContainer.Props]]
-     * @param props the properties of the `WorkspaceContainer`. If `props.containerId` was already opened, its WorkspaceContainer is returned.
+    findContainer(containerId: WorkspaceContainerId): WorkspaceContainer | undefined;
+    /** Obtain the [[WorkspaceContainer]] specified by `props`.
+     * @param props The properties of the `WorkspaceContainer`, opening it if it is not already opened.
      * Otherwise it is created.
-     * @param account If present, the properties for this container if it is to be opened from the cloud. If not present, the container is just a local directory.
+     * @note This function allows a `WorkspaceContainer.Props` without its [AccessToken]($bentley). It will attempt to obtain one from the [[BlobContainer]] service,
+     * hence this function is async.
+     * @see [[getContainer]] to obtain a container synchronously.
     */
-    getContainer(props: WorkspaceContainer.Props): WorkspaceContainer;
-    /** get the properties for the supplied container name by searching for an entry with that name in a `cloud/containers` setting. */
-    resolveContainer(containerName: WorkspaceContainer.Name): WorkspaceContainer.Props;
-    /** get the properties for the supplied workspace database name by searching for an entry with that name in a `workspace/databases` setting. */
-    resolveDatabase(databaseAlias: WorkspaceDb.Name): WorkspaceDb.Props & WorkspaceContainer.Alias;
-    /**
-     * Get an opened [[WorkspaceDb]]. If the WorkspaceDb is present but not open, it is opened first.
-     * If `cloudProps` are supplied, a CloudContainer will be used to open the WorkspaceDb.
+    getContainerAsync(props: WorkspaceContainerProps): Promise<WorkspaceContainer>;
+    /** Get a WorkspaceContainer with a supplied access token. This function is synchronous and may be used if:
+     * - a valid [AccessToken]($bentley) is already available;
+     * - the container has already been previously prefetched in another session (this is useful for offline usage); or
+     * - the container is public and doesn't require an [AccessToken]($bentley).
+     * @see [[getContainerAsync]] to obtain a container asynchronously if the above conditions do not apply.
      */
-    getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb;
-    /** Get an opened [[WorkspaceDb]] from a WorkspaceDb alias.
-     * @param dbAlias the database alias, resolved via [[resolveDatabase]].
+    getContainer(props: GetWorkspaceContainerArgs): WorkspaceContainer;
+    /** Load a [[SettingsDictionary]] from the specified [[WorkspaceDb]] and add it to this workspace's current [[Settings]].
+     * @note this function will load the dictionaries from the supplied list, and it will also call itself recursively for any entries in
+     * the loaded Settings with the name [[WorkspaceSettingNames.settingsWorkspaces]]. In this manner, WorkspaceSettings may be "chained" together so that loading one
+     * causes its "dependent" WorkspaceSettings to be loaded. Its `Promise` is resolved after all have been loaded (or failed to load).
      */
-    getWorkspaceDb(dbAlias: WorkspaceDb.Name): Promise<WorkspaceDb>;
-    /** Load a WorkspaceResource of type string, parse it, and add it to the current Settings for this Workspace.
-     * @note settingsRsc must specify a resource holding a stringified JSON representation of a [[SettingDictionary]]
+    loadSettingsDictionary(
+    /** The properties of the [[WorkspaceDb]], plus the resourceName and [[SettingsPriority]]. May be either a single value or an array of them */
+    props: WorkspaceDbSettingsProps | WorkspaceDbSettingsProps[], 
+    /** If present, an array that is populated with a list of problems while attempting to load the [[SettingsDictionary]](s).   */
+    problems?: WorkspaceDbLoadError[]): Promise<void>;
+    /** Get a single [[WorkspaceDb]].  */
+    getWorkspaceDb(props: WorkspaceDbCloudProps): Promise<WorkspaceDb>;
+    /**
+     * 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]].
+     * The returned array will be sorted according to their [[SettingsPriority]], with the first entry being the highest priority [[WorkspaceDb]].
+     * @note The list is built by combining, in order, all of the settings with the supplied [[SettingName]]. It may therefore include the
+     * properties of same WorkspaceDb multiple times. This list is automatically de-duped by [[getWorkspaceDb]].
+     * @note This function is rarely used directly. Usually it is called by [[getWorkspaceDbs]]. However, this function is synchronous and may sometimes
+     * be useful for editors, tests, or diagnostics.
      */
-    loadSettingsDictionary(settingRsc: WorkspaceResource.Name, db: WorkspaceDb, priority: SettingsPriority): void;
-    /** Close this Workspace. All WorkspaceContainers are dropped. */
-    close(): void;
-}
-/** @beta */
-export declare namespace Workspace {
-    /** @internal */
-    function construct(settings: Settings, opts?: WorkspaceOpts): Workspace;
+    resolveWorkspaceDbSetting(
+    /** the name of the setting. */
+    settingName: SettingName, 
+    /** optional filter to choose specific WorkspaceDbs from the settings values. If present, only those WorkspaceDbs for which the filter returns `true` will be included. */
+    filter?: Workspace.DbListFilter): WorkspaceDbCloudProps[];
+    /**
+     * Get a sorted array of [[WorkspaceDb]]s that can be used to query or load resources. If the arguments supply a `settingName`, this function will
+     * use [[resolveWorkspaceDbSetting]] to get get the array of [[WorkspaceDbCloudProps]].
+     * @returns A `Promise` resolving to an array of [[WorkspaceDb]]s sorted by [[SettingsPriority]] so that resources found in WorkspaceDbs earlier in the list take precedence
+     * over ones with the same name in later WorkspaceDbs. No WorkspaceDb will appear more than once in the list.
+     * @note this function may request an [AccessToken]($bentley) for each WorkspaceDb if necessary, and hence is asynchronous.
+     */
+    getWorkspaceDbs(args: Workspace.DbListOrSettingName & {
+        /** if supplied, this array is populated with a list of problems (e.g. no read permission) attempting to load WorkspacesDbs. */
+        problems?: WorkspaceDbLoadError[];
+        /** only valid when called with a settingName, if so passed as `filter` argument to [[resolveWorkspaceDbSetting]]  */
+        filter?: Workspace.DbListFilter;
+    }): Promise<WorkspaceDb[]>;
 }
 /**
- * A WorkspaceContainer is a type of `CloudSqlite.CloudContainer` that holds WorkspaceDbs. Normally a WorkspaceContainer will hold (many versions of) a single 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.
+ * In this case, [[cloudContainer]] will be `undefined`.
+ * @see [[Workspace.getContainer]] and [[Workspace.getContainerAsync]] to load a container.
  * @beta
  */
 export interface WorkspaceContainer {
-    /** the local directory where this WorkspaceContainer will store temporary files extracted for file-resources. */
+    /** @internal */
+    [_implementationProhibited]: unknown;
+    /** the local directory where this WorkspaceContainer will store temporary files extracted for file-resources.
+     * @internal
+     */
     readonly filesDir: LocalDirName;
-    /** The unique identifier for a WorkspaceContainer a cloud storage account. */
-    readonly id: WorkspaceContainer.Id;
-    /** Workspace holding this WorkspaceContainer. */
+    /** The workspace into which this container was loaded. */
     readonly workspace: Workspace;
-    /** CloudContainer for this WorkspaceContainer (`undefined` if this is a local WorkspaceContainer.) */
+    /** Cloud container for this WorkspaceContainer, or `undefined` if this is a local WorkspaceContainer. */
     readonly cloudContainer?: CloudSqlite.CloudContainer;
+    /** Properties supplied when this container was loaded */
+    readonly fromProps: WorkspaceContainerProps;
     /** @internal */
-    addWorkspaceDb(toAdd: WorkspaceDbImpl): void;
+    addWorkspaceDb(toAdd: WorkspaceDb): void;
     /**
-     * Find the appropriate version of a WorkspaceDb in this WorkspaceContainer based on the SemVer rule
-     * in the `WorkspaceDb.Props`.
-     * If no version satisfying the WorkspaceDb.Props rules exists, throws an exception.
+     * Find the fully-qualified name of a [[WorkspaceDb]] satisfying the name and version criteria specified by `props`.
+     * @throws Error if no version satisfying the criteria exists.
+     */
+    resolveDbFileName(props: WorkspaceDbProps): WorkspaceDbFullName;
+    /** 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.
+     * @internal
      */
-    resolveDbFileName(props: WorkspaceDb.Props): WorkspaceDb.DbFullName;
-    /**
-     * Create a copy of an existing [[WorkspaceDb]] in this WorkspaceContainer with a new version number. This function is used
-     * by administrator tools that modify Workspaces. This requires that the write lock on the container be held. The copy should be modified with
-     * new content before the write lock is released, and thereafter should never be modified again.
-     * @param fromProps Properties that describe the source WorkspaceDb for the new version
-     * @param versionType The type of version increment to apply to the existing version.
-     * @note The copy actually shares all of the data with the original, but with copy-on-write if/when data in the new WorkspaceDb is modified.
-     */
-    makeNewVersion(fromProps: WorkspaceDb.Props, versionType: WorkspaceDb.VersionIncrement): Promise<{
-        oldName: WorkspaceDb.DbName;
-        newName: WorkspaceDb.DbName;
-    }>;
-    /** find or open a WorkspaceDb from this WorkspaceContainer. */
-    getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb;
-    /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace. */
     closeWorkspaceDb(container: WorkspaceDb): void;
-    /** Close this WorkspaceContainer. All currently opened WorkspaceDbs are dropped. */
-    close(): void;
 }
-/**
- * An editable [[WorkspaceDb]]. This is used only by tools to allow administrators to create and modify `WorkspaceDb`s.
- * For CloudSqlite Workspaces, the write token must be obtained before the methods in this interface may be used. Normally
- * only admins will have write access to Workspaces. Only one admin at at time may be editing a Workspace.
+/** The names of various [[Setting]]s with special meaning to the [[Workspace]] system.
  * @beta
  */
-export interface EditableWorkspaceDb extends WorkspaceDb {
-    createDb(version?: string): Promise<void>;
-    /** Add a new string resource to this WorkspaceDb.
-     * @param rscName The name of the string resource.
-     * @param val The string to save.
-     */
-    addString(rscName: WorkspaceResource.Name, val: string): void;
-    /** Update an existing string resource with a new value, or add it if it does not exist.
-     * @param rscName The name of the string resource.
-     * @param val The new value.
-     */
-    updateString(rscName: WorkspaceResource.Name, val: string): void;
-    /** Remove a string resource. */
-    removeString(rscName: WorkspaceResource.Name): void;
-    /** Add a new blob resource to this WorkspaceDb.
-     * @param rscName The name of the blob resource.
-     * @param val The blob to save.
-     */
-    addBlob(rscName: WorkspaceResource.Name, val: Uint8Array): void;
-    /** Update an existing blob resource with a new value, or add it if it does not exist.
-     * @param rscName The name of the blob resource.
-     * @param val The new value.
-     */
-    updateBlob(rscName: WorkspaceResource.Name, val: Uint8Array): void;
-    /** Get a BlobIO writer for a previously-added blob WorkspaceResource.
-     * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.
-     */
-    getBlobWriter(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;
-    /** Remove a blob resource. */
-    removeBlob(rscName: WorkspaceResource.Name): void;
-    /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.
-     * @param rscName The name of the file resource.
-     * @param localFileName The name of a local file to be read.
-     * @param fileExt The extension (do not include the leading ".") to be appended to the generated fileName
-     * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last "." in `localFileName`
-     * are used. Pass this argument to override that.
-     */
-    addFile(rscName: WorkspaceResource.Name, localFileName: LocalFileName, fileExt?: string): void;
-    /** Replace an existing file resource with the contents of another local file.
-     * @param rscName The name of the file resource.
-     * @param localFileName The name of a local file to be read.
-     * @throws if rscName does not exist
-     */
-    updateFile(rscName: WorkspaceResource.Name, localFileName: LocalFileName): void;
-    /** Remove a file resource. */
-    removeFile(rscName: WorkspaceResource.Name): void;
+export declare namespace WorkspaceSettingNames {
+    /** The name of a setting that, when present in a [[WorkspaceDb]] loaded by [[Workspace.loadSettingsDictionary]], will automatically
+     * be used to find and load additional [[SettingsDictionary]]'s in other [[WorkspaceDb]]s. This permits you to chain the settings inside on [[WorkspaceDb]]
+     * to others upon which they depend.
+     * This setting's value is an array of [[WorkspaceDbSettingsProps]]s.
+     */
+    const settingsWorkspaces: string;
 }
-/** @beta */
-export declare namespace EditableWorkspaceDb {
-    /** construct a new instance of an EditableWorkspaceDb */
-    function construct(props: WorkspaceDb.Props, container: WorkspaceContainer): EditableWorkspaceDb;
-    /** Create a new, empty, EditableWorkspaceDb file on the local filesystem for importing Workspace resources. */
-    function createEmpty(fileName: LocalFileName): void;
+/** A function supplied as part of a [[QueryWorkspaceResourcesArgs]] to iterate the resources retrieved by [[Workspace.queryResources]].
+ * The `resources` object should only be used inside the function - it is an error to attempt to iterate it after the function returns.
+ * @beta
+ */
+export type QueryWorkspaceResourcesCallback = (resources: Iterable<{
+    name: string;
+    db: WorkspaceDb;
+}>) => void;
+/** Arguments supplied to [[Workspace.queryResources]] defining the query criteria and the list of [[WorkspaceDb]]s to query.
+ * @beta
+ */
+export interface QueryWorkspaceResourcesArgs {
+    /** The list of `WorkspaceDb`s to query, in the order in which they are to be queried.
+     * @see [[Workspace.resolveWorkspaceDbSetting]] or [[Workspace.getWorkspaceDbs]] to obtain an appropriate list of `WorkspaceDb`s.
+     */
+    dbs: WorkspaceDb[];
+    /** The type of resource to query. */
+    type?: "string" | "blob";
+    /** A pattern against which to compare the name of each resource, using [[nameCompare]] as the comparison operator.
+     * Only resources whose names match the pattern will be included in the query results.
+     */
+    namePattern?: string;
+    /** The comparison operator by which to compare the name of each resource to [[namePattern]].
+     * Only resources whose names match the pattern will be included in the query results.
+     * Ignored i [[namePattern]] is undefined.
+     */
+    nameCompare?: "GLOB" | "LIKE" | "NOT GLOB" | "NOT LIKE" | "=" | "<" | ">";
+    /** A function invoked to process the resources that match the query criteria. */
+    callback: QueryWorkspaceResourcesCallback;
 }
-/** Implementation of WorkspaceDb */
-declare class WorkspaceDbImpl implements WorkspaceDb {
-    readonly sqliteDb: SQLiteDb;
-    readonly dbName: WorkspaceDb.DbName;
-    readonly container: WorkspaceContainer;
-    readonly onClose: BeEvent<() => void>;
-    dbFileName: string;
-    /** true if this WorkspaceDb is currently open */
-    get isOpen(): boolean;
-    queryFileResource(rscName: WorkspaceResource.Name): {
-        localFileName: LocalFileName;
-        info: IModelJsNative.EmbedFileQuery;
-    } | undefined;
-    constructor(props: WorkspaceDb.Props, container: WorkspaceContainer);
-    open(): void;
-    close(): void;
-    getString(rscName: WorkspaceResource.Name): string | undefined;
-    getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;
-    getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;
-    getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined;
-    prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch;
+/** Arguments supplied to [[Workspace.getStringResource]] and [[WOrkspace.getBlobResource]].
+ * @beta
+ */
+export interface GetWorkspaceResourceArgs {
+    /** The list of `WorkspaceDb`s to search, in the order in which they are to be searched.
+     * @see [[Workspace.resolveWorkspaceDbSetting]] or [[Workspace.getWorkspaceDbs]] to obtain an appropriate list of `WorkspaceDb`s.
+     */
+    dbs: WorkspaceDb[];
+    /** The name of the resource to find. */
+    name: WorkspaceResourceName;
+}
+/** @beta */
+export declare namespace Workspace {
+    /** A function invoked to handle exceptions produced while loading workspace data.
+     * Applications can override this function to notify the user and/or attempt to diagnose the problem.
+     * The default implementation simply logs each exception.
+     */
+    let exceptionDiagnosticFn: (e: WorkspaceDbLoadErrors) => void;
+    /** Arguments supplied to [[Workspace.onSettingsDictionaryLoadedFn]] for every [[SettingsDictionary]] that is loaded from a [[WorkspaceDb]]. */
+    interface SettingsDictionaryLoaded {
+        /** The dictionary that was loaded */
+        dict: SettingsDictionary;
+        /** The WorkspaceDb from which the dictionary was loaded. */
+        from: WorkspaceDb;
+    }
+    /** A function invoked each time any [[SettingsDictionary]] is loaded from a [[WorkspaceDb]].
+     * Applications can override this function to notify the user and/or record diagnostics.
+     * The default implementation simply records an information message in the [Logger]($bentley).
+     */
+    let onSettingsDictionaryLoadedFn: (loaded: SettingsDictionaryLoaded) => void;
+    /** Either an array of [[WorkspaceDbCloudProps]] or the name of a [[Setting]] that resolves to an array of [[WorkspaceDbCloudProps]].
+     * Used by [[Workspace.getWorkspaceDbs]].
+     */
+    type DbListOrSettingName = {
+        readonly dbs: WorkspaceDbCloudProps[];
+        readonly settingName?: never;
+    } | {
+        readonly settingName: SettingName;
+        readonly dbs?: never;
+    };
+    /** In arguments supplied to [[Workspace.getWorkspaceDbs]] and [[Workspace.resolveWorkspaceDbSetting]], an optional function used to exclude some
+     * [[WorkspaceDb]]s. Only those [[WorkspaceDb]]s for which the function returns `true` will be included.
+     */
+    type DbListFilter = (
+    /** The properties of the WorkspaceDb to be returned */
+    dbProp: WorkspaceDbCloudProps, 
+    /** The SettingsDictionary holding the [[WorkspaceSettingNames.settingsWorkspace]] setting. May be used, for example, to determine the
+     * [[SettingsPriority]] of the dictionary.
+     */
+    dict: SettingsDictionary) => boolean;
+    /** Searches a list of [[WorkspaceDb]]s for a string resource of a given name.
+     * The list is searched in order, and the first resource with the request name is returned.
+     * If no such resource exists, the function returns `undefined`.
+     * @see [[WorkspaceDb.getString]] if you only need to search a single `WorkspaceDb`.
+     * @beta
+     */
+    function getStringResource(args: GetWorkspaceResourceArgs): string | undefined;
+    /** Searches a list of [[WorkspaceDb]]s for a blob resource of a given name.
+     * The list is searched in order, and the first resource with the request name is returned.
+     * If no such resource exists, the function returns `undefined`.
+     * @see [[WorkspaceDb.getblob]] if you only need to search a single `WorkspaceDb`.
+     * @beta
+     */
+    function getBlobResource(args: GetWorkspaceResourceArgs): Uint8Array | undefined;
+    /** Query a list of [[WorkspaceDb]]s to find resources of a particular type with names matching a specified pattern.
+     * @see [[WorkspaceDb.queryResources]] if you only need to query a single `WorkspaceDb`.
+     * @beta
+     */
+    function queryResources(args: QueryWorkspaceResourcesArgs): void;
 }
-export {};
 //# sourceMappingURL=Workspace.d.ts.map