@itwin/core-backend 4.5.0-dev.8 → 4.5.0-dev.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/CHANGELOG.md +21 -1
  2. package/lib/cjs/BackendHubAccess.d.ts +1 -1
  3. package/lib/cjs/BackendHubAccess.d.ts.map +1 -1
  4. package/lib/cjs/BackendHubAccess.js.map +1 -1
  5. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  6. package/lib/cjs/BisCoreSchema.js.map +1 -1
  7. package/lib/cjs/BlobContainerService.js.map +1 -1
  8. package/lib/cjs/BriefcaseManager.js.map +1 -1
  9. package/lib/cjs/Category.js.map +1 -1
  10. package/lib/cjs/ChangeSummaryManager.js +2 -2
  11. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  12. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  13. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  14. package/lib/cjs/ChangesetECAdaptor.js +237 -237
  15. package/lib/cjs/ChangesetECAdaptor.js.map +1 -1
  16. package/lib/cjs/ChannelControl.js.map +1 -1
  17. package/lib/cjs/CheckpointManager.d.ts +4 -3
  18. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  19. package/lib/cjs/CheckpointManager.js +37 -28
  20. package/lib/cjs/CheckpointManager.js.map +1 -1
  21. package/lib/cjs/ClassRegistry.js +5 -5
  22. package/lib/cjs/ClassRegistry.js.map +1 -1
  23. package/lib/cjs/CloudSqlite.d.ts +3 -1
  24. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  25. package/lib/cjs/CloudSqlite.js +2 -2
  26. package/lib/cjs/CloudSqlite.js.map +1 -1
  27. package/lib/cjs/CodeService.js.map +1 -1
  28. package/lib/cjs/CodeSpecs.js.map +1 -1
  29. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  30. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  31. package/lib/cjs/DevTools.js.map +1 -1
  32. package/lib/cjs/DisplayStyle.js.map +1 -1
  33. package/lib/cjs/ECDb.js.map +1 -1
  34. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  35. package/lib/cjs/ECSqlStatement.js.map +1 -1
  36. package/lib/cjs/Element.js.map +1 -1
  37. package/lib/cjs/ElementAspect.js.map +1 -1
  38. package/lib/cjs/ElementGraphics.js.map +1 -1
  39. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  40. package/lib/cjs/Entity.js.map +1 -1
  41. package/lib/cjs/EntityReferences.js.map +1 -1
  42. package/lib/cjs/ExportGraphics.js.map +1 -1
  43. package/lib/cjs/ExternalSource.js.map +1 -1
  44. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  45. package/lib/cjs/GeometrySummary.js +47 -47
  46. package/lib/cjs/GeometrySummary.js.map +1 -1
  47. package/lib/cjs/HubMock.js.map +1 -1
  48. package/lib/cjs/IModelCloneContext.js.map +1 -1
  49. package/lib/cjs/IModelDb.d.ts +14 -23
  50. package/lib/cjs/IModelDb.d.ts.map +1 -1
  51. package/lib/cjs/IModelDb.js +33 -35
  52. package/lib/cjs/IModelDb.js.map +1 -1
  53. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  54. package/lib/cjs/IModelHost.js.map +1 -1
  55. package/lib/cjs/IModelJsFs.js.map +1 -1
  56. package/lib/cjs/IpcHost.d.ts.map +1 -1
  57. package/lib/cjs/IpcHost.js +3 -0
  58. package/lib/cjs/IpcHost.js.map +1 -1
  59. package/lib/cjs/LineStyle.js.map +1 -1
  60. package/lib/cjs/LocalHub.js +1 -1
  61. package/lib/cjs/LocalHub.js.map +1 -1
  62. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  63. package/lib/cjs/Material.js.map +1 -1
  64. package/lib/cjs/Model.js.map +1 -1
  65. package/lib/cjs/NativeAppStorage.js.map +1 -1
  66. package/lib/cjs/NativeHost.js.map +1 -1
  67. package/lib/cjs/NavigationRelationship.js.map +1 -1
  68. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  69. package/lib/cjs/PropertyStore.js.map +1 -1
  70. package/lib/cjs/Relationship.js.map +1 -1
  71. package/lib/cjs/RpcBackend.js.map +1 -1
  72. package/lib/cjs/SQLiteDb.js.map +1 -1
  73. package/lib/cjs/Schema.js.map +1 -1
  74. package/lib/cjs/SchemaSync.js.map +1 -1
  75. package/lib/cjs/SchemaUtils.js.map +1 -1
  76. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  77. package/lib/cjs/SqliteChangesetReader.js.map +1 -1
  78. package/lib/cjs/SqliteStatement.js.map +1 -1
  79. package/lib/cjs/Texture.js.map +1 -1
  80. package/lib/cjs/TileStorage.js.map +1 -1
  81. package/lib/cjs/TxnManager.js.map +1 -1
  82. package/lib/cjs/ViewDefinition.js.map +1 -1
  83. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  84. package/lib/cjs/ViewStore.js.map +1 -1
  85. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  86. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +44 -44
  87. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  88. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  89. package/lib/cjs/assets/Settings/backend.setting.json5 +132 -132
  90. package/lib/cjs/core-backend.js.map +1 -1
  91. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  92. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  93. package/lib/cjs/domains/GenericElements.js.map +1 -1
  94. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  95. package/lib/cjs/rpc/multipart.js.map +1 -1
  96. package/lib/cjs/rpc/tracing.js.map +1 -1
  97. package/lib/cjs/rpc/web/logging.js.map +1 -1
  98. package/lib/cjs/rpc/web/request.js.map +1 -1
  99. package/lib/cjs/rpc/web/response.js.map +1 -1
  100. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  101. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  102. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  103. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts.map +1 -1
  104. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +12 -13
  105. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  106. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  107. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  108. package/lib/cjs/workspace/Settings.js.map +1 -1
  109. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  110. package/lib/cjs/workspace/Workspace.js.map +1 -1
  111. package/package.json +12 -12
