@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
package/lib/cjs/Entity.js CHANGED
@@ -1,135 +1,135 @@
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.Entity = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const core_common_1 = require("@itwin/core-common");
13
- const IModelDb_1 = require("./IModelDb");
14
- /** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].
15
- * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
16
- * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
17
- * @public
18
- */
19
- class Entity {
20
- /** @internal */
21
- constructor(props, iModel) {
22
- /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
23
- * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
24
- */
25
- this.isInstanceOfEntity = true;
26
- this.iModel = iModel;
27
- this.id = core_bentley_1.Id64.fromJSON(props.id);
28
- // copy all auto-handled properties from input to the object being constructed
29
- this.forEachProperty((propName, meta) => this[propName] = meta.createProperty(props[propName]), false);
30
- }
31
- get _ctor() { return this.constructor; }
32
- /** The name of the BIS class associated with this class.
33
- * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
34
- * Failure to do so will ordinarily result in an error when the class is registered, since there may only
35
- * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
36
- */
37
- static get className() { return "Entity"; }
38
- /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
39
- * This property makes such code slightly less tedious to read and write.
40
- * @internal
41
- */
42
- get asAny() { return this; }
43
- /** The name of the BIS Schema that defines this class */
44
- get schemaName() { return this._ctor.schema.schemaName; }
45
- /** The name of the BIS class associated with this class. */
46
- get className() { return this._ctor.className; }
47
- /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
48
- * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
49
- */
50
- toJSON() {
51
- const val = {};
52
- val.classFullName = this.classFullName;
53
- if (core_bentley_1.Id64.isValid(this.id))
54
- val.id = this.id;
55
- this.forEachProperty((propName) => val[propName] = this[propName], false);
56
- return val;
57
- }
58
- /** Call a function for each property of this Entity.
59
- * @param func The callback to be invoked on each property
60
- * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
61
- * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
62
- */
63
- forEachProperty(func, includeCustom = true) { IModelDb_1.IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }
64
- /** Get the full BIS class name of this Entity in the form "schema:class" */
65
- static get classFullName() { return `${this.schema.schemaName}:${this.className}`; }
66
- /** Get the full BIS class name of this Entity in the form "schema:class". */
67
- get classFullName() { return this._ctor.classFullName; }
68
- /** @internal */
69
- static get protectedOperations() { return []; }
70
- /** return whether this Entity class is a subclass of another Entity class
71
- * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
72
- * inheritance, you can use [ECClass.is]($ecschema-metadata)
73
- * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
74
- * typescript's restriction on the `this` type in static methods
75
- */
76
- static is(otherClass) { return (0, core_bentley_1.isSubclassOf)(this, otherClass); }
77
- /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
78
- * ClassRegistry overrides this when generating a class
79
- * @internal
80
- */
81
- static get isGeneratedClass() { return false; }
82
- // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds
83
- /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
84
- * This is important for cloning operations but can be useful in other situations as well.
85
- * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet
86
- * which does not iterate plain Id64s, see [EntityReferenceSet]($backend).
87
- * @see collectReferenceIds
88
- * @beta
89
- */
90
- getReferenceIds() {
91
- const referenceIds = new Set();
92
- this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation
93
- return referenceIds;
94
- }
95
- /** This is the intended and future behavior of [[getReferenceIds]].
96
- * In the next breaking change it will replace getReferenceIds, and is already used by the transformer
97
- * @internal
98
- */
99
- getReferenceConcreteIds() {
100
- const referenceIds = new core_common_1.EntityReferenceSet();
101
- this.collectReferenceConcreteIds(referenceIds);
102
- return referenceIds;
103
- }
104
- /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
105
- * A *reference* is any entity referenced by this entity's EC Data
106
- * This is important for cloning operations but can be useful in other situations as well.
107
- * @param _referenceIds The Id64Set to populate with reference Ids.
108
- * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,
109
- * which does not accept plain Id64s, see EntityReferenceSet.
110
- * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
111
- * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
112
- * @see getReferenceIds
113
- * @beta
114
- */
115
- collectReferenceIds(referenceIds) {
116
- const concreteEntityIds = this.getReferenceConcreteIds();
117
- for (const entity of concreteEntityIds) {
118
- // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention
119
- const EntityReferences = require("./EntityReferences").EntityReferences;
120
- // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else
121
- if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {
122
- referenceIds.add(EntityReferences.toId64(entity));
123
- }
124
- }
125
- }
126
- /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.
127
- * In the next breaking change it will replace getReferenceIds
128
- * @internal
129
- */
130
- collectReferenceConcreteIds(_referenceIds) {
131
- return; // no references by default
132
- }
133
- }
134
- exports.Entity = Entity;
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.Entity = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_common_1 = require("@itwin/core-common");
13
+ const IModelDb_1 = require("./IModelDb");
14
+ /** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].
15
+ * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
16
+ * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
17
+ * @public
18
+ */
19
+ class Entity {
20
+ /** @internal */
21
+ constructor(props, iModel) {
22
+ /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
23
+ * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
24
+ */
25
+ this.isInstanceOfEntity = true;
26
+ this.iModel = iModel;
27
+ this.id = core_bentley_1.Id64.fromJSON(props.id);
28
+ // copy all auto-handled properties from input to the object being constructed
29
+ this.forEachProperty((propName, meta) => this[propName] = meta.createProperty(props[propName]), false);
30
+ }
31
+ get _ctor() { return this.constructor; }
32
+ /** The name of the BIS class associated with this class.
33
+ * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
34
+ * Failure to do so will ordinarily result in an error when the class is registered, since there may only
35
+ * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
36
+ */
37
+ static get className() { return "Entity"; }
38
+ /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
39
+ * This property makes such code slightly less tedious to read and write.
40
+ * @internal
41
+ */
42
+ get asAny() { return this; }
43
+ /** The name of the BIS Schema that defines this class */
44
+ get schemaName() { return this._ctor.schema.schemaName; }
45
+ /** The name of the BIS class associated with this class. */
46
+ get className() { return this._ctor.className; }
47
+ /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
48
+ * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
49
+ */
50
+ toJSON() {
51
+ const val = {};
52
+ val.classFullName = this.classFullName;
53
+ if (core_bentley_1.Id64.isValid(this.id))
54
+ val.id = this.id;
55
+ this.forEachProperty((propName) => val[propName] = this[propName], false);
56
+ return val;
57
+ }
58
+ /** Call a function for each property of this Entity.
59
+ * @param func The callback to be invoked on each property
60
+ * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
61
+ * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
62
+ */
63
+ forEachProperty(func, includeCustom = true) { IModelDb_1.IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }
64
+ /** Get the full BIS class name of this Entity in the form "schema:class" */
65
+ static get classFullName() { return `${this.schema.schemaName}:${this.className}`; }
66
+ /** Get the full BIS class name of this Entity in the form "schema:class". */
67
+ get classFullName() { return this._ctor.classFullName; }
68
+ /** @internal */
69
+ static get protectedOperations() { return []; }
70
+ /** return whether this Entity class is a subclass of another Entity class
71
+ * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
72
+ * inheritance, you can use [ECClass.is]($ecschema-metadata)
73
+ * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
74
+ * typescript's restriction on the `this` type in static methods
75
+ */
76
+ static is(otherClass) { return (0, core_bentley_1.isSubclassOf)(this, otherClass); }
77
+ /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
78
+ * ClassRegistry overrides this when generating a class
79
+ * @internal
80
+ */
81
+ static get isGeneratedClass() { return false; }
82
+ // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds
83
+ /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
84
+ * This is important for cloning operations but can be useful in other situations as well.
85
+ * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet
86
+ * which does not iterate plain Id64s, see [EntityReferenceSet]($backend).
87
+ * @see collectReferenceIds
88
+ * @beta
89
+ */
90
+ getReferenceIds() {
91
+ const referenceIds = new Set();
92
+ this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation
93
+ return referenceIds;
94
+ }
95
+ /** This is the intended and future behavior of [[getReferenceIds]].
96
+ * In the next breaking change it will replace getReferenceIds, and is already used by the transformer
97
+ * @internal
98
+ */
99
+ getReferenceConcreteIds() {
100
+ const referenceIds = new core_common_1.EntityReferenceSet();
101
+ this.collectReferenceConcreteIds(referenceIds);
102
+ return referenceIds;
103
+ }
104
+ /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
105
+ * A *reference* is any entity referenced by this entity's EC Data
106
+ * This is important for cloning operations but can be useful in other situations as well.
107
+ * @param _referenceIds The Id64Set to populate with reference Ids.
108
+ * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,
109
+ * which does not accept plain Id64s, see EntityReferenceSet.
110
+ * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
111
+ * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
112
+ * @see getReferenceIds
113
+ * @beta
114
+ */
115
+ collectReferenceIds(referenceIds) {
116
+ const concreteEntityIds = this.getReferenceConcreteIds();
117
+ for (const entity of concreteEntityIds) {
118
+ // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention
119
+ const EntityReferences = require("./EntityReferences").EntityReferences;
120
+ // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else
121
+ if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {
122
+ referenceIds.add(EntityReferences.toId64(entity));
123
+ }
124
+ }
125
+ }
126
+ /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.
127
+ * In the next breaking change it will replace getReferenceIds
128
+ * @internal
129
+ */
130
+ collectReferenceConcreteIds(_referenceIds) {
131
+ return; // no references by default
132
+ }
133
+ }
134
+ exports.Entity = Entity;
135
135
  //# sourceMappingURL=Entity.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqE;AACrE,oDAAyG;AACzG,yCAAsC;AAGtC;;;;GAIG;AACH,MAAa,MAAM;IAmCjB,gBAAgB;IAChB,YAAY,KAAkB,EAAE,MAAgB;QAnChD;;WAEG;QACa,uBAAkB,GAAS,IAAI,CAAC;QAiC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,IAAsB,EAAE,EAAE,CAAE,IAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,cAAc,CAAE,KAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrJ,CAAC;IAjCD,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACH,IAAW,KAAK,KAAU,OAAO,IAAI,CAAC,CAAC,CAAC;IAExC,yDAAyD;IACzD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAgB/D;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAI,IAAY,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI,IAAI,mBAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAEvK,4EAA4E;IACrE,MAAM,KAAK,aAAa,KAAa,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAEvE,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB,IAAa,OAAO,IAAA,2BAAY,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/F;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD,uHAAuH;IACvH;;;;;;OAMG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,8CAA8C;QACtF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,uBAAuB;QAC5B,MAAM,YAAY,GAAG,IAAI,gCAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACO,mBAAmB,CAAC,YAA6B;QACzD,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACzD,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE;YACtC,oGAAoG;YACpG,MAAM,gBAAgB,GAAI,OAAO,CAAC,oBAAoB,CAAyC,CAAC,gBAAgB,CAAC;YACjH,8HAA8H;YAC9H,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC1E,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;aACnD;SACF;IACH,CAAC;IAED;;;OAGG;IACO,2BAA2B,CAAC,aAAiC;QACrE,OAAO,CAAC,2BAA2B;IACrC,CAAC;CACF;AA3ID,wBA2IC","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 Schema\r\n */\r\n\r\nimport { Id64, Id64String, isSubclassOf } from \"@itwin/core-bentley\";\r\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].\r\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\r\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\r\n * @public\r\n */\r\nexport class Entity {\r\n /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\r\n * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\r\n */\r\n public readonly isInstanceOfEntity: true = true;\r\n /** The Schema that defines this class. */\r\n public static schema: typeof Schema;\r\n\r\n private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\r\n\r\n /** The name of the BIS class associated with this class.\r\n * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\r\n * Failure to do so will ordinarily result in an error when the class is registered, since there may only\r\n * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\r\n */\r\n public static get className(): string { return \"Entity\"; }\r\n\r\n /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\r\n * This property makes such code slightly less tedious to read and write.\r\n * @internal\r\n */\r\n public get asAny(): any { return this; }\r\n\r\n /** The name of the BIS Schema that defines this class */\r\n public get schemaName(): string { return this._ctor.schema.schemaName; }\r\n\r\n /** The name of the BIS class associated with this class. */\r\n public get className(): string { return this._ctor.className; }\r\n\r\n /** The [[IModelDb]] that contains this Entity */\r\n public iModel: IModelDb;\r\n\r\n /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\r\n public id: Id64String;\r\n\r\n /** @internal */\r\n constructor(props: EntityProps, iModel: IModelDb) {\r\n this.iModel = iModel;\r\n this.id = Id64.fromJSON(props.id);\r\n // copy all auto-handled properties from input to the object being constructed\r\n this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\r\n }\r\n\r\n /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\r\n * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\r\n */\r\n public toJSON(): EntityProps {\r\n const val: any = {};\r\n val.classFullName = this.classFullName;\r\n if (Id64.isValid(this.id))\r\n val.id = this.id;\r\n this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\r\n return val;\r\n }\r\n\r\n /** Call a function for each property of this Entity.\r\n * @param func The callback to be invoked on each property\r\n * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\r\n * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\r\n */\r\n public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) { IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }\r\n\r\n /** Get the full BIS class name of this Entity in the form \"schema:class\" */\r\n public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\r\n\r\n /** Get the full BIS class name of this Entity in the form \"schema:class\". */\r\n public get classFullName(): string { return this._ctor.classFullName; }\r\n\r\n /** @internal */\r\n public static get protectedOperations(): string[] { return []; }\r\n\r\n /** return whether this Entity class is a subclass of another Entity class\r\n * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\r\n * inheritance, you can use [ECClass.is]($ecschema-metadata)\r\n * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\r\n * typescript's restriction on the `this` type in static methods\r\n */\r\n public static is(otherClass: typeof Entity): boolean { return isSubclassOf(this, otherClass); }\r\n\r\n /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\r\n * ClassRegistry overrides this when generating a class\r\n * @internal\r\n */\r\n public static get isGeneratedClass() { return false; }\r\n\r\n // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds\r\n /** Get the Ids of this element's *references*. A *reference* is an element that this element references.\r\n * This is important for cloning operations but can be useful in other situations as well.\r\n * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet\r\n * which does not iterate plain Id64s, see [EntityReferenceSet]($backend).\r\n * @see collectReferenceIds\r\n * @beta\r\n */\r\n public getReferenceIds(): Set<Id64String> {\r\n const referenceIds = new Set<Id64String>();\r\n this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation\r\n return referenceIds;\r\n }\r\n\r\n /** This is the intended and future behavior of [[getReferenceIds]].\r\n * In the next breaking change it will replace getReferenceIds, and is already used by the transformer\r\n * @internal\r\n */\r\n public getReferenceConcreteIds(): EntityReferenceSet {\r\n const referenceIds = new EntityReferenceSet();\r\n this.collectReferenceConcreteIds(referenceIds);\r\n return referenceIds;\r\n }\r\n\r\n /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\r\n * A *reference* is any entity referenced by this entity's EC Data\r\n * This is important for cloning operations but can be useful in other situations as well.\r\n * @param _referenceIds The Id64Set to populate with reference Ids.\r\n * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,\r\n * which does not accept plain Id64s, see EntityReferenceSet.\r\n * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).\r\n * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\r\n * @see getReferenceIds\r\n * @beta\r\n */\r\n protected collectReferenceIds(referenceIds: Set<Id64String>): void {\r\n const concreteEntityIds = this.getReferenceConcreteIds();\r\n for (const entity of concreteEntityIds) {\r\n // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention\r\n const EntityReferences = (require(\"./EntityReferences\") as typeof import(\"./EntityReferences\")).EntityReferences;\r\n // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else\r\n if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {\r\n referenceIds.add(EntityReferences.toId64(entity));\r\n }\r\n }\r\n }\r\n\r\n /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.\r\n * In the next breaking change it will replace getReferenceIds\r\n * @internal\r\n */\r\n protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void {\r\n return; // no references by default\r\n }\r\n}\r\n\r\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\r\n * @public\r\n */\r\nexport type EntityClassType<T> = Function & { prototype: T };\r\n"]}
