@itwin/core-backend 4.5.0-dev.9 → 4.6.0-dev.1

package/lib/cjs/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;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAA8D;AAE9D,8CAA2C;AAmD3C;;;EAGE;AACF,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,6CAA6C;IAC7C,iEAAc,CAAA;IACd,iDAAiD;IACjD,uEAAiB,CAAA;IACjB,2DAA2D;IAC3D,yEAAkB,CAAA;IAClB,oDAAoD;IACpD,2DAAW,CAAA;IACX,4CAA4C;IAC5C,6DAAY,CAAA;AACd,CAAC,EAXW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAW3B;AAyGD,gBAAgB;AAChB,SAAS,SAAS,CAAwB,GAAQ;IAChD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QACjC,OAAO,GAAG,CAAC;IAEb,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;IACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;SAC9B;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,kBAAkB;IACtB,YAAmC,IAAY,EAAkB,QAA0B,EAAkB,QAA2B;QAArG,SAAI,GAAJ,IAAI,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAkB;QAAkB,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACtI,UAAU,CAAwB,WAAmB;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;IACrD,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,YAAY;IAAzB;QACU,kBAAa,GAAyB,EAAE,CAAC;QAGjC,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAyGhE,CAAC;IA3GW,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IAGX,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;SACnD;IACH,CAAC;IAEM,OAAO,CAAC,cAAsB,EAAE,QAA0B,EAAE,YAAoB;QACrF,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,aAAa,CAAC,cAAsB,EAAE,QAA0B,EAAE,QAA2B;QAClG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QAChG,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACnD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACtC,OAAO;iBACR;aACF;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,cAAc,CAAC,cAA8B,EAAE,UAAU,GAAG,IAAI;QACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE;gBACjD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,cAAc,CAAwB,IAAiB,EAAE,QAA4B,EAAE,YAAgB;QAC5G,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAkB,CAAC;YACnD,MAAM,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,SAAS,KAAK,QAAQ,EAAE;gBAC1B,OAAO,QAAQ,CAAC;aACjB;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,UAAU,CAAwB,IAAiB,EAAE,YAAgB;QAC1E,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAI,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,cAAc,CAAwB,IAAiB;QAC5D,MAAM,GAAG,GAA0B,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,CAAI,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE;YAC3D,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC;IAIM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACvD,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAgB,IAAI,CAAC,CAAC;QACjD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3D,CAAC;IAGM,QAAQ,CAAwB,IAAiB,EAAE,YAAuB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAW,IAAI,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;CACF;AA7GD,oCA6GC","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 * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/** The type of a Setting, according to its schema\r\n * @beta\r\n */\r\nexport type SettingType = JSONSchemaType;\r\n\r\n/**\r\n * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSchema]].\r\n * @see [SettingName]($docs/learning/backend/Workspace#settingnames)\r\n * @beta\r\n */\r\nexport type SettingName = string;\r\n\r\n/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.\r\n * DictionaryNames must be valid JavaScript property names.\r\n * @beta\r\n */\r\nexport type DictionaryName = string;\r\n\r\n/**\r\n * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The\r\n * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.\r\n * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,\r\n * applications can \"combine\" the prioritized Setting values as appropriate. The default implementation of this function\r\n * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority\r\n * value is returned.\r\n * @beta\r\n */\r\nexport type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;\r\n\r\n/** An entry in the array returned by [[Settings.inspectSetting]]\r\n * @beta\r\n *\r\n */\r\nexport interface SettingInspector<T> { value: T, dictionary: DictionaryName, priority: number }\r\n\r\n/** An object with string-named members (as opposed to an array object).\r\n * @beta\r\n */\r\nexport interface SettingObject {\r\n  [name: string]: SettingType;\r\n}\r\n\r\n/**\r\n * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but\r\n * may also be created in memory by applications\r\n * @beta\r\n */\r\nexport type SettingDictionary = SettingObject;\r\n\r\n/**\r\n * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.\r\n * @beta\r\n*/\r\nexport enum SettingsPriority {\r\n  /** values supplied default-settings files */\r\n  defaults = 100,\r\n  /** values supplied by applications at runtime */\r\n  application = 200,\r\n  /** values that apply to all iTwins for an organization. */\r\n  organization = 300,\r\n  /** values that apply to all iModels in an iTwin. */\r\n  iTwin = 400,\r\n  /** values that apply to a single iModel. */\r\n  iModel = 500,\r\n}\r\n\r\n/** The current set of Settings for a Workspace.\r\n * @beta\r\n */\r\nexport interface Settings {\r\n  /** @internal */\r\n  close(): void;\r\n\r\n  /** Event raised whenever a SettingsDictionary is added or removed. */\r\n  readonly onSettingsChanged: BeEvent<() => void>;\r\n\r\n  /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read\r\n   * and parsed and the fileName is used as the DictionaryName.\r\n   * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\r\n\r\n  /** Add all files in the supplied directory with the extension \".json\" or \".json5\"\r\n   * @param dirName the name of a local settings directory\r\n   */\r\n  addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;\r\n\r\n  /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settingsJson the JSON5 stringified string to be parsed.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;\r\n\r\n  /** Add a SettingDictionary object.\r\n   * @param dictionaryName the name of the SettingDictionary\r\n   * @param priority the SettingsPriority for the SettingDictionary\r\n   * @param settings the SettingDictionary object to be added.\r\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\r\n   */\r\n  addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;\r\n\r\n  /** Remove a SettingDictionary by name. */\r\n  dropDictionary(dictionaryName: DictionaryName): void;\r\n\r\n  /**\r\n   * Resolve a setting, by name, using a SettingResolver.\r\n   * @param settingName The name of the setting to resolve\r\n   * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.\r\n   * @returns the resolved setting value.\r\n   */\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;\r\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;\r\n\r\n  /** Get the highest priority setting for a SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary.\r\n   * @note This method is generic on SettingType, 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 (e.g. [[getString]]) if you only want the value\r\n   * if its type is correct.\r\n   */\r\n  getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;\r\n\r\n  /** Get a string setting by SettingName.\r\n   * @param settingName The name of the setting\r\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting 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  /** Get a boolean setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting 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  /** Get a number setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting 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  /** Get an object setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting 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  /** Get an array setting by SettingName.\r\n  * @param settingName The name of the setting\r\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.\r\n  */\r\n  getArray<T extends SettingType>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\r\n  getArray<T extends SettingType>(settingName: SettingName): Array<T> | undefined;\r\n\r\n  /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.\r\n   * @note this method is mainly for debugging and diagnostics.\r\n   */\r\n  inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];\r\n}\r\n\r\n/** @internal */\r\nfunction deepClone<T extends SettingType>(obj: any): T {\r\n  if (!obj || typeof obj !== \"object\")\r\n    return obj;\r\n\r\n  const result = Array.isArray(obj) ? [] : {} as any;\r\n  Object.keys(obj).forEach((key: string) => {\r\n    const val = obj[key];\r\n    if (val && typeof val === \"object\") {\r\n      result[key] = deepClone(val);\r\n    } else {\r\n      result[key] = val;\r\n    }\r\n  });\r\n  return result;\r\n}\r\n\r\nclass SettingsDictionary {\r\n  public constructor(public readonly name: string, public readonly priority: SettingsPriority, public readonly settings: SettingDictionary) { }\r\n  public getSetting<T extends SettingType>(settingName: string): SettingType | undefined {\r\n    return this.settings[settingName] as T | undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * Internal implementation of Settings interface.\r\n * @internal\r\n */\r\nexport class BaseSettings implements Settings {\r\n  private _dictionaries: SettingsDictionary[] = [];\r\n  protected verifyPriority(_priority: SettingsPriority) { }\r\n  public close() { }\r\n  public readonly onSettingsChanged = new BeEvent<() => void>();\r\n\r\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\r\n    this.addJson(fileName, priority, fs.readFileSync(fileName, \"utf-8\"));\r\n  }\r\n\r\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName), priority);\r\n    }\r\n  }\r\n\r\n  public addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string) {\r\n    this.addDictionary(dictionaryName, priority, parse(settingsJson));\r\n  }\r\n\r\n  public addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary) {\r\n    this.verifyPriority(priority);\r\n    this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice\r\n    const file = new SettingsDictionary(dictionaryName, priority, settings);\r\n    const doAdd = () => {\r\n      for (let i = 0; i < this._dictionaries.length; ++i) {\r\n        if (this._dictionaries[i].priority <= file.priority) {\r\n          this._dictionaries.splice(i, 0, file);\r\n          return;\r\n        }\r\n      }\r\n      this._dictionaries.push(file);\r\n    };\r\n    doAdd();\r\n    this.onSettingsChanged.raiseEvent();\r\n  }\r\n\r\n  public dropDictionary(dictionaryName: DictionaryName, raiseEvent = true) {\r\n    for (let i = 0; i < this._dictionaries.length; ++i) {\r\n      if (this._dictionaries[i].name === dictionaryName) {\r\n        this._dictionaries.splice(i, 1);\r\n        if (raiseEvent)\r\n          this.onSettingsChanged.raiseEvent();\r\n        return true;\r\n      }\r\n    }\r\n    return false;\r\n  }\r\n\r\n  public resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined {\r\n    for (const dict of this._dictionaries) {\r\n      const val = dict.getSetting(name) as T | undefined;\r\n      const resolved = val && resolver(val, dict.name, dict.priority);\r\n      if (undefined !== resolved) {\r\n        return resolved;\r\n      }\r\n    }\r\n    return defaultValue;\r\n  }\r\n\r\n  public getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined {\r\n    return this.resolveSetting(name, (val) => deepClone<T>(val)) ?? defaultValue;\r\n  }\r\n\r\n  /** for debugging. Returns an array of all values for a setting, sorted by priority.\r\n   * @note values are not cloned. Do not modify objects or arrays.\r\n   */\r\n  public inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[] {\r\n    const all: SettingInspector<T>[] = [];\r\n    this.resolveSetting<T>(name, (value, dictionary, priority) => {\r\n      all.push({ value, dictionary, priority });\r\n      return undefined;\r\n    });\r\n\r\n    return all;\r\n  }\r\n\r\n  public getString(name: SettingName, defaultValue: string): string;\r\n  public getString(name: SettingName): string | undefined;\r\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\r\n    const out = this.getSetting<string>(name);\r\n    return typeof out === \"string\" ? out : defaultValue;\r\n  }\r\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\r\n  public getBoolean(name: SettingName): boolean | undefined;\r\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\r\n    const out = this.getSetting<boolean>(name);\r\n    return typeof out === \"boolean\" ? out : defaultValue;\r\n  }\r\n  public getNumber(name: SettingName, defaultValue: number): number;\r\n  public getNumber(name: SettingName): number | undefined;\r\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\r\n    const out = this.getSetting<number>(name);\r\n    return typeof out === \"number\" ? out : defaultValue;\r\n  }\r\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\r\n  public getObject<T extends object>(name: SettingName): T | undefined;\r\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\r\n    const out = this.getSetting<SettingObject>(name);\r\n    return typeof out === \"object\" ? out as T : defaultValue;\r\n  }\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue: Array<T>): Array<T>;\r\n  public getArray<T extends SettingType>(name: SettingName): Array<T> | undefined;\r\n  public getArray<T extends SettingType>(name: SettingName, defaultValue?: Array<T>): Array<T> | undefined {\r\n    const out = this.getSetting<Array<T>>(name);\r\n    return Array.isArray(out) ? out : defaultValue;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Settings.js","sourceRoot":"","sources":["../../../src/workspace/Settings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAA8D;AAE9D,8CAA2C;AAmD3C;;;EAGE;AACF,IAAY,gBAWX;AAXD,WAAY,gBAAgB;IAC1B,6CAA6C;IAC7C,iEAAc,CAAA;IACd,iDAAiD;IACjD,uEAAiB,CAAA;IACjB,2DAA2D;IAC3D,yEAAkB,CAAA;IAClB,oDAAoD;IACpD,2DAAW,CAAA;IACX,4CAA4C;IAC5C,6DAAY,CAAA;AACd,CAAC,EAXW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAW3B;AAyGD,gBAAgB;AAChB,SAAS,SAAS,CAAwB,GAAQ;IAChD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QACjC,OAAO,GAAG,CAAC;IAEb,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAS,CAAC;IACnD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;SAC9B;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,kBAAkB;IACtB,YAAmC,IAAY,EAAkB,QAA0B,EAAkB,QAA2B;QAArG,SAAI,GAAJ,IAAI,CAAQ;QAAkB,aAAQ,GAAR,QAAQ,CAAkB;QAAkB,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACtI,UAAU,CAAwB,WAAmB;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAkB,CAAC;IACrD,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,YAAY;IAAzB;QACU,kBAAa,GAAyB,EAAE,CAAC;QAGjC,sBAAiB,GAAG,IAAI,sBAAO,EAAc,CAAC;IAyGhE,CAAC;IA3GW,cAAc,CAAC,SAA2B,IAAI,CAAC;IAClD,KAAK,KAAK,CAAC;IAGX,OAAO,CAAC,QAAuB,EAAE,QAA0B;QAChE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAEM,YAAY,CAAC,OAAqB,EAAE,QAA0B;QACnE,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;SACnD;IACH,CAAC;IAEM,OAAO,CAAC,cAAsB,EAAE,QAA0B,EAAE,YAAoB;QACrF,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,aAAa,CAAC,cAAsB,EAAE,QAA0B,EAAE,QAA2B;QAClG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,oDAAoD;QAChG,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACnD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;oBACtC,OAAO;iBACR;aACF;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAEM,cAAc,CAAC,cAA8B,EAAE,UAAU,GAAG,IAAI;QACrE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE;gBACjD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,IAAI,UAAU;oBACZ,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,cAAc,CAAwB,IAAiB,EAAE,QAA4B,EAAE,YAAgB;QAC5G,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAkB,CAAC;YACnD,MAAM,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI,SAAS,KAAK,QAAQ,EAAE;gBAC1B,OAAO,QAAQ,CAAC;aACjB;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,UAAU,CAAwB,IAAiB,EAAE,YAAgB;QAC1E,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAI,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,cAAc,CAAwB,IAAiB;QAC5D,MAAM,GAAG,GAA0B,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,CAAI,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE;YAC3D,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC;IAIM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,UAAU,CAAC,IAAiB,EAAE,YAAsB;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAU,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACvD,CAAC;IAGM,SAAS,CAAC,IAAiB,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAS,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACtD,CAAC;IAGM,SAAS,CAAmB,IAAiB,EAAE,YAAgB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAgB,IAAI,CAAC,CAAC;QACjD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3D,CAAC;IAGM,QAAQ,CAAwB,IAAiB,EAAE,YAAuB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAW,IAAI,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;IACjD,CAAC;CACF;AA7GD,oCA6GC","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 * as fs from \"fs-extra\";\nimport { parse } from \"json5\";\nimport { extname, join } from \"path\";\nimport { BeEvent, JSONSchemaType } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsFs } from \"../IModelJsFs\";\n\n/** The type of a Setting, according to its schema\n * @beta\n */\nexport type SettingType = JSONSchemaType;\n\n/**\n * The name of a Setting. SettingNames must be valid JavaScript property names, defined in a [[SettingSchema]].\n * @see [SettingName]($docs/learning/backend/Workspace#settingnames)\n * @beta\n */\nexport type SettingName = string;\n\n/** The name of a [[SettingDictionary]]. `SettingDictionary`s are stored in [[Settings]] and may be removed by DictionaryName.\n * DictionaryNames must be valid JavaScript property names.\n * @beta\n */\nexport type DictionaryName = string;\n\n/**\n * A function called by [[Settings.resolveSetting]] for every SettingDictionary with a Setting that matches a name. The\n * SettingDictionaries are sorted by priority and this function is called in priority order with the highest priority first.\n * When this function returns a non-undefined value, the iteration is stopped and that value is returned. In this way,\n * applications can \"combine\" the prioritized Setting values as appropriate. The default implementation of this function\n * used by [[Settings.getSetting]] merely returns a clone of the value the first time it is called, so the highest priority\n * value is returned.\n * @beta\n */\nexport type SettingResolver<T> = (val: T, dict: DictionaryName, priority: SettingsPriority) => T | undefined;\n\n/** An entry in the array returned by [[Settings.inspectSetting]]\n * @beta\n *\n */\nexport interface SettingInspector<T> { value: T, dictionary: DictionaryName, priority: number }\n\n/** An object with string-named members (as opposed to an array object).\n * @beta\n */\nexport interface SettingObject {\n  [name: string]: SettingType;\n}\n\n/**\n * An object with Settings as its members. A SettingDictionary also has a name and generally comes from a parsed JSON file, but\n * may also be created in memory by applications\n * @beta\n */\nexport type SettingDictionary = SettingObject;\n\n/**\n * Values for SettingsPriority determine the sort order for Settings. Higher values take precedence over lower values.\n * @beta\n*/\nexport enum SettingsPriority {\n  /** values supplied default-settings files */\n  defaults = 100,\n  /** values supplied by applications at runtime */\n  application = 200,\n  /** values that apply to all iTwins for an organization. */\n  organization = 300,\n  /** values that apply to all iModels in an iTwin. */\n  iTwin = 400,\n  /** values that apply to a single iModel. */\n  iModel = 500,\n}\n\n/** The current set of Settings for a Workspace.\n * @beta\n */\nexport interface Settings {\n  /** @internal */\n  close(): void;\n\n  /** Event raised whenever a SettingsDictionary is added or removed. */\n  readonly onSettingsChanged: BeEvent<() => void>;\n\n  /** Add a SettingDictionary from a local settings file. The file should be in [JSON5](https://json5.org/) format. It is read\n   * and parsed and the fileName is used as the DictionaryName.\n   * @param fileName the name of a local settings file of the SettingDictionary. This becomes the DictionaryName.\n   * @param priority the SettingsPriority for the SettingDictionary\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\n   */\n  addFile(fileName: LocalFileName, priority: SettingsPriority): void;\n\n  /** Add all files in the supplied directory with the extension \".json\" or \".json5\"\n   * @param dirName the name of a local settings directory\n   */\n  addDirectory(dirName: LocalDirName, priority: SettingsPriority): void;\n\n  /** Add a SettingDictionary from a JSON5 stringified string. The string is parsed and the resultant object is added as a SettingDictionary.\n   * @param dictionaryName the name of the SettingDictionary\n   * @param priority the SettingsPriority for the SettingDictionary\n   * @param settingsJson the JSON5 stringified string to be parsed.\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\n   */\n  addJson(dictionaryName: DictionaryName, priority: SettingsPriority, settingsJson: string): void;\n\n  /** Add a SettingDictionary object.\n   * @param dictionaryName the name of the SettingDictionary\n   * @param priority the SettingsPriority for the SettingDictionary\n   * @param settings the SettingDictionary object to be added.\n   * @note If the SettingDictionary was previously added, the new content overrides the old content.\n   */\n  addDictionary(dictionaryName: DictionaryName, priority: SettingsPriority, settings: SettingDictionary): void;\n\n  /** Remove a SettingDictionary by name. */\n  dropDictionary(dictionaryName: DictionaryName): void;\n\n  /**\n   * Resolve a setting, by name, using a SettingResolver.\n   * @param settingName The name of the setting to resolve\n   * @param resolver function to be called for each SettingDictionary with a matching Setting. Iteration stops when it returns a non-undefined value.\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary or resolver never returned a value.\n   * @returns the resolved setting value.\n   */\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue: T): T;\n  resolveSetting<T extends SettingType>(settingName: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined;\n\n  /** Get the highest priority setting for a SettingName.\n   * @param settingName The name of the setting\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary.\n   * @note This method is generic on SettingType, 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 (e.g. [[getString]]) if you only want the value\n   * if its type is correct.\n   */\n  getSetting<T extends SettingType>(settingName: SettingName, defaultValue?: T): T | undefined;\n\n  /** Get a string setting by SettingName.\n   * @param settingName The name of the setting\n   * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a string.\n   */\n  getString(settingName: SettingName, defaultValue: string): string;\n  getString(settingName: SettingName, defaultValue?: string): string | undefined;\n\n  /** Get a boolean setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a boolean.\n  */\n  getBoolean(settingName: SettingName, defaultValue: boolean): boolean;\n  getBoolean(settingName: SettingName, defaultValue?: boolean): boolean | undefined;\n\n  /** Get a number setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not a number.\n  */\n  getNumber(settingName: SettingName, defaultValue: number): number;\n  getNumber(settingName: SettingName): number | undefined;\n\n  /** Get an object setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting 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  /** Get an array setting by SettingName.\n  * @param settingName The name of the setting\n  * @param defaultValue value returned if settingName is not present in any SettingDictionary, or if the highest priority setting is not an array.\n  */\n  getArray<T extends SettingType>(settingName: SettingName, defaultValue: Array<T>): Array<T>;\n  getArray<T extends SettingType>(settingName: SettingName): Array<T> | undefined;\n\n  /** Get an array of [[SettingInspector] objects, sorted in priority order, for all Settings that match a SettingName.\n   * @note this method is mainly for debugging and diagnostics.\n   */\n  inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[];\n}\n\n/** @internal */\nfunction deepClone<T extends SettingType>(obj: any): T {\n  if (!obj || typeof obj !== \"object\")\n    return obj;\n\n  const result = Array.isArray(obj) ? [] : {} as any;\n  Object.keys(obj).forEach((key: string) => {\n    const val = obj[key];\n    if (val && typeof val === \"object\") {\n      result[key] = deepClone(val);\n    } else {\n      result[key] = val;\n    }\n  });\n  return result;\n}\n\nclass SettingsDictionary {\n  public constructor(public readonly name: string, public readonly priority: SettingsPriority, public readonly settings: SettingDictionary) { }\n  public getSetting<T extends SettingType>(settingName: string): SettingType | undefined {\n    return this.settings[settingName] as T | undefined;\n  }\n}\n\n/**\n * Internal implementation of Settings interface.\n * @internal\n */\nexport class BaseSettings implements Settings {\n  private _dictionaries: SettingsDictionary[] = [];\n  protected verifyPriority(_priority: SettingsPriority) { }\n  public close() { }\n  public readonly onSettingsChanged = new BeEvent<() => void>();\n\n  public addFile(fileName: LocalFileName, priority: SettingsPriority) {\n    this.addJson(fileName, priority, fs.readFileSync(fileName, \"utf-8\"));\n  }\n\n  public addDirectory(dirName: LocalDirName, priority: SettingsPriority) {\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\n      const ext = extname(fileName);\n      if (ext === \".json5\" || ext === \".json\")\n        this.addFile(join(dirName, fileName), priority);\n    }\n  }\n\n  public addJson(dictionaryName: string, priority: SettingsPriority, settingsJson: string) {\n    this.addDictionary(dictionaryName, priority, parse(settingsJson));\n  }\n\n  public addDictionary(dictionaryName: string, priority: SettingsPriority, settings: SettingDictionary) {\n    this.verifyPriority(priority);\n    this.dropDictionary(dictionaryName, false); // make sure we don't have the same dictionary twice\n    const file = new SettingsDictionary(dictionaryName, priority, settings);\n    const doAdd = () => {\n      for (let i = 0; i < this._dictionaries.length; ++i) {\n        if (this._dictionaries[i].priority <= file.priority) {\n          this._dictionaries.splice(i, 0, file);\n          return;\n        }\n      }\n      this._dictionaries.push(file);\n    };\n    doAdd();\n    this.onSettingsChanged.raiseEvent();\n  }\n\n  public dropDictionary(dictionaryName: DictionaryName, raiseEvent = true) {\n    for (let i = 0; i < this._dictionaries.length; ++i) {\n      if (this._dictionaries[i].name === dictionaryName) {\n        this._dictionaries.splice(i, 1);\n        if (raiseEvent)\n          this.onSettingsChanged.raiseEvent();\n        return true;\n      }\n    }\n    return false;\n  }\n\n  public resolveSetting<T extends SettingType>(name: SettingName, resolver: SettingResolver<T>, defaultValue?: T): T | undefined {\n    for (const dict of this._dictionaries) {\n      const val = dict.getSetting(name) as T | undefined;\n      const resolved = val && resolver(val, dict.name, dict.priority);\n      if (undefined !== resolved) {\n        return resolved;\n      }\n    }\n    return defaultValue;\n  }\n\n  public getSetting<T extends SettingType>(name: SettingName, defaultValue?: T): T | undefined {\n    return this.resolveSetting(name, (val) => deepClone<T>(val)) ?? defaultValue;\n  }\n\n  /** for debugging. Returns an array of all values for a setting, sorted by priority.\n   * @note values are not cloned. Do not modify objects or arrays.\n   */\n  public inspectSetting<T extends SettingType>(name: SettingName): SettingInspector<T>[] {\n    const all: SettingInspector<T>[] = [];\n    this.resolveSetting<T>(name, (value, dictionary, priority) => {\n      all.push({ value, dictionary, priority });\n      return undefined;\n    });\n\n    return all;\n  }\n\n  public getString(name: SettingName, defaultValue: string): string;\n  public getString(name: SettingName): string | undefined;\n  public getString(name: SettingName, defaultValue?: string): string | undefined {\n    const out = this.getSetting<string>(name);\n    return typeof out === \"string\" ? out : defaultValue;\n  }\n  public getBoolean(name: SettingName, defaultValue: boolean): boolean;\n  public getBoolean(name: SettingName): boolean | undefined;\n  public getBoolean(name: SettingName, defaultValue?: boolean): boolean | undefined {\n    const out = this.getSetting<boolean>(name);\n    return typeof out === \"boolean\" ? out : defaultValue;\n  }\n  public getNumber(name: SettingName, defaultValue: number): number;\n  public getNumber(name: SettingName): number | undefined;\n  public getNumber(name: SettingName, defaultValue?: number): number | undefined {\n    const out = this.getSetting<number>(name);\n    return typeof out === \"number\" ? out : defaultValue;\n  }\n  public getObject<T extends object>(name: SettingName, defaultValue: T): T;\n  public getObject<T extends object>(name: SettingName): T | undefined;\n  public getObject<T extends object>(name: SettingName, defaultValue?: T): T | undefined {\n    const out = this.getSetting<SettingObject>(name);\n    return typeof out === \"object\" ? out as T : defaultValue;\n  }\n  public getArray<T extends SettingType>(name: SettingName, defaultValue: Array<T>): Array<T>;\n  public getArray<T extends SettingType>(name: SettingName): Array<T> | undefined;\n  public getArray<T extends SettingType>(name: SettingName, defaultValue?: Array<T>): Array<T> | undefined {\n    const out = this.getSetting<Array<T>>(name);\n    return Array.isArray(out) ? out : defaultValue;\n  }\n}\n"]}

package/lib/cjs/workspace/SettingsSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAuG;AAEvG,8CAA2C;AAgC3C;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gBAAwB,CAAC,CAAC,YAAY;IAOtC;;;OAGG;IACI,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,mBAAmB,CAAI,GAAM,EAAE,UAAkB,EAAE,GAAW;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;QAC5B,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,UAAU;YACpD,OAAO,GAAG,CAAC;QAEb,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;YAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzC,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/C,SAAS;YACX,IAAI,OAAO,KAAK,KAAK,SAAS;gBAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,wBAAwB,GAAG,MAAM,KAAK,OAAO,KAAK,EAAE,CAAC,CAAC;SAC/F;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAwD;QAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,OAAO,CAAC,aAAqB;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,OAAO,CAAC,QAAuB;QAC3C,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;SAClD;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5E;IACH,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,YAAY,CAAC,OAAqB;QAC9C,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;SACzC;IACH,CAAC;IAED,oEAAoE;IAC7D,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAmC;QACtD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;gBAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,SAAiB;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,KAAK,EAAE,UAAU,EAAE;YACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAmC;QAC/E,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE;oBACrB,KAAK,MAAM,KAAK,IAAI,QAAQ;wBAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC9C;gBACD,IAAI,KAAK,EAAE;oBACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI;4BACF,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;yBACxC;wBAAC,OAAO,CAAM,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;yBAC7D;iBACJ;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI;oBACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAChD;gBAAC,OAAO,CAAM,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;iBACzD;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;SAC3E;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAyB;QACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAEhE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAA2B,UAAU,CAAC,GAAG,CAAC,CAAC;YACzD,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAA+C;QAC5E,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;;AAxLuB,0BAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;AAC3E,iDAAiD;AAC1B,0BAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;AACrE,qFAAqF;AAC9D,+BAAe,GAAG,IAAI,sBAAO,EAAc,CAAC;AANxD,0CAAe","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 * as fs from \"fs-extra\";\r\nimport { parse } from \"json5\";\r\nimport { extname, join } from \"path\";\r\nimport { BeEvent, JSONSchema, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\r\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\n/**\r\n * The properties of a single Setting, used by the settings editor. This interface also includes the\r\n * default value if it is not specified in any Settings file.\r\n * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.\r\n * @note the `type` member is marked optional in JSONSchema but is required for Settings.\r\n * @beta\r\n */\r\nexport interface SettingSchema extends Readonly<JSONSchema> {\r\n  readonly items?: SettingSchema; // must be single object, not array\r\n  readonly type: JSONSchemaTypeName; // type is required for settings\r\n  readonly properties?: { [name: string]: SettingSchema };\r\n\r\n  /** whether the setting replaces lower priority entries with the same name or combines with them. */\r\n  readonly cumulative?: true;\r\n}\r\n\r\n/**\r\n * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]\r\n * and are identified by their (required) `groupName` member\r\n * @beta\r\n */\r\nexport interface SettingSchemaGroup {\r\n  readonly groupName: string;\r\n  readonly properties: { [name: string]: SettingSchema };\r\n  readonly order?: number;\r\n  readonly title?: string;\r\n  readonly description?: string;\r\n  readonly extensionId?: string;\r\n}\r\n\r\n/**\r\n * The registry of available [[SettingSchemaGroup]]s.\r\n * The registry is used for editing Settings files and for finding default values for settings.\r\n * @beta\r\n */\r\nexport class SettingsSchemas {\r\n  private constructor() { } // singleton\r\n  private static readonly _allGroups = new Map<string, SettingSchemaGroup>();\r\n  /** a map of all registered [[SettingSchema]]s */\r\n  public static readonly allSchemas = new Map<string, SettingSchema>();\r\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\r\n  public static readonly onSchemaChanged = new BeEvent<() => void>();\r\n\r\n  /** Clear the contents of the registry and remove all event listeners.\r\n   * @note This is really only necessary for tests of the Settings system.\r\n   * @internal\r\n   */\r\n  public static reset() {\r\n    this._allGroups.clear();\r\n    this.allSchemas.clear();\r\n    this.onSchemaChanged.clear();\r\n  }\r\n\r\n  /** @internal */\r\n  public static validateArrayObject<T>(val: T, schemaName: string, msg: string): T {\r\n    const schema = this.allSchemas.get(schemaName);\r\n    const items = schema?.items;\r\n    if (undefined === items)\r\n      return val;\r\n    const required = items.required;\r\n    const properties = items.properties;\r\n    if (undefined === required || undefined === properties)\r\n      return val;\r\n\r\n    for (const entry of required) {\r\n      const entryType = properties[entry].type;\r\n      const value = (val as any)[entry];\r\n      if (entryType === \"array\" && Array.isArray(value))\r\n        continue;\r\n      if (typeof value !== entryType)\r\n        throw new Error(`invalid \"${schemaName}\" setting entry for \"${msg}\": ${entry} is ${value}`);\r\n    }\r\n    return val;\r\n  }\r\n\r\n  /**\r\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used\r\n   * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.\r\n   */\r\n  public static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void {\r\n    if (!Array.isArray(settingsGroup))\r\n      settingsGroup = [settingsGroup];\r\n\r\n    this.doAdd(settingsGroup);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\r\n  public static addJson(settingSchema: string): void {\r\n    this.addGroup(parse(settingSchema));\r\n  }\r\n\r\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\r\n  public static addFile(fileName: LocalFileName): void {\r\n    try {\r\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\r\n    } catch (e: any) {\r\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\r\n    }\r\n  }\r\n\r\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\r\n  public static addDirectory(dirName: LocalDirName) {\r\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\r\n      const ext = extname(fileName);\r\n      if (ext === \".json5\" || ext === \".json\")\r\n        this.addFile(join(dirName, fileName));\r\n    }\r\n  }\r\n\r\n  /** Remove a previously added [[SettingSchemaGroup]] by groupName */\r\n  public static removeGroup(groupName: string): void {\r\n    this.doRemove(groupName);\r\n    this.onSchemaChanged.raiseEvent();\r\n  }\r\n\r\n  private static doAdd(settingsGroup: SettingSchemaGroup[]) {\r\n    settingsGroup.forEach((group) => {\r\n      if (undefined === group.groupName)\r\n        throw new Error(`settings group has no \"groupName\" member`);\r\n\r\n      this.doRemove(group.groupName);\r\n      this.validateAndAdd(group);\r\n      this._allGroups.set(group.groupName, group);\r\n    });\r\n  }\r\n\r\n  private static doRemove(groupName: string) {\r\n    const group = this._allGroups.get(groupName);\r\n    if (undefined !== group?.properties) {\r\n      for (const key of Object.keys(group.properties))\r\n        this.allSchemas.delete(key);\r\n    }\r\n    this._allGroups.delete(groupName);\r\n  }\r\n\r\n  private static validateName(name: string) {\r\n    if (!name.trim())\r\n      throw new Error(`empty property name`);\r\n    if (this.allSchemas.has(name))\r\n      throw new Error(`property \"${name}\" is already defined`);\r\n  }\r\n\r\n  private static validateProperty(name: string, property: SettingSchema | undefined) {\r\n    if (!property)\r\n      throw new Error(`missing required property ${name}`);\r\n\r\n    if (!property.type)\r\n      throw new Error(`property ${name} has no type`);\r\n\r\n    switch (property.type) {\r\n      case \"boolean\":\r\n      case \"integer\":\r\n      case \"null\":\r\n      case \"number\":\r\n      case \"string\":\r\n        return;\r\n\r\n      case \"object\":\r\n        const required = property.required;\r\n        const props = property.properties;\r\n        if (required && props) {\r\n          for (const entry of required)\r\n            this.validateProperty(entry, props[entry]);\r\n        }\r\n        if (props) {\r\n          for (const key of Object.keys(props))\r\n            try {\r\n              this.validateProperty(key, props[key]);\r\n            } catch (e: any) {\r\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\r\n            }\r\n        }\r\n        return;\r\n\r\n      case \"array\":\r\n        if (typeof property.items !== \"object\")\r\n          throw new Error(`array property ${name} has no items member`);\r\n        try {\r\n          this.validateProperty(\"items\", property.items);\r\n        } catch (e: any) {\r\n          throw new Error(`array property ${name}: ${e.message}`);\r\n        }\r\n        return;\r\n\r\n      default:\r\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\r\n    }\r\n  }\r\n\r\n  private static validateAndAdd(group: SettingSchemaGroup) {\r\n    const properties = group.properties;\r\n    if (undefined === properties)\r\n      throw new Error(`group ${group.groupName} has no properties`);\r\n\r\n    for (const key of Object.keys(properties)) {\r\n      this.validateName(key);\r\n      this.validateProperty(key, properties[key]);\r\n      const property: Mutable<SettingSchema> = properties[key];\r\n      property.default = property.default ?? this.getDefaultValue(property.type);\r\n      this.allSchemas.set(key, property);\r\n    }\r\n  }\r\n\r\n  private static getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\r\n    type = Array.isArray(type) ? type[0] : type;\r\n    switch (type) {\r\n      case \"boolean\":\r\n        return false;\r\n      case \"integer\":\r\n      case \"number\":\r\n        return 0;\r\n      case \"string\":\r\n        return \"\";\r\n      case \"array\":\r\n        return [];\r\n      case \"object\":\r\n        return {};\r\n      default:\r\n        return undefined;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SettingsSchemas.js","sourceRoot":"","sources":["../../../src/workspace/SettingsSchemas.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAuG;AAEvG,8CAA2C;AAgC3C;;;;GAIG;AACH,MAAa,eAAe;IAC1B,gBAAwB,CAAC,CAAC,YAAY;IAOtC;;;OAGG;IACI,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,mBAAmB,CAAI,GAAM,EAAE,UAAkB,EAAE,GAAW;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;QAC5B,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,GAAG,CAAC;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,UAAU;YACpD,OAAO,GAAG,CAAC;QAEb,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;YAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACzC,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/C,SAAS;YACX,IAAI,OAAO,KAAK,KAAK,SAAS;gBAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,wBAAwB,GAAG,MAAM,KAAK,OAAO,KAAK,EAAE,CAAC,CAAC;SAC/F;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAwD;QAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,OAAO,CAAC,aAAqB;QACzC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,OAAO,CAAC,QAAuB;QAC3C,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;SAClD;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5E;IACH,CAAC;IAED,2FAA2F;IACpF,MAAM,CAAC,YAAY,CAAC,OAAqB;QAC9C,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;SACzC;IACH,CAAC;IAED,oEAAoE;IAC7D,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,aAAmC;QACtD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS;gBAC/B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;YAE9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,SAAiB;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,KAAK,EAAE,UAAU,EAAE;YACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACtC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;IAC7D,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAmC;QAC/E,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE;oBACrB,KAAK,MAAM,KAAK,IAAI,QAAQ;wBAC1B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC9C;gBACD,IAAI,KAAK,EAAE;oBACT,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI;4BACF,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;yBACxC;wBAAC,OAAO,CAAM,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;yBAC7D;iBACJ;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI;oBACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAChD;gBAAC,OAAO,CAAM,EAAE;oBACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;iBACzD;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;SAC3E;IACH,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,KAAyB;QACrD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAEhE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAA2B,UAAU,CAAC,GAAG,CAAC,CAAC;YACzD,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAA+C;QAC5E,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE;YACZ,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;SACpB;IACH,CAAC;;AAxLuB,0BAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;AAC3E,iDAAiD;AAC1B,0BAAU,GAAG,IAAI,GAAG,EAAyB,CAAC;AACrE,qFAAqF;AAC9D,+BAAe,GAAG,IAAI,sBAAO,EAAc,CAAC;AANxD,0CAAe","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 * as fs from \"fs-extra\";\nimport { parse } from \"json5\";\nimport { extname, join } from \"path\";\nimport { BeEvent, JSONSchema, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsFs } from \"../IModelJsFs\";\n\n/**\n * The properties of a single Setting, used by the settings editor. This interface also includes the\n * default value if it is not specified in any Settings file.\n * This interface includes all members of [JSONSchema]($bentley) with the extensions added by VSCode.\n * @note the `type` member is marked optional in JSONSchema but is required for Settings.\n * @beta\n */\nexport interface SettingSchema extends Readonly<JSONSchema> {\n  readonly items?: SettingSchema; // must be single object, not array\n  readonly type: JSONSchemaTypeName; // type is required for settings\n  readonly properties?: { [name: string]: SettingSchema };\n\n  /** whether the setting replaces lower priority entries with the same name or combines with them. */\n  readonly cumulative?: true;\n}\n\n/**\n * The properties of a group of [[SettingSchema]]s for an application. Groups can be added and removed from [[SettingsSchemas]]\n * and are identified by their (required) `groupName` member\n * @beta\n */\nexport interface SettingSchemaGroup {\n  readonly groupName: string;\n  readonly properties: { [name: string]: SettingSchema };\n  readonly order?: number;\n  readonly title?: string;\n  readonly description?: string;\n  readonly extensionId?: string;\n}\n\n/**\n * The registry of available [[SettingSchemaGroup]]s.\n * The registry is used for editing Settings files and for finding default values for settings.\n * @beta\n */\nexport class SettingsSchemas {\n  private constructor() { } // singleton\n  private static readonly _allGroups = new Map<string, SettingSchemaGroup>();\n  /** a map of all registered [[SettingSchema]]s */\n  public static readonly allSchemas = new Map<string, SettingSchema>();\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\n  public static readonly onSchemaChanged = new BeEvent<() => void>();\n\n  /** Clear the contents of the registry and remove all event listeners.\n   * @note This is really only necessary for tests of the Settings system.\n   * @internal\n   */\n  public static reset() {\n    this._allGroups.clear();\n    this.allSchemas.clear();\n    this.onSchemaChanged.clear();\n  }\n\n  /** @internal */\n  public static validateArrayObject<T>(val: T, schemaName: string, msg: string): T {\n    const schema = this.allSchemas.get(schemaName);\n    const items = schema?.items;\n    if (undefined === items)\n      return val;\n    const required = items.required;\n    const properties = items.properties;\n    if (undefined === required || undefined === properties)\n      return val;\n\n    for (const entry of required) {\n      const entryType = properties[entry].type;\n      const value = (val as any)[entry];\n      if (entryType === \"array\" && Array.isArray(value))\n        continue;\n      if (typeof value !== entryType)\n        throw new Error(`invalid \"${schemaName}\" setting entry for \"${msg}\": ${entry} is ${value}`);\n    }\n    return val;\n  }\n\n  /**\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `groupName` member that is used\n   * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.\n   */\n  public static addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void {\n    if (!Array.isArray(settingsGroup))\n      settingsGroup = [settingsGroup];\n\n    this.doAdd(settingsGroup);\n    this.onSchemaChanged.raiseEvent();\n  }\n\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\n  public static addJson(settingSchema: string): void {\n    this.addGroup(parse(settingSchema));\n  }\n\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\n  public static addFile(fileName: LocalFileName): void {\n    try {\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\n    } catch (e: any) {\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\n    }\n  }\n\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\n  public static addDirectory(dirName: LocalDirName) {\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\n      const ext = extname(fileName);\n      if (ext === \".json5\" || ext === \".json\")\n        this.addFile(join(dirName, fileName));\n    }\n  }\n\n  /** Remove a previously added [[SettingSchemaGroup]] by groupName */\n  public static removeGroup(groupName: string): void {\n    this.doRemove(groupName);\n    this.onSchemaChanged.raiseEvent();\n  }\n\n  private static doAdd(settingsGroup: SettingSchemaGroup[]) {\n    settingsGroup.forEach((group) => {\n      if (undefined === group.groupName)\n        throw new Error(`settings group has no \"groupName\" member`);\n\n      this.doRemove(group.groupName);\n      this.validateAndAdd(group);\n      this._allGroups.set(group.groupName, group);\n    });\n  }\n\n  private static doRemove(groupName: string) {\n    const group = this._allGroups.get(groupName);\n    if (undefined !== group?.properties) {\n      for (const key of Object.keys(group.properties))\n        this.allSchemas.delete(key);\n    }\n    this._allGroups.delete(groupName);\n  }\n\n  private static validateName(name: string) {\n    if (!name.trim())\n      throw new Error(`empty property name`);\n    if (this.allSchemas.has(name))\n      throw new Error(`property \"${name}\" is already defined`);\n  }\n\n  private static validateProperty(name: string, property: SettingSchema | undefined) {\n    if (!property)\n      throw new Error(`missing required property ${name}`);\n\n    if (!property.type)\n      throw new Error(`property ${name} has no type`);\n\n    switch (property.type) {\n      case \"boolean\":\n      case \"integer\":\n      case \"null\":\n      case \"number\":\n      case \"string\":\n        return;\n\n      case \"object\":\n        const required = property.required;\n        const props = property.properties;\n        if (required && props) {\n          for (const entry of required)\n            this.validateProperty(entry, props[entry]);\n        }\n        if (props) {\n          for (const key of Object.keys(props))\n            try {\n              this.validateProperty(key, props[key]);\n            } catch (e: any) {\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\n            }\n        }\n        return;\n\n      case \"array\":\n        if (typeof property.items !== \"object\")\n          throw new Error(`array property ${name} has no items member`);\n        try {\n          this.validateProperty(\"items\", property.items);\n        } catch (e: any) {\n          throw new Error(`array property ${name}: ${e.message}`);\n        }\n        return;\n\n      default:\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\n    }\n  }\n\n  private static validateAndAdd(group: SettingSchemaGroup) {\n    const properties = group.properties;\n    if (undefined === properties)\n      throw new Error(`group ${group.groupName} has no properties`);\n\n    for (const key of Object.keys(properties)) {\n      this.validateName(key);\n      this.validateProperty(key, properties[key]);\n      const property: Mutable<SettingSchema> = properties[key];\n      property.default = property.default ?? this.getDefaultValue(property.type);\n      this.allSchemas.set(key, property);\n    }\n  }\n\n  private static getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\n    type = Array.isArray(type) ? type[0] : type;\n    switch (type) {\n      case \"boolean\":\n        return false;\n      case \"integer\":\n      case \"number\":\n        return 0;\n      case \"string\":\n        return \"\";\n      case \"array\":\n        return [];\n      case \"object\":\n        return {};\n      default:\n        return undefined;\n    }\n  }\n}\n"]}

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

