@itwin/core-backend 5.9.0-dev.9 → 5.9.1

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":["/*---------------------------------------------------------------------------------------------\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 [[EditableWorkspaceDb.updateSettingsResource]].\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 no workspaceDb is defined - 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]]. When working in the context of an iTwin,\n * use [[IModelHost.getITwinWorkspace]] to obtain a [[Workspace]] for the iTwin and access its `settings` property.\n * Like iModel-specific settings, any settings supplied by the iTwin will override those defined at the application level.\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 * iTwin-specific settings are stored in a [[CloudSqliteContainer]] in the cloud.\n * When [[IModelHost.getITwinWorkspace]] is invoked, the container is accessed using the iTwinId and the settings are loaded into the returned [[Workspace]].\n * You can add and remove a [[SettingsDictionary]] from the container using [[Workspace.saveSettingsDictionary]] and [[Workspace.deleteSettingsDictionary]].\n *\n * See the [learning article]($docs/learning/backend/Workspace) for a detailed overview and examples.\n *\n * @see [[IModelHost.appWorkspace]] application-wide settings, [[IModelDb.workspace]] for settings specific to a given iModel, and [[IModelHost.getITwinWorkspace]] for settings specific to a given iTwin.\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"]}
+{"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 [[EditableWorkspaceDb.updateSettingsResource]].\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 no workspaceDb is defined - 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]]. When working in the context of an iTwin,\n * use [[IModelHost.getITwinWorkspace]] to obtain a [[Workspace]] for the iTwin and access its `settings` property.\n * Like iModel-specific settings, any settings supplied by the iTwin will override those defined at the application level.\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\n * (and their corresponding [[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 [[EditTxn.saveSettingDictionary]] and [[EditTxn.deleteSettingDictionary]].\n * If you are migrating older code, [[IModelDb.saveSettingDictionary]] and [[IModelDb.deleteSettingDictionary]] are deprecated in favor of the [[EditTxn]] APIs.\n *\n * iTwin-specific settings are stored in a [[CloudSqliteContainer]] in the cloud.\n * When [[IModelHost.getITwinWorkspace]] is invoked, the container is accessed using the iTwinId and the settings are loaded into the returned [[Workspace]].\n * You can add and remove a [[SettingsDictionary]] from the container using [[IModelHost.saveSettingDictionary]] and [[IModelHost.deleteSettingDictionary]].\n *\n * See the [learning article]($docs/learning/backend/Workspace) for a detailed overview and examples.\n *\n * @see [[IModelHost.appWorkspace]] application-wide settings, [[IModelDb.workspace]] for settings specific to a given iModel, and [[IModelHost.getITwinWorkspace]] for settings specific to a given iTwin.\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   * @note Values added via this method exist only for the current session. They are not persisted and will be lost when the host shuts down.\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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "5.9.0-dev.9",
+  "version": "5.9.1",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "module": "lib/esm/core-backend.js",
@@ -27,10 +27,10 @@
   },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.4",
-    "@itwin/core-bentley": "5.9.0-dev.9",
-    "@itwin/core-geometry": "5.9.0-dev.9",
-    "@itwin/core-common": "5.9.0-dev.9",
-    "@itwin/ecschema-metadata": "5.9.0-dev.9"
+    "@itwin/core-bentley": "5.9.1",
+    "@itwin/core-common": "5.9.1",
+    "@itwin/core-geometry": "5.9.1",
+    "@itwin/ecschema-metadata": "5.9.1"
   },
   "peerDependenciesMeta": {
     "@opentelemetry/api": {
@@ -56,7 +56,7 @@
     "@types/sinon": "^17.0.2",
     "@types/touch": "^3.1.2",
     "@types/ws": "^7.0.0",
-    "@xmldom/xmldom": "~0.8.12",
+    "@xmldom/xmldom": "~0.8.13",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cpx2": "^8.0.0",
@@ -77,17 +77,17 @@
     "marked": "^14.1.3",
     "sql-formatter": "^15.4.6",
     "webpack": "^5.97.1",
-    "@itwin/build-tools": "5.9.0-dev.9",
-    "@itwin/core-geometry": "5.9.0-dev.9",
-    "@itwin/ecschema-metadata": "5.9.0-dev.9",
-    "@itwin/ecschema-locaters": "5.9.0-dev.9",
-    "@itwin/core-bentley": "5.9.0-dev.9",
-    "@itwin/core-common": "5.9.0-dev.9",
-    "@itwin/ecsql-common": "5.9.0-dev.9",
-    "internal-tools": "3.0.0-dev.69"
+    "@itwin/build-tools": "5.9.1",
+    "@itwin/ecschema-locaters": "5.9.1",
+    "@itwin/core-geometry": "5.9.1",
+    "@itwin/core-bentley": "5.9.1",
+    "@itwin/ecschema-metadata": "5.9.1",
+    "@itwin/core-common": "5.9.1",
+    "internal-tools": "3.0.0-dev.69",
+    "@itwin/ecsql-common": "5.9.1"
   },
   "dependencies": {
-    "@bentley/imodeljs-native": "5.9.1",
+    "@bentley/imodeljs-native": "5.9.17",
     "@itwin/object-storage-azure": "^3.0.4",
     "@azure/storage-blob": "^12.28.0",
     "form-data": "^4.0.4",