1
+ {"version":3,"file":"Entity.js","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqE;AACrE,oDAAyG;AACzG,yCAAsC;AAGtC;;;;GAIG;AACH,MAAa,MAAM;IAmCjB,gBAAgB;IAChB,YAAY,KAAkB,EAAE,MAAgB;QAnChD;;WAEG;QACa,uBAAkB,GAAS,IAAI,CAAC;QAiC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClC,8EAA8E;QAC9E,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,IAAsB,EAAE,EAAE,CAAE,IAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,cAAc,CAAE,KAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrJ,CAAC;IAjCD,IAAY,KAAK,KAAoB,OAAO,IAAI,CAAC,WAA4B,CAAC,CAAC,CAAC;IAEhF;;;;OAIG;IACI,MAAM,KAAK,SAAS,KAAa,OAAO,QAAQ,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACH,IAAW,KAAK,KAAU,OAAO,IAAI,CAAC,CAAC,CAAC;IAExC,yDAAyD;IACzD,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAgB/D;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACvC,IAAI,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QACnB,IAAI,CAAC,eAAe,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAI,IAAY,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,IAAsB,EAAE,gBAAyB,IAAI,IAAI,mBAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAEvK,4EAA4E;IACrE,MAAM,KAAK,aAAa,KAAa,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAEvE,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAe,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhE;;;;;OAKG;IACI,MAAM,CAAC,EAAE,CAAC,UAAyB,IAAa,OAAO,IAAA,2BAAY,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAE/F;;;OAGG;IACI,MAAM,KAAK,gBAAgB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtD,uHAAuH;IACvH;;;;;;OAMG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,8CAA8C;QACtF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,uBAAuB;QAC5B,MAAM,YAAY,GAAG,IAAI,gCAAkB,EAAE,CAAC;QAC9C,IAAI,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAC/C,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACO,mBAAmB,CAAC,YAA6B;QACzD,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACzD,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE;YACtC,oGAAoG;YACpG,MAAM,gBAAgB,GAAI,OAAO,CAAC,oBAAoB,CAAyC,CAAC,gBAAgB,CAAC;YACjH,8HAA8H;YAC9H,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC1E,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;aACnD;SACF;IACH,CAAC;IAED;;;OAGG;IACO,2BAA2B,CAAC,aAAiC;QACrE,OAAO,CAAC,2BAA2B;IACrC,CAAC;CACF;AA3ID,wBA2IC","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 Schema\n */\n\nimport { Id64, Id64String, isSubclassOf } from \"@itwin/core-bentley\";\nimport { EntityProps, EntityReferenceSet, PropertyCallback, PropertyMetaData } from \"@itwin/core-common\";\nimport { IModelDb } from \"./IModelDb\";\nimport { Schema } from \"./Schema\";\n\n/** Represents an entity in an [[IModelDb]] such as an [[Element]], [[Model]], or [[Relationship]].\n * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).\n * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].\n * @public\n */\nexport class Entity {\n /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types\n * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].\n */\n public readonly isInstanceOfEntity: true = true;\n /** The Schema that defines this class. */\n public static schema: typeof Schema;\n\n private get _ctor(): typeof Entity { return this.constructor as typeof Entity; }\n\n /** The name of the BIS class associated with this class.\n * @note Every subclass of Entity **MUST** override this method to identify its BIS class.\n * Failure to do so will ordinarily result in an error when the class is registered, since there may only\n * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)\n */\n public static get className(): string { return \"Entity\"; }\n\n /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.\n * This property makes such code slightly less tedious to read and write.\n * @internal\n */\n public get asAny(): any { return this; }\n\n /** The name of the BIS Schema that defines this class */\n public get schemaName(): string { return this._ctor.schema.schemaName; }\n\n /** The name of the BIS class associated with this class. */\n public get className(): string { return this._ctor.className; }\n\n /** The [[IModelDb]] that contains this Entity */\n public iModel: IModelDb;\n\n /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */\n public id: Id64String;\n\n /** @internal */\n constructor(props: EntityProps, iModel: IModelDb) {\n this.iModel = iModel;\n this.id = Id64.fromJSON(props.id);\n // copy all auto-handled properties from input to the object being constructed\n this.forEachProperty((propName: string, meta: PropertyMetaData) => (this as any)[propName] = meta.createProperty((props as any)[propName]), false);\n }\n\n /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -\n * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).\n */\n public toJSON(): EntityProps {\n const val: any = {};\n val.classFullName = this.classFullName;\n if (Id64.isValid(this.id))\n val.id = this.id;\n this.forEachProperty((propName: string) => val[propName] = (this as any)[propName], false);\n return val;\n }\n\n /** Call a function for each property of this Entity.\n * @param func The callback to be invoked on each property\n * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.\n * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.\n */\n public forEachProperty(func: PropertyCallback, includeCustom: boolean = true) { IModelDb.forEachMetaData(this.iModel, this.classFullName, true, func, includeCustom); }\n\n /** Get the full BIS class name of this Entity in the form \"schema:class\" */\n public static get classFullName(): string { return `${this.schema.schemaName}:${this.className}`; }\n\n /** Get the full BIS class name of this Entity in the form \"schema:class\". */\n public get classFullName(): string { return this._ctor.classFullName; }\n\n /** @internal */\n public static get protectedOperations(): string[] { return []; }\n\n /** return whether this Entity class is a subclass of another Entity class\n * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's\n * inheritance, you can use [ECClass.is]($ecschema-metadata)\n * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of\n * typescript's restriction on the `this` type in static methods\n */\n public static is(otherClass: typeof Entity): boolean { return isSubclassOf(this, otherClass); }\n\n /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation\n * ClassRegistry overrides this when generating a class\n * @internal\n */\n public static get isGeneratedClass() { return false; }\n\n // NOTE: will also consider using generated collectReferences everywhere and a separate collectJsonPropertyReferenceIds\n /** Get the Ids of this element's *references*. A *reference* is an element that this element references.\n * This is important for cloning operations but can be useful in other situations as well.\n * @note In the next breaking change, the behavior of this function will change to return a EntityReferenceSet\n * which does not iterate plain Id64s, see [EntityReferenceSet]($backend).\n * @see collectReferenceIds\n * @beta\n */\n public getReferenceIds(): Set<Id64String> {\n const referenceIds = new Set<Id64String>();\n this.collectReferenceIds(referenceIds); // eslint-disable-line deprecation/deprecation\n return referenceIds;\n }\n\n /** This is the intended and future behavior of [[getReferenceIds]].\n * In the next breaking change it will replace getReferenceIds, and is already used by the transformer\n * @internal\n */\n public getReferenceConcreteIds(): EntityReferenceSet {\n const referenceIds = new EntityReferenceSet();\n this.collectReferenceConcreteIds(referenceIds);\n return referenceIds;\n }\n\n /** Collect the Ids of this entity's *references* at this level of the class hierarchy.\n * A *reference* is any entity referenced by this entity's EC Data\n * This is important for cloning operations but can be useful in other situations as well.\n * @param _referenceIds The Id64Set to populate with reference Ids.\n * @note In the next breaking change, the behavior of this function will change to require a EntityReferenceSet argument,\n * which does not accept plain Id64s, see EntityReferenceSet.\n * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).\n * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.\n * @see getReferenceIds\n * @beta\n */\n protected collectReferenceIds(referenceIds: Set<Id64String>): void {\n const concreteEntityIds = this.getReferenceConcreteIds();\n for (const entity of concreteEntityIds) {\n // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/naming-convention\n const EntityReferences = (require(\"./EntityReferences\") as typeof import(\"./EntityReferences\")).EntityReferences;\n // the old [[collectReferenceIds]] only supported elements/models, and the id spaces can overlap so dont include anything else\n if (EntityReferences.isElement(entity) || EntityReferences.isModel(entity)) {\n referenceIds.add(EntityReferences.toId64(entity));\n }\n }\n }\n\n /** This is the intended and future behavior of [[getReferenceIds]], and is used in the transformer already.\n * In the next breaking change it will replace getReferenceIds\n * @internal\n */\n protected collectReferenceConcreteIds(_referenceIds: EntityReferenceSet): void {\n return; // no references by default\n }\n}\n\n/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.\n * @public\n */\nexport type EntityClassType<T> = Function & { prototype: T };\n"]}
@@ -1,50 +1,50 @@
1
- /** @packageDocumentation
2
- * @module Schema
3
- */
4
- import { ConcreteEntityTypes, ElementAspectProps, ElementProps, EntityReference, ModelProps } from "@itwin/core-common";
5
- import { Id64String } from "@itwin/core-bentley";
6
- import type { Entity } from "./Entity";
7
- import { Model } from "./Model";
8
- import { Element } from "./Element";
9
- import { ElementAspect } from "./ElementAspect";
10
- import { Relationship, RelationshipProps } from "./Relationship";
11
- /** Concrete classes that can be created, with the notable exception of CodeSpecs since it is does not derive from Entity
12
- * other entity classes. In the future if there is a need
13
- * to manage them this way, it can be added
14
- * @alpha
15
- */
16
- export declare type ConcreteEntity = Element | Model | ElementAspect | Relationship;
17
- /** Props for a [[ConcreteEntity]]
18
- * @alpha
19
- */
20
- export declare type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;
21
- /**
22
- * Utilities for the [EntityReference]($common) type which is a kind of strings
23
- * @alpha
24
- */
25
- export declare namespace EntityReferences {
26
- function isModel(id: EntityReference): boolean;
27
- function isElement(id: EntityReference): boolean;
28
- function isElementAspect(id: EntityReference): boolean;
29
- function isRelationship(id: EntityReference): boolean;
30
- function toId64(id: EntityReference): string;
31
- /** split a concrete entity id into its type and raw id */
32
- function split(id: EntityReference): [ConcreteEntityTypes, Id64String];
33
- /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
34
- * @internal
35
- */
36
- function isValid(id: EntityReference): boolean;
37
- /** create the invalid id for a concrete entity type
38
- * @internal
39
- */
40
- function makeInvalid(type: ConcreteEntityTypes): EntityReference;
41
- /** create an EntityReference given an entity */
42
- function from(entity: ConcreteEntity): EntityReference;
43
- /** create an EntityReference given an id and a JavaScript class */
44
- function fromClass(id: Id64String, entityClass: typeof Entity): EntityReference;
45
- /** Create an EntityReference quickly from an exact reference type and id */
46
- function fromEntityType(id: Id64String, type: ConcreteEntityTypes): EntityReference;
47
- /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */
48
- function typeFromClass(entityClass: typeof Entity): ConcreteEntityTypes;
49
- }
1
+ /** @packageDocumentation
2
+ * @module Schema
3
+ */
4
+ import { ConcreteEntityTypes, ElementAspectProps, ElementProps, EntityReference, ModelProps } from "@itwin/core-common";
5
+ import { Id64String } from "@itwin/core-bentley";
6
+ import type { Entity } from "./Entity";
7
+ import { Model } from "./Model";
8
+ import { Element } from "./Element";
9
+ import { ElementAspect } from "./ElementAspect";
10
+ import { Relationship, RelationshipProps } from "./Relationship";
11
+ /** Concrete classes that can be created, with the notable exception of CodeSpecs since it is does not derive from Entity
12
+ * other entity classes. In the future if there is a need
13
+ * to manage them this way, it can be added
14
+ * @alpha
15
+ */
16
+ export declare type ConcreteEntity = Element | Model | ElementAspect | Relationship;
17
+ /** Props for a [[ConcreteEntity]]
18
+ * @alpha
19
+ */
20
+ export declare type ConcreteEntityProps = ElementProps | ModelProps | ElementAspectProps | RelationshipProps;
21
+ /**
22
+ * Utilities for the [EntityReference]($common) type which is a kind of strings
23
+ * @alpha
24
+ */
25
+ export declare namespace EntityReferences {
26
+ function isModel(id: EntityReference): boolean;
27
+ function isElement(id: EntityReference): boolean;
28
+ function isElementAspect(id: EntityReference): boolean;
29
+ function isRelationship(id: EntityReference): boolean;
30
+ function toId64(id: EntityReference): string;
31
+ /** split a concrete entity id into its type and raw id */
32
+ function split(id: EntityReference): [ConcreteEntityTypes, Id64String];
33
+ /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
34
+ * @internal
35
+ */
36
+ function isValid(id: EntityReference): boolean;
37
+ /** create the invalid id for a concrete entity type
38
+ * @internal
39
+ */
40
+ function makeInvalid(type: ConcreteEntityTypes): EntityReference;
41
+ /** create an EntityReference given an entity */
42
+ function from(entity: ConcreteEntity): EntityReference;
43
+ /** create an EntityReference given an id and a JavaScript class */
44
+ function fromClass(id: Id64String, entityClass: typeof Entity): EntityReference;
45
+ /** Create an EntityReference quickly from an exact reference type and id */
46
+ function fromEntityType(id: Id64String, type: ConcreteEntityTypes): EntityReference;
47
+ /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */
48
+ function typeFromClass(entityClass: typeof Entity): ConcreteEntityTypes;
49
+ }
50
50
  //# sourceMappingURL=EntityReferences.d.ts.map
