@itwin/core-backend 3.6.0-dev.8 → 3.6.0

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 (267) hide show
  1. package/CHANGELOG.md +45 -1
  2. package/LICENSE.md +1 -1
  3. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  4. package/lib/cjs/AliCloudStorageService.js +71 -71
  5. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  6. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  7. package/lib/cjs/BackendHubAccess.js +41 -41
  8. package/lib/cjs/BackendHubAccess.js.map +1 -1
  9. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  10. package/lib/cjs/BackendLoggerCategory.js +99 -99
  11. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  12. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  13. package/lib/cjs/BisCoreSchema.js +60 -60
  14. package/lib/cjs/BisCoreSchema.js.map +1 -1
  15. package/lib/cjs/BriefcaseManager.d.ts +170 -170
  16. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  17. package/lib/cjs/BriefcaseManager.js +414 -413
  18. package/lib/cjs/BriefcaseManager.js.map +1 -1
  19. package/lib/cjs/Category.d.ts +153 -153
  20. package/lib/cjs/Category.js +243 -243
  21. package/lib/cjs/Category.js.map +1 -1
  22. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  23. package/lib/cjs/ChangeSummaryManager.js +447 -447
  24. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  25. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  26. package/lib/cjs/ChangedElementsDb.js +165 -165
  27. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  28. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  29. package/lib/cjs/ChangedElementsManager.js +88 -88
  30. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  31. package/lib/cjs/CheckpointManager.d.ts +121 -120
  32. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  33. package/lib/cjs/CheckpointManager.js +349 -343
  34. package/lib/cjs/CheckpointManager.js.map +1 -1
  35. package/lib/cjs/ClassRegistry.d.ts +79 -79
  36. package/lib/cjs/ClassRegistry.d.ts.map +1 -1
  37. package/lib/cjs/ClassRegistry.js +250 -249
  38. package/lib/cjs/ClassRegistry.js.map +1 -1
  39. package/lib/cjs/CloudSqlite.d.ts +350 -350
  40. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  41. package/lib/cjs/CloudSqlite.js +153 -152
  42. package/lib/cjs/CloudSqlite.js.map +1 -1
  43. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  44. package/lib/cjs/CloudStorageBackend.js +173 -173
  45. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  46. package/lib/cjs/CodeService.d.ts +396 -396
  47. package/lib/cjs/CodeService.js +63 -63
  48. package/lib/cjs/CodeService.js.map +1 -1
  49. package/lib/cjs/CodeSpecs.d.ts +55 -50
  50. package/lib/cjs/CodeSpecs.d.ts.map +1 -1
  51. package/lib/cjs/CodeSpecs.js +124 -112
  52. package/lib/cjs/CodeSpecs.js.map +1 -1
  53. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  54. package/lib/cjs/ConcurrentQuery.js +36 -36
  55. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  56. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  57. package/lib/cjs/CustomViewState3dCreator.js +81 -81
  58. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  59. package/lib/cjs/DevTools.d.ts +71 -71
  60. package/lib/cjs/DevTools.js +154 -154
  61. package/lib/cjs/DevTools.js.map +1 -1
  62. package/lib/cjs/DisplayStyle.d.ts +106 -106
  63. package/lib/cjs/DisplayStyle.js +256 -256
  64. package/lib/cjs/DisplayStyle.js.map +1 -1
  65. package/lib/cjs/ECDb.d.ts +191 -191
  66. package/lib/cjs/ECDb.js +350 -350
  67. package/lib/cjs/ECDb.js.map +1 -1
  68. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  69. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  70. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  71. package/lib/cjs/ECSqlStatement.d.ts +473 -466
  72. package/lib/cjs/ECSqlStatement.d.ts.map +1 -1
  73. package/lib/cjs/ECSqlStatement.js +791 -791
  74. package/lib/cjs/ECSqlStatement.js.map +1 -1
  75. package/lib/cjs/Element.d.ts +1109 -1102
  76. package/lib/cjs/Element.d.ts.map +1 -1
  77. package/lib/cjs/Element.js +1427 -1416
  78. package/lib/cjs/Element.js.map +1 -1
  79. package/lib/cjs/ElementAspect.d.ts +179 -176
  80. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  81. package/lib/cjs/ElementAspect.js +211 -211
  82. package/lib/cjs/ElementAspect.js.map +1 -1
  83. package/lib/cjs/ElementGraphics.d.ts +9 -9
  84. package/lib/cjs/ElementGraphics.js +41 -41
  85. package/lib/cjs/ElementGraphics.js.map +1 -1
  86. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  87. package/lib/cjs/ElementTreeWalker.js +409 -409
  88. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  89. package/lib/cjs/Entity.d.ts +106 -106
  90. package/lib/cjs/Entity.js +134 -134
  91. package/lib/cjs/Entity.js.map +1 -1
  92. package/lib/cjs/EntityReferences.d.ts +49 -49
  93. package/lib/cjs/EntityReferences.js +95 -95
  94. package/lib/cjs/EntityReferences.js.map +1 -1
  95. package/lib/cjs/ExportGraphics.d.ts +317 -317
  96. package/lib/cjs/ExportGraphics.js +208 -208
  97. package/lib/cjs/ExportGraphics.js.map +1 -1
  98. package/lib/cjs/ExternalSource.d.ts +96 -96
  99. package/lib/cjs/ExternalSource.js +131 -131
  100. package/lib/cjs/ExternalSource.js.map +1 -1
  101. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  102. package/lib/cjs/GeoCoordConfig.js +85 -85
  103. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  104. package/lib/cjs/GeometrySummary.d.ts +4 -4
  105. package/lib/cjs/GeometrySummary.js +380 -380
  106. package/lib/cjs/GeometrySummary.js.map +1 -1
  107. package/lib/cjs/HubMock.d.ts +94 -94
  108. package/lib/cjs/HubMock.js +222 -222
  109. package/lib/cjs/HubMock.js.map +1 -1
  110. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  111. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  112. package/lib/cjs/IModelCloneContext.js +15 -15
  113. package/lib/cjs/IModelCloneContext.js.map +1 -1
  114. package/lib/cjs/IModelDb.d.ts +1210 -1183
  115. package/lib/cjs/IModelDb.d.ts.map +1 -1
  116. package/lib/cjs/IModelDb.js +2386 -2374
  117. package/lib/cjs/IModelDb.js.map +1 -1
  118. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  119. package/lib/cjs/IModelElementCloneContext.js +159 -159
  120. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  121. package/lib/cjs/IModelHost.d.ts +369 -370
  122. package/lib/cjs/IModelHost.d.ts.map +1 -1
  123. package/lib/cjs/IModelHost.js +496 -496
  124. package/lib/cjs/IModelHost.js.map +1 -1
  125. package/lib/cjs/IModelJsFs.d.ts +62 -62
  126. package/lib/cjs/IModelJsFs.js +140 -140
  127. package/lib/cjs/IModelJsFs.js.map +1 -1
  128. package/lib/cjs/IpcHost.d.ts +104 -104
  129. package/lib/cjs/IpcHost.js +278 -278
  130. package/lib/cjs/IpcHost.js.map +1 -1
  131. package/lib/cjs/LineStyle.d.ts +311 -311
  132. package/lib/cjs/LineStyle.js +295 -295
  133. package/lib/cjs/LineStyle.js.map +1 -1
  134. package/lib/cjs/LocalHub.d.ts +162 -162
  135. package/lib/cjs/LocalHub.d.ts.map +1 -1
  136. package/lib/cjs/LocalHub.js +585 -587
  137. package/lib/cjs/LocalHub.js.map +1 -1
  138. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  139. package/lib/cjs/LocalhostIpcHost.js +81 -81
  140. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  141. package/lib/cjs/Material.d.ts +131 -103
  142. package/lib/cjs/Material.d.ts.map +1 -1
  143. package/lib/cjs/Material.js +181 -147
  144. package/lib/cjs/Material.js.map +1 -1
  145. package/lib/cjs/Model.d.ts +392 -392
  146. package/lib/cjs/Model.js +485 -485
  147. package/lib/cjs/Model.js.map +1 -1
  148. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  149. package/lib/cjs/NativeAppStorage.js +202 -202
  150. package/lib/cjs/NativeAppStorage.js.map +1 -1
  151. package/lib/cjs/NativeHost.d.ts +52 -52
  152. package/lib/cjs/NativeHost.js +163 -163
  153. package/lib/cjs/NativeHost.js.map +1 -1
  154. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  155. package/lib/cjs/NavigationRelationship.js +225 -225
  156. package/lib/cjs/NavigationRelationship.js.map +1 -1
  157. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  158. package/lib/cjs/PromiseMemoizer.js +101 -101
  159. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  160. package/lib/cjs/PropertyStore.d.ts +132 -132
  161. package/lib/cjs/PropertyStore.js +11 -11
  162. package/lib/cjs/PropertyStore.js.map +1 -1
  163. package/lib/cjs/Relationship.d.ts +416 -416
  164. package/lib/cjs/Relationship.js +494 -494
  165. package/lib/cjs/Relationship.js.map +1 -1
  166. package/lib/cjs/RpcBackend.d.ts +5 -5
  167. package/lib/cjs/RpcBackend.d.ts.map +1 -1
  168. package/lib/cjs/RpcBackend.js +32 -31
  169. package/lib/cjs/RpcBackend.js.map +1 -1
  170. package/lib/cjs/SQLiteDb.d.ts +219 -219
  171. package/lib/cjs/SQLiteDb.js +214 -214
  172. package/lib/cjs/SQLiteDb.js.map +1 -1
  173. package/lib/cjs/Schema.d.ts +55 -55
  174. package/lib/cjs/Schema.js +83 -83
  175. package/lib/cjs/Schema.js.map +1 -1
  176. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  177. package/lib/cjs/ServerBasedLocks.js +168 -168
  178. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  179. package/lib/cjs/SqliteStatement.d.ts +360 -360
  180. package/lib/cjs/SqliteStatement.js +586 -586
  181. package/lib/cjs/SqliteStatement.js.map +1 -1
  182. package/lib/cjs/Texture.d.ts +58 -58
  183. package/lib/cjs/Texture.js +82 -82
  184. package/lib/cjs/Texture.js.map +1 -1
  185. package/lib/cjs/TileStorage.d.ts +18 -18
  186. package/lib/cjs/TileStorage.js +90 -90
  187. package/lib/cjs/TileStorage.js.map +1 -1
  188. package/lib/cjs/TxnManager.d.ts +202 -202
  189. package/lib/cjs/TxnManager.js +356 -356
  190. package/lib/cjs/TxnManager.js.map +1 -1
  191. package/lib/cjs/ViewDefinition.d.ts +439 -439
  192. package/lib/cjs/ViewDefinition.js +646 -646
  193. package/lib/cjs/ViewDefinition.js.map +1 -1
  194. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  195. package/lib/cjs/ViewStateHydrator.js +103 -103
  196. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  197. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  198. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  199. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  200. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  201. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  202. package/lib/cjs/core-backend.d.ts +184 -184
  203. package/lib/cjs/core-backend.js +204 -204
  204. package/lib/cjs/core-backend.js.map +1 -1
  205. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  206. package/lib/cjs/domains/FunctionalElements.js +145 -145
  207. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  208. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  209. package/lib/cjs/domains/FunctionalSchema.d.ts.map +1 -1
  210. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  211. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  212. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  213. package/lib/cjs/domains/GenericElements.js +263 -263
  214. package/lib/cjs/domains/GenericElements.js.map +1 -1
  215. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  216. package/lib/cjs/domains/GenericSchema.js +28 -28
  217. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  218. package/lib/cjs/rpc/multipart.d.ts +11 -11
  219. package/lib/cjs/rpc/multipart.d.ts.map +1 -1
  220. package/lib/cjs/rpc/multipart.js +71 -70
  221. package/lib/cjs/rpc/multipart.js.map +1 -1
  222. package/lib/cjs/rpc/tracing.d.ts +28 -28
  223. package/lib/cjs/rpc/tracing.d.ts.map +1 -1
  224. package/lib/cjs/rpc/tracing.js +74 -73
  225. package/lib/cjs/rpc/tracing.js.map +1 -1
  226. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  227. package/lib/cjs/rpc/web/logging.d.ts.map +1 -1
  228. package/lib/cjs/rpc/web/logging.js +43 -42
  229. package/lib/cjs/rpc/web/logging.js.map +1 -1
  230. package/lib/cjs/rpc/web/request.d.ts +6 -6
  231. package/lib/cjs/rpc/web/request.d.ts.map +1 -1
  232. package/lib/cjs/rpc/web/request.js +74 -73
  233. package/lib/cjs/rpc/web/request.js.map +1 -1
  234. package/lib/cjs/rpc/web/response.d.ts +6 -6
  235. package/lib/cjs/rpc/web/response.d.ts.map +1 -1
  236. package/lib/cjs/rpc/web/response.js +106 -105
  237. package/lib/cjs/rpc/web/response.js.map +1 -1
  238. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  239. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  240. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  241. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  242. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts.map +1 -1
  243. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +294 -291
  244. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  245. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  246. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  247. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +205 -202
  248. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  249. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  250. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  251. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  252. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  253. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  254. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  255. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  256. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  257. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  258. package/lib/cjs/workspace/Settings.d.ts +186 -186
  259. package/lib/cjs/workspace/Settings.js +155 -155
  260. package/lib/cjs/workspace/Settings.js.map +1 -1
  261. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  262. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  263. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  264. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  265. package/lib/cjs/workspace/Workspace.js +543 -543
  266. package/lib/cjs/workspace/Workspace.js.map +1 -1
  267. package/package.json +13 -13