@@ -6,11 +6,11 @@ import { LocalDirName, LocalFileName } from "@itwin/core-common";
 import { CloudSqlite } from "../CloudSqlite";
 import { SQLiteDb } from "../SQLiteDb";
 import { Settings, SettingsPriority } from "./Settings";
+import type { IModelJsNative } from "@bentley/imodeljs-native";
 /** The Settings used by Workspace api
  * @beta
  */
 export declare const WorkspaceSetting: {
-    Accounts: string;
     Containers: string;
     Databases: string;
 };
@@ -40,6 +40,28 @@ export declare namespace WorkspaceContainer {
      * @returns a Promise that resolves to the AccessToken for the container.
      */
     type TokenFunc = (props: Props) => Promise<AccessToken>;
+    function validateDbName(dbName: WorkspaceDb.DbName): void;
+    /**
+     * Validate that a WorkspaceContainer.Id is valid.
+     * The rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata):
+     *  - may only contain lower case letters, numbers or dashes
+     *  - may not start or end with with a dash nor have more than one dash in a row
+     *  - may not be shorter than 3 or longer than 63 characters
+     */
+    function validateContainerId(id: WorkspaceContainer.Id): void;
+    /** @internal */
+    function validateVersion(version?: WorkspaceDb.Version): string;
+    /**
+     * Parse the name stored in a WorkspaceContainer into the dbName and version number. A single WorkspaceContainer may hold
+     * many versions of the same WorkspaceDb. The name of the Db in the WorkspaceContainer is in the format "name:version". This
+     * function splits them into separate strings.
+     */
+    function parseDbFileName(dbFileName: WorkspaceDb.DbFullName): {
+        dbName: WorkspaceDb.DbName;
+        version: WorkspaceDb.Version;
+    };
+    /** Create a dbName for a WorkspaceDb from its base name and version. This will be in the format "name:version" */
+    function makeDbFileName(dbName: WorkspaceDb.DbName, version?: WorkspaceDb.Version): WorkspaceDb.DbName;
 }
 /** @beta */
 export declare namespace WorkspaceDb {
@@ -64,6 +86,12 @@ export declare namespace WorkspaceDb {
      * @see semver.ReleaseType
      */
     type VersionIncrement = "major" | "minor" | "patch";
+    /** file extension for local WorkspaceDbs
+     * @internal
+     */
+    const fileExt = "itwin-workspace";
+    /** construct a new instance of a WorkspaceDb */
+    function construct(props: WorkspaceDb.Props, container: WorkspaceContainer): WorkspaceDb;
 }
 /** Types used to identify Workspace resources
  *  @beta
@@ -99,11 +127,18 @@ export interface WorkspaceDb {
     readonly onClose: BeEvent<() => void>;
     /** Name by which a WorkspaceDb may be opened. This will be either a local file name or the name of a database in a cloud container */
     readonly dbFileName: string;
+    /** the SQLiteDb for this WorkspaceDb*/
+    readonly sqliteDb: SQLiteDb;
+    open(): void;
+    close(): void;
     /** Get a string resource from this WorkspaceDb, if present. */
     getString(rscName: WorkspaceResource.Name): string | undefined;
     /** Get a blob resource from this WorkspaceDb, if present. */
     getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;
-    /** @internal */
+    /** Get a BlobIO reader for a blob WorkspaceResource.
+     * @note when finished, caller *must* call `close` on the BlobIO.
+     * @internal
+     */
     getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;
     /**
      * Extract a local copy of a file resource from this WorkspaceDb, if present.
@@ -128,7 +163,12 @@ export interface WorkspaceDb {
      * @returns a `CloudSqlite.CloudPrefetch` object that can be used to await and/or cancel the prefetch.
      * @throws if this WorkspaceDb is not from a `CloudContainer`.
      */
-    prefetch(): CloudSqlite.CloudPrefetch;
+    prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch;
+    /** @internal */
+    queryFileResource(rscName: WorkspaceResource.Name): {
+        localFileName: LocalFileName;
+        info: IModelJsNative.EmbedFileQuery;
+    } | undefined;
 }
 /** The properties of the CloudCache used for Workspaces.
  * @beta
@@ -197,10 +237,18 @@ export interface Workspace {
     /** Close this Workspace. All WorkspaceContainers are dropped. */
     close(): void;
 }