@@ -1,96 +1,96 @@
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.EntityReferences = void 0;
11
- const core_common_1 = require("@itwin/core-common");
12
- const core_bentley_1 = require("@itwin/core-bentley");
13
- const Model_1 = require("./Model");
14
- const Element_1 = require("./Element");
15
- const ElementAspect_1 = require("./ElementAspect");
16
- const Relationship_1 = require("./Relationship");
17
- const assert = require("assert");
18
- /**
19
- * Utilities for the [EntityReference]($common) type which is a kind of strings
20
- * @alpha
21
- */
22
- var EntityReferences;
23
- (function (EntityReferences) {
24
- function isModel(id) {
25
- return id[0] === core_common_1.ConcreteEntityTypes.Model;
26
- }
27
- EntityReferences.isModel = isModel;
28
- function isElement(id) {
29
- return id[0] === core_common_1.ConcreteEntityTypes.Element;
30
- }
31
- EntityReferences.isElement = isElement;
32
- function isElementAspect(id) {
33
- return id[0] === core_common_1.ConcreteEntityTypes.ElementAspect;
34
- }
35
- EntityReferences.isElementAspect = isElementAspect;
36
- function isRelationship(id) {
37
- return id[0] === core_common_1.ConcreteEntityTypes.Relationship;
38
- }
39
- EntityReferences.isRelationship = isRelationship;
40
- function toId64(id) {
41
- return id.slice(1);
42
- }
43
- EntityReferences.toId64 = toId64;
44
- /** split a concrete entity id into its type and raw id */
45
- function split(id) {
46
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
47
- return [id[0], id.slice(1)];
48
- }
49
- EntityReferences.split = split;
50
- /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
51
- * @internal
52
- */
53
- function isValid(id) {
54
- return core_bentley_1.Id64.isValid(toId64(id));
55
- }
56
- EntityReferences.isValid = isValid;
57
- /** create the invalid id for a concrete entity type
58
- * @internal
59
- */
60
- function makeInvalid(type) {
61
- return `${type}${core_bentley_1.Id64.invalid}`;
62
- }
63
- EntityReferences.makeInvalid = makeInvalid;
64
- /** create an EntityReference given an entity */
65
- function from(entity) {
66
- const type = typeFromClass(entity.constructor);
67
- return `${type}${entity.id}`;
68
- }
69
- EntityReferences.from = from;
70
- /** create an EntityReference given an id and a JavaScript class */
71
- function fromClass(id, entityClass) {
72
- const type = typeFromClass(entityClass);
73
- return `${type}${id}`;
74
- }
75
- EntityReferences.fromClass = fromClass;
76
- /** Create an EntityReference quickly from an exact reference type and id */
77
- function fromEntityType(id, type) {
78
- return `${type}${id}`;
79
- }
80
- EntityReferences.fromEntityType = fromEntityType;
81
- /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */
82
- function typeFromClass(entityClass) {
83
- if (entityClass.is(Element_1.Element))
84
- return core_common_1.ConcreteEntityTypes.Element;
85
- else if (entityClass.is(ElementAspect_1.ElementAspect))
86
- return core_common_1.ConcreteEntityTypes.ElementAspect;
87
- else if (entityClass.is(Model_1.Model))
88
- return core_common_1.ConcreteEntityTypes.Model;
89
- else if (entityClass.is(Relationship_1.Relationship))
90
- return core_common_1.ConcreteEntityTypes.Relationship;
91
- else
92
- assert(false, "unknown or abstract entity type passed to EntityReferences.from");
93
- }
94
- EntityReferences.typeFromClass = typeFromClass;
95
- })(EntityReferences = exports.EntityReferences || (exports.EntityReferences = {}));
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.EntityReferences = void 0;
11
+ const core_common_1 = require("@itwin/core-common");
12
+ const core_bentley_1 = require("@itwin/core-bentley");
13
+ const Model_1 = require("./Model");
14
+ const Element_1 = require("./Element");
15
+ const ElementAspect_1 = require("./ElementAspect");
16
+ const Relationship_1 = require("./Relationship");
17
+ const assert = require("assert");
18
+ /**
19
+ * Utilities for the [EntityReference]($common) type which is a kind of strings
20
+ * @alpha
21
+ */
22
+ var EntityReferences;
23
+ (function (EntityReferences) {
24
+ function isModel(id) {
25
+ return id[0] === core_common_1.ConcreteEntityTypes.Model;
26
+ }
27
+ EntityReferences.isModel = isModel;
28
+ function isElement(id) {
29
+ return id[0] === core_common_1.ConcreteEntityTypes.Element;
30
+ }
31
+ EntityReferences.isElement = isElement;
32
+ function isElementAspect(id) {
33
+ return id[0] === core_common_1.ConcreteEntityTypes.ElementAspect;
34
+ }
35
+ EntityReferences.isElementAspect = isElementAspect;
36
+ function isRelationship(id) {
37
+ return id[0] === core_common_1.ConcreteEntityTypes.Relationship;
38
+ }
39
+ EntityReferences.isRelationship = isRelationship;
40
+ function toId64(id) {
41
+ return id.slice(1);
42
+ }
43
+ EntityReferences.toId64 = toId64;
44
+ /** split a concrete entity id into its type and raw id */
45
+ function split(id) {
46
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
47
+ return [id[0], id.slice(1)];
48
+ }
49
+ EntityReferences.split = split;
50
+ /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
51
+ * @internal
52
+ */
53
+ function isValid(id) {
54
+ return core_bentley_1.Id64.isValid(toId64(id));
55
+ }
56
+ EntityReferences.isValid = isValid;
57
+ /** create the invalid id for a concrete entity type
58
+ * @internal
59
+ */
60
+ function makeInvalid(type) {
61
+ return `${type}${core_bentley_1.Id64.invalid}`;
62
+ }
63
+ EntityReferences.makeInvalid = makeInvalid;
64
+ /** create an EntityReference given an entity */
65
+ function from(entity) {
66
+ const type = typeFromClass(entity.constructor);
67
+ return `${type}${entity.id}`;
68
+ }
69
+ EntityReferences.from = from;
70
+ /** create an EntityReference given an id and a JavaScript class */
71
+ function fromClass(id, entityClass) {
72
+ const type = typeFromClass(entityClass);
73
+ return `${type}${id}`;
74
+ }
75
+ EntityReferences.fromClass = fromClass;
76
+ /** Create an EntityReference quickly from an exact reference type and id */
77
+ function fromEntityType(id, type) {
78
+ return `${type}${id}`;
79
+ }
80
+ EntityReferences.fromEntityType = fromEntityType;
81
+ /** @internal the argument entityClass be concrete (i.e. not the Entity abstract base class) */
82
+ function typeFromClass(entityClass) {
83
+ if (entityClass.is(Element_1.Element))
84
+ return core_common_1.ConcreteEntityTypes.Element;
85
+ else if (entityClass.is(ElementAspect_1.ElementAspect))
86
+ return core_common_1.ConcreteEntityTypes.ElementAspect;
87
+ else if (entityClass.is(Model_1.Model))
88
+ return core_common_1.ConcreteEntityTypes.Model;
89
+ else if (entityClass.is(Relationship_1.Relationship))
90
+ return core_common_1.ConcreteEntityTypes.Relationship;
91
+ else
92
+ assert(false, "unknown or abstract entity type passed to EntityReferences.from");
93
+ }
94
+ EntityReferences.typeFromClass = typeFromClass;
95
+ })(EntityReferences = exports.EntityReferences || (exports.EntityReferences = {}));
96
96
  //# sourceMappingURL=EntityReferences.js.map