@@ -1,250 +1,251 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Schema
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.MetaDataRegistry = exports.ClassRegistry = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const core_common_1 = require("@itwin/core-common");
13
- const Entity_1 = require("./Entity");
14
- const Schema_1 = require("./Schema");
15
- const EntityReferences_1 = require("./EntityReferences");
16
- const assert = require("assert");
17
- const isGeneratedClassTag = Symbol("isGeneratedClassTag");
18
- /** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
19
- * @public
20
- */
21
- class ClassRegistry {
22
- /** @internal */
23
- static isNotFoundError(err) { return (err instanceof core_common_1.IModelError) && (err.errorNumber === core_bentley_1.IModelStatus.NotFound); }
24
- /** @internal */
25
- static makeMetaDataNotFoundError(className) { return new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `metadata not found for ${className}`); }
26
- /** @internal */
27
- static register(entityClass, schema) {
28
- entityClass.schema = schema;
29
- const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();
30
- if (this._classMap.has(key)) {
31
- const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;
32
- core_bentley_1.Logger.logError("core-frontend.classRegistry", errMsg);
33
- throw new Error(errMsg);
34
- }
35
- this._classMap.set(key, entityClass);
36
- }
37
- /** Generate a proxy Schema for a domain that has not been registered. */
38
- static generateProxySchema(domain, iModel) {
39
- const hasBehavior = iModel.withPreparedSqliteStatement(`
40
- SELECT NULL FROM [ec_CustomAttribute] [c]
41
- JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]
42
- JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]
43
- JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]
44
- WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {
45
- stmt.bindString(1, domain);
46
- stmt.bindString(2, "BisCore.SchemaHasBehavior");
47
- return stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW;
48
- });
49
- const schemaClass = class extends Schema_1.Schema {
50
- static get schemaName() { return domain; }
51
- static get missingRequiredBehavior() { return hasBehavior; }
52
- };
53
- Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
54
- return schemaClass;
55
- }
56
- /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
57
- * Then, gets its metadata and returns that.
58
- * @param iModel - iModel containing the metadata for this type
59
- * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
60
- * @returns the qualified full name of an ECEntityClass
61
- * @internal public for testing only
62
- */
63
- static getRootEntity(iModel, ecTypeQualifier) {
64
- var _a;
65
- const [classSchema, className] = ecTypeQualifier.split(".");
66
- const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);
67
- if (schemaItemJson.error)
68
- throw new core_common_1.IModelError(schemaItemJson.error, `failed to get schema item '${ecTypeQualifier}'`);
69
- const schemaItem = JSON.parse(schemaItemJson.result);
70
- if (!("appliesTo" in schemaItem) && schemaItem.baseClass === undefined) {
71
- return ecTypeQualifier;
72
- }
73
- // typescript doesn't understand that the inverse of the above condition is
74
- // ("appliesTo" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)
75
- const parentItemQualifier = (_a = schemaItem.appliesTo) !== null && _a !== void 0 ? _a : schemaItem.baseClass;
76
- return this.getRootEntity(iModel, parentItemQualifier);
77
- }
78
- /** Generate a JavaScript class from Entity metadata.
79
- * @param entityMetaData The Entity metadata that defines the class
80
- */
81
- static generateClassForEntity(entityMetaData, iModel) {
82
- var _a, _b;
83
- const name = entityMetaData.ecclass.split(":");
84
- const domainName = name[0];
85
- const className = name[1];
86
- if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass
87
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `class ${name} has no superclass`);
88
- // make sure schema exists
89
- let schema = Schema_1.Schemas.getRegisteredSchema(domainName);
90
- if (undefined === schema)
91
- schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too
92
- const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());
93
- if (undefined === superclass)
94
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `cannot find superclass for class ${name}`);
95
- // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot
96
- // be used to tell if there are any generated classes in the hierarchy
97
- let generatedClassHasNonGeneratedNonCoreAncestor = false;
98
- let currentSuperclass = superclass;
99
- const MAX_ITERS = 1000;
100
- for (let i = 0; i < MAX_ITERS; ++i) {
101
- if (currentSuperclass.schema.schemaName === "BisCore")
102
- break;
103
- if (!currentSuperclass.isGeneratedClass) {
104
- generatedClassHasNonGeneratedNonCoreAncestor = true;
105
- break;
106
- }
107
- const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);
108
- if (superclassMetaData === undefined)
109
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);
110
- const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);
111
- if (maybeNextSuperclass === undefined)
112
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);
113
- currentSuperclass = maybeNextSuperclass;
114
- }
115
- const generatedClass = (_b = class extends superclass {
116
- static get className() { return className; }
117
- static get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }
118
- },
119
- _a = isGeneratedClassTag,
120
- _b[_a] = true,
121
- _b);
122
- // the above creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
123
- Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
124
- // a class only gets an automatic `collectReferenceConcreteIds` implementation if:
125
- // - it is not in the `BisCore` schema
126
- // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
127
- if (!generatedClassHasNonGeneratedNonCoreAncestor) {
128
- const navigationProps = Object.entries(entityMetaData.properties)
129
- .filter(([_name, prop]) => prop.isNavigation)
130
- // eslint-disable-next-line @typescript-eslint/no-shadow
131
- .map(([name, prop]) => {
132
- assert(prop.relationshipClass);
133
- const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(":"));
134
- assert(maybeMetaData.result !== undefined, "The nav props relationship metadata was not found");
135
- const relMetaData = JSON.parse(maybeMetaData.result);
136
- const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);
137
- // root class must be in BisCore so should be loaded since biscore classes will never get this
138
- // generated implementation
139
- const normalizeClassName = (clsName) => clsName.replace(".", ":");
140
- const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));
141
- assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);
142
- return { name, concreteEntityType: EntityReferences_1.EntityReferences.typeFromClass(rootClass) };
143
- });
144
- Object.defineProperty(generatedClass.prototype, "collectReferenceConcreteIds", {
145
- value(referenceIds) {
146
- // eslint-disable-next-line @typescript-eslint/dot-notation
147
- const superImpl = superclass.prototype["collectReferenceConcreteIds"];
148
- superImpl.call(this, referenceIds);
149
- for (const navProp of navigationProps) {
150
- const relatedElem = this[navProp.name]; // cast to any since subclass can have any extensions
151
- if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
152
- continue;
153
- const referenceId = EntityReferences_1.EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);
154
- referenceIds.add(referenceId);
155
- }
156
- },
157
- // defaults for methods on a prototype (required for sinon to stub out methods on tests)
158
- writable: true,
159
- configurable: true,
160
- });
161
- }
162
- // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations
163
- if (schema.missingRequiredBehavior) {
164
- const throwError = () => {
165
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);
166
- };
167
- superclass.protectedOperations.forEach((operation) => generatedClass[operation] = throwError);
168
- }
169
- this.register(generatedClass, schema); // register it before returning
170
- return generatedClass;
171
- }
172
- /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]
173
- * @param moduleObj The module to search for subclasses of Entity
174
- * @param schema The schema for all found classes
175
- */
176
- static registerModule(moduleObj, schema) {
177
- for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in
178
- const thisClass = moduleObj[thisMember];
179
- if (thisClass.prototype instanceof Entity_1.Entity)
180
- this.register(thisClass, schema);
181
- }
182
- }
183
- /**
184
- * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
185
- * class. This function also ensures that all of the base classes of the Entity exist and are registered.
186
- */
187
- static generateClass(classFullName, iModel) {
188
- const metadata = iModel.classMetaDataRegistry.find(classFullName);
189
- if (metadata === undefined || metadata.ecclass === undefined)
190
- throw this.makeMetaDataNotFoundError(classFullName);
191
- // Make sure we have all base classes registered.
192
- if (metadata.baseClasses && (0 !== metadata.baseClasses.length))
193
- this.getClass(metadata.baseClasses[0], iModel);
194
- // Now we can generate the class from the classDef.
195
- return this.generateClassForEntity(metadata, iModel);
196
- }
197
- /** Find a registered class by classFullName.
198
- * @param classFullName class to find
199
- * @param iModel The IModel that contains the class definitions
200
- * @returns The Entity class or undefined
201
- */
202
- static findRegisteredClass(classFullName) {
203
- return this._classMap.get(classFullName.toLowerCase());
204
- }
205
- /** Get the Entity class for the specified Entity className.
206
- * @param classFullName The full BIS class name of the Entity
207
- * @param iModel The IModel that contains the class definitions
208
- * @returns The Entity class
209
- */
210
- static getClass(classFullName, iModel) {
211
- const key = classFullName.toLowerCase();
212
- const ctor = this._classMap.get(key);
213
- return ctor ? ctor : this.generateClass(key, iModel);
214
- }
215
- /** Unregister a class, by name, if one is already registered.
216
- * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
217
- * @param classFullName Name of the class to unregister
218
- * @return true if the class was unregistered
219
- * @internal
220
- */
221
- static unregisterCLass(classFullName) { return this._classMap.delete(classFullName.toLowerCase()); }
222
- /** Unregister all classes from a schema.
223
- * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
224
- * @param schema Name of the schema to unregister
225
- * @internal
226
- */
227
- static unregisterClassesFrom(schema) {
228
- for (const entry of Array.from(this._classMap)) {
229
- if (entry[1].schema === schema)
230
- this.unregisterCLass(entry[0]);
231
- }
232
- }
233
- }
234
- exports.ClassRegistry = ClassRegistry;
235
- ClassRegistry._classMap = new Map();
236
- /**
237
- * A cache that records the mapping between class names and class metadata
238
- * @internal
239
- */
240
- class MetaDataRegistry {
241
- constructor() {
242
- this._registry = new Map();
243
- }
244
- /** Get the specified Entity metadata */
245
- find(classFullName) { return this._registry.get(classFullName.toLowerCase()); }
246
- /** Add metadata to the cache */
247
- add(classFullName, metaData) { this._registry.set(classFullName.toLowerCase(), metaData); }
248
- }
249
- exports.MetaDataRegistry = MetaDataRegistry;
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module Schema
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.MetaDataRegistry = exports.ClassRegistry = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_common_1 = require("@itwin/core-common");
13
+ const Entity_1 = require("./Entity");
14
+ const Schema_1 = require("./Schema");
15
+ const EntityReferences_1 = require("./EntityReferences");
16
+ const assert = require("assert");
17
+ const isGeneratedClassTag = Symbol("isGeneratedClassTag");
18
+ /** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
19
+ * @public
20
+ */
21
+ class ClassRegistry {
22
+ /** @internal */
23
+ static isNotFoundError(err) { return (err instanceof core_common_1.IModelError) && (err.errorNumber === core_bentley_1.IModelStatus.NotFound); }
24
+ /** @internal */
25
+ static makeMetaDataNotFoundError(className) { return new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `metadata not found for ${className}`); }
26
+ /** @internal */
27
+ static register(entityClass, schema) {
28
+ entityClass.schema = schema;
29
+ const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();
30
+ if (this._classMap.has(key)) {
31
+ const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;
32
+ core_bentley_1.Logger.logError("core-frontend.classRegistry", errMsg);
33
+ throw new Error(errMsg);
34
+ }
35
+ this._classMap.set(key, entityClass);
36
+ }
37
+ /** Generate a proxy Schema for a domain that has not been registered. */
38
+ static generateProxySchema(domain, iModel) {
39
+ const hasBehavior = iModel.withPreparedSqliteStatement(`
40
+ SELECT NULL FROM [ec_CustomAttribute] [c]
41
+ JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]
42
+ JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]
43
+ JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]
44
+ WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {
45
+ stmt.bindString(1, domain);
46
+ stmt.bindString(2, "BisCore.SchemaHasBehavior");
47
+ return stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW;
48
+ });
49
+ const schemaClass = class extends Schema_1.Schema {
50
+ static get schemaName() { return domain; }
51
+ static get missingRequiredBehavior() { return hasBehavior; }
52
+ };
53
+ Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
54
+ return schemaClass;
55
+ }
56
+ /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
57
+ * Then, gets its metadata and returns that.
58
+ * @param iModel - iModel containing the metadata for this type
59
+ * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
60
+ * @returns the qualified full name of an ECEntityClass
61
+ * @internal public for testing only
62
+ */
63
+ static getRootEntity(iModel, ecTypeQualifier) {
64
+ var _a;
65
+ const [classSchema, className] = ecTypeQualifier.split(".");
66
+ const schemaItemJson = iModel.nativeDb.getSchemaItem(classSchema, className);
67
+ if (schemaItemJson.error)
68
+ throw new core_common_1.IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);
69
+ assert(undefined !== schemaItemJson.result);
70
+ const schemaItem = JSON.parse(schemaItemJson.result);
71
+ if (!("appliesTo" in schemaItem) && schemaItem.baseClass === undefined) {
72
+ return ecTypeQualifier;
73
+ }
74
+ // typescript doesn't understand that the inverse of the above condition is
75
+ // ("appliesTo" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)
76
+ const parentItemQualifier = (_a = schemaItem.appliesTo) !== null && _a !== void 0 ? _a : schemaItem.baseClass;
77
+ return this.getRootEntity(iModel, parentItemQualifier);
78
+ }
79
+ /** Generate a JavaScript class from Entity metadata.
80
+ * @param entityMetaData The Entity metadata that defines the class
81
+ */
82
+ static generateClassForEntity(entityMetaData, iModel) {
83
+ var _a, _b;
84
+ const name = entityMetaData.ecclass.split(":");
85
+ const domainName = name[0];
86
+ const className = name[1];
87
+ if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass
88
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `class ${name} has no superclass`);
89
+ // make sure schema exists
90
+ let schema = Schema_1.Schemas.getRegisteredSchema(domainName);
91
+ if (undefined === schema)
92
+ schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too
93
+ const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());
94
+ if (undefined === superclass)
95
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `cannot find superclass for class ${name}`);
96
+ // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot
97
+ // be used to tell if there are any generated classes in the hierarchy
98
+ let generatedClassHasNonGeneratedNonCoreAncestor = false;
99
+ let currentSuperclass = superclass;
100
+ const MAX_ITERS = 1000;
101
+ for (let i = 0; i < MAX_ITERS; ++i) {
102
+ if (currentSuperclass.schema.schemaName === "BisCore")
103
+ break;
104
+ if (!currentSuperclass.isGeneratedClass) {
105
+ generatedClassHasNonGeneratedNonCoreAncestor = true;
106
+ break;
107
+ }
108
+ const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);
109
+ if (superclassMetaData === undefined)
110
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);
111
+ const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);
112
+ if (maybeNextSuperclass === undefined)
113
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);
114
+ currentSuperclass = maybeNextSuperclass;
115
+ }
116
+ const generatedClass = (_b = class extends superclass {
117
+ static get className() { return className; }
118
+ static get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }
119
+ },
120
+ _a = isGeneratedClassTag,
121
+ _b[_a] = true,
122
+ _b);
123
+ // the above creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
124
+ Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
125
+ // a class only gets an automatic `collectReferenceConcreteIds` implementation if:
126
+ // - it is not in the `BisCore` schema
127
+ // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
128
+ if (!generatedClassHasNonGeneratedNonCoreAncestor) {
129
+ const navigationProps = Object.entries(entityMetaData.properties)
130
+ .filter(([_name, prop]) => prop.isNavigation)
131
+ // eslint-disable-next-line @typescript-eslint/no-shadow
132
+ .map(([name, prop]) => {
133
+ assert(prop.relationshipClass);
134
+ const maybeMetaData = iModel.nativeDb.getSchemaItem(...prop.relationshipClass.split(":"));
135
+ assert(maybeMetaData.result !== undefined, "The nav props relationship metadata was not found");
136
+ const relMetaData = JSON.parse(maybeMetaData.result);
137
+ const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);
138
+ // root class must be in BisCore so should be loaded since biscore classes will never get this
139
+ // generated implementation
140
+ const normalizeClassName = (clsName) => clsName.replace(".", ":");
141
+ const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));
142
+ assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);
143
+ return { name, concreteEntityType: EntityReferences_1.EntityReferences.typeFromClass(rootClass) };
144
+ });
145
+ Object.defineProperty(generatedClass.prototype, "collectReferenceConcreteIds", {
146
+ value(referenceIds) {
147
+ // eslint-disable-next-line @typescript-eslint/dot-notation
148
+ const superImpl = superclass.prototype["collectReferenceConcreteIds"];
149
+ superImpl.call(this, referenceIds);
150
+ for (const navProp of navigationProps) {
151
+ const relatedElem = this[navProp.name]; // cast to any since subclass can have any extensions
152
+ if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
153
+ continue;
154
+ const referenceId = EntityReferences_1.EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);
155
+ referenceIds.add(referenceId);
156
+ }
157
+ },
158
+ // defaults for methods on a prototype (required for sinon to stub out methods on tests)
159
+ writable: true,
160
+ configurable: true,
161
+ });
162
+ }
163
+ // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations
164
+ if (schema.missingRequiredBehavior) {
165
+ const throwError = () => {
166
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);
167
+ };
168
+ superclass.protectedOperations.forEach((operation) => generatedClass[operation] = throwError);
169
+ }
170
+ this.register(generatedClass, schema); // register it before returning
171
+ return generatedClass;
172
+ }
173
+ /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]
174
+ * @param moduleObj The module to search for subclasses of Entity
175
+ * @param schema The schema for all found classes
176
+ */
177
+ static registerModule(moduleObj, schema) {
178
+ for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in
179
+ const thisClass = moduleObj[thisMember];
180
+ if (thisClass.prototype instanceof Entity_1.Entity)
181
+ this.register(thisClass, schema);
182
+ }
183
+ }
184
+ /**
185
+ * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
186
+ * class. This function also ensures that all of the base classes of the Entity exist and are registered.
187
+ */
188
+ static generateClass(classFullName, iModel) {
189
+ const metadata = iModel.classMetaDataRegistry.find(classFullName);
190
+ if (metadata === undefined || metadata.ecclass === undefined)
191
+ throw this.makeMetaDataNotFoundError(classFullName);
192
+ // Make sure we have all base classes registered.
193
+ if (metadata.baseClasses && (0 !== metadata.baseClasses.length))
194
+ this.getClass(metadata.baseClasses[0], iModel);
195
+ // Now we can generate the class from the classDef.
196
+ return this.generateClassForEntity(metadata, iModel);
197
+ }
198
+ /** Find a registered class by classFullName.
199
+ * @param classFullName class to find
200
+ * @param iModel The IModel that contains the class definitions
201
+ * @returns The Entity class or undefined
202
+ */
203
+ static findRegisteredClass(classFullName) {
204
+ return this._classMap.get(classFullName.toLowerCase());
205
+ }
206
+ /** Get the Entity class for the specified Entity className.
207
+ * @param classFullName The full BIS class name of the Entity
208
+ * @param iModel The IModel that contains the class definitions
209
+ * @returns The Entity class
210
+ */
211
+ static getClass(classFullName, iModel) {
212
+ const key = classFullName.toLowerCase();
213
+ const ctor = this._classMap.get(key);
214
+ return ctor ? ctor : this.generateClass(key, iModel);
215
+ }
216
+ /** Unregister a class, by name, if one is already registered.
217
+ * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
218
+ * @param classFullName Name of the class to unregister
219
+ * @return true if the class was unregistered
220
+ * @internal
221
+ */
222
+ static unregisterCLass(classFullName) { return this._classMap.delete(classFullName.toLowerCase()); }
223
+ /** Unregister all classes from a schema.
224
+ * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
225
+ * @param schema Name of the schema to unregister
226
+ * @internal
227
+ */
228
+ static unregisterClassesFrom(schema) {
229
+ for (const entry of Array.from(this._classMap)) {
230
+ if (entry[1].schema === schema)
231
+ this.unregisterCLass(entry[0]);
232
+ }
233
+ }
234
+ }
235
+ exports.ClassRegistry = ClassRegistry;
236
+ ClassRegistry._classMap = new Map();
237
+ /**
238
+ * A cache that records the mapping between class names and class metadata
239
+ * @internal
240
+ */
241
+ class MetaDataRegistry {
242
+ constructor() {
243
+ this._registry = new Map();
244
+ }
245
+ /** Get the specified Entity metadata */
246
+ find(classFullName) { return this._registry.get(classFullName.toLowerCase()); }
247
+ /** Add metadata to the cache */
248
+ add(classFullName, metaData) { this._registry.set(classFullName.toLowerCase(), metaData); }
249
+ }
250
+ exports.MetaDataRegistry = MetaDataRegistry;
250
251
  //# sourceMappingURL=ClassRegistry.js.map