+/** @beta */
+export declare namespace Workspace {
+    /** @internal */
+    function construct(settings: Settings, opts?: WorkspaceOpts): Workspace;
+}
 /**
- * A WorkspaceContainer holds WorkspaceDbs.
- * Access rights are administered per WorkspaceContainer. That is, if a user has rights to access a WorkspaceContainer, that right
- * applies to all WorkspaceDbs in the WorkspaceContainer.
+ * A WorkspaceContainer is a type of `CloudSqlite.CloudContainer` that holds WorkspaceDbs. Normally a WorkspaceContainer will hold (many versions of) a single WorkspaceDb.
+ * Each version of a WorkspaceDb is treated as immutable after it is created and is stored in the WorkspaceContainer indefinitely. That means that
+ * older versions of the WorkspaceDb may continue to be used, for example by archived projects. For programmers familiar with [NPM](https://www.npmjs.com/), this is conceptually
+ * similar and versioning follows the same rules as NPM using [Semantic Versioning](https://semver.org/).
+ * @note It is possible to store more than one WorkspaceDb in the same WorkspaceContainer, but access rights are administered per WorkspaceContainer.
+ * That is, if a user has rights to access a WorkspaceContainer, that right applies to all WorkspaceDbs in the WorkspaceContainer.
  * @beta
  */
 export interface WorkspaceContainer {
@@ -210,137 +258,43 @@ export interface WorkspaceContainer {
     readonly id: WorkspaceContainer.Id;
     /** Workspace holding this WorkspaceContainer. */
     readonly workspace: Workspace;
-    /** CloudContainer for this WorkspaceContainer (`undefined` if this is a local WorkspaceContainer.)
-     * @internal
-    */
+    /** CloudContainer for this WorkspaceContainer (`undefined` if this is a local WorkspaceContainer.) */
     readonly cloudContainer?: CloudSqlite.CloudContainer;
     /** @internal */
-    addWorkspaceDb(toAdd: ITwinWorkspaceDb): void;
-    /** @internal */
-    resolveDbFileName(props: WorkspaceDb.Props): string;
-    /** find or open a WorkspaceDb from this WorkspaceContainer. */
-    getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb;
-    /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace. */
-    dropWorkspaceDb(container: WorkspaceDb): void;
-    /** Close this WorkspaceContainer. All currently opened WorkspaceDbs are dropped. */
-    close(): void;
-}
-/** @internal */
-export declare class ITwinWorkspace implements Workspace {
-    private _containers;
-    readonly containerDir: LocalDirName;
-    readonly settings: Settings;
-    private _cloudCache?;
-    getCloudCache(): CloudSqlite.CloudCache;
-    constructor(settings: Settings, opts?: WorkspaceOpts);
-    addContainer(toAdd: ITwinWorkspaceContainer): void;
-    findContainer(containerId: WorkspaceContainer.Id): ITwinWorkspaceContainer | undefined;
-    getContainer(props: WorkspaceContainer.Props): WorkspaceContainer;
-    getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb;
-    getWorkspaceDb(dbAlias: string): Promise<WorkspaceDb>;
-    loadSettingsDictionary(settingRsc: WorkspaceResource.Name, db: WorkspaceDb, priority: SettingsPriority): void;
-    close(): void;
-    resolveContainer(containerName: string): WorkspaceContainer.Props;
-    resolveDatabase(databaseName: string): WorkspaceDb.Props & WorkspaceContainer.Alias;
-}
-/** @internal */
-export declare class ITwinWorkspaceContainer implements WorkspaceContainer {
-    readonly workspace: ITwinWorkspace;
-    readonly filesDir: LocalDirName;
-    readonly id: WorkspaceContainer.Id;
-    readonly cloudContainer?: CloudSqlite.CloudContainer | undefined;
-    private _wsDbs;
-    get dirName(): string;
-    static noLeadingOrTrailingSpaces(name: string, msg: string): void;
-    /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)
-     *  - may only contain lower case letters, numbers or dashes
-     *  - may not start or end with with a dash nor have more than one dash in a row
-     *  - may not be shorter than 3 or longer than 63 characters
+    addWorkspaceDb(toAdd: WorkspaceDbImpl): void;
+    /**
+     * Find the appropriate version of a WorkspaceDb in this WorkspaceContainer based on the SemVer rule
+     * in the `WorkspaceDb.Props`.
+     * If no version satisfying the WorkspaceDb.Props rules exists, throws an exception.
      */
-    private static validateContainerId;
-    static validateDbName(dbName: WorkspaceDb.DbName): void;
-    constructor(workspace: ITwinWorkspace, props: WorkspaceContainer.Props);
-    static validateVersion(version?: WorkspaceDb.Version): string;
-    static parseDbFileName(dbFileName: WorkspaceDb.DbFullName): {
-        dbName: WorkspaceDb.DbName;
-        version: WorkspaceDb.Version;
-    };
-    static makeDbFileName(dbName: WorkspaceDb.DbName, version?: WorkspaceDb.Version): WorkspaceDb.DbName;
-    static resolveCloudFileName(cloudContainer: CloudSqlite.CloudContainer, props: WorkspaceDb.Props): WorkspaceDb.DbFullName;
+    resolveDbFileName(props: WorkspaceDb.Props): WorkspaceDb.DbFullName;
     /**
-     * Create a copy of an existing [[WorkspaceDb]] in a cloud container with a new version number.
-     * @param cloudContainer The attached cloud container holding the existing WorkspaceDb
+     * Create a copy of an existing [[WorkspaceDb]] in this WorkspaceContainer with a new version number. This function is used
+     * by administrator tools that modify Workspaces. This requires that the write lock on the container be held. The copy should be modified with
+     * new content before the write lock is released, and thereafter should never be modified again.
      * @param fromProps Properties that describe the source WorkspaceDb for the new version
      * @param versionType The type of version increment to apply to the existing version.
-     * @note This requires that the cloudContainer is attached and the write lock on the container be held. The copy should be modified with
-     * new content before the write lock is released, and thereafter should never be modified again.
+     * @note The copy actually shares all of the data with the original, but with copy-on-write if/when data in the new WorkspaceDb is modified.
      */
-    static makeNewVersion(cloudContainer: CloudSqlite.CloudContainer, fromProps: WorkspaceDb.Props, versionType: WorkspaceDb.VersionIncrement): Promise<{
-        oldName: string;
-        newName: string;
+    makeNewVersion(fromProps: WorkspaceDb.Props, versionType: WorkspaceDb.VersionIncrement): Promise<{
+        oldName: WorkspaceDb.DbName;
+        newName: WorkspaceDb.DbName;
     }>;
-    /**
-     * Convert a WorkspaceDb.Props specification into a DbFileName. For cloud-based containers, this resolves to the dbName, incorporating the appropriate
-     * version. For file-based containers, this returns a local filename of a WorkspaceDb file with the extension ".itwin-workspace"
-     */
-    resolveDbFileName(props: WorkspaceDb.Props): WorkspaceDb.DbFullName;
-    addWorkspaceDb(toAdd: ITwinWorkspaceDb): void;
+    /** find or open a WorkspaceDb from this WorkspaceContainer. */
     getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb;
-    dropWorkspaceDb(toDrop: WorkspaceDb): void;
+    /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace. */
+    closeWorkspaceDb(container: WorkspaceDb): void;
+    /** Close this WorkspaceContainer. All currently opened WorkspaceDbs are dropped. */
     close(): void;
-    /** Delete all local files extracted by [[WorkspaceDb.getFile]] for this container. */
-    purgeContainerFiles(): void;
 }
 /**
- * Implementation of WorkspaceDb
- * @internal
- */
-export declare class ITwinWorkspaceDb implements WorkspaceDb {
-    /** file extension for local WorkspaceDbs */
-    static readonly fileExt = "itwin-workspace";
-    /** the SQLiteDb for this WorkspaceDb*/
-    readonly sqliteDb: SQLiteDb;
-    /** the base WorkspaceDb name, without directory, extension, or version information. */
-    readonly dbName: WorkspaceDb.DbName;
-    /** The WorkspaceContainer holding this WorkspaceDb */
-    readonly container: WorkspaceContainer;
-    /** called before db is closed */
-    readonly onClose: BeEvent<() => void>;
-    /** either a local file name or the name of the file in a cloud container, including version identifier */
-    dbFileName: string;
-    /** true if this WorkspaceDb is currently open */
-    get isOpen(): boolean;
-    queryFileResource(rscName: WorkspaceResource.Name): {
-        localFileName: string;
-        info: import("@bentley/imodeljs-native").IModelJsNative.EmbedFileQuery;
-    } | undefined;
-    constructor(props: WorkspaceDb.Props, container: WorkspaceContainer);
-    open(): void;
-    close(): void;
-    getString(rscName: WorkspaceResource.Name): string | undefined;
-    /** Get a BlobIO reader for a blob WorkspaceResource.
-     * @note when finished, caller *must* call `close` on the BlobIO.
-     */
-    getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;
-    getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;
-    getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined;
-    prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch;
-}
-/**
- * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.
- * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time
- * may be editing.
- * @internal
+ * An editable [[WorkspaceDb]]. This is used only by tools to allow administrators to create and modify `WorkspaceDb`s.
+ * For CloudSqlite Workspaces, the write token must be obtained before the methods in this interface may be used. Normally
+ * only admins will have write access to Workspaces. Only one admin at at time may be editing a Workspace.
+ * @beta
  */
-export declare class EditableWorkspaceDb extends ITwinWorkspaceDb {
-    private static validateResourceName;
-    private validateResourceSize;
-    open(): void;
-    private getFileModifiedTime;
-    private performWriteSql;
+export interface EditableWorkspaceDb extends WorkspaceDb {
     createDb(version?: string): Promise<void>;
-    /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */
-    static createEmpty(fileName: LocalFileName): void;
     /** Add a new string resource to this WorkspaceDb.
      * @param rscName The name of the string resource.
      * @param val The string to save.
@@ -386,4 +340,34 @@ export declare class EditableWorkspaceDb extends ITwinWorkspaceDb {
     /** Remove a file resource. */
     removeFile(rscName: WorkspaceResource.Name): void;
 }
+/** @beta */
+export declare namespace EditableWorkspaceDb {
+    /** construct a new instance of an EditableWorkspaceDb */
+    function construct(props: WorkspaceDb.Props, container: WorkspaceContainer): EditableWorkspaceDb;
+    /** Create a new, empty, EditableWorkspaceDb file on the local filesystem for importing Workspace resources. */
+    function createEmpty(fileName: LocalFileName): void;
+}
+/** Implementation of WorkspaceDb */
+declare class WorkspaceDbImpl implements WorkspaceDb {
+    readonly sqliteDb: SQLiteDb;
+    readonly dbName: WorkspaceDb.DbName;
+    readonly container: WorkspaceContainer;
+    readonly onClose: BeEvent<() => void>;
+    dbFileName: string;
+    /** true if this WorkspaceDb is currently open */
+    get isOpen(): boolean;
+    queryFileResource(rscName: WorkspaceResource.Name): {
+        localFileName: LocalFileName;
+        info: IModelJsNative.EmbedFileQuery;
+    } | undefined;
+    constructor(props: WorkspaceDb.Props, container: WorkspaceContainer);
+    open(): void;
+    close(): void;
+    getString(rscName: WorkspaceResource.Name): string | undefined;
+    getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;
+    getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;
+    getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined;
+    prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch;
+}
+export {};
 //# sourceMappingURL=Workspace.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAE,WAAW,EAAE,OAAO,EAAsB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzF,OAAO,EAAe,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAMxD;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;CAI5B,CAAC;AAEF,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAClC,wEAAwE;IACxE,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B;;;;;;OAMG;IACH,KAAY,EAAE,GAAG,MAAM,CAAC;IAExB,gGAAgG;IAChG,UAAiB,KAAK;QAAG,aAAa,EAAE,MAAM,CAAA;KAAE;IAEhD,oDAAoD;IACpD,UAAiB,KAAM,SAAQ,QAAQ,CAAC,WAAW,CAAC,oBAAoB,EAAE,aAAa,CAAC;QACtF,wIAAwI;QACxI,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;IAED;;;OAGG;IACH,KAAY,SAAS,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CAChE;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IAC3B,oEAAoE;IACpE,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,kGAAkG;IAClG,KAAY,MAAM,GAAG,MAAM,CAAC;IAE5B,+FAA+F;IAC/F,KAAY,UAAU,GAAG,MAAM,CAAC;IAEhC,8DAA8D;IAC9D,KAAY,OAAO,GAAG,MAAM,CAAC;IAE7B,mHAAmH;IACnH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC,yFAAyF;IACzF,UAAiB,KAAM,SAAQ,WAAW,CAAC,UAAU;QACnD,yIAAyI;QACzI,OAAO,CAAC,EAAE,YAAY,CAAC;QACvB,iGAAiG;QACjG,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;IAED;;OAEG;IACH,KAAY,gBAAgB,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CAC5D;AAED;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IACjC;;;;;;OAMG;IACH,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,wFAAwF;IACxF,UAAiB,KAAK;QACpB,sDAAsD;QACtD,OAAO,EAAE,IAAI,CAAC;KACf;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;IACpC,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IACtC,sIAAsI;IACtI,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;IAC/D,6DAA6D;IAC7D,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,UAAU,GAAG,SAAS,CAAC;IACjE,gBAAgB;IAChB,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEhE;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpG;;;;;;OAMG;IACH,QAAQ,IAAI,WAAW,CAAC,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACpG,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,wGAAwG;IACxG,aAAa,CAAC,EAAE,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;IAEhD;;mBAEe;IACf,cAAc,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,wGAAwG;IACxG,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,6DAA6D;IAC7D,aAAa,IAAI,WAAW,CAAC,UAAU,CAAC;IAExC;;;OAGG;IACH,aAAa,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAElF;;;;MAIE;IACF,YAAY,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,GAAG,kBAAkB,CAAC;IAElE,mIAAmI;IACnI,gBAAgB,CAAC,aAAa,EAAE,kBAAkB,CAAC,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC;IAEnF,+IAA+I;IAC/I,eAAe,CAAC,aAAa,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC;IAE/F;;;OAGG;IACH,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,EAAE,cAAc,EAAE,kBAAkB,CAAC,KAAK,GAAG,WAAW,CAAC;IAE3G;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEhE;;OAEG;IACH,sBAAsB,CAAC,UAAU,EAAE,iBAAiB,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9G,iEAAiE;IACjE,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,iHAAiH;IACjH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC;IACnC,iDAAiD;IACjD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B;;MAEE;IACF,QAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;IAErD,gBAAgB;IAChB,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC9C,gBAAgB;IAChB,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,MAAM,CAAC;IAEpD,+DAA+D;IAC/D,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC;IACtD,+EAA+E;IAC/E,eAAe,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;IAC9C,oFAAoF;IACpF,KAAK,IAAI,IAAI,CAAC;CACf;AAED,gBAAgB;AAChB,qBAAa,cAAe,YAAW,SAAS;IAC9C,OAAO,CAAC,WAAW,CAA6D;IAChF,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,OAAO,CAAC,WAAW,CAAC,CAAyB;IACtC,aAAa,IAAI,WAAW,CAAC,UAAU;gBAI3B,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa;IAYpD,YAAY,CAAC,KAAK,EAAE,uBAAuB;IAM3C,aAAa,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE;IAIhD,YAAY,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,GAAG,kBAAkB;IAIjE,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,EAAE,cAAc,EAAE,kBAAkB,CAAC,KAAK,GAAG,WAAW;IAIpG,cAAc,CAAC,OAAO,EAAE,MAAM;IAWpC,sBAAsB,CAAC,UAAU,EAAE,iBAAiB,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,gBAAgB;IAQtG,KAAK;IAOL,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,kBAAkB,CAAC,KAAK;IAgBjE,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,WAAW,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK;CAgB3F;AAED,gBAAgB;AAChB,qBAAa,uBAAwB,YAAW,kBAAkB;IAChE,SAAgB,SAAS,EAAE,cAAc,CAAC;IAC1C,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,SAAgB,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC;IAE1C,SAAgB,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC;IACxE,OAAO,CAAC,MAAM,CAAmD;IACjE,IAAW,OAAO,WAAyD;WAE7D,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKjE;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;WAKpB,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM;gBAMpC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,CAAC,KAAK;WAyB/D,eAAe,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO;WAa7C,eAAe,CAAC,UAAU,EAAE,WAAW,CAAC,UAAU,GAAG;QAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAA;KAAE;WAKjH,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,MAAM;WAI7F,oBAAoB,CAAC,cAAc,EAAE,WAAW,CAAC,cAAc,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,UAAU;IAwBhI;;;;;;;OAOG;WACiB,cAAc,CAAC,cAAc,EAAE,WAAW,CAAC,cAAc,EAAE,SAAS,EAAE,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,gBAAgB;;;;IAYtJ;;;OAGG;IACI,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,UAAU;IAQnE,cAAc,CAAC,KAAK,EAAE,gBAAgB;IAMtC,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW;IAOrD,eAAe,CAAC,MAAM,EAAE,WAAW;IASnC,KAAK;IAOZ,sFAAsF;IAC/E,mBAAmB;CAG3B;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAClD,4CAA4C;IAC5C,gBAAuB,OAAO,qBAAqB;IACnD,uCAAuC;IACvC,SAAgB,QAAQ,WAAkB;IAC1C,uFAAuF;IACvF,SAAgB,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;IAC3C,sDAAsD;IACtD,SAAgB,SAAS,EAAE,kBAAkB,CAAC;IAC9C,iCAAiC;IACjC,SAAgB,OAAO,gBAAqB,IAAI,EAAI;IACpD,0GAA0G;IACnG,UAAU,EAAE,MAAM,CAAC;IAE1B,iDAAiD;IACjD,IAAW,MAAM,YAAmC;IAC7C,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI;;;;gBAYrC,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,kBAAkB;IAQnE,IAAI;IAIJ,KAAK;IAQL,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS;IAOrE;;OAEG;IACI,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,QAAQ,CAAC,MAAM;IAS/D,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,UAAU,GAAG,SAAS;IAOhE,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS;IA0BnG,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa;CAM7E;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAMnC,OAAO,CAAC,oBAAoB;IAMZ,IAAI;IAIpB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,eAAe;IAeV,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM;IAgBtC,kFAAkF;WACpE,WAAW,CAAC,QAAQ,EAAE,aAAa;IAejD;;;OAGG;IACI,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAMpE;;;OAGG;IACI,YAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAKvE,gCAAgC;IACzB,YAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI;IAI1D;;;OAGG;IACI,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAMtE;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAKzE;;OAEG;IACI,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,QAAQ,CAAC,MAAM;IAStE,8BAA8B;IACvB,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI;IAIxD;;;;;;OAMG;IACI,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAQrG;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI;IAKtF,8BAA8B;IACvB,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI;CAQzD"}
+{"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EAAE,WAAW,EAAE,OAAO,EAAsB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzF,OAAO,EAAe,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAU/D;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;CAG5B,CAAC;AAEF,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAClC,wEAAwE;IACxE,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B;;;;;;OAMG;IACH,KAAY,EAAE,GAAG,MAAM,CAAC;IAExB,gGAAgG;IAChG,UAAiB,KAAK;QAAG,aAAa,EAAE,MAAM,CAAA;KAAE;IAEhD,oDAAoD;IACpD,UAAiB,KAAM,SAAQ,QAAQ,CAAC,WAAW,CAAC,oBAAoB,EAAE,aAAa,CAAC;QACtF,wIAAwI;QACxI,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;IAED;;;OAGG;IACH,KAAY,SAAS,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAE/D,SAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,QAIxD;IAED;;;;;;OAMG;IACH,SAAgB,mBAAmB,CAAC,EAAE,EAAE,kBAAkB,CAAC,EAAE,QAG5D;IAED,gBAAgB;IAChB,SAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,UAW5D;IAED;;;;OAIG;IACH,SAAgB,eAAe,CAAC,UAAU,EAAE,WAAW,CAAC,UAAU,GAAG;QAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAA;KAAE,CAGhI;IAED,kHAAkH;IAClH,SAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,MAAM,CAE5G;CACF;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IAC3B,oEAAoE;IACpE,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,kGAAkG;IAClG,KAAY,MAAM,GAAG,MAAM,CAAC;IAE5B,+FAA+F;IAC/F,KAAY,UAAU,GAAG,MAAM,CAAC;IAEhC,8DAA8D;IAC9D,KAAY,OAAO,GAAG,MAAM,CAAC;IAE7B,mHAAmH;IACnH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC,yFAAyF;IACzF,UAAiB,KAAM,SAAQ,WAAW,CAAC,UAAU;QACnD,yIAAyI;QACzI,OAAO,CAAC,EAAE,YAAY,CAAC;QACvB,iGAAiG;QACjG,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;IAED;;OAEG;IACH,KAAY,gBAAgB,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;IAE3D;;OAEG;IACI,MAAM,OAAO,oBAAoB,CAAC;IAEzC,gDAAgD;IAChD,SAAgB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,kBAAkB,GAAG,WAAW,CAE9F;CACF;AAED;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IACjC;;;;;;OAMG;IACH,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,wFAAwF;IACxF,UAAiB,KAAK;QACpB,sDAAsD;QACtD,OAAO,EAAE,IAAI,CAAC;KACf;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;IACpC,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;IACtC,sIAAsI;IACtI,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,IAAI,IAAI,IAAI,CAAC;IACb,KAAK,IAAI,IAAI,CAAC;IAEd,+DAA+D;IAC/D,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS,CAAC;IAC/D,6DAA6D;IAC7D,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,UAAU,GAAG,SAAS,CAAC;IACjE;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEhE;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpG;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAAC;IAEtE,gBAAgB;IAChB,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;KAAE,GAAG,SAAS,CAAC;CACvI;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACpG,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,wGAAwG;IACxG,aAAa,CAAC,EAAE,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;IAEhD;;mBAEe;IACf,cAAc,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,wGAAwG;IACxG,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,6DAA6D;IAC7D,aAAa,IAAI,WAAW,CAAC,UAAU,CAAC;IAExC;;;OAGG;IACH,aAAa,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE,GAAG,kBAAkB,GAAG,SAAS,CAAC;IAElF;;;;MAIE;IACF,YAAY,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,GAAG,kBAAkB,CAAC;IAElE,mIAAmI;IACnI,gBAAgB,CAAC,aAAa,EAAE,kBAAkB,CAAC,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC;IAEnF,+IAA+I;IAC/I,eAAe,CAAC,aAAa,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC;IAE/F;;;OAGG;IACH,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,EAAE,cAAc,EAAE,kBAAkB,CAAC,KAAK,GAAG,WAAW,CAAC;IAE3G;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEhE;;OAEG;IACH,sBAAsB,CAAC,UAAU,EAAE,iBAAiB,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9G,iEAAiE;IACjE,KAAK,IAAI,IAAI,CAAC;CACf;AAED,YAAY;AACZ,yBAAiB,SAAS,CAAC;IACzB,gBAAgB;IAChB,SAAgB,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAE7E;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,iHAAiH;IACjH,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC;IACnC,iDAAiD;IACjD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,sGAAsG;IACtG,QAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;IAErD,gBAAgB;IAChB,cAAc,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC;IAEpE;;;;;;;OAOG;IACH,cAAc,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAA;KAAE,CAAC,CAAC;IAE/J,+DAA+D;IAC/D,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC;IAEtD,+EAA+E;IAC/E,gBAAgB,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI,CAAC;IAE/C,oFAAoF;IACpF,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9D;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjE,gCAAgC;IAChC,YAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEhE,8BAA8B;IAC9B,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/F;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhF,8BAA8B;IAC9B,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAC;CACnD;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,yDAAyD;IACzD,SAAgB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,kBAAkB,GAAG,mBAAmB,CAEtG;IACD,+GAA+G;IAC/G,SAAgB,WAAW,CAAC,QAAQ,EAAE,aAAa,QAalD;CACF;AAiND,oCAAoC;AACpC,cAAM,eAAgB,YAAW,WAAW;IAC1C,SAAgB,QAAQ,WAAkB;IAC1C,SAAgB,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;IAC3C,SAAgB,SAAS,EAAE,kBAAkB,CAAC;IAC9C,SAAgB,OAAO,gBAAqB,IAAI,EAAI;IAC7C,UAAU,EAAE,MAAM,CAAC;IAE1B,iDAAiD;IACjD,IAAW,MAAM,YAAmC;IAC7C,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG;QAAE,aAAa,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;KAAE,GAAG,SAAS;gBAYzH,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,kBAAkB;IAQnE,IAAI;IAIJ,KAAK;IAQL,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS;IAO9D,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,QAAQ,CAAC,MAAM;IAS/D,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,GAAG,UAAU,GAAG,SAAS;IAOhE,OAAO,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS;IA0BnG,QAAQ,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa;CAM7E"}