@@ -1 +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":["/*---------------------------------------------------------------------------------------------\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"]}
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"]}
@@ -1 +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":["/*---------------------------------------------------------------------------------------------\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"]}
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"]}
@@ -1 +1 @@
1
- {"version":3,"file":"Workspace.js","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mCAAoC;AACpC,+BAA+B;AAC/B,+BAA8C;AAC9C,iCAAiC;AACjC,sDAAyF;AACzF,oDAA8E;AAC9E,gDAA6C;AAC7C,8CAA2D;AAC3D,8CAA2C;AAC3C,0CAAuC;AAEvC,yCAAwD;AACxD,uDAAoD;AAEpD,yDAAyD;AACzD,2CAA2C;AAE3C;;GAEG;AACU,QAAA,gBAAgB,GAAG;IAC9B,QAAQ,EAAE,gBAAgB;IAC1B,UAAU,EAAE,kBAAkB;IAC9B,SAAS,EAAE,qBAAqB;CACjC,CAAC;AAqPF,gBAAgB;AAChB,MAAa,cAAc;IAKlB,aAAa;QAClB,OAAO,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED,YAAmB,QAAkB,EAAE,IAAoB;QARnD,gBAAW,GAAG,IAAI,GAAG,EAAkD,CAAC;QAS9E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,YAAY,IAAI,IAAA,WAAI,EAAC,uBAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACjF,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,cAAc,CAAC;QACxC,IAAI,aAAa,GAAG,IAAI,EAAE,aAAa,CAAC;QACxC,IAAI,aAAa,EAAE;YACjB,IAAI,OAAO,aAAa,KAAK,QAAQ;gBACnC,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;YAClC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,2BAAgB,CAAC,WAAW,CAAC,CAAC,CAAC;SACvF;IACH,CAAC;IAEM,YAAY,CAAC,KAA8B;QAChD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEM,aAAa,CAAC,WAAkC;QACrD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAEM,YAAY,CAAC,KAA+B;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC;IAEM,uBAAuB,CAAC,OAA0B,EAAE,cAAwC;QACjG,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,OAAe;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,SAAS,GAAmC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACtF,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,WAAW,GAAG,MAAM,yBAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;SACtC;QACD,OAAO,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,sBAAsB,CAAC,UAAkC,EAAE,EAAe,EAAE,QAA0B;QAC3G,MAAM,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO;YACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,EAAE,CAAC,CAAC;QAEnE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,IAAI,UAAU,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,WAAW;YAC7C,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAEM,gBAAgB,CAAC,aAAqB;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAA2B,wBAAgB,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3G,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;oBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa;wBAC3D,OAAO,iCAAe,CAAC,mBAAmB,CAAC,KAAK,EAAE,wBAAgB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;iBACjG;aACF;YACD,OAAO,SAAS,CAAC,CAAC,+CAA+C;QACnE,CAAC,CAAC,CAAC;QACH,IAAI,QAAQ,KAAK,SAAS;YACxB,MAAM,IAAI,KAAK,CAAC,eAAe,wBAAgB,CAAC,UAAU,gBAAgB,aAAa,GAAG,CAAC,CAAC;QAE9F,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,eAAe,CAAC,YAAoB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAA+C,wBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9H,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;oBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;wBAC1D,OAAO,iCAAe,CAAC,mBAAmB,CAAC,KAAK,EAAE,wBAAgB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;iBAC/F;aACF;YACD,OAAO,SAAS,CAAC,CAAC,+CAA+C;QACnE,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,KAAK,SAAS;YACxB,MAAM,IAAI,KAAK,CAAC,eAAe,wBAAgB,CAAC,SAAS,gBAAgB,YAAY,GAAG,CAAC,CAAC;QAE5F,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAjGD,wCAiGC;AAED,gBAAgB;AAChB,MAAa,uBAAuB;IAOlC,IAAW,OAAO,KAAK,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,yBAAyB,CAAC,IAAY,EAAE,GAAW;QAC/D,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI;YACtB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,KAAK,IAAI,0CAA0C,CAAC,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,mBAAmB,CAAC,EAAyB;QAC1D,IAAI,CAAC,uCAAuC,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,MAA0B;QACrD,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5I,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,YAAmB,SAAyB,EAAE,KAA+B;QAxBrE,WAAM,GAAG,IAAI,GAAG,EAAwC,CAAC;QAyB/D,uBAAuB,CAAC,mBAAmB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5B,IAAI,KAAK,CAAC,OAAO,KAAK,EAAE;YACtB,IAAI,CAAC,cAAc,GAAG,yBAAW,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;QAExF,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE5C,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO;QAET,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;QACvD,IAAI,KAAK,KAAK,KAAK,CAAC,aAAa,EAAE;YACjC,IAAI;gBACF,cAAc,CAAC,eAAe,EAAE,CAAC;aAClC;YAAC,OAAO,CAAU,EAAE;gBACnB,kBAAkB;aACnB;SACF;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,OAA6B;QACzD,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC;QAC7B,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;YACtD,kIAAkI;YAClI,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC;YACxF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACnD,OAAO,GAAG,UAAU,CAAC;SACtB;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,UAAkC;QAC9D,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,MAA0B,EAAE,OAA6B;QACpF,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IACtD,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,cAA0C,EAAE,KAAwB;QACrG,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,cAAc,CAAC,cAAc,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,2CAA2C;QAEpG,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,MAAM,MAAM,GAAG,uBAAuB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;YAC3D,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,QAAQ,KAAK,OAAO,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;gBAC7F,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACjC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAExB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,IAAI,GAAG,CAAC;QACnC,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;YACnH,IAAI,OAAO;gBACT,OAAO,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC;SACjC;QAAC,OAAO,CAAU,EAAE;SACpB;QACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,oBAAoB,KAAK,GAAG,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,cAA0C,EAAE,SAA4B,EAAE,WAAyC;QACpJ,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QACrE,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC9D,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,KAAwB;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,mCAAmC;QAE/G,OAAO,uBAAuB,CAAC,oBAAoB,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;IAEM,cAAc,CAAC,KAAuB;QAC3C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,eAAe,KAAK,CAAC,MAAM,8BAA8B,CAAC,CAAC;QAC7E,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAEM,cAAc,CAAC,KAAwB;QAC5C,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC9E,IAAI,CAAC,EAAE,CAAC,MAAM;YACZ,EAAE,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,eAAe,CAAC,MAAmB;QACxC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,MAAM,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;IACH,CAAC;IAEM,KAAK;QACV,KAAK,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM;YACnC,EAAE,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,sFAAsF;IAC/E,mBAAmB;QACxB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAtKD,0DAsKC;AAED;;;GAGG;AACH,MAAa,gBAAgB;IAc3B,iDAAiD;IACjD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,iBAAiB,CAAC,OAA+B;QACtD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,SAAS,CAAC;QAEnB,iIAAiI;QACjI,IAAI,aAAa,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5H,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,8FAA8F;YACrH,aAAa,GAAG,GAAG,aAAa,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACrD,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,YAAmB,KAAwB,EAAE,SAA6B;QAzB1E,uCAAuC;QACvB,aAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAK1C,iCAAiC;QACjB,YAAO,GAAG,IAAI,sBAAO,EAAc,CAAC;QAmBlD,uBAAuB,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACrD,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC1F,CAAC;IAEM,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;SACtC;IACH,CAAC;IAEM,SAAS,CAAC,OAA+B;QAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,sCAAsC,EAAE,CAAC,IAAI,EAAE,EAAE;YACxF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA+B;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,mBAAQ,CAAC,YAAY,EAAE,CAAC;YAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACnH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,OAA+B;QAC5C,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,OAA+B,EAAE,cAA8B;QAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,MAAM,aAAa,GAAG,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC;QAE3D,gDAAgD;QAChD,MAAM,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxE,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;YAC3E,OAAO,aAAa,CAAC,CAAC,kBAAkB;QAE1C,kFAAkF;QAClF,IAAI,IAAI;YACN,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;;YAE7B,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,EAAE,CAAC,UAAU,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,oEAAoE;QAC9G,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB;QACzD,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,QAAQ,CAAC,IAAgC;QAC9C,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;QACrD,IAAI,cAAc,KAAK,SAAS;YAC9B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,OAAO,yBAAW,CAAC,kBAAkB,CAAC,cAAc,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;;AAxGD,4CAA4C;AACrB,wBAAO,GAAG,iBAAiB,AAApB,CAAqB;AAFxC,4CAAgB;AA4G7B;;;;;GAKG;AACH,MAAa,mBAAoB,SAAQ,gBAAgB;IAC/C,MAAM,CAAC,oBAAoB,CAAC,IAA4B;QAC9D,uBAAuB,CAAC,yBAAyB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACzE,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI;YACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC9C,CAAC;IAEO,oBAAoB,CAAC,GAAwB;QACnD,MAAM,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;QAClE,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE,eAAe;YAC7C,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IAEe,IAAI;QAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC3F,CAAC;IAEO,mBAAmB,CAAC,aAA4B;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC;IAEO,eAAe,CAAC,OAA+B,EAAE,GAAW,EAAE,IAAsC;QAC1G,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9C,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE,EAAE;gBAClC,IAAI,uBAAQ,CAAC,+BAA+B,KAAK,EAAE;oBACjD,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,aAAa,OAAO,kBAAkB,CAAC,CAAC;gBAEpE,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,cAAc,GAAG,GAAG,CAAC,CAAC;aACjD;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACpC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;YAClC,mBAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClD;aAAM;YACL,0HAA0H;YAC1H,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,2BAAc,CAAC,MAAM,EAAE,SAAS,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;YACpF,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;gBAC3B,uBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACpC,mBAAmB,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,UAAU,GAAG,uBAAuB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/E,MAAM,yBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAClH,uBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,WAAW,CAAC,QAAuB;QAC/C,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC1B,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,MAAM,YAAY,GAAG,sDAAsD,CAAC;QAC5E,EAAE,CAAC,UAAU,CAAC,gEAAgE,YAAY,GAAG,CAAC,CAAC;QAC/F,EAAE,CAAC,UAAU,CAAC,8DAA8D,YAAY,GAAG,CAAC,CAAC;QAC7F,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,EAAE;YAC1C,EAAE,CAAC,UAAU,CAAC,kBAAkB,SAAS,8BAA8B,SAAS,kFAAkF,SAAS,oDAAoD,CAAC,CAAC;QACnO,CAAC,CAAC;QACF,aAAa,CAAC,SAAS,CAAC,CAAC;QACzB,aAAa,CAAC,OAAO,CAAC,CAAC;QACvB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAA+B,EAAE,GAAW;QAC3D,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,2CAA2C,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,OAA+B,EAAE,GAAW;QAC9D,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,0HAA0H,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC/L,CAAC;IAED,gCAAgC;IACzB,YAAY,CAAC,OAA+B;QACjD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,OAA+B,EAAE,GAAe;QAC7D,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,yCAAyC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,OAA+B,EAAE,GAAe;QAChE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,wHAAwH,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3L,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA+B;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,mBAAQ,CAAC,YAAY,EAAE,CAAC;YAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACpI,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA+B;QAC/C,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,8BAA8B,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,OAA+B,EAAE,aAA4B,EAAE,OAAgB;QAC5F,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,GAAG,OAAO,IAAI,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG;YACtB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7H,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,OAA+B,EAAE,aAA4B;QAC7E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;QACzD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA+B;QAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,IAAI;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,kBAAkB,CAAC,CAAC;QAC/D,IAAI,IAAI,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;YAC3C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;CACF;AAlKD,kDAkKC","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 { createHash } from \"crypto\";\nimport * as fs from \"fs-extra\";\nimport { dirname, extname, join } from \"path\";\nimport * as semver from \"semver\";\nimport { AccessToken, BeEvent, DbResult, OpenMode, Optional } from \"@itwin/core-bentley\";\nimport { IModelError, LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { CloudSqlite } from \"../CloudSqlite\";\nimport { IModelHost, KnownLocations } from \"../IModelHost\";\nimport { IModelJsFs } from \"../IModelJsFs\";\nimport { SQLiteDb } from \"../SQLiteDb\";\nimport { SqliteStatement } from \"../SqliteStatement\";\nimport { Settings, SettingsPriority } from \"./Settings\";\nimport { SettingsSchemas } from \"./SettingsSchemas\";\n\n/* eslint-disable @typescript-eslint/naming-convention */\n// cspell:ignore rowid primarykey julianday\n\n/** The Settings used by Workspace api\n * @beta\n */\nexport const WorkspaceSetting = {\n Accounts: \"cloud/accounts\",\n Containers: \"cloud/containers\",\n Databases: \"workspace/databases\",\n};\n\n/** @beta */\nexport namespace WorkspaceContainer {\n /** The name of a WorkspaceContainer in a \"cloud/containers\" setting. */\n export type Name = string;\n\n /** The unique identifier of a WorkspaceContainer. This becomes the base name for the local directory holding the WorkspaceDbs from a WorkspaceContainer.\n * Usually supplied via the `containerId` member of a \"cloud/containers\" setting.\n * `WorkspaceContainer.Id`s may:\n * - only contain lower case letters, numbers or dashes\n * - not start or end with a dash\n * - not be shorter than 3 or longer than 63 characters\n */\n export type Id = string;\n\n /** A member named `containerName` that specifies by an entry in a \"cloud/containers\" setting */\n export interface Alias { containerName: string }\n\n /** Properties that specify a WorkspaceContainer. */\n export interface Props extends Optional<CloudSqlite.ContainerAccessProps, \"accessToken\"> {\n /** attempt to synchronize (i.e. call `checkForChanges`) this cloud container whenever it is connected to a cloud cache. Default=true */\n syncOnConnect?: boolean;\n }\n\n /** A function to supply an [AccessToken]($bentley) for a `WorkspaceContainer`.\n * @param props The properties of the WorkspaceContainer necessary to obtain the access token\n * @returns a Promise that resolves to the AccessToken for the container.\n */\n export type TokenFunc = (props: Props) => Promise<AccessToken>;\n}\n\n/** @beta */\nexport namespace WorkspaceDb {\n /** The name of a WorkspaceDb in a \"workspace/databases\" setting. */\n export type Name = string;\n\n /** The base name of a WorkspaceDb within a WorkspaceContainer (without any version identifier) */\n export type DbName = string;\n\n /** The name of a WorkspaceDb within a WorkspaceContainer, including the version identifier */\n export type DbFullName = string;\n\n /** The semver-format version identifier for a WorkspaceDb. */\n export type Version = string;\n\n /** The [semver range format](https://github.com/npm/node-semver) identifier for a range of acceptable versions. */\n export type VersionRange = string;\n\n /** Properties that specify how to load a WorkspaceDb within a [[WorkspaceContainer]]. */\n export interface Props extends CloudSqlite.DbNameProp {\n /** a semver version range specifier that determines the acceptable range of versions to load. If not present, use the newest version. */\n version?: VersionRange;\n /** if true, allow semver *prerelease* versions. By default only released version are allowed. */\n includePrerelease?: boolean;\n }\n\n /** Scope to increment for a version number.\n * @see semver.ReleaseType\n */\n export type VersionIncrement = \"major\" | \"minor\" | \"patch\";\n}\n\n/** Types used to identify Workspace resources\n * @beta\n */\nexport namespace WorkspaceResource {\n /**\n * The name for identifying WorkspaceResources in a [[WorkspaceDb]].\n * * `WorkspaceResource.Name`s may not:\n * - be blank or start or end with a space\n * - be longer than 1024 characters\n * @note a single WorkspaceDb may hold WorkspaceResources of type 'blob', 'string' and 'file', all with the same WorkspaceResource.Name.\n */\n export type Name = string;\n\n /** Properties that specify an individual WorkspaceResource within a [[WorkspaceDb]]. */\n export interface Props {\n /** the name of the resource within the WorkspaceDb */\n rscName: Name;\n }\n}\n\n/**\n * A WorkspaceDb holds workspace resources. `WorkspaceDb`s may just be local files, or they may be stored\n * in cloud WorkspaceContainers. Each `WorkspaceResource` in a WorkspaceDb is identified by a [[WorkspaceResource.Name]].\n * Resources of type `string` and `blob` may be loaded directly from the `WorkspaceDb`. Resources of type `file` are\n * copied from the WorkspaceDb into a temporary local file so they can be accessed by programs directly from disk.\n * @beta\n */\nexport interface WorkspaceDb {\n /** The WorkspaceContainer holding this WorkspaceDb. */\n readonly container: WorkspaceContainer;\n /** The base name of this WorkspaceDb, without version */\n readonly dbName: WorkspaceDb.DbName;\n /** event raised before this WorkspaceDb is closed. */\n readonly onClose: BeEvent<() => void>;\n /** 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 */\n readonly dbFileName: string;\n /** Get a string resource from this WorkspaceDb, if present. */\n getString(rscName: WorkspaceResource.Name): string | undefined;\n /** Get a blob resource from this WorkspaceDb, if present. */\n getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;\n /** @internal */\n getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;\n\n /**\n * Extract a local copy of a file resource from this WorkspaceDb, if present.\n * @param rscName The name of the file resource in the WorkspaceDb\n * @param targetFileName optional name for extracted file. Some applications require files in specific locations or filenames. If\n * you know the full path to use for the extracted file, you can supply it. Generally, it is best to *not* supply the filename and\n * keep the extracted files in the filesDir.\n * @returns the full path to a file on the local filesystem.\n * @note The file is copied from the file into the local filesystem so it may be accessed directly. This happens only\n * as necessary, if the local file doesn't exist, or if it is out-of-date because it was updated in the file.\n * For this reason, you should not save the local file name, and instead call this method every time you access it, so its\n * content is always holds the correct version.\n * @note The filename will be a hash value, not the resource name.\n * @note Workspace resource files are set readonly as they are copied from the file.\n * To edit them, you must first copy them to another location.\n */\n getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined;\n\n /**\n * Ensure that the contents of a `WorkspaceDb` are downloaded into the local cache so that it may be accessed offline.\n * Until the promise is resolved, the `WorkspaceDb` is not fully downloaded, but it *may* be safely accessed during the download.\n * To determine the progress of the download, use the `localBlocks` and `totalBlocks` values returned by `CloudContainer.queryDatabase`.\n * @returns a `CloudSqlite.CloudPrefetch` object that can be used to await and/or cancel the prefetch.\n * @throws if this WorkspaceDb is not from a `CloudContainer`.\n */\n prefetch(): CloudSqlite.CloudPrefetch;\n}\n\n/** The properties of the CloudCache used for Workspaces.\n * @beta\n */\nexport interface WorkspaceCloudCacheProps extends Optional<CloudSqlite.CacheProps, \"name\" | \"rootDir\"> {\n /** if true, empty the cache before using it. */\n clearContents?: boolean;\n}\n\n/**\n * Options for constructing a [[Workspace]].\n * @beta\n */\nexport interface WorkspaceOpts {\n /** The local directory for non-cloud-based WorkspaceDb files. The workspace api will look in this directory\n * for files named `${containerId}/${dbId}.itwin-workspace`.\n * @note if not supplied, defaults to `iTwin/Workspace` in the user-local folder.\n */\n containerDir?: LocalDirName;\n\n /** the local fileName(s) of one or more settings files to load after the Workspace is first created. */\n settingsFiles?: LocalFileName | [LocalFileName];\n\n /**\n * only for tests\n * @internal */\n testCloudCache?: CloudSqlite.CloudCache;\n}\n\n/**\n * Settings and resources that customize an application for the current session.\n * See [Workspaces]($docs/learning/backend/Workspace)\n * @beta\n */\nexport interface Workspace {\n /** The directory for local WorkspaceDb files with the name `${containerId}/${dbId}.itwin-workspace`. */\n readonly containerDir: LocalDirName;\n /** The [[Settings]] for this Workspace */\n readonly settings: Settings;\n\n /** Get The CloudCache for cloud-based WorkspaceContainers */\n getCloudCache(): CloudSqlite.CloudCache;\n\n /** search for a previously opened container.\n * @param containerId the id of the container\n * @returns the [[WorkspaceContainer]] for `containerId` if it was not previously opened with [[getContainer]]\n */\n findContainer(containerId: WorkspaceContainer.Id): WorkspaceContainer | undefined;\n\n /** get a [[WorkspaceContainer]] by [[WorkspaceContainer.Props]]\n * @param props the properties of the `WorkspaceContainer`. If `props.containerId` was already opened, its WorkspaceContainer is returned.\n * Otherwise it is created.\n * @param account If present, the properties for this container if it is to be opened from the cloud. If not present, the container is just a local directory.\n */\n getContainer(props: WorkspaceContainer.Props): WorkspaceContainer;\n\n /** get the properties for the supplied container name by searching for an entry with that name in a `cloud/containers` setting. */\n resolveContainer(containerName: WorkspaceContainer.Name): WorkspaceContainer.Props;\n\n /** get the properties for the supplied workspace database name by searching for an entry with that name in a `workspace/databases` setting. */\n resolveDatabase(databaseAlias: WorkspaceDb.Name): WorkspaceDb.Props & WorkspaceContainer.Alias;\n\n /**\n * Get an opened [[WorkspaceDb]]. If the WorkspaceDb is present but not open, it is opened first.\n * If `cloudProps` are supplied, a CloudContainer will be used to open the WorkspaceDb.\n */\n getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb;\n\n /** Get an opened [[WorkspaceDb]] from a WorkspaceDb alias.\n * @param dbAlias the database alias, resolved via [[resolveDatabase]].\n */\n getWorkspaceDb(dbAlias: WorkspaceDb.Name): Promise<WorkspaceDb>;\n\n /** Load a WorkspaceResource of type string, parse it, and add it to the current Settings for this Workspace.\n * @note settingsRsc must specify a resource holding a stringified JSON representation of a [[SettingDictionary]]\n */\n loadSettingsDictionary(settingRsc: WorkspaceResource.Name, db: WorkspaceDb, priority: SettingsPriority): void;\n\n /** Close this Workspace. All WorkspaceContainers are dropped. */\n close(): void;\n}\n\n/**\n * A WorkspaceContainer holds WorkspaceDbs.\n * Access rights are administered per WorkspaceContainer. That is, if a user has rights to access a WorkspaceContainer, that right\n * applies to all WorkspaceDbs in the WorkspaceContainer.\n * @beta\n */\nexport interface WorkspaceContainer {\n /** the local directory where this WorkspaceContainer will store temporary files extracted for file-resources. */\n readonly filesDir: LocalDirName;\n /** The unique identifier for a WorkspaceContainer a cloud storage account. */\n readonly id: WorkspaceContainer.Id;\n /** Workspace holding this WorkspaceContainer. */\n readonly workspace: Workspace;\n /** CloudContainer for this WorkspaceContainer (`undefined` if this is a local WorkspaceContainer.)\n * @internal\n */\n readonly cloudContainer?: CloudSqlite.CloudContainer;\n\n /** @internal */\n addWorkspaceDb(toAdd: ITwinWorkspaceDb): void;\n /** @internal */\n resolveDbFileName(props: WorkspaceDb.Props): string;\n\n /** find or open a WorkspaceDb from this WorkspaceContainer. */\n getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb;\n /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace. */\n dropWorkspaceDb(container: WorkspaceDb): void;\n /** Close this WorkspaceContainer. All currently opened WorkspaceDbs are dropped. */\n close(): void;\n}\n\n/** @internal */\nexport class ITwinWorkspace implements Workspace {\n private _containers = new Map<WorkspaceContainer.Id, ITwinWorkspaceContainer>();\n public readonly containerDir: LocalDirName;\n public readonly settings: Settings;\n private _cloudCache?: CloudSqlite.CloudCache;\n public getCloudCache(): CloudSqlite.CloudCache {\n return this._cloudCache ??= CloudSqlite.CloudCaches.getCache({ cacheName: \"Workspace\", cacheSize: \"20G\" });\n }\n\n public constructor(settings: Settings, opts?: WorkspaceOpts) {\n this.settings = settings;\n this.containerDir = opts?.containerDir ?? join(IModelHost.cacheDir, \"Workspace\");\n this._cloudCache = opts?.testCloudCache;\n let settingsFiles = opts?.settingsFiles;\n if (settingsFiles) {\n if (typeof settingsFiles === \"string\")\n settingsFiles = [settingsFiles];\n settingsFiles.forEach((file) => settings.addFile(file, SettingsPriority.application));\n }\n }\n\n public addContainer(toAdd: ITwinWorkspaceContainer) {\n if (undefined !== this._containers.get(toAdd.id))\n throw new Error(\"container already exists in workspace\");\n this._containers.set(toAdd.id, toAdd);\n }\n\n public findContainer(containerId: WorkspaceContainer.Id) {\n return this._containers.get(containerId);\n }\n\n public getContainer(props: WorkspaceContainer.Props): WorkspaceContainer {\n return this.findContainer(props.containerId) ?? new ITwinWorkspaceContainer(this, props);\n }\n\n public getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb {\n return this.getContainer(containerProps).getWorkspaceDb(dbProps);\n }\n\n public async getWorkspaceDb(dbAlias: string) {\n const dbProps = this.resolveDatabase(dbAlias);\n const props = this.resolveContainer(dbProps.containerName);\n let container: WorkspaceContainer | undefined = this.findContainer(props.containerId);\n if (undefined === container) {\n props.accessToken = await CloudSqlite.requestToken(props);\n container = this.getContainer(props);\n }\n return container?.getWorkspaceDb(dbProps);\n }\n\n public loadSettingsDictionary(settingRsc: WorkspaceResource.Name, db: WorkspaceDb, priority: SettingsPriority) {\n const setting = db.getString(settingRsc);\n if (undefined === setting)\n throw new Error(`could not load setting resource ${settingRsc}`);\n\n this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc}`, priority, setting);\n }\n\n public close() {\n this.settings.close();\n for (const [_id, container] of this._containers)\n container.close();\n this._containers.clear();\n }\n\n public resolveContainer(containerName: string): WorkspaceContainer.Props {\n const resolved = this.settings.resolveSetting<WorkspaceContainer.Props>(WorkspaceSetting.Containers, (val) => {\n if (Array.isArray(val)) {\n for (const entry of val) {\n if (typeof entry === \"object\" && entry.name === containerName)\n return SettingsSchemas.validateArrayObject(entry, WorkspaceSetting.Containers, containerName);\n }\n }\n return undefined; // keep going through all settings dictionaries\n });\n if (resolved === undefined)\n throw new Error(`no setting \"${WorkspaceSetting.Containers}\" entry for \"${containerName}\"`);\n\n return resolved;\n }\n\n public resolveDatabase(databaseName: string): WorkspaceDb.Props & WorkspaceContainer.Alias {\n const resolved = this.settings.resolveSetting<WorkspaceDb.Props & WorkspaceContainer.Alias>(WorkspaceSetting.Databases, (val) => {\n if (Array.isArray(val)) {\n for (const entry of val) {\n if (typeof entry === \"object\" && entry.name === databaseName)\n return SettingsSchemas.validateArrayObject(entry, WorkspaceSetting.Databases, databaseName);\n }\n }\n return undefined; // keep going through all settings dictionaries\n });\n\n if (resolved === undefined)\n throw new Error(`no setting \"${WorkspaceSetting.Databases}\" entry for \"${databaseName}\"`);\n\n return resolved;\n }\n}\n\n/** @internal */\nexport class ITwinWorkspaceContainer implements WorkspaceContainer {\n public readonly workspace: ITwinWorkspace;\n public readonly filesDir: LocalDirName;\n public readonly id: WorkspaceContainer.Id;\n\n public readonly cloudContainer?: CloudSqlite.CloudContainer | undefined;\n private _wsDbs = new Map<WorkspaceDb.DbName, ITwinWorkspaceDb>();\n public get dirName() { return join(this.workspace.containerDir, this.id); }\n\n public static noLeadingOrTrailingSpaces(name: string, msg: string) {\n if (name.trim() !== name)\n throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);\n }\n\n /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)\n * - may only contain lower case letters, numbers or dashes\n * - may not start or end with with a dash nor have more than one dash in a row\n * - may not be shorter than 3 or longer than 63 characters\n */\n private static validateContainerId(id: WorkspaceContainer.Id) {\n if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))\n throw new Error(`invalid containerId: [${id}]`);\n }\n\n public static validateDbName(dbName: WorkspaceDb.DbName) {\n if (dbName === \"\" || dbName.length > 255 || /[#\\.<>:\"/\\\\\"`'|?*\\u0000-\\u001F]/g.test(dbName) || /^(con|prn|aux|nul|com\\d|lpt\\d)$/i.test(dbName))\n throw new Error(`invalid dbName: [${dbName}]`);\n this.noLeadingOrTrailingSpaces(dbName, \"dbName\");\n }\n\n public constructor(workspace: ITwinWorkspace, props: WorkspaceContainer.Props) {\n ITwinWorkspaceContainer.validateContainerId(props.containerId);\n this.workspace = workspace;\n this.id = props.containerId;\n\n if (props.baseUri !== \"\")\n this.cloudContainer = CloudSqlite.createCloudContainer({ accessToken: \"\", ...props });\n\n workspace.addContainer(this);\n this.filesDir = join(this.dirName, \"Files\");\n\n const cloudContainer = this.cloudContainer;\n if (undefined === cloudContainer)\n return;\n\n cloudContainer.connect(this.workspace.getCloudCache());\n if (false !== props.syncOnConnect) {\n try {\n cloudContainer.checkForChanges();\n } catch (e: unknown) {\n // must be offline\n }\n }\n }\n\n public static validateVersion(version?: WorkspaceDb.Version) {\n version = version ?? \"1.0.0\";\n if (version) {\n const opts = { loose: true, includePrerelease: true };\n // clean allows prerelease, so try it first. If that fails attempt to coerce it (coerce strips prerelease even if you say not to.)\n const semVersion = semver.clean(version, opts) ?? semver.coerce(version, opts)?.version;\n if (!semVersion)\n throw new Error(\"invalid version specification\");\n version = semVersion;\n }\n return version;\n }\n\n public static parseDbFileName(dbFileName: WorkspaceDb.DbFullName): { dbName: WorkspaceDb.DbName, version: WorkspaceDb.Version } {\n const parts = dbFileName.split(\":\");\n return { dbName: parts[0], version: parts[1] };\n }\n\n public static makeDbFileName(dbName: WorkspaceDb.DbName, version?: WorkspaceDb.Version): WorkspaceDb.DbName {\n return `${dbName}:${this.validateVersion(version)}`;\n }\n\n public static resolveCloudFileName(cloudContainer: CloudSqlite.CloudContainer, props: WorkspaceDb.Props): WorkspaceDb.DbFullName {\n const dbName = props.dbName;\n const dbs = cloudContainer.queryDatabases(`${dbName}*`); // get all databases that start with dbName\n\n const versions = [];\n for (const db of dbs) {\n const thisDb = ITwinWorkspaceContainer.parseDbFileName(db);\n if (thisDb.dbName === dbName && \"string\" === typeof thisDb.version && thisDb.version.length > 0)\n versions.push(thisDb.version);\n }\n\n if (versions.length === 0)\n versions[0] = \"1.0.0\";\n\n const range = props.version ?? \"*\";\n try {\n const version = semver.maxSatisfying(versions, range, { loose: true, includePrerelease: props.includePrerelease });\n if (version)\n return `${dbName}:${version}`;\n } catch (e: unknown) {\n }\n throw new Error(`No version of [${dbName}] available for \"${range}\"`);\n }\n\n /**\n * Create a copy of an existing [[WorkspaceDb]] in a cloud container with a new version number.\n * @param cloudContainer The attached cloud container holding the existing WorkspaceDb\n * @param fromProps Properties that describe the source WorkspaceDb for the new version\n * @param versionType The type of version increment to apply to the existing version.\n * @note This requires that the cloudContainer is attached and the write lock on the container be held. The copy should be modified with\n * new content before the write lock is released, and thereafter should never be modified again.\n */\n public static async makeNewVersion(cloudContainer: CloudSqlite.CloudContainer, fromProps: WorkspaceDb.Props, versionType: WorkspaceDb.VersionIncrement) {\n const oldName = this.resolveCloudFileName(cloudContainer, fromProps);\n const oldDb = this.parseDbFileName(oldName);\n const newVersion = semver.inc(oldDb.version, versionType);\n if (!newVersion)\n throw new Error(\"invalid version\");\n\n const newName = this.makeDbFileName(oldDb.dbName, newVersion);\n await cloudContainer.copyDatabase(oldName, newName);\n return { oldName, newName };\n }\n\n /**\n * Convert a WorkspaceDb.Props specification into a DbFileName. For cloud-based containers, this resolves to the dbName, incorporating the appropriate\n * version. For file-based containers, this returns a local filename of a WorkspaceDb file with the extension \".itwin-workspace\"\n */\n public resolveDbFileName(props: WorkspaceDb.Props): WorkspaceDb.DbFullName {\n const cloudContainer = this.cloudContainer;\n if (undefined === cloudContainer)\n return join(this.dirName, `${props.dbName}.${ITwinWorkspaceDb.fileExt}`); // local file, versions not allowed\n\n return ITwinWorkspaceContainer.resolveCloudFileName(cloudContainer, props);\n }\n\n public addWorkspaceDb(toAdd: ITwinWorkspaceDb) {\n if (undefined !== this._wsDbs.get(toAdd.dbName))\n throw new Error(`workspaceDb ${toAdd.dbName} already exists in workspace`);\n this._wsDbs.set(toAdd.dbName, toAdd);\n }\n\n public getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb {\n const db = this._wsDbs.get(props.dbName) ?? new ITwinWorkspaceDb(props, this);\n if (!db.isOpen)\n db.open();\n return db;\n }\n\n public dropWorkspaceDb(toDrop: WorkspaceDb) {\n const name = toDrop.dbName;\n const wsDb = this._wsDbs.get(name);\n if (wsDb === toDrop) {\n this._wsDbs.delete(name);\n wsDb.close();\n }\n }\n\n public close() {\n for (const [_name, db] of this._wsDbs)\n db.close();\n this._wsDbs.clear();\n this.cloudContainer?.disconnect();\n }\n\n /** Delete all local files extracted by [[WorkspaceDb.getFile]] for this container. */\n public purgeContainerFiles() {\n IModelJsFs.purgeDirSync(this.filesDir);\n }\n}\n\n/**\n * Implementation of WorkspaceDb\n * @internal\n */\nexport class ITwinWorkspaceDb implements WorkspaceDb {\n /** file extension for local WorkspaceDbs */\n public static readonly fileExt = \"itwin-workspace\";\n /** the SQLiteDb for this WorkspaceDb*/\n public readonly sqliteDb = new SQLiteDb();\n /** the base WorkspaceDb name, without directory, extension, or version information. */\n public readonly dbName: WorkspaceDb.DbName;\n /** The WorkspaceContainer holding this WorkspaceDb */\n public readonly container: WorkspaceContainer;\n /** called before db is closed */\n public readonly onClose = new BeEvent<() => void>();\n /** either a local file name or the name of the file in a cloud container, including version identifier */\n public dbFileName: string;\n\n /** true if this WorkspaceDb is currently open */\n public get isOpen() { return this.sqliteDb.isOpen; }\n public queryFileResource(rscName: WorkspaceResource.Name) {\n const info = this.sqliteDb.nativeDb.queryEmbeddedFile(rscName);\n if (undefined === info)\n return undefined;\n\n // since resource names can contain illegal characters, path separators, etc., we make the local file name from its hash, in hex.\n let localFileName = join(this.container.filesDir, createHash(\"sha1\").update(this.dbFileName).update(rscName).digest(\"hex\"));\n if (info.fileExt !== \"\") // since some applications may expect to see the extension, append it here if it was supplied.\n localFileName = `${localFileName}.${info.fileExt}`;\n return { localFileName, info };\n }\n\n public constructor(props: WorkspaceDb.Props, container: WorkspaceContainer) {\n ITwinWorkspaceContainer.validateDbName(props.dbName);\n this.dbName = props.dbName;\n this.container = container;\n this.dbFileName = container.resolveDbFileName(props);\n container.addWorkspaceDb(this);\n }\n\n public open() {\n this.sqliteDb.openDb(this.dbFileName, OpenMode.Readonly, this.container.cloudContainer);\n }\n\n public close() {\n if (this.isOpen) {\n this.onClose.raiseEvent();\n this.sqliteDb.closeDb();\n this.container.dropWorkspaceDb(this);\n }\n }\n\n public getString(rscName: WorkspaceResource.Name): string | undefined {\n return this.sqliteDb.withSqliteStatement(\"SELECT value from strings WHERE id=?\", (stmt) => {\n stmt.bindString(1, rscName);\n return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueString(0) : undefined;\n });\n }\n\n /** Get a BlobIO reader for a blob WorkspaceResource.\n * @note when finished, caller *must* call `close` on the BlobIO.\n */\n public getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO {\n return this.sqliteDb.withSqliteStatement(\"SELECT rowid from blobs WHERE id=?\", (stmt) => {\n stmt.bindString(1, rscName);\n const blobReader = SQLiteDb.createBlobIO();\n blobReader.open(this.sqliteDb.nativeDb, { tableName: \"blobs\", columnName: \"value\", row: stmt.getValueInteger(0) });\n return blobReader;\n });\n }\n\n public getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined {\n return this.sqliteDb.withSqliteStatement(\"SELECT value from blobs WHERE id=?\", (stmt) => {\n stmt.bindString(1, rscName);\n return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueBlob(0) : undefined;\n });\n }\n\n public getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined {\n const file = this.queryFileResource(rscName);\n if (!file)\n return undefined;\n\n const info = file.info;\n const localFileName = targetFileName ?? file.localFileName;\n\n // check whether the file is already up to date.\n const stat = fs.existsSync(localFileName) && fs.statSync(localFileName);\n if (stat && Math.round(stat.mtimeMs) === info.date && stat.size === info.size)\n return localFileName; // yes, we're done\n\n // extractEmbeddedFile fails if the file exists or if the directory does not exist\n if (stat)\n fs.removeSync(localFileName);\n else\n IModelJsFs.recursiveMkDirSync(dirname(localFileName));\n\n this.sqliteDb.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });\n const date = new Date(info.date);\n fs.utimesSync(localFileName, date, date); // set the last-modified date of the file to match date in container\n fs.chmodSync(localFileName, \"0444\"); // set file readonly\n return localFileName;\n }\n\n public prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch {\n const cloudContainer = this.container.cloudContainer;\n if (cloudContainer === undefined)\n throw new Error(\"no cloud container to prefetch\");\n return CloudSqlite.startCloudPrefetch(cloudContainer, this.dbFileName, opts);\n }\n}\n\n/**\n * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.\n * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time\n * may be editing.\n * @internal\n */\nexport class EditableWorkspaceDb extends ITwinWorkspaceDb {\n private static validateResourceName(name: WorkspaceResource.Name) {\n ITwinWorkspaceContainer.noLeadingOrTrailingSpaces(name, \"resource name\");\n if (name.length > 1024)\n throw new Error(\"resource name too long\");\n }\n\n private validateResourceSize(val: Uint8Array | string) {\n const len = typeof val === \"string\" ? val.length : val.byteLength;\n if (len > (1024 * 1024 * 1024)) // one gigabyte\n throw new Error(\"value is too large\");\n }\n\n public override open() {\n this.sqliteDb.openDb(this.dbFileName, OpenMode.ReadWrite, this.container.cloudContainer);\n }\n\n private getFileModifiedTime(localFileName: LocalFileName): number {\n return Math.round(fs.statSync(localFileName).mtimeMs);\n }\n\n private performWriteSql(rscName: WorkspaceResource.Name, sql: string, bind?: (stmt: SqliteStatement) => void) {\n this.sqliteDb.withSqliteStatement(sql, (stmt) => {\n stmt.bindString(1, rscName);\n bind?.(stmt);\n const rc = stmt.step();\n if (DbResult.BE_SQLITE_DONE !== rc) {\n if (DbResult.BE_SQLITE_CONSTRAINT_PRIMARYKEY === rc)\n throw new IModelError(rc, `resource \"${rscName}\" already exists`);\n\n throw new IModelError(rc, `workspace [${sql}]`);\n }\n });\n this.sqliteDb.saveChanges();\n }\n\n public async createDb(version?: string) {\n if (!this.container.cloudContainer) {\n EditableWorkspaceDb.createEmpty(this.dbFileName);\n } else {\n // currently the only way to create a workspaceDb in a cloud container is to create a temporary workspaceDb and upload it.\n const tempDbFile = join(KnownLocations.tmpdir, `empty.${ITwinWorkspaceDb.fileExt}`);\n if (fs.existsSync(tempDbFile))\n IModelJsFs.removeSync(tempDbFile);\n EditableWorkspaceDb.createEmpty(tempDbFile);\n this.dbFileName = ITwinWorkspaceContainer.makeDbFileName(this.dbName, version);\n await CloudSqlite.uploadDb(this.container.cloudContainer, { localFileName: tempDbFile, dbName: this.dbFileName });\n IModelJsFs.removeSync(tempDbFile);\n }\n this.open();\n }\n\n /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */\n public static createEmpty(fileName: LocalFileName) {\n const db = new SQLiteDb();\n IModelJsFs.recursiveMkDirSync(dirname(fileName));\n db.createDb(fileName);\n const timeStampCol = \"lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\";\n db.executeSQL(`CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT,${timeStampCol})`);\n db.executeSQL(`CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB,${timeStampCol})`);\n const createTrigger = (tableName: string) => {\n db.executeSQL(`CREATE TRIGGER ${tableName}_timeStamp AFTER UPDATE ON ${tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${tableName} SET lastMod=julianday('now') WHERE id=new.id; END`);\n };\n createTrigger(\"strings\");\n createTrigger(\"blobs\");\n db.closeDb(true);\n }\n\n /** Add a new string resource to this WorkspaceDb.\n * @param rscName The name of the string resource.\n * @param val The string to save.\n */\n public addString(rscName: WorkspaceResource.Name, val: string): void {\n EditableWorkspaceDb.validateResourceName(rscName);\n this.validateResourceSize(val);\n this.performWriteSql(rscName, \"INSERT INTO strings(id,value) VALUES(?,?)\", (stmt) => stmt.bindString(2, val));\n }\n\n /** Update an existing string resource with a new value, or add it if it does not exist.\n * @param rscName The name of the string resource.\n * @param val The new value.\n */\n public updateString(rscName: WorkspaceResource.Name, val: string): void {\n this.validateResourceSize(val);\n this.performWriteSql(rscName, \"INSERT INTO strings(id,value) VALUES(?,?) ON CONFLICT(id) DO UPDATE SET value=excluded.value WHERE value!=excluded.value\", (stmt) => stmt.bindString(2, val));\n }\n\n /** Remove a string resource. */\n public removeString(rscName: WorkspaceResource.Name): void {\n this.performWriteSql(rscName, \"DELETE FROM strings WHERE id=?\");\n }\n\n /** Add a new blob resource to this WorkspaceDb.\n * @param rscName The name of the blob resource.\n * @param val The blob to save.\n */\n public addBlob(rscName: WorkspaceResource.Name, val: Uint8Array): void {\n EditableWorkspaceDb.validateResourceName(rscName);\n this.validateResourceSize(val);\n this.performWriteSql(rscName, \"INSERT INTO blobs(id,value) VALUES(?,?)\", (stmt) => stmt.bindBlob(2, val));\n }\n\n /** Update an existing blob resource with a new value, or add it if it does not exist.\n * @param rscName The name of the blob resource.\n * @param val The new value.\n */\n public updateBlob(rscName: WorkspaceResource.Name, val: Uint8Array): void {\n this.validateResourceSize(val);\n this.performWriteSql(rscName, \"INSERT INTO blobs(id,value) VALUES(?,?) ON CONFLICT(id) DO UPDATE SET value=excluded.value WHERE value!=excluded.value\", (stmt) => stmt.bindBlob(2, val));\n }\n\n /** Get a BlobIO writer for a previously-added blob WorkspaceResource.\n * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\n */\n public getBlobWriter(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO {\n return this.sqliteDb.withSqliteStatement(\"SELECT rowid from blobs WHERE id=?\", (stmt) => {\n stmt.bindString(1, rscName);\n const blobWriter = SQLiteDb.createBlobIO();\n blobWriter.open(this.sqliteDb.nativeDb, { tableName: \"blobs\", columnName: \"value\", row: stmt.getValueInteger(0), writeable: true });\n return blobWriter;\n });\n }\n\n /** Remove a blob resource. */\n public removeBlob(rscName: WorkspaceResource.Name): void {\n this.performWriteSql(rscName, \"DELETE FROM blobs WHERE id=?\");\n }\n\n /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.\n * @param rscName The name of the file resource.\n * @param localFileName The name of a local file to be read.\n * @param fileExt The extension (do not include the leading \".\") to be appended to the generated fileName\n * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last \".\" in `localFileName`\n * are used. Pass this argument to override that.\n */\n public addFile(rscName: WorkspaceResource.Name, localFileName: LocalFileName, fileExt?: string): void {\n EditableWorkspaceDb.validateResourceName(rscName);\n fileExt = fileExt ?? extname(localFileName);\n if (fileExt?.[0] === \".\")\n fileExt = fileExt.slice(1);\n this.sqliteDb.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });\n }\n\n /** Replace an existing file resource with the contents of another local file.\n * @param rscName The name of the file resource.\n * @param localFileName The name of a local file to be read.\n * @throws if rscName does not exist\n */\n public updateFile(rscName: WorkspaceResource.Name, localFileName: LocalFileName): void {\n this.queryFileResource(rscName); // throws if not present\n this.sqliteDb.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });\n }\n\n /** Remove a file resource. */\n public removeFile(rscName: WorkspaceResource.Name): void {\n const file = this.queryFileResource(rscName);\n if (undefined === file)\n throw new Error(`file resource \"${rscName}\" does not exist`);\n if (file && fs.existsSync(file.localFileName))\n fs.unlinkSync(file.localFileName);\n this.sqliteDb.nativeDb.removeEmbeddedFile(rscName);\n }\n}\n"]}
1
+ {"version":3,"file":"Workspace.js","sourceRoot":"","sources":["../../../src/workspace/Workspace.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mCAAoC;AACpC,+BAA+B;AAC/B,+BAA8C;AAC9C,iCAAiC;AACjC,sDAAyF;AACzF,oDAA8E;AAC9E,gDAA6C;AAC7C,8CAA2D;AAC3D,8CAA2C;AAC3C,0CAAuC;AAEvC,yCAAwD;AACxD,uDAAoD;AAEpD,yDAAyD;AACzD,2CAA2C;AAE3C;;GAEG;AACU,QAAA,gBAAgB,GAAG;IAC9B,QAAQ,EAAE,gBAAgB;IAC1B,UAAU,EAAE,kBAAkB;IAC9B,SAAS,EAAE,qBAAqB;CACjC,CAAC;AAqPF,gBAAgB;AAChB,MAAa,cAAc;IAKlB,aAAa;QAClB,OAAO,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED,YAAmB,QAAkB,EAAE,IAAoB;QARnD,gBAAW,GAAG,IAAI,GAAG,EAAkD,CAAC;QAS9E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,YAAY,IAAI,IAAA,WAAI,EAAC,uBAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACjF,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,cAAc,CAAC;QACxC,IAAI,aAAa,GAAG,IAAI,EAAE,aAAa,CAAC;QACxC,IAAI,aAAa,EAAE;YACjB,IAAI,OAAO,aAAa,KAAK,QAAQ;gBACnC,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;YAClC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,2BAAgB,CAAC,WAAW,CAAC,CAAC,CAAC;SACvF;IACH,CAAC;IAEM,YAAY,CAAC,KAA8B;QAChD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEM,aAAa,CAAC,WAAkC;QACrD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAEM,YAAY,CAAC,KAA+B;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC;IAEM,uBAAuB,CAAC,OAA0B,EAAE,cAAwC;QACjG,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,OAAe;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,SAAS,GAAmC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACtF,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,WAAW,GAAG,MAAM,yBAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;SACtC;QACD,OAAO,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,sBAAsB,CAAC,UAAkC,EAAE,EAAe,EAAE,QAA0B;QAC3G,MAAM,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO;YACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,EAAE,CAAC,CAAC;QAEnE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,IAAI,UAAU,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,WAAW;YAC7C,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAEM,gBAAgB,CAAC,aAAqB;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAA2B,wBAAgB,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3G,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;oBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa;wBAC3D,OAAO,iCAAe,CAAC,mBAAmB,CAAC,KAAK,EAAE,wBAAgB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;iBACjG;aACF;YACD,OAAO,SAAS,CAAC,CAAC,+CAA+C;QACnE,CAAC,CAAC,CAAC;QACH,IAAI,QAAQ,KAAK,SAAS;YACxB,MAAM,IAAI,KAAK,CAAC,eAAe,wBAAgB,CAAC,UAAU,gBAAgB,aAAa,GAAG,CAAC,CAAC;QAE9F,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,eAAe,CAAC,YAAoB;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAA+C,wBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9H,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACtB,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;oBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;wBAC1D,OAAO,iCAAe,CAAC,mBAAmB,CAAC,KAAK,EAAE,wBAAgB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;iBAC/F;aACF;YACD,OAAO,SAAS,CAAC,CAAC,+CAA+C;QACnE,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,KAAK,SAAS;YACxB,MAAM,IAAI,KAAK,CAAC,eAAe,wBAAgB,CAAC,SAAS,gBAAgB,YAAY,GAAG,CAAC,CAAC;QAE5F,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAjGD,wCAiGC;AAED,gBAAgB;AAChB,MAAa,uBAAuB;IAOlC,IAAW,OAAO,KAAK,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,yBAAyB,CAAC,IAAY,EAAE,GAAW;QAC/D,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI;YACtB,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,KAAK,IAAI,0CAA0C,CAAC,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,mBAAmB,CAAC,EAAyB;QAC1D,IAAI,CAAC,uCAAuC,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,MAA0B;QACrD,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC;YAC5I,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,YAAmB,SAAyB,EAAE,KAA+B;QAxBrE,WAAM,GAAG,IAAI,GAAG,EAAwC,CAAC;QAyB/D,uBAAuB,CAAC,mBAAmB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC;QAE5B,IAAI,KAAK,CAAC,OAAO,KAAK,EAAE;YACtB,IAAI,CAAC,cAAc,GAAG,yBAAW,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;QAExF,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE5C,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO;QAET,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;QACvD,IAAI,KAAK,KAAK,KAAK,CAAC,aAAa,EAAE;YACjC,IAAI;gBACF,cAAc,CAAC,eAAe,EAAE,CAAC;aAClC;YAAC,OAAO,CAAU,EAAE;gBACnB,kBAAkB;aACnB;SACF;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,OAA6B;QACzD,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC;QAC7B,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;YACtD,kIAAkI;YAClI,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC;YACxF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACnD,OAAO,GAAG,UAAU,CAAC;SACtB;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,UAAkC;QAC9D,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,MAA0B,EAAE,OAA6B;QACpF,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IACtD,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,cAA0C,EAAE,KAAwB;QACrG,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,cAAc,CAAC,cAAc,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,2CAA2C;QAEpG,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,MAAM,MAAM,GAAG,uBAAuB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;YAC3D,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,QAAQ,KAAK,OAAO,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;gBAC7F,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACjC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAExB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,IAAI,GAAG,CAAC;QACnC,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;YACnH,IAAI,OAAO;gBACT,OAAO,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC;SACjC;QAAC,OAAO,CAAU,EAAE;SACpB;QACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,oBAAoB,KAAK,GAAG,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,cAA0C,EAAE,SAA4B,EAAE,WAAyC;QACpJ,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QACrE,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC9D,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,KAAwB;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,SAAS,KAAK,cAAc;YAC9B,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,mCAAmC;QAE/G,OAAO,uBAAuB,CAAC,oBAAoB,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;IAEM,cAAc,CAAC,KAAuB;QAC3C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,eAAe,KAAK,CAAC,MAAM,8BAA8B,CAAC,CAAC;QAC7E,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAEM,cAAc,CAAC,KAAwB;QAC5C,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC9E,IAAI,CAAC,EAAE,CAAC,MAAM;YACZ,EAAE,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,eAAe,CAAC,MAAmB;QACxC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,MAAM,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;IACH,CAAC;IAEM,KAAK;QACV,KAAK,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM;YACnC,EAAE,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,sFAAsF;IAC/E,mBAAmB;QACxB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAtKD,0DAsKC;AAED;;;GAGG;AACH,MAAa,gBAAgB;IAc3B,iDAAiD;IACjD,IAAW,MAAM,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,iBAAiB,CAAC,OAA+B;QACtD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,SAAS,CAAC;QAEnB,iIAAiI;QACjI,IAAI,aAAa,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5H,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,8FAA8F;YACrH,aAAa,GAAG,GAAG,aAAa,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACrD,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,YAAmB,KAAwB,EAAE,SAA6B;QAzB1E,uCAAuC;QACvB,aAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAK1C,iCAAiC;QACjB,YAAO,GAAG,IAAI,sBAAO,EAAc,CAAC;QAmBlD,uBAAuB,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACrD,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC1F,CAAC;IAEM,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;SACtC;IACH,CAAC;IAEM,SAAS,CAAC,OAA+B;QAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,sCAAsC,EAAE,CAAC,IAAI,EAAE,EAAE;YACxF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA+B;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,mBAAQ,CAAC,YAAY,EAAE,CAAC;YAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACnH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,OAA+B;QAC5C,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,OAA+B,EAAE,cAA8B;QAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,MAAM,aAAa,GAAG,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC;QAE3D,gDAAgD;QAChD,MAAM,IAAI,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxE,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;YAC3E,OAAO,aAAa,CAAC,CAAC,kBAAkB;QAE1C,kFAAkF;QAClF,IAAI,IAAI;YACN,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;;YAE7B,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,EAAE,CAAC,UAAU,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,oEAAoE;QAC9G,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB;QACzD,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,QAAQ,CAAC,IAAgC;QAC9C,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;QACrD,IAAI,cAAc,KAAK,SAAS;YAC9B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,OAAO,yBAAW,CAAC,kBAAkB,CAAC,cAAc,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC/E,CAAC;;AAxGD,4CAA4C;AACrB,wBAAO,GAAG,iBAAiB,AAApB,CAAqB;AAFxC,4CAAgB;AA4G7B;;;;;GAKG;AACH,MAAa,mBAAoB,SAAQ,gBAAgB;IAC/C,MAAM,CAAC,oBAAoB,CAAC,IAA4B;QAC9D,uBAAuB,CAAC,yBAAyB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACzE,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI;YACpB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC9C,CAAC;IAEO,oBAAoB,CAAC,GAAwB;QACnD,MAAM,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;QAClE,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE,eAAe;YAC7C,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IAEe,IAAI;QAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,uBAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC3F,CAAC;IAEO,mBAAmB,CAAC,aAA4B;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC;IAEO,eAAe,CAAC,OAA+B,EAAE,GAAW,EAAE,IAAsC;QAC1G,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9C,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE,EAAE;gBAClC,IAAI,uBAAQ,CAAC,+BAA+B,KAAK,EAAE;oBACjD,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,aAAa,OAAO,kBAAkB,CAAC,CAAC;gBAEpE,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,cAAc,GAAG,GAAG,CAAC,CAAC;aACjD;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACpC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;YAClC,mBAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClD;aAAM;YACL,0HAA0H;YAC1H,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,2BAAc,CAAC,MAAM,EAAE,SAAS,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC;YACpF,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;gBAC3B,uBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACpC,mBAAmB,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAC5C,IAAI,CAAC,UAAU,GAAG,uBAAuB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/E,MAAM,yBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAClH,uBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,WAAW,CAAC,QAAuB;QAC/C,MAAM,EAAE,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC1B,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,MAAM,YAAY,GAAG,sDAAsD,CAAC;QAC5E,EAAE,CAAC,UAAU,CAAC,gEAAgE,YAAY,GAAG,CAAC,CAAC;QAC/F,EAAE,CAAC,UAAU,CAAC,8DAA8D,YAAY,GAAG,CAAC,CAAC;QAC7F,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,EAAE;YAC1C,EAAE,CAAC,UAAU,CAAC,kBAAkB,SAAS,8BAA8B,SAAS,kFAAkF,SAAS,oDAAoD,CAAC,CAAC;QACnO,CAAC,CAAC;QACF,aAAa,CAAC,SAAS,CAAC,CAAC;QACzB,aAAa,CAAC,OAAO,CAAC,CAAC;QACvB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAA+B,EAAE,GAAW;QAC3D,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,2CAA2C,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,OAA+B,EAAE,GAAW;QAC9D,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,0HAA0H,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC/L,CAAC;IAED,gCAAgC;IACzB,YAAY,CAAC,OAA+B;QACjD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,gCAAgC,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,OAA+B,EAAE,GAAe;QAC7D,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,yCAAyC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,OAA+B,EAAE,GAAe;QAChE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,wHAAwH,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3L,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,OAA+B;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACtF,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC5B,MAAM,UAAU,GAAG,mBAAQ,CAAC,YAAY,EAAE,CAAC;YAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACpI,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA+B;QAC/C,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,8BAA8B,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,OAA+B,EAAE,aAA4B,EAAE,OAAgB;QAC5F,mBAAmB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,GAAG,OAAO,IAAI,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG;YACtB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7H,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,OAA+B,EAAE,aAA4B;QAC7E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB;QACzD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC;IAED,8BAA8B;IACvB,UAAU,CAAC,OAA+B;QAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,IAAI;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,kBAAkB,CAAC,CAAC;QAC/D,IAAI,IAAI,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC;YAC3C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;CACF;AAlKD,kDAkKC","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 { createHash } from \"crypto\";\r\nimport * as fs from \"fs-extra\";\r\nimport { dirname, extname, join } from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { AccessToken, BeEvent, DbResult, OpenMode, Optional } from \"@itwin/core-bentley\";\r\nimport { IModelError, LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"../CloudSqlite\";\r\nimport { IModelHost, KnownLocations } from \"../IModelHost\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\nimport { SQLiteDb } from \"../SQLiteDb\";\r\nimport { SqliteStatement } from \"../SqliteStatement\";\r\nimport { Settings, SettingsPriority } from \"./Settings\";\r\nimport { SettingsSchemas } from \"./SettingsSchemas\";\r\n\r\n/* eslint-disable @typescript-eslint/naming-convention */\r\n// cspell:ignore rowid primarykey julianday\r\n\r\n/** The Settings used by Workspace api\r\n * @beta\r\n */\r\nexport const WorkspaceSetting = {\r\n Accounts: \"cloud/accounts\",\r\n Containers: \"cloud/containers\",\r\n Databases: \"workspace/databases\",\r\n};\r\n\r\n/** @beta */\r\nexport namespace WorkspaceContainer {\r\n /** The name of a WorkspaceContainer in a \"cloud/containers\" setting. */\r\n export type Name = string;\r\n\r\n /** The unique identifier of a WorkspaceContainer. This becomes the base name for the local directory holding the WorkspaceDbs from a WorkspaceContainer.\r\n * Usually supplied via the `containerId` member of a \"cloud/containers\" setting.\r\n * `WorkspaceContainer.Id`s may:\r\n * - only contain lower case letters, numbers or dashes\r\n * - not start or end with a dash\r\n * - not be shorter than 3 or longer than 63 characters\r\n */\r\n export type Id = string;\r\n\r\n /** A member named `containerName` that specifies by an entry in a \"cloud/containers\" setting */\r\n export interface Alias { containerName: string }\r\n\r\n /** Properties that specify a WorkspaceContainer. */\r\n export interface Props extends Optional<CloudSqlite.ContainerAccessProps, \"accessToken\"> {\r\n /** attempt to synchronize (i.e. call `checkForChanges`) this cloud container whenever it is connected to a cloud cache. Default=true */\r\n syncOnConnect?: boolean;\r\n }\r\n\r\n /** A function to supply an [AccessToken]($bentley) for a `WorkspaceContainer`.\r\n * @param props The properties of the WorkspaceContainer necessary to obtain the access token\r\n * @returns a Promise that resolves to the AccessToken for the container.\r\n */\r\n export type TokenFunc = (props: Props) => Promise<AccessToken>;\r\n}\r\n\r\n/** @beta */\r\nexport namespace WorkspaceDb {\r\n /** The name of a WorkspaceDb in a \"workspace/databases\" setting. */\r\n export type Name = string;\r\n\r\n /** The base name of a WorkspaceDb within a WorkspaceContainer (without any version identifier) */\r\n export type DbName = string;\r\n\r\n /** The name of a WorkspaceDb within a WorkspaceContainer, including the version identifier */\r\n export type DbFullName = string;\r\n\r\n /** The semver-format version identifier for a WorkspaceDb. */\r\n export type Version = string;\r\n\r\n /** The [semver range format](https://github.com/npm/node-semver) identifier for a range of acceptable versions. */\r\n export type VersionRange = string;\r\n\r\n /** Properties that specify how to load a WorkspaceDb within a [[WorkspaceContainer]]. */\r\n export interface Props extends CloudSqlite.DbNameProp {\r\n /** a semver version range specifier that determines the acceptable range of versions to load. If not present, use the newest version. */\r\n version?: VersionRange;\r\n /** if true, allow semver *prerelease* versions. By default only released version are allowed. */\r\n includePrerelease?: boolean;\r\n }\r\n\r\n /** Scope to increment for a version number.\r\n * @see semver.ReleaseType\r\n */\r\n export type VersionIncrement = \"major\" | \"minor\" | \"patch\";\r\n}\r\n\r\n/** Types used to identify Workspace resources\r\n * @beta\r\n */\r\nexport namespace WorkspaceResource {\r\n /**\r\n * The name for identifying WorkspaceResources in a [[WorkspaceDb]].\r\n * * `WorkspaceResource.Name`s may not:\r\n * - be blank or start or end with a space\r\n * - be longer than 1024 characters\r\n * @note a single WorkspaceDb may hold WorkspaceResources of type 'blob', 'string' and 'file', all with the same WorkspaceResource.Name.\r\n */\r\n export type Name = string;\r\n\r\n /** Properties that specify an individual WorkspaceResource within a [[WorkspaceDb]]. */\r\n export interface Props {\r\n /** the name of the resource within the WorkspaceDb */\r\n rscName: Name;\r\n }\r\n}\r\n\r\n/**\r\n * A WorkspaceDb holds workspace resources. `WorkspaceDb`s may just be local files, or they may be stored\r\n * in cloud WorkspaceContainers. Each `WorkspaceResource` in a WorkspaceDb is identified by a [[WorkspaceResource.Name]].\r\n * Resources of type `string` and `blob` may be loaded directly from the `WorkspaceDb`. Resources of type `file` are\r\n * copied from the WorkspaceDb into a temporary local file so they can be accessed by programs directly from disk.\r\n * @beta\r\n */\r\nexport interface WorkspaceDb {\r\n /** The WorkspaceContainer holding this WorkspaceDb. */\r\n readonly container: WorkspaceContainer;\r\n /** The base name of this WorkspaceDb, without version */\r\n readonly dbName: WorkspaceDb.DbName;\r\n /** event raised before this WorkspaceDb is closed. */\r\n readonly onClose: BeEvent<() => void>;\r\n /** 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 */\r\n readonly dbFileName: string;\r\n /** Get a string resource from this WorkspaceDb, if present. */\r\n getString(rscName: WorkspaceResource.Name): string | undefined;\r\n /** Get a blob resource from this WorkspaceDb, if present. */\r\n getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined;\r\n /** @internal */\r\n getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO;\r\n\r\n /**\r\n * Extract a local copy of a file resource from this WorkspaceDb, if present.\r\n * @param rscName The name of the file resource in the WorkspaceDb\r\n * @param targetFileName optional name for extracted file. Some applications require files in specific locations or filenames. If\r\n * you know the full path to use for the extracted file, you can supply it. Generally, it is best to *not* supply the filename and\r\n * keep the extracted files in the filesDir.\r\n * @returns the full path to a file on the local filesystem.\r\n * @note The file is copied from the file into the local filesystem so it may be accessed directly. This happens only\r\n * as necessary, if the local file doesn't exist, or if it is out-of-date because it was updated in the file.\r\n * For this reason, you should not save the local file name, and instead call this method every time you access it, so its\r\n * content is always holds the correct version.\r\n * @note The filename will be a hash value, not the resource name.\r\n * @note Workspace resource files are set readonly as they are copied from the file.\r\n * To edit them, you must first copy them to another location.\r\n */\r\n getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined;\r\n\r\n /**\r\n * Ensure that the contents of a `WorkspaceDb` are downloaded into the local cache so that it may be accessed offline.\r\n * Until the promise is resolved, the `WorkspaceDb` is not fully downloaded, but it *may* be safely accessed during the download.\r\n * To determine the progress of the download, use the `localBlocks` and `totalBlocks` values returned by `CloudContainer.queryDatabase`.\r\n * @returns a `CloudSqlite.CloudPrefetch` object that can be used to await and/or cancel the prefetch.\r\n * @throws if this WorkspaceDb is not from a `CloudContainer`.\r\n */\r\n prefetch(): CloudSqlite.CloudPrefetch;\r\n}\r\n\r\n/** The properties of the CloudCache used for Workspaces.\r\n * @beta\r\n */\r\nexport interface WorkspaceCloudCacheProps extends Optional<CloudSqlite.CacheProps, \"name\" | \"rootDir\"> {\r\n /** if true, empty the cache before using it. */\r\n clearContents?: boolean;\r\n}\r\n\r\n/**\r\n * Options for constructing a [[Workspace]].\r\n * @beta\r\n */\r\nexport interface WorkspaceOpts {\r\n /** The local directory for non-cloud-based WorkspaceDb files. The workspace api will look in this directory\r\n * for files named `${containerId}/${dbId}.itwin-workspace`.\r\n * @note if not supplied, defaults to `iTwin/Workspace` in the user-local folder.\r\n */\r\n containerDir?: LocalDirName;\r\n\r\n /** the local fileName(s) of one or more settings files to load after the Workspace is first created. */\r\n settingsFiles?: LocalFileName | [LocalFileName];\r\n\r\n /**\r\n * only for tests\r\n * @internal */\r\n testCloudCache?: CloudSqlite.CloudCache;\r\n}\r\n\r\n/**\r\n * Settings and resources that customize an application for the current session.\r\n * See [Workspaces]($docs/learning/backend/Workspace)\r\n * @beta\r\n */\r\nexport interface Workspace {\r\n /** The directory for local WorkspaceDb files with the name `${containerId}/${dbId}.itwin-workspace`. */\r\n readonly containerDir: LocalDirName;\r\n /** The [[Settings]] for this Workspace */\r\n readonly settings: Settings;\r\n\r\n /** Get The CloudCache for cloud-based WorkspaceContainers */\r\n getCloudCache(): CloudSqlite.CloudCache;\r\n\r\n /** search for a previously opened container.\r\n * @param containerId the id of the container\r\n * @returns the [[WorkspaceContainer]] for `containerId` if it was not previously opened with [[getContainer]]\r\n */\r\n findContainer(containerId: WorkspaceContainer.Id): WorkspaceContainer | undefined;\r\n\r\n /** get a [[WorkspaceContainer]] by [[WorkspaceContainer.Props]]\r\n * @param props the properties of the `WorkspaceContainer`. If `props.containerId` was already opened, its WorkspaceContainer is returned.\r\n * Otherwise it is created.\r\n * @param account If present, the properties for this container if it is to be opened from the cloud. If not present, the container is just a local directory.\r\n */\r\n getContainer(props: WorkspaceContainer.Props): WorkspaceContainer;\r\n\r\n /** get the properties for the supplied container name by searching for an entry with that name in a `cloud/containers` setting. */\r\n resolveContainer(containerName: WorkspaceContainer.Name): WorkspaceContainer.Props;\r\n\r\n /** get the properties for the supplied workspace database name by searching for an entry with that name in a `workspace/databases` setting. */\r\n resolveDatabase(databaseAlias: WorkspaceDb.Name): WorkspaceDb.Props & WorkspaceContainer.Alias;\r\n\r\n /**\r\n * Get an opened [[WorkspaceDb]]. If the WorkspaceDb is present but not open, it is opened first.\r\n * If `cloudProps` are supplied, a CloudContainer will be used to open the WorkspaceDb.\r\n */\r\n getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb;\r\n\r\n /** Get an opened [[WorkspaceDb]] from a WorkspaceDb alias.\r\n * @param dbAlias the database alias, resolved via [[resolveDatabase]].\r\n */\r\n getWorkspaceDb(dbAlias: WorkspaceDb.Name): Promise<WorkspaceDb>;\r\n\r\n /** Load a WorkspaceResource of type string, parse it, and add it to the current Settings for this Workspace.\r\n * @note settingsRsc must specify a resource holding a stringified JSON representation of a [[SettingDictionary]]\r\n */\r\n loadSettingsDictionary(settingRsc: WorkspaceResource.Name, db: WorkspaceDb, priority: SettingsPriority): void;\r\n\r\n /** Close this Workspace. All WorkspaceContainers are dropped. */\r\n close(): void;\r\n}\r\n\r\n/**\r\n * A WorkspaceContainer holds WorkspaceDbs.\r\n * Access rights are administered per WorkspaceContainer. That is, if a user has rights to access a WorkspaceContainer, that right\r\n * applies to all WorkspaceDbs in the WorkspaceContainer.\r\n * @beta\r\n */\r\nexport interface WorkspaceContainer {\r\n /** the local directory where this WorkspaceContainer will store temporary files extracted for file-resources. */\r\n readonly filesDir: LocalDirName;\r\n /** The unique identifier for a WorkspaceContainer a cloud storage account. */\r\n readonly id: WorkspaceContainer.Id;\r\n /** Workspace holding this WorkspaceContainer. */\r\n readonly workspace: Workspace;\r\n /** CloudContainer for this WorkspaceContainer (`undefined` if this is a local WorkspaceContainer.)\r\n * @internal\r\n */\r\n readonly cloudContainer?: CloudSqlite.CloudContainer;\r\n\r\n /** @internal */\r\n addWorkspaceDb(toAdd: ITwinWorkspaceDb): void;\r\n /** @internal */\r\n resolveDbFileName(props: WorkspaceDb.Props): string;\r\n\r\n /** find or open a WorkspaceDb from this WorkspaceContainer. */\r\n getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb;\r\n /** Close and remove a currently opened [[WorkspaceDb]] from this Workspace. */\r\n dropWorkspaceDb(container: WorkspaceDb): void;\r\n /** Close this WorkspaceContainer. All currently opened WorkspaceDbs are dropped. */\r\n close(): void;\r\n}\r\n\r\n/** @internal */\r\nexport class ITwinWorkspace implements Workspace {\r\n private _containers = new Map<WorkspaceContainer.Id, ITwinWorkspaceContainer>();\r\n public readonly containerDir: LocalDirName;\r\n public readonly settings: Settings;\r\n private _cloudCache?: CloudSqlite.CloudCache;\r\n public getCloudCache(): CloudSqlite.CloudCache {\r\n return this._cloudCache ??= CloudSqlite.CloudCaches.getCache({ cacheName: \"Workspace\", cacheSize: \"20G\" });\r\n }\r\n\r\n public constructor(settings: Settings, opts?: WorkspaceOpts) {\r\n this.settings = settings;\r\n this.containerDir = opts?.containerDir ?? join(IModelHost.cacheDir, \"Workspace\");\r\n this._cloudCache = opts?.testCloudCache;\r\n let settingsFiles = opts?.settingsFiles;\r\n if (settingsFiles) {\r\n if (typeof settingsFiles === \"string\")\r\n settingsFiles = [settingsFiles];\r\n settingsFiles.forEach((file) => settings.addFile(file, SettingsPriority.application));\r\n }\r\n }\r\n\r\n public addContainer(toAdd: ITwinWorkspaceContainer) {\r\n if (undefined !== this._containers.get(toAdd.id))\r\n throw new Error(\"container already exists in workspace\");\r\n this._containers.set(toAdd.id, toAdd);\r\n }\r\n\r\n public findContainer(containerId: WorkspaceContainer.Id) {\r\n return this._containers.get(containerId);\r\n }\r\n\r\n public getContainer(props: WorkspaceContainer.Props): WorkspaceContainer {\r\n return this.findContainer(props.containerId) ?? new ITwinWorkspaceContainer(this, props);\r\n }\r\n\r\n public getWorkspaceDbFromProps(dbProps: WorkspaceDb.Props, containerProps: WorkspaceContainer.Props): WorkspaceDb {\r\n return this.getContainer(containerProps).getWorkspaceDb(dbProps);\r\n }\r\n\r\n public async getWorkspaceDb(dbAlias: string) {\r\n const dbProps = this.resolveDatabase(dbAlias);\r\n const props = this.resolveContainer(dbProps.containerName);\r\n let container: WorkspaceContainer | undefined = this.findContainer(props.containerId);\r\n if (undefined === container) {\r\n props.accessToken = await CloudSqlite.requestToken(props);\r\n container = this.getContainer(props);\r\n }\r\n return container?.getWorkspaceDb(dbProps);\r\n }\r\n\r\n public loadSettingsDictionary(settingRsc: WorkspaceResource.Name, db: WorkspaceDb, priority: SettingsPriority) {\r\n const setting = db.getString(settingRsc);\r\n if (undefined === setting)\r\n throw new Error(`could not load setting resource ${settingRsc}`);\r\n\r\n this.settings.addJson(`${db.container.id}/${db.dbName}/${settingRsc}`, priority, setting);\r\n }\r\n\r\n public close() {\r\n this.settings.close();\r\n for (const [_id, container] of this._containers)\r\n container.close();\r\n this._containers.clear();\r\n }\r\n\r\n public resolveContainer(containerName: string): WorkspaceContainer.Props {\r\n const resolved = this.settings.resolveSetting<WorkspaceContainer.Props>(WorkspaceSetting.Containers, (val) => {\r\n if (Array.isArray(val)) {\r\n for (const entry of val) {\r\n if (typeof entry === \"object\" && entry.name === containerName)\r\n return SettingsSchemas.validateArrayObject(entry, WorkspaceSetting.Containers, containerName);\r\n }\r\n }\r\n return undefined; // keep going through all settings dictionaries\r\n });\r\n if (resolved === undefined)\r\n throw new Error(`no setting \"${WorkspaceSetting.Containers}\" entry for \"${containerName}\"`);\r\n\r\n return resolved;\r\n }\r\n\r\n public resolveDatabase(databaseName: string): WorkspaceDb.Props & WorkspaceContainer.Alias {\r\n const resolved = this.settings.resolveSetting<WorkspaceDb.Props & WorkspaceContainer.Alias>(WorkspaceSetting.Databases, (val) => {\r\n if (Array.isArray(val)) {\r\n for (const entry of val) {\r\n if (typeof entry === \"object\" && entry.name === databaseName)\r\n return SettingsSchemas.validateArrayObject(entry, WorkspaceSetting.Databases, databaseName);\r\n }\r\n }\r\n return undefined; // keep going through all settings dictionaries\r\n });\r\n\r\n if (resolved === undefined)\r\n throw new Error(`no setting \"${WorkspaceSetting.Databases}\" entry for \"${databaseName}\"`);\r\n\r\n return resolved;\r\n }\r\n}\r\n\r\n/** @internal */\r\nexport class ITwinWorkspaceContainer implements WorkspaceContainer {\r\n public readonly workspace: ITwinWorkspace;\r\n public readonly filesDir: LocalDirName;\r\n public readonly id: WorkspaceContainer.Id;\r\n\r\n public readonly cloudContainer?: CloudSqlite.CloudContainer | undefined;\r\n private _wsDbs = new Map<WorkspaceDb.DbName, ITwinWorkspaceDb>();\r\n public get dirName() { return join(this.workspace.containerDir, this.id); }\r\n\r\n public static noLeadingOrTrailingSpaces(name: string, msg: string) {\r\n if (name.trim() !== name)\r\n throw new Error(`${msg} [${name}] may not have leading or tailing spaces`);\r\n }\r\n\r\n /** rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata)\r\n * - may only contain lower case letters, numbers or dashes\r\n * - may not start or end with with a dash nor have more than one dash in a row\r\n * - may not be shorter than 3 or longer than 63 characters\r\n */\r\n private static validateContainerId(id: WorkspaceContainer.Id) {\r\n if (!/^(?=.{3,63}$)[a-z0-9]+(-[a-z0-9]+)*$/g.test(id))\r\n throw new Error(`invalid containerId: [${id}]`);\r\n }\r\n\r\n public static validateDbName(dbName: WorkspaceDb.DbName) {\r\n if (dbName === \"\" || dbName.length > 255 || /[#\\.<>:\"/\\\\\"`'|?*\\u0000-\\u001F]/g.test(dbName) || /^(con|prn|aux|nul|com\\d|lpt\\d)$/i.test(dbName))\r\n throw new Error(`invalid dbName: [${dbName}]`);\r\n this.noLeadingOrTrailingSpaces(dbName, \"dbName\");\r\n }\r\n\r\n public constructor(workspace: ITwinWorkspace, props: WorkspaceContainer.Props) {\r\n ITwinWorkspaceContainer.validateContainerId(props.containerId);\r\n this.workspace = workspace;\r\n this.id = props.containerId;\r\n\r\n if (props.baseUri !== \"\")\r\n this.cloudContainer = CloudSqlite.createCloudContainer({ accessToken: \"\", ...props });\r\n\r\n workspace.addContainer(this);\r\n this.filesDir = join(this.dirName, \"Files\");\r\n\r\n const cloudContainer = this.cloudContainer;\r\n if (undefined === cloudContainer)\r\n return;\r\n\r\n cloudContainer.connect(this.workspace.getCloudCache());\r\n if (false !== props.syncOnConnect) {\r\n try {\r\n cloudContainer.checkForChanges();\r\n } catch (e: unknown) {\r\n // must be offline\r\n }\r\n }\r\n }\r\n\r\n public static validateVersion(version?: WorkspaceDb.Version) {\r\n version = version ?? \"1.0.0\";\r\n if (version) {\r\n const opts = { loose: true, includePrerelease: true };\r\n // clean allows prerelease, so try it first. If that fails attempt to coerce it (coerce strips prerelease even if you say not to.)\r\n const semVersion = semver.clean(version, opts) ?? semver.coerce(version, opts)?.version;\r\n if (!semVersion)\r\n throw new Error(\"invalid version specification\");\r\n version = semVersion;\r\n }\r\n return version;\r\n }\r\n\r\n public static parseDbFileName(dbFileName: WorkspaceDb.DbFullName): { dbName: WorkspaceDb.DbName, version: WorkspaceDb.Version } {\r\n const parts = dbFileName.split(\":\");\r\n return { dbName: parts[0], version: parts[1] };\r\n }\r\n\r\n public static makeDbFileName(dbName: WorkspaceDb.DbName, version?: WorkspaceDb.Version): WorkspaceDb.DbName {\r\n return `${dbName}:${this.validateVersion(version)}`;\r\n }\r\n\r\n public static resolveCloudFileName(cloudContainer: CloudSqlite.CloudContainer, props: WorkspaceDb.Props): WorkspaceDb.DbFullName {\r\n const dbName = props.dbName;\r\n const dbs = cloudContainer.queryDatabases(`${dbName}*`); // get all databases that start with dbName\r\n\r\n const versions = [];\r\n for (const db of dbs) {\r\n const thisDb = ITwinWorkspaceContainer.parseDbFileName(db);\r\n if (thisDb.dbName === dbName && \"string\" === typeof thisDb.version && thisDb.version.length > 0)\r\n versions.push(thisDb.version);\r\n }\r\n\r\n if (versions.length === 0)\r\n versions[0] = \"1.0.0\";\r\n\r\n const range = props.version ?? \"*\";\r\n try {\r\n const version = semver.maxSatisfying(versions, range, { loose: true, includePrerelease: props.includePrerelease });\r\n if (version)\r\n return `${dbName}:${version}`;\r\n } catch (e: unknown) {\r\n }\r\n throw new Error(`No version of [${dbName}] available for \"${range}\"`);\r\n }\r\n\r\n /**\r\n * Create a copy of an existing [[WorkspaceDb]] in a cloud container with a new version number.\r\n * @param cloudContainer The attached cloud container holding the existing WorkspaceDb\r\n * @param fromProps Properties that describe the source WorkspaceDb for the new version\r\n * @param versionType The type of version increment to apply to the existing version.\r\n * @note This requires that the cloudContainer is attached and the write lock on the container be held. The copy should be modified with\r\n * new content before the write lock is released, and thereafter should never be modified again.\r\n */\r\n public static async makeNewVersion(cloudContainer: CloudSqlite.CloudContainer, fromProps: WorkspaceDb.Props, versionType: WorkspaceDb.VersionIncrement) {\r\n const oldName = this.resolveCloudFileName(cloudContainer, fromProps);\r\n const oldDb = this.parseDbFileName(oldName);\r\n const newVersion = semver.inc(oldDb.version, versionType);\r\n if (!newVersion)\r\n throw new Error(\"invalid version\");\r\n\r\n const newName = this.makeDbFileName(oldDb.dbName, newVersion);\r\n await cloudContainer.copyDatabase(oldName, newName);\r\n return { oldName, newName };\r\n }\r\n\r\n /**\r\n * Convert a WorkspaceDb.Props specification into a DbFileName. For cloud-based containers, this resolves to the dbName, incorporating the appropriate\r\n * version. For file-based containers, this returns a local filename of a WorkspaceDb file with the extension \".itwin-workspace\"\r\n */\r\n public resolveDbFileName(props: WorkspaceDb.Props): WorkspaceDb.DbFullName {\r\n const cloudContainer = this.cloudContainer;\r\n if (undefined === cloudContainer)\r\n return join(this.dirName, `${props.dbName}.${ITwinWorkspaceDb.fileExt}`); // local file, versions not allowed\r\n\r\n return ITwinWorkspaceContainer.resolveCloudFileName(cloudContainer, props);\r\n }\r\n\r\n public addWorkspaceDb(toAdd: ITwinWorkspaceDb) {\r\n if (undefined !== this._wsDbs.get(toAdd.dbName))\r\n throw new Error(`workspaceDb ${toAdd.dbName} already exists in workspace`);\r\n this._wsDbs.set(toAdd.dbName, toAdd);\r\n }\r\n\r\n public getWorkspaceDb(props: WorkspaceDb.Props): WorkspaceDb {\r\n const db = this._wsDbs.get(props.dbName) ?? new ITwinWorkspaceDb(props, this);\r\n if (!db.isOpen)\r\n db.open();\r\n return db;\r\n }\r\n\r\n public dropWorkspaceDb(toDrop: WorkspaceDb) {\r\n const name = toDrop.dbName;\r\n const wsDb = this._wsDbs.get(name);\r\n if (wsDb === toDrop) {\r\n this._wsDbs.delete(name);\r\n wsDb.close();\r\n }\r\n }\r\n\r\n public close() {\r\n for (const [_name, db] of this._wsDbs)\r\n db.close();\r\n this._wsDbs.clear();\r\n this.cloudContainer?.disconnect();\r\n }\r\n\r\n /** Delete all local files extracted by [[WorkspaceDb.getFile]] for this container. */\r\n public purgeContainerFiles() {\r\n IModelJsFs.purgeDirSync(this.filesDir);\r\n }\r\n}\r\n\r\n/**\r\n * Implementation of WorkspaceDb\r\n * @internal\r\n */\r\nexport class ITwinWorkspaceDb implements WorkspaceDb {\r\n /** file extension for local WorkspaceDbs */\r\n public static readonly fileExt = \"itwin-workspace\";\r\n /** the SQLiteDb for this WorkspaceDb*/\r\n public readonly sqliteDb = new SQLiteDb();\r\n /** the base WorkspaceDb name, without directory, extension, or version information. */\r\n public readonly dbName: WorkspaceDb.DbName;\r\n /** The WorkspaceContainer holding this WorkspaceDb */\r\n public readonly container: WorkspaceContainer;\r\n /** called before db is closed */\r\n public readonly onClose = new BeEvent<() => void>();\r\n /** either a local file name or the name of the file in a cloud container, including version identifier */\r\n public dbFileName: string;\r\n\r\n /** true if this WorkspaceDb is currently open */\r\n public get isOpen() { return this.sqliteDb.isOpen; }\r\n public queryFileResource(rscName: WorkspaceResource.Name) {\r\n const info = this.sqliteDb.nativeDb.queryEmbeddedFile(rscName);\r\n if (undefined === info)\r\n return undefined;\r\n\r\n // since resource names can contain illegal characters, path separators, etc., we make the local file name from its hash, in hex.\r\n let localFileName = join(this.container.filesDir, createHash(\"sha1\").update(this.dbFileName).update(rscName).digest(\"hex\"));\r\n if (info.fileExt !== \"\") // since some applications may expect to see the extension, append it here if it was supplied.\r\n localFileName = `${localFileName}.${info.fileExt}`;\r\n return { localFileName, info };\r\n }\r\n\r\n public constructor(props: WorkspaceDb.Props, container: WorkspaceContainer) {\r\n ITwinWorkspaceContainer.validateDbName(props.dbName);\r\n this.dbName = props.dbName;\r\n this.container = container;\r\n this.dbFileName = container.resolveDbFileName(props);\r\n container.addWorkspaceDb(this);\r\n }\r\n\r\n public open() {\r\n this.sqliteDb.openDb(this.dbFileName, OpenMode.Readonly, this.container.cloudContainer);\r\n }\r\n\r\n public close() {\r\n if (this.isOpen) {\r\n this.onClose.raiseEvent();\r\n this.sqliteDb.closeDb();\r\n this.container.dropWorkspaceDb(this);\r\n }\r\n }\r\n\r\n public getString(rscName: WorkspaceResource.Name): string | undefined {\r\n return this.sqliteDb.withSqliteStatement(\"SELECT value from strings WHERE id=?\", (stmt) => {\r\n stmt.bindString(1, rscName);\r\n return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueString(0) : undefined;\r\n });\r\n }\r\n\r\n /** Get a BlobIO reader for a blob WorkspaceResource.\r\n * @note when finished, caller *must* call `close` on the BlobIO.\r\n */\r\n public getBlobReader(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO {\r\n return this.sqliteDb.withSqliteStatement(\"SELECT rowid from blobs WHERE id=?\", (stmt) => {\r\n stmt.bindString(1, rscName);\r\n const blobReader = SQLiteDb.createBlobIO();\r\n blobReader.open(this.sqliteDb.nativeDb, { tableName: \"blobs\", columnName: \"value\", row: stmt.getValueInteger(0) });\r\n return blobReader;\r\n });\r\n }\r\n\r\n public getBlob(rscName: WorkspaceResource.Name): Uint8Array | undefined {\r\n return this.sqliteDb.withSqliteStatement(\"SELECT value from blobs WHERE id=?\", (stmt) => {\r\n stmt.bindString(1, rscName);\r\n return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getValueBlob(0) : undefined;\r\n });\r\n }\r\n\r\n public getFile(rscName: WorkspaceResource.Name, targetFileName?: LocalFileName): LocalFileName | undefined {\r\n const file = this.queryFileResource(rscName);\r\n if (!file)\r\n return undefined;\r\n\r\n const info = file.info;\r\n const localFileName = targetFileName ?? file.localFileName;\r\n\r\n // check whether the file is already up to date.\r\n const stat = fs.existsSync(localFileName) && fs.statSync(localFileName);\r\n if (stat && Math.round(stat.mtimeMs) === info.date && stat.size === info.size)\r\n return localFileName; // yes, we're done\r\n\r\n // extractEmbeddedFile fails if the file exists or if the directory does not exist\r\n if (stat)\r\n fs.removeSync(localFileName);\r\n else\r\n IModelJsFs.recursiveMkDirSync(dirname(localFileName));\r\n\r\n this.sqliteDb.nativeDb.extractEmbeddedFile({ name: rscName, localFileName });\r\n const date = new Date(info.date);\r\n fs.utimesSync(localFileName, date, date); // set the last-modified date of the file to match date in container\r\n fs.chmodSync(localFileName, \"0444\"); // set file readonly\r\n return localFileName;\r\n }\r\n\r\n public prefetch(opts?: CloudSqlite.PrefetchProps): CloudSqlite.CloudPrefetch {\r\n const cloudContainer = this.container.cloudContainer;\r\n if (cloudContainer === undefined)\r\n throw new Error(\"no cloud container to prefetch\");\r\n return CloudSqlite.startCloudPrefetch(cloudContainer, this.dbFileName, opts);\r\n }\r\n}\r\n\r\n/**\r\n * An editable [[WorkspaceDb]]. This is used by administrators for creating and modifying `WorkspaceDb`s.\r\n * For cloud-backed containers, the write token must be obtained before this class may be used. Only one user at at time\r\n * may be editing.\r\n * @internal\r\n */\r\nexport class EditableWorkspaceDb extends ITwinWorkspaceDb {\r\n private static validateResourceName(name: WorkspaceResource.Name) {\r\n ITwinWorkspaceContainer.noLeadingOrTrailingSpaces(name, \"resource name\");\r\n if (name.length > 1024)\r\n throw new Error(\"resource name too long\");\r\n }\r\n\r\n private validateResourceSize(val: Uint8Array | string) {\r\n const len = typeof val === \"string\" ? val.length : val.byteLength;\r\n if (len > (1024 * 1024 * 1024)) // one gigabyte\r\n throw new Error(\"value is too large\");\r\n }\r\n\r\n public override open() {\r\n this.sqliteDb.openDb(this.dbFileName, OpenMode.ReadWrite, this.container.cloudContainer);\r\n }\r\n\r\n private getFileModifiedTime(localFileName: LocalFileName): number {\r\n return Math.round(fs.statSync(localFileName).mtimeMs);\r\n }\r\n\r\n private performWriteSql(rscName: WorkspaceResource.Name, sql: string, bind?: (stmt: SqliteStatement) => void) {\r\n this.sqliteDb.withSqliteStatement(sql, (stmt) => {\r\n stmt.bindString(1, rscName);\r\n bind?.(stmt);\r\n const rc = stmt.step();\r\n if (DbResult.BE_SQLITE_DONE !== rc) {\r\n if (DbResult.BE_SQLITE_CONSTRAINT_PRIMARYKEY === rc)\r\n throw new IModelError(rc, `resource \"${rscName}\" already exists`);\r\n\r\n throw new IModelError(rc, `workspace [${sql}]`);\r\n }\r\n });\r\n this.sqliteDb.saveChanges();\r\n }\r\n\r\n public async createDb(version?: string) {\r\n if (!this.container.cloudContainer) {\r\n EditableWorkspaceDb.createEmpty(this.dbFileName);\r\n } else {\r\n // currently the only way to create a workspaceDb in a cloud container is to create a temporary workspaceDb and upload it.\r\n const tempDbFile = join(KnownLocations.tmpdir, `empty.${ITwinWorkspaceDb.fileExt}`);\r\n if (fs.existsSync(tempDbFile))\r\n IModelJsFs.removeSync(tempDbFile);\r\n EditableWorkspaceDb.createEmpty(tempDbFile);\r\n this.dbFileName = ITwinWorkspaceContainer.makeDbFileName(this.dbName, version);\r\n await CloudSqlite.uploadDb(this.container.cloudContainer, { localFileName: tempDbFile, dbName: this.dbFileName });\r\n IModelJsFs.removeSync(tempDbFile);\r\n }\r\n this.open();\r\n }\r\n\r\n /** Create a new, empty, EditableWorkspaceDb for importing Workspace resources. */\r\n public static createEmpty(fileName: LocalFileName) {\r\n const db = new SQLiteDb();\r\n IModelJsFs.recursiveMkDirSync(dirname(fileName));\r\n db.createDb(fileName);\r\n const timeStampCol = \"lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\";\r\n db.executeSQL(`CREATE TABLE strings(id TEXT PRIMARY KEY NOT NULL,value TEXT,${timeStampCol})`);\r\n db.executeSQL(`CREATE TABLE blobs(id TEXT PRIMARY KEY NOT NULL,value BLOB,${timeStampCol})`);\r\n const createTrigger = (tableName: string) => {\r\n db.executeSQL(`CREATE TRIGGER ${tableName}_timeStamp AFTER UPDATE ON ${tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${tableName} SET lastMod=julianday('now') WHERE id=new.id; END`);\r\n };\r\n createTrigger(\"strings\");\r\n createTrigger(\"blobs\");\r\n db.closeDb(true);\r\n }\r\n\r\n /** Add a new string resource to this WorkspaceDb.\r\n * @param rscName The name of the string resource.\r\n * @param val The string to save.\r\n */\r\n public addString(rscName: WorkspaceResource.Name, val: string): void {\r\n EditableWorkspaceDb.validateResourceName(rscName);\r\n this.validateResourceSize(val);\r\n this.performWriteSql(rscName, \"INSERT INTO strings(id,value) VALUES(?,?)\", (stmt) => stmt.bindString(2, val));\r\n }\r\n\r\n /** Update an existing string resource with a new value, or add it if it does not exist.\r\n * @param rscName The name of the string resource.\r\n * @param val The new value.\r\n */\r\n public updateString(rscName: WorkspaceResource.Name, val: string): void {\r\n this.validateResourceSize(val);\r\n this.performWriteSql(rscName, \"INSERT INTO strings(id,value) VALUES(?,?) ON CONFLICT(id) DO UPDATE SET value=excluded.value WHERE value!=excluded.value\", (stmt) => stmt.bindString(2, val));\r\n }\r\n\r\n /** Remove a string resource. */\r\n public removeString(rscName: WorkspaceResource.Name): void {\r\n this.performWriteSql(rscName, \"DELETE FROM strings WHERE id=?\");\r\n }\r\n\r\n /** Add a new blob resource to this WorkspaceDb.\r\n * @param rscName The name of the blob resource.\r\n * @param val The blob to save.\r\n */\r\n public addBlob(rscName: WorkspaceResource.Name, val: Uint8Array): void {\r\n EditableWorkspaceDb.validateResourceName(rscName);\r\n this.validateResourceSize(val);\r\n this.performWriteSql(rscName, \"INSERT INTO blobs(id,value) VALUES(?,?)\", (stmt) => stmt.bindBlob(2, val));\r\n }\r\n\r\n /** Update an existing blob resource with a new value, or add it if it does not exist.\r\n * @param rscName The name of the blob resource.\r\n * @param val The new value.\r\n */\r\n public updateBlob(rscName: WorkspaceResource.Name, val: Uint8Array): void {\r\n this.validateResourceSize(val);\r\n this.performWriteSql(rscName, \"INSERT INTO blobs(id,value) VALUES(?,?) ON CONFLICT(id) DO UPDATE SET value=excluded.value WHERE value!=excluded.value\", (stmt) => stmt.bindBlob(2, val));\r\n }\r\n\r\n /** Get a BlobIO writer for a previously-added blob WorkspaceResource.\r\n * @note after writing is complete, caller must call `close` on the BlobIO and must call `saveChanges` on the `db`.\r\n */\r\n public getBlobWriter(rscName: WorkspaceResource.Name): SQLiteDb.BlobIO {\r\n return this.sqliteDb.withSqliteStatement(\"SELECT rowid from blobs WHERE id=?\", (stmt) => {\r\n stmt.bindString(1, rscName);\r\n const blobWriter = SQLiteDb.createBlobIO();\r\n blobWriter.open(this.sqliteDb.nativeDb, { tableName: \"blobs\", columnName: \"value\", row: stmt.getValueInteger(0), writeable: true });\r\n return blobWriter;\r\n });\r\n }\r\n\r\n /** Remove a blob resource. */\r\n public removeBlob(rscName: WorkspaceResource.Name): void {\r\n this.performWriteSql(rscName, \"DELETE FROM blobs WHERE id=?\");\r\n }\r\n\r\n /** Copy the contents of an existing local file into this WorkspaceDb as a file resource.\r\n * @param rscName The name of the file resource.\r\n * @param localFileName The name of a local file to be read.\r\n * @param fileExt The extension (do not include the leading \".\") to be appended to the generated fileName\r\n * when this WorkspaceDb is extracted from the WorkspaceDb. By default the characters after the last \".\" in `localFileName`\r\n * are used. Pass this argument to override that.\r\n */\r\n public addFile(rscName: WorkspaceResource.Name, localFileName: LocalFileName, fileExt?: string): void {\r\n EditableWorkspaceDb.validateResourceName(rscName);\r\n fileExt = fileExt ?? extname(localFileName);\r\n if (fileExt?.[0] === \".\")\r\n fileExt = fileExt.slice(1);\r\n this.sqliteDb.nativeDb.embedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName), fileExt });\r\n }\r\n\r\n /** Replace an existing file resource with the contents of another local file.\r\n * @param rscName The name of the file resource.\r\n * @param localFileName The name of a local file to be read.\r\n * @throws if rscName does not exist\r\n */\r\n public updateFile(rscName: WorkspaceResource.Name, localFileName: LocalFileName): void {\r\n this.queryFileResource(rscName); // throws if not present\r\n this.sqliteDb.nativeDb.replaceEmbeddedFile({ name: rscName, localFileName, date: this.getFileModifiedTime(localFileName) });\r\n }\r\n\r\n /** Remove a file resource. */\r\n public removeFile(rscName: WorkspaceResource.Name): void {\r\n const file = this.queryFileResource(rscName);\r\n if (undefined === file)\r\n throw new Error(`file resource \"${rscName}\" does not exist`);\r\n if (file && fs.existsSync(file.localFileName))\r\n fs.unlinkSync(file.localFileName);\r\n this.sqliteDb.nativeDb.removeEmbeddedFile(rscName);\r\n }\r\n}\r\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itwin/core-backend",
3
- "version": "4.5.0-dev.8",
3
+ "version": "4.5.0-dev.9",
4
4
  "description": "iTwin.js backend components",
5
5
  "main": "lib/cjs/core-backend.js",
6
6
  "typings": "lib/cjs/core-backend",
@@ -25,9 +25,9 @@
25
25
  "url": "http://www.bentley.com"
26
26
  },
27
27
  "peerDependencies": {
28
- "@itwin/core-bentley": "^4.5.0-dev.8",
29
- "@itwin/core-common": "^4.5.0-dev.8",
30
- "@itwin/core-geometry": "^4.5.0-dev.8",
28
+ "@itwin/core-bentley": "^4.5.0-dev.9",
29
+ "@itwin/core-common": "^4.5.0-dev.9",
30
+ "@itwin/core-geometry": "^4.5.0-dev.9",
31
31
  "@opentelemetry/api": "^1.0.4"
32
32
  },
33
33
  "peerDependenciesMeta": {
@@ -69,16 +69,16 @@
69
69
  "ts-node": "^10.8.2",
70
70
  "typescript": "~5.0.2",
71
71
  "webpack": "^5.76.0",
72
- "@itwin/build-tools": "4.5.0-dev.8",
73
- "@itwin/core-bentley": "4.5.0-dev.8",
74
- "@itwin/core-common": "4.5.0-dev.8",
75
- "@itwin/core-geometry": "4.5.0-dev.8",
76
- "@itwin/core-webpack-tools": "4.5.0-dev.8",
77
- "@itwin/ecsql-common": "4.5.0-dev.8",
72
+ "@itwin/build-tools": "4.5.0-dev.9",
73
+ "@itwin/core-webpack-tools": "4.5.0-dev.9",
74
+ "@itwin/core-bentley": "4.5.0-dev.9",
75
+ "@itwin/core-common": "4.5.0-dev.9",
76
+ "@itwin/ecsql-common": "4.5.0-dev.9",
77
+ "@itwin/core-geometry": "4.5.0-dev.9",
78
78
  "internal-tools": "3.0.0-dev.69"
79
79
  },
80
80
  "dependencies": {
81
- "@bentley/imodeljs-native": "4.4.2",
81
+ "@bentley/imodeljs-native": "4.4.3",
82
82
  "@itwin/cloud-agnostic-core": "^2.1.0",
83
83
  "@itwin/object-storage-azure": "^2.2.2",
84
84
  "@itwin/object-storage-core": "^2.2.2",
@@ -91,7 +91,7 @@
91
91
  "semver": "^7.3.5",
92
92
  "touch": "^3.1.0",
93
93
  "ws": "^7.5.3",
94
- "@itwin/core-telemetry": "4.5.0-dev.8"
94
+ "@itwin/core-telemetry": "4.5.0-dev.9"
95
95
  },
96
96
  "nyc": {
97
97
  "extends": "./node_modules/@itwin/build-tools/.nycrc"