@itwin/core-backend 5.8.0-dev.2 → 5.8.0-dev.20

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

@@ -1 +1 @@
-{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAQhE,YAAY;AACZ,MAAM,KAAW,OAAO,CA+DvB;AA/DD,WAAiB,OAAO;IACtB,2CAA2C;IAC3C,SAAgB,KAAK,CAAoB,OAAU;QACjD,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;YACzC,OAAO,OAAO,CAAC;QAEjB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAE,OAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,OAAO,MAAM,CAAC;IAChB,CAAC;IAPe,aAAK,QAOpB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAsB,EAAE,CAAsB;QACrE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,qCAAqC;QACrC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBACpE,OAAO,KAAK,CAAC;YACf,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1B,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,QAAQ,CAAE,CAAuB,CAAC,GAAG,CAAC,EAAG,CAAuB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5E,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IA5Ce,gBAAQ,WA4CvB,CAAA;AACH,CAAC,EA/DgB,OAAO,KAAP,OAAO,QA+DvB;AA0CD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAahC;AAbD,WAAiB,gBAAgB;IAC/B,yGAAyG;IAC5F,yBAAQ,GAAG,GAAG,CAAC;IAC5B,sDAAsD;IACzC,4BAAW,GAAG,GAAG,CAAC;IAC/B,6DAA6D;IAChD,6BAAY,GAAG,GAAG,CAAC;IAChC,sDAAsD;IACzC,sBAAK,GAAG,GAAG,CAAC;IACzB,wDAAwD;IAC3C,uBAAM,GAAG,GAAG,CAAC;IAC1B,gDAAgD;IACnC,uBAAM,GAAG,GAAG,CAAC;AAC5B,CAAC,EAbgB,gBAAgB,KAAhB,gBAAgB,QAahC","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 { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { WorkspaceDb } from \"./Workspace\";\r\nimport { _implementationProhibited } from \"../internal/Symbols\";\r\n\r\n/** The value of a single named parameter within a [[Workspace.settings]] that configures some aspect of the applications run-time behavior.\r\n * Settings are stored in a [[SettingsDictionary]]. A setting is described by its [[SettingSchema]].\r\n * @beta\r\n */\r\nexport type Setting = JSONSchemaType;\r\n\r\n/** @beta */\r\nexport namespace Setting { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Create a deep copy of a [[Setting]]. */\r\n  export function clone<T extends Setting>(setting: T): T {\r\n    if (!setting || typeof setting !== \"object\")\r\n      return setting;\r\n\r\n    const result = Array.isArray(setting) ? [] : {} as any;\r\n    Object.keys(setting).forEach((key: string) => result[key] = clone((setting as any)[key]));\r\n    return result;\r\n  }\r\n\r\n  /** Returns true if `a` and `b` are considered equivalent [[Setting]] values.\r\n   * Settings of primitive types like `number` and `string` are compared using `===`.\r\n   * Settings of type \"object\" are compared by comparing each property using `areEqual`; the objects are considered\r\n   * equal if they have the exact same set of property names with equivalent values.\r\n   * Settings of type \"array\" are compared by comparing each element of the arrays use `areEqual`; the arrays are considered\r\n   * equal if they have the same number of elements with equivalent values in the same exact order.\r\n   */\r\n  export function areEqual(a: Setting | undefined, b: Setting | undefined): boolean {\r\n    if (a === b) {\r\n      return true;\r\n    }\r\n\r\n    // For primitive types, === suffices.\r\n    if (typeof a !== \"object\" || typeof b !== \"object\") {\r\n      return false;\r\n    }\r\n\r\n    if (Array.isArray(a) || Array.isArray(b)) {\r\n      if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {\r\n        return false;\r\n      }\r\n\r\n      for (let i = 0; i < a.length; i++) {\r\n        if (!areEqual(a[i], b[i])) {\r\n          return false;\r\n        }\r\n      }\r\n\r\n      return true;\r\n    }\r\n\r\n    const aKeys = Object.keys(a);\r\n    const bKeys = Object.keys(b);\r\n    if (aKeys.length !== bKeys.length) {\r\n      return false;\r\n    }\r\n\r\n    aKeys.sort();\r\n    bKeys.sort();\r\n    for (let i = 0; i < aKeys.length; i++) {\r\n      const key = aKeys[i];\r\n      if (key !== bKeys[i]) {\r\n        return false;\r\n      }\r\n\r\n      if (!areEqual((a as SettingsContainer)[key], (b as SettingsContainer)[key])) {\r\n        return false;\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/**\r\n * The name of a [[Setting]].\r\n * Setting names must be [valid JavaScript property names](https://developer.mozilla.org/en-US/docs/Glossary/property/JavaScript) containing no spaces or periods.\r\n * The name of a setting begins with the schema prefix of the [[SettingGroupSchema]] in which its [[SettingSchema]] is defined.\r\n * A setting name therefore forms a path like file names in a file system.\r\n * For example, the following are setting names defined in the `energyAnalysis`, `iot-scan-visualization`, and `vibration-map` schemas.\r\n *\r\n * ```ts\r\n * \"energyAnalysis/formats/totalWork\"\r\n * \"energyAnalysis/formats/totalHours\"\r\n * \"energyAnalysis/units/power\"\r\n * \"energyAnalysis/units/temperature\"\r\n * \"energyAnalysis/startupMode\"\r\n * \"iot-scan-visualization/ports/cameras\"\r\n * \"vibration-map/filters/scope\"\r\n * \"vibration-map/filters/prefabricated\"\r\n * ```\r\n *\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** An object that defines the values for any number of [[Setting]]s. Each of its properties' names must conform to the semantics of a [[SettingName]].\r\n * @beta\r\n */\r\nexport interface SettingsContainer {\r\n  /** Accesses settings by their names. */\r\n  [name: SettingName]: Setting | undefined;\r\n}\r\n\r\n/** Defines the precedence of a [[SettingsDictionary]].\r\n * [[Settings]] may contain multiple dictionaries containing different values for the same [[SettingName]].\r\n * When resolving the value of a [[Setting]], the value from the highest-priority dictionary is used.\r\n * Priorities are grouped into coarse categories like [[SettingsPriority.application]] and [[SettingsPriority.iModel]].\r\n * Settings with priorities less than or equal to [[SettingsPriority.application]] are stored in [[IModelHost.appWorkspace]], while\r\n * those with priorities higher than [[SettingsPriority.application]] are stored inside [[IModelDb.workspace]].\r\n * @beta\r\n */\r\nexport type SettingsPriority = number;\r\n\r\n/** @beta */\r\nexport namespace SettingsPriority { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Settings that originate from default setting files loaded automatically at the start of a session. */\r\n  export const defaults = 100;\r\n  /** Settings supplied by an application at runtime. */\r\n  export const application = 200;\r\n  /** Settings that apply to all iTwins for an organization. */\r\n  export const organization = 300;\r\n  /** Settings that apply to all iModels in an iTwin. */\r\n  export const iTwin = 400;\r\n  /** Settings that apply to all branches of an iModel. */\r\n  export const branch = 500;\r\n  /** Settings that apply to a specific iModel. */\r\n  export const iModel = 600;\r\n}\r\n\r\n/** A named container that supplies values for [[Setting]]s.\r\n * @see [[Settings.addDictionary]] to register a new settings dictionary.\r\n * @beta\r\n */\r\nexport interface SettingsDictionary {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /** Metadata describing the dictionary. */\r\n  readonly props: SettingsDictionaryProps;\r\n\r\n  /** Obtain a copy of the value of the setting named `settingName` stored in this dictionary, or `undefined` if no such setting exists.\r\n   * The returned value is always cloned using [[Setting.clone]].\r\n   * @note Generally, applications use methods like [[Settings.getString]] and [[Setting.getArray]] to resolve a setting value from multiple\r\n   * dictionaries. Those methods - unlike this one - also validate that `settingName` is of type `T` as defined by its [[SettingSchema]].\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName): T | undefined;\r\n}\r\n\r\n/** Uniquely identifies a [[SettingsDictionary]].\r\n * @beta\r\n */\r\nexport interface SettingsDictionarySource {\r\n  /** The name of the dictionary, which must be unique within its [[workspaceDb]], or - if [[workspaceDb]] is undefined - unique among all dictionaries not associated with any [[WorkspaceDb]]. */\r\n  readonly name: string;\r\n  /** The [[WorkspaceDb]] from which the dictionary originated. */\r\n  readonly workspaceDb?: WorkspaceDb;\r\n}\r\n\r\n/** Properties of a [[SettingsDictionary]], defining its name, the [[WorkspaceDb]] (if any) from which it originated, and its [[priority]] relative to other dictionaries.\r\n * @beta\r\n */\r\nexport interface SettingsDictionaryProps extends SettingsDictionarySource {\r\n  /** Precedence value determining which setting value to use when multiple dictionaries supply values for the same [[SettingName]]. */\r\n  readonly priority: SettingsPriority;\r\n}\r\n\r\n/**\r\n * The collection of [[Setting]]s that supply the run-time configuration of a [[Workspace]].\r\n * The `Settings` object comprises a collection of named [[SettingsDictionary]] objects.\r\n * Methods like [[getSetting]], [[getString]], and [[getArray]] provide access to the value of an individual [[Setting]] by searching\r\n * the [[dictionaries]] in order by their [[SettingsPriority]] to find the highest-priority setting with the requested [[SettingName]].\r\n * Most methods that retrieve [[Setting]] values validate them against their [[SettingSchema]]s to ensure that they are of the correct type.\r\n * A [[SettingsDictionary]] can be added or removed using [[addDictionary]] and [[dropDictionary]].\r\n * Because [[Setting]]s can change at any time during the session, you should avoid caching their values wherever possible.\r\n * If you must cache them (for example, to display in a user interface), you should listen for the [[onSettingsChanged]] event to be\r\n * notified of potential changes.\r\n *\r\n * Settings are accessed via [[Workspace.settings]]. They are defined at the application level by [[IModelHost.appWorkspace]], but individual iModels may supply\r\n * additional iModel-specific settings or overrides for application-level settings. When working in the context of a specific iModel, use [[IModelDb.workspace]]'s `settings`\r\n * property. Any settings not overridden by the iModel will fall back to the settings defined in [[IModelHost.appWorkspace]].\r\n *\r\n * Application settings are loaded into [[IModelHost.appWorkspace]] when the session begins (i.e., when [[IModelHost.startup]] is invoked), and unloaded when it ends (in [[IModelHost.shutdown]]).\r\n * They are read from [JSON5](https://json5.org/) files delivered with the application. The application should register any additional [[SettingsDictionary]]'s '(and their corresponding\r\n * [[SettingGroupSchema]]s) at this time.\r\n *\r\n * iModel-specific settings are stored in the iModel's property table and loaded into [[IModelDb.workspace]] when the iModel is first opened.\r\n * You can add and remove a [[SettingsDictionary]] from the property table using [[IModelDb.saveSettingDictionary]] and [[IModelDb.deleteSettingDictionary]].\r\n *\r\n * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.\r\n *\r\n * @see [[IModelHost.appWorkspace]] application-wide settings, and [[IModelDb.workspace]] for settings specific to a given iModel.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  [_implementationProhibited]: unknown;\r\n\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** The set of settings dictionaries from which [[Setting]] values are obtained, sorted by [[SettingsPriority]].\r\n   * The set can contain at most one dictionary for each unique combination of name and [[WorkspaceDb]].\r\n   * @see [[addDictionary]], [[addFile]], [[addJson]], and [[addDirectory]] to add a new dictionary.\r\n   * @see [[dropDictionary]] to remove a dictionary.\r\n   * @see [[getDictionary]] to look up a dictionary.\r\n   */\r\n  readonly dictionaries: readonly SettingsDictionary[];\r\n\r\n  /** Event raised whenever a [[SettingsDictionary]] is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Parses the contents of a local [JSON5](https://json5.org/) file as a [[SettingsContainer]] and invokes [[addDictionary]] to\r\n   * add a [[SettingsDictionary]] named `fileName` with the specified priority.\r\n   * @param fileName the name of a local settings file containing the dictionary.\r\n   * @param priority the priority for the dictionary.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Invokes [[addFile]] for all files in `directory` with the extension \".json\" or \".json5\". */\r\n  addDirectory(directory: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Parses `settingsJson` as a [[SettingsContainer]] and invokes [[addDictionary]] to add a [[SettingsDictionary]] with the specified `props`.\r\n   * This is typically used when reading dictionaries out of a [[WorkspaceDb]], where they are stored as stringified JSON.\r\n   */\r\n  addJson(props: SettingsDictionaryProps, settingsJson: string): void;\r\n\r\n  /** Find a [[SettingsDictionary]] with the same name and [[WorkspaceDb]] as `source`. */\r\n  getDictionary(source: SettingsDictionarySource): SettingsDictionary | undefined;\r\n\r\n  /** Add a new [[SettingsDictionary]] with the priority, name, and [[WorkspaceDb]] specified by `props` and setting values supplied by `settings`.\r\n   * @note If a dictionary with the same name and [[WorkspaceDb]] already exists, it will be replaced.\r\n   * @see [[addFile]], [[addJson]], and [[addDirectory]] for convenient ways to add dictionaries from various sources.\r\n   */\r\n  addDictionary(props: SettingsDictionaryProps, settings: SettingsContainer): void;\r\n\r\n  /** Removes a previously-added [[SettingsDictionary]]. */\r\n  dropDictionary(props: SettingsDictionarySource): void;\r\n\r\n  /** Looks up the highest priority setting value for a SettingName, falling back to a default value if no value for the setting is found.\r\n   * The [[dictionaries]] are searched in order by [[SettingsPriority]]; the first one that provides a value for `settingName` wins.\r\n   * @param settingName The name of the setting.\r\n   * @param defaultValue value returned if settingName is not present in any [[SettingsDictionary]].\r\n   * @note This method is generic on [[Setting]] type, but no type checking is actually performed at run time. So, if you\r\n   * use this method to get a setting with an expected type, but its value is a different type, the return type of this method will be wrong.\r\n   * You must always type check the result. Use the non-generic \"get\" methods like [[getString]] and [[getArray]] if you only want the value\r\n   * if its type is correct.\r\n   * @note Unlike [[getArray]], this method does not combine arrays - it ignores [[SettingsSchema.combineArrays]].\r\n   */\r\n  getSetting<T extends Setting>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\r\n  getSettingEntries<T extends Setting>(settingName: SettingName): Iterable<{ value: T, dictionary: SettingsDictionary}>;\r\n\r\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\r\n  getSettingValues<T extends Setting>(settingName: SettingName): Iterable<T>;\r\n\r\n  /** Look up the value of a string [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not a string.\r\n   */\r\n  getString(settingName: SettingName, defaultValue: string): string;\r\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\r\n\r\n  /** Look up the value of a boolean [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not a boolean.\r\n   */\r\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\r\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\r\n\r\n  /** Look up the value of a numeric [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not a number.\r\n   */\r\n  getNumber(settingName: SettingName, defaultValue: number): number;\r\n  getNumber(settingName: SettingName): number | undefined;\r\n\r\n  /** Look up the value of an object [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not an object.\r\n   */\r\n  getObject<T extends object>(settingName: SettingName, defaultValue: T): T;\r\n  getObject<T extends object>(settingName: SettingName): T | undefined;\r\n\r\n  /** Look up the value of an array [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\r\n   * @throws Error if the setting exists but is not an array.\r\n   */\r\n  getArray<T extends Setting>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends Setting>(settingName: SettingName): Array<T> | undefined;\r\n}\r\n"]}
+{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAQhE,YAAY;AACZ,MAAM,KAAW,OAAO,CA+DvB;AA/DD,WAAiB,OAAO;IACtB,2CAA2C;IAC3C,SAAgB,KAAK,CAAoB,OAAU;QACjD,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;YACzC,OAAO,OAAO,CAAC;QAEjB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAE,OAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,OAAO,MAAM,CAAC;IAChB,CAAC;IAPe,aAAK,QAOpB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,QAAQ,CAAC,CAAsB,EAAE,CAAsB;QACrE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,qCAAqC;QACrC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBACpE,OAAO,KAAK,CAAC;YACf,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1B,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,QAAQ,CAAE,CAAuB,CAAC,GAAG,CAAC,EAAG,CAAuB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5E,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IA5Ce,gBAAQ,WA4CvB,CAAA;AACH,CAAC,EA/DgB,OAAO,KAAP,OAAO,QA+DvB;AA0CD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAahC;AAbD,WAAiB,gBAAgB;IAC/B,yGAAyG;IAC5F,yBAAQ,GAAG,GAAG,CAAC;IAC5B,sDAAsD;IACzC,4BAAW,GAAG,GAAG,CAAC;IAC/B,6DAA6D;IAChD,6BAAY,GAAG,GAAG,CAAC;IAChC,sDAAsD;IACzC,sBAAK,GAAG,GAAG,CAAC;IACzB,wDAAwD;IAC3C,uBAAM,GAAG,GAAG,CAAC;IAC1B,gDAAgD;IACnC,uBAAM,GAAG,GAAG,CAAC;AAC5B,CAAC,EAbgB,gBAAgB,KAAhB,gBAAgB,QAahC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { WorkspaceDb } from \"./Workspace\";\nimport { _implementationProhibited } from \"../internal/Symbols\";\n\n/** The value of a single named parameter within a [[Workspace.settings]] that configures some aspect of the applications run-time behavior.\n * Settings are stored in a [[SettingsDictionary]]. A setting is described by its [[SettingSchema]].\n * @beta\n */\nexport type Setting = JSONSchemaType;\n\n/** @beta */\nexport namespace Setting { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** Create a deep copy of a [[Setting]]. */\n  export function clone<T extends Setting>(setting: T): T {\n    if (!setting || typeof setting !== \"object\")\n      return setting;\n\n    const result = Array.isArray(setting) ? [] : {} as any;\n    Object.keys(setting).forEach((key: string) => result[key] = clone((setting as any)[key]));\n    return result;\n  }\n\n  /** Returns true if `a` and `b` are considered equivalent [[Setting]] values.\n   * Settings of primitive types like `number` and `string` are compared using `===`.\n   * Settings of type \"object\" are compared by comparing each property using `areEqual`; the objects are considered\n   * equal if they have the exact same set of property names with equivalent values.\n   * Settings of type \"array\" are compared by comparing each element of the arrays use `areEqual`; the arrays are considered\n   * equal if they have the same number of elements with equivalent values in the same exact order.\n   */\n  export function areEqual(a: Setting | undefined, b: Setting | undefined): boolean {\n    if (a === b) {\n      return true;\n    }\n\n    // For primitive types, === suffices.\n    if (typeof a !== \"object\" || typeof b !== \"object\") {\n      return false;\n    }\n\n    if (Array.isArray(a) || Array.isArray(b)) {\n      if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {\n        return false;\n      }\n\n      for (let i = 0; i < a.length; i++) {\n        if (!areEqual(a[i], b[i])) {\n          return false;\n        }\n      }\n\n      return true;\n    }\n\n    const aKeys = Object.keys(a);\n    const bKeys = Object.keys(b);\n    if (aKeys.length !== bKeys.length) {\n      return false;\n    }\n\n    aKeys.sort();\n    bKeys.sort();\n    for (let i = 0; i < aKeys.length; i++) {\n      const key = aKeys[i];\n      if (key !== bKeys[i]) {\n        return false;\n      }\n\n      if (!areEqual((a as SettingsContainer)[key], (b as SettingsContainer)[key])) {\n        return false;\n      }\n    }\n\n    return true;\n  }\n}\n\n/**\n * The name of a [[Setting]].\n * Setting names must be [valid JavaScript property names](https://developer.mozilla.org/en-US/docs/Glossary/property/JavaScript) containing no spaces or periods.\n * The name of a setting begins with the schema prefix of the [[SettingGroupSchema]] in which its [[SettingSchema]] is defined.\n * A setting name therefore forms a path like file names in a file system.\n * For example, the following are setting names defined in the `energyAnalysis`, `iot-scan-visualization`, and `vibration-map` schemas.\n *\n * ```ts\n * \"energyAnalysis/formats/totalWork\"\n * \"energyAnalysis/formats/totalHours\"\n * \"energyAnalysis/units/power\"\n * \"energyAnalysis/units/temperature\"\n * \"energyAnalysis/startupMode\"\n * \"iot-scan-visualization/ports/cameras\"\n * \"vibration-map/filters/scope\"\n * \"vibration-map/filters/prefabricated\"\n * ```\n *\n * @beta\n */\nexport type SettingName = string;\n\n/** An object that defines the values for any number of [[Setting]]s. Each of its properties' names must conform to the semantics of a [[SettingName]].\n * @beta\n */\nexport interface SettingsContainer {\n  /** Accesses settings by their names. */\n  [name: SettingName]: Setting | undefined;\n}\n\n/** Defines the precedence of a [[SettingsDictionary]].\n * [[Settings]] may contain multiple dictionaries containing different values for the same [[SettingName]].\n * When resolving the value of a [[Setting]], the value from the highest-priority dictionary is used.\n * Priorities are grouped into coarse categories like [[SettingsPriority.application]] and [[SettingsPriority.iModel]].\n * Settings with priorities less than or equal to [[SettingsPriority.application]] are stored in [[IModelHost.appWorkspace]], while\n * those with priorities higher than [[SettingsPriority.application]] are stored inside [[IModelDb.workspace]].\n * @beta\n */\nexport type SettingsPriority = number;\n\n/** @beta */\nexport namespace SettingsPriority { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** Settings that originate from default setting files loaded automatically at the start of a session. */\n  export const defaults = 100;\n  /** Settings supplied by an application at runtime. */\n  export const application = 200;\n  /** Settings that apply to all iTwins for an organization. */\n  export const organization = 300;\n  /** Settings that apply to all iModels in an iTwin. */\n  export const iTwin = 400;\n  /** Settings that apply to all branches of an iModel. */\n  export const branch = 500;\n  /** Settings that apply to a specific iModel. */\n  export const iModel = 600;\n}\n\n/** A named container that supplies values for [[Setting]]s.\n * @see [[Settings.addDictionary]] to register a new settings dictionary.\n * @beta\n */\nexport interface SettingsDictionary {\n  /** @internal */\n  [_implementationProhibited]: unknown;\n\n  /** Metadata describing the dictionary. */\n  readonly props: SettingsDictionaryProps;\n\n  /** Obtain a copy of the value of the setting named `settingName` stored in this dictionary, or `undefined` if no such setting exists.\n   * The returned value is always cloned using [[Setting.clone]].\n   * @note Generally, applications use methods like [[Settings.getString]] and [[Setting.getArray]] to resolve a setting value from multiple\n   * dictionaries. Those methods - unlike this one - also validate that `settingName` is of type `T` as defined by its [[SettingSchema]].\n   */\n  getSetting<T extends Setting>(settingName: SettingName): T | undefined;\n\n  /** Return a deep copy of all settings in this dictionary as a [[SettingsContainer]].\n   * This is useful for inspecting the full contents of the dictionary or for building a modified copy\n   * to pass to [[EditableSettingsDb.updateSettingsDictionary]].\n   * The returned container is cloned using [[Setting.clone]], so callers may freely mutate it without\n   * affecting this dictionary's internal state.\n   * @beta\n   */\n  toJSON(): SettingsContainer;\n}\n\n/** Uniquely identifies a [[SettingsDictionary]].\n * @beta\n */\nexport interface SettingsDictionarySource {\n  /** The name of the dictionary, which must be unique within its [[workspaceDb]], or - if [[workspaceDb]] is undefined - unique among all dictionaries not associated with any [[WorkspaceDb]]. */\n  readonly name: string;\n  /** The [[WorkspaceDb]] from which the dictionary originated. */\n  readonly workspaceDb?: WorkspaceDb;\n}\n\n/** Properties of a [[SettingsDictionary]], defining its name, the [[WorkspaceDb]] (if any) from which it originated, and its [[priority]] relative to other dictionaries.\n * @beta\n */\nexport interface SettingsDictionaryProps extends SettingsDictionarySource {\n  /** Precedence value determining which setting value to use when multiple dictionaries supply values for the same [[SettingName]]. */\n  readonly priority: SettingsPriority;\n}\n\n/**\n * The collection of [[Setting]]s that supply the run-time configuration of a [[Workspace]].\n * The `Settings` object comprises a collection of named [[SettingsDictionary]] objects.\n * Methods like [[getSetting]], [[getString]], and [[getArray]] provide access to the value of an individual [[Setting]] by searching\n * the [[dictionaries]] in order by their [[SettingsPriority]] to find the highest-priority setting with the requested [[SettingName]].\n * Most methods that retrieve [[Setting]] values validate them against their [[SettingSchema]]s to ensure that they are of the correct type.\n * A [[SettingsDictionary]] can be added or removed using [[addDictionary]] and [[dropDictionary]].\n * Because [[Setting]]s can change at any time during the session, you should avoid caching their values wherever possible.\n * If you must cache them (for example, to display in a user interface), you should listen for the [[onSettingsChanged]] event to be\n * notified of potential changes.\n *\n * Settings are accessed via [[Workspace.settings]]. They are defined at the application level by [[IModelHost.appWorkspace]], but individual iModels may supply\n * additional iModel-specific settings or overrides for application-level settings. When working in the context of a specific iModel, use [[IModelDb.workspace]]'s `settings`\n * property. Any settings not overridden by the iModel will fall back to the settings defined in [[IModelHost.appWorkspace]].\n *\n * Application settings are loaded into [[IModelHost.appWorkspace]] when the session begins (i.e., when [[IModelHost.startup]] is invoked), and unloaded when it ends (in [[IModelHost.shutdown]]).\n * They are read from [JSON5](https://json5.org/) files delivered with the application. The application should register any additional [[SettingsDictionary]]'s '(and their corresponding\n * [[SettingGroupSchema]]s) at this time.\n *\n * iModel-specific settings are stored in the iModel's property table and loaded into [[IModelDb.workspace]] when the iModel is first opened.\n * You can add and remove a [[SettingsDictionary]] from the property table using [[IModelDb.saveSettingDictionary]] and [[IModelDb.deleteSettingDictionary]].\n *\n * See the [learning article]($docs/learning/backend/Workspace) for a detailed overiew and examples.\n *\n * @see [[IModelHost.appWorkspace]] application-wide settings, and [[IModelDb.workspace]] for settings specific to a given iModel.\n * @beta\n */\nexport interface Settings {\n  /** @internal */\n  [_implementationProhibited]: unknown;\n\n  /** @internal */\n  close(): void;\n\n  /** The set of settings dictionaries from which [[Setting]] values are obtained, sorted by [[SettingsPriority]].\n   * The set can contain at most one dictionary for each unique combination of name and [[WorkspaceDb]].\n   * @see [[addDictionary]], [[addFile]], [[addJson]], and [[addDirectory]] to add a new dictionary.\n   * @see [[dropDictionary]] to remove a dictionary.\n   * @see [[getDictionary]] to look up a dictionary.\n   */\n  readonly dictionaries: readonly SettingsDictionary[];\n\n  /** Event raised whenever a [[SettingsDictionary]] is added or removed. */\n  readonly onSettingsChanged: BeEvent<() => void>;\n\n  /** Parses the contents of a local [JSON5](https://json5.org/) file as a [[SettingsContainer]] and invokes [[addDictionary]] to\n   * add a [[SettingsDictionary]] named `fileName` with the specified priority.\n   * @param fileName the name of a local settings file containing the dictionary.\n   * @param priority the priority for the dictionary.\n   */\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\n\n  /** Invokes [[addFile]] for all files in `directory` with the extension \".json\" or \".json5\". */\n  addDirectory(directory: LocalDirName, priority: SettingsPriority): void;\n\n  /** Parses `settingsJson` as a [[SettingsContainer]] and invokes [[addDictionary]] to add a [[SettingsDictionary]] with the specified `props`.\n   * This is typically used when reading dictionaries out of a [[WorkspaceDb]], where they are stored as stringified JSON.\n   */\n  addJson(props: SettingsDictionaryProps, settingsJson: string): void;\n\n  /** Find a [[SettingsDictionary]] with the same name and [[WorkspaceDb]] as `source`. */\n  getDictionary(source: SettingsDictionarySource): SettingsDictionary | undefined;\n\n  /** Add a new [[SettingsDictionary]] with the priority, name, and [[WorkspaceDb]] specified by `props` and setting values supplied by `settings`.\n   * @note If a dictionary with the same name and [[WorkspaceDb]] already exists, it will be replaced.\n   * @see [[addFile]], [[addJson]], and [[addDirectory]] for convenient ways to add dictionaries from various sources.\n   */\n  addDictionary(props: SettingsDictionaryProps, settings: SettingsContainer): void;\n\n  /** Removes a previously-added [[SettingsDictionary]]. */\n  dropDictionary(props: SettingsDictionarySource): void;\n\n  /** Looks up the highest priority setting value for a SettingName, falling back to a default value if no value for the setting is found.\n   * The [[dictionaries]] are searched in order by [[SettingsPriority]]; the first one that provides a value for `settingName` wins.\n   * @param settingName The name of the setting.\n   * @param defaultValue value returned if settingName is not present in any [[SettingsDictionary]].\n   * @note This method is generic on [[Setting]] type, but no type checking is actually performed at run time. So, if you\n   * use this method to get a setting with an expected type, but its value is a different type, the return type of this method will be wrong.\n   * You must always type check the result. Use the non-generic \"get\" methods like [[getString]] and [[getArray]] if you only want the value\n   * if its type is correct.\n   * @note Unlike [[getArray]], this method does not combine arrays - it ignores [[SettingsSchema.combineArrays]].\n   */\n  getSetting<T extends Setting>(settingName: SettingName, defaultValue?: T): T | undefined;\n\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\n  getSettingEntries<T extends Setting>(settingName: SettingName): Iterable<{ value: T, dictionary: SettingsDictionary}>;\n\n  /** Obtain an iterator over all of the values in the [[dictionaries]] for the [[Setting]] identified by `settingName`, ordered by [[SettingsPriority]]. */\n  getSettingValues<T extends Setting>(settingName: SettingName): Iterable<T>;\n\n  /** Look up the value of a string [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\n   * @throws Error if the setting exists but is not a string.\n   */\n  getString(settingName: SettingName, defaultValue: string): string;\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\n\n  /** Look up the value of a boolean [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\n   * @throws Error if the setting exists but is not a boolean.\n   */\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\n\n  /** Look up the value of a numeric [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\n   * @throws Error if the setting exists but is not a number.\n   */\n  getNumber(settingName: SettingName, defaultValue: number): number;\n  getNumber(settingName: SettingName): number | undefined;\n\n  /** Look up the value of an object [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\n   * @throws Error if the setting exists but is not an object.\n   */\n  getObject<T extends object>(settingName: SettingName, defaultValue: T): T;\n  getObject<T extends object>(settingName: SettingName): T | undefined;\n\n  /** Look up the value of an array [[Setting]] named `settingName`, returning `defaultValue` if no such value is defined.\n   * @throws Error if the setting exists but is not an array.\n   */\n  getArray<T extends Setting>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\n  getArray<T extends Setting>(settingName: SettingName): Array<T> | undefined;\n}\n"]}

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

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

@@ -0,0 +1,250 @@
+/** @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.
+     * @note Do not pass an untrusted or unintended path in `localFileName`.
+     * This helper creates or overwrites the file at that location; callers that need fail-if-exists behavior should check first.
+     */
+    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.
+     * Repeated calls that resolve to the same SettingsDb return the same cached instance.
+     * @param props - The properties of the SettingsDb.
+     * @returns An EditableSettingsDb for modifying settings.
+     * @throws if the targeted SettingsDb has already been published and is immutable. Use [[createNewSettingsDbVersion]] first to create an editable version.
+     */
+    getEditableDb(props?: SettingsDbProps): EditableSettingsDb;
+    /**
+     * Acquire the write lock on the container. Use [[releaseWriteLock]] to release the lock after publishing your changes, or
+     * [[abandonChanges]] to release the lock and discard your changes.
+     * Only one user can hold the write lock at any given time. However, readers can continue to read the published contents of the container while
+     * a writer holds the write lock. Readers will only see the writer's changes after they are published by [[releaseWriteLock]].
+     * @param user - The name of the user acquiring the write lock.
+     * @throws if the write lock is already held by another user.
+     */
+    acquireWriteLock(user: string): void;
+    /**
+     * Release the write lock on the container. This should be called after all changes to the container's contents are complete. It
+     * publishes and uploads the changes made to any [[SettingsDb]]s while the lock was held, after which those dbs become immutable.
+     */
+    releaseWriteLock(): void;
+    /**
+     * Abandon any changes made to the container and release the write lock. Any newly created versions of SettingsDbs are discarded.
+     */
+    abandonChanges(): void;
+}
+/**
+ * An editable [[SettingsDb]]. This is used only by tools to allow administrators to create and modify SettingsDbs.
+ * For cloud-based SettingsDbs, the container's write token must be obtained via [[EditableSettingsCloudContainer.acquireWriteLock]] before the methods in this interface may be used.
+ * Normally, only admins will have write access.
+ * Only one admin at a time may be editing a settings container.
+ * @note Unlike [[EditableWorkspaceDb]], this interface only supports settings operations — no blob, file, or string resource methods.
+ * @beta
+ */
+export interface EditableSettingsDb extends SettingsDb {
+    /** The editable container that owns this SettingsDb. */
+    readonly container: EditableSettingsCloudContainer;
+    /**
+     * Update the contents of the manifest in this SettingsDb.
+     * @note This replaces the stored manifest entirely; omitted fields are lost.
+     * @param manifest - The updated manifest.
+     */
+    updateManifest(manifest: SettingsDbManifest): void;
+    /**
+     * Replace all settings in this SettingsDb with the given container.
+     * @param settings - The settings object to store.
+     */
+    updateSettings(settings: SettingsContainer): void;
+    /**
+     * Add or update a single [[Setting]] by name.
+     * If a setting with the given name already exists, its value is replaced.
+     * If it does not exist, it is added. Other settings are preserved.
+     * @param args - The arguments specifying the setting name and value.
+     */
+    updateSetting(args: UpdateSettingArgs): void;
+    /**
+     * Remove a single [[Setting]] by name. Other settings are preserved.
+     * @param settingName - The name of the setting to remove.
+     */
+    removeSetting(settingName: SettingName): void;
+}
+/** An object that permits administrators to modify the contents of settings containers.
+ * Use [[SettingsEditor.construct]] to obtain a SettingsEditor, and [[close]] when finished using it.
+ * Only one SettingsEditor may be in use at any given time.
+ * Use [[getContainer]] to edit an existing container, or [[createNewCloudContainer]] to create a new container.
+ * @beta
+ */
+export interface SettingsEditor {
+    /** @internal */
+    [_implementationProhibited]: unknown;
+    /**
+     * The workspace dedicated to this editor.
+     * @note This workspace is independent from [[IModelHost.appWorkspace]] and all [[IModelDb.workspace]]s.
+     */
+    readonly workspace: Workspace;
+    /**
+     * Retrieves a container for the editor with the specified properties and access token.
+     */
+    getContainer(args: GetWorkspaceContainerArgs): EditableSettingsCloudContainer;
+    /**
+     * Asynchronously retrieves a container for the editor with the specified properties.
+     */
+    getContainerAsync(props: WorkspaceContainerProps): Promise<EditableSettingsCloudContainer>;
+    /**
+     * Creates a new cloud container for holding SettingsDbs, from the [[BlobContainer]] service.
+     * The container is automatically assigned `containerType: "settings"` in its metadata and
+     * initialized with a default [[SettingsDb]].
+     * @param args - The arguments for creating the container, including scope, metadata, and manifest.
+     * @returns A promise that resolves to the new EditableSettingsCloudContainer.
+     * @note The current user must have administrator rights for the iTwin for the container.
+     * @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;;;;OAIG;IACH,SAAgB,aAAa,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,QAAQ,EAAE,kBAAkB,CAAA;KAAE,GAAG,IAAI,CAExG;IAED,8FAA8F;IAC9F,UAAiB,2BAA2B;QAC1C,+DAA+D;QAC/D,OAAO,EAAE,UAAU,CAAC;QACpB,oGAAoG;QACpG,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,6BAA6B;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;;;;OAOG;IACH,SAAsB,eAAe,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC,gBAAgB,EAAE,CAAC,CAIlH;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAC3B,gFAAgF;IAChF,QAAQ,EAAE,kBAAkB,CAAC;IAC7B;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,oEAAoE;IACpE,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC;IACzC,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,KAAK,EAAE,yBAAyB,CAAC;IACjC,4DAA4D;IAC5D,KAAK,EAAE,yBAAyB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,qEAAqE;IACrE,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,2CAA2C;IAC3C,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,qCAAqC;IACrC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IAC1E;;;;;;OAMG;IACH,0BAA0B,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEnG;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAEzD;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,CAAC,EAAE,eAAe,GAAG,kBAAkB,CAAC;IAE3D;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,IAAI,IAAI,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,8BAA8B,CAAC;IAEnD;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,cAAc,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAElD;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,gBAAgB;IAChB,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,yBAAyB,GAAG,8BAA8B,CAAC;IAE9E;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3F;;;;;;;;OAQG;IACH,uBAAuB,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAEvG;;;;;;;OAOG;IACH,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,2BAA2B,GAAG,OAAO,CAAC,8BAA8B,EAAE,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACf"}

package/lib/esm/workspace/SettingsEditor.js

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