@itwin/core-backend 3.4.0-dev.61 → 3.4.0-dev.63

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 (223) hide show
  1. package/CHANGELOG.md +23 -1
  2. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  3. package/lib/cjs/AliCloudStorageService.js +71 -71
  4. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  5. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  6. package/lib/cjs/BackendHubAccess.js +41 -41
  7. package/lib/cjs/BackendHubAccess.js.map +1 -1
  8. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  9. package/lib/cjs/BackendLoggerCategory.js +99 -99
  10. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  11. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  12. package/lib/cjs/BisCoreSchema.js +60 -60
  13. package/lib/cjs/BisCoreSchema.js.map +1 -1
  14. package/lib/cjs/BriefcaseManager.d.ts +165 -165
  15. package/lib/cjs/BriefcaseManager.js +405 -405
  16. package/lib/cjs/BriefcaseManager.js.map +1 -1
  17. package/lib/cjs/Category.d.ts +153 -153
  18. package/lib/cjs/Category.js +243 -243
  19. package/lib/cjs/Category.js.map +1 -1
  20. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  21. package/lib/cjs/ChangeSummaryManager.js +445 -445
  22. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  23. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  24. package/lib/cjs/ChangedElementsDb.js +165 -165
  25. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  26. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  27. package/lib/cjs/ChangedElementsManager.js +88 -88
  28. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  29. package/lib/cjs/CheckpointManager.d.ts +120 -120
  30. package/lib/cjs/CheckpointManager.js +343 -343
  31. package/lib/cjs/CheckpointManager.js.map +1 -1
  32. package/lib/cjs/ClassRegistry.d.ts +71 -71
  33. package/lib/cjs/ClassRegistry.js +215 -215
  34. package/lib/cjs/ClassRegistry.js.map +1 -1
  35. package/lib/cjs/CloudSqlite.d.ts +349 -349
  36. package/lib/cjs/CloudSqlite.js +151 -151
  37. package/lib/cjs/CloudSqlite.js.map +1 -1
  38. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  39. package/lib/cjs/CloudStorageBackend.js +173 -173
  40. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  41. package/lib/cjs/CodeService.d.ts +396 -396
  42. package/lib/cjs/CodeService.js +63 -63
  43. package/lib/cjs/CodeService.js.map +1 -1
  44. package/lib/cjs/CodeSpecs.d.ts +50 -50
  45. package/lib/cjs/CodeSpecs.js +112 -112
  46. package/lib/cjs/CodeSpecs.js.map +1 -1
  47. package/lib/cjs/ConcurrentQuery.d.ts +11 -11
  48. package/lib/cjs/ConcurrentQuery.js +30 -30
  49. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  50. package/lib/cjs/CustomViewState3dCreator.d.ts +32 -32
  51. package/lib/cjs/CustomViewState3dCreator.js +113 -113
  52. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  53. package/lib/cjs/DevTools.d.ts +71 -71
  54. package/lib/cjs/DevTools.js +154 -154
  55. package/lib/cjs/DevTools.js.map +1 -1
  56. package/lib/cjs/DisplayStyle.d.ts +106 -106
  57. package/lib/cjs/DisplayStyle.js +256 -256
  58. package/lib/cjs/DisplayStyle.js.map +1 -1
  59. package/lib/cjs/ECDb.d.ts +191 -191
  60. package/lib/cjs/ECDb.js +350 -350
  61. package/lib/cjs/ECDb.js.map +1 -1
  62. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  63. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  64. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  65. package/lib/cjs/ECSqlStatement.d.ts +466 -466
  66. package/lib/cjs/ECSqlStatement.js +791 -791
  67. package/lib/cjs/ECSqlStatement.js.map +1 -1
  68. package/lib/cjs/Element.d.ts +1109 -1109
  69. package/lib/cjs/Element.js +1420 -1420
  70. package/lib/cjs/Element.js.map +1 -1
  71. package/lib/cjs/ElementAspect.d.ts +156 -156
  72. package/lib/cjs/ElementAspect.js +178 -178
  73. package/lib/cjs/ElementAspect.js.map +1 -1
  74. package/lib/cjs/ElementGraphics.d.ts +9 -9
  75. package/lib/cjs/ElementGraphics.js +41 -41
  76. package/lib/cjs/ElementGraphics.js.map +1 -1
  77. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  78. package/lib/cjs/ElementTreeWalker.js +409 -409
  79. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  80. package/lib/cjs/Entity.d.ts +76 -76
  81. package/lib/cjs/Entity.js +82 -82
  82. package/lib/cjs/Entity.js.map +1 -1
  83. package/lib/cjs/ExportGraphics.d.ts +317 -317
  84. package/lib/cjs/ExportGraphics.js +208 -208
  85. package/lib/cjs/ExportGraphics.js.map +1 -1
  86. package/lib/cjs/ExternalSource.d.ts +94 -94
  87. package/lib/cjs/ExternalSource.js +125 -125
  88. package/lib/cjs/ExternalSource.js.map +1 -1
  89. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  90. package/lib/cjs/GeoCoordConfig.js +82 -82
  91. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  92. package/lib/cjs/GeometrySummary.d.ts +4 -4
  93. package/lib/cjs/GeometrySummary.js +380 -380
  94. package/lib/cjs/GeometrySummary.js.map +1 -1
  95. package/lib/cjs/HubMock.d.ts +93 -93
  96. package/lib/cjs/HubMock.js +190 -190
  97. package/lib/cjs/HubMock.js.map +1 -1
  98. package/lib/cjs/IModelCloneContext.d.ts +85 -85
  99. package/lib/cjs/IModelCloneContext.js +150 -150
  100. package/lib/cjs/IModelCloneContext.js.map +1 -1
  101. package/lib/cjs/IModelDb.d.ts +1164 -1164
  102. package/lib/cjs/IModelDb.js +2324 -2324
  103. package/lib/cjs/IModelDb.js.map +1 -1
  104. package/lib/cjs/IModelHost.d.ts +361 -361
  105. package/lib/cjs/IModelHost.js +489 -489
  106. package/lib/cjs/IModelHost.js.map +1 -1
  107. package/lib/cjs/IModelJsFs.d.ts +62 -62
  108. package/lib/cjs/IModelJsFs.js +140 -140
  109. package/lib/cjs/IModelJsFs.js.map +1 -1
  110. package/lib/cjs/IpcHost.d.ts +98 -98
  111. package/lib/cjs/IpcHost.js +234 -234
  112. package/lib/cjs/IpcHost.js.map +1 -1
  113. package/lib/cjs/LineStyle.d.ts +311 -311
  114. package/lib/cjs/LineStyle.js +295 -295
  115. package/lib/cjs/LineStyle.js.map +1 -1
  116. package/lib/cjs/LocalHub.d.ts +162 -162
  117. package/lib/cjs/LocalHub.js +587 -587
  118. package/lib/cjs/LocalHub.js.map +1 -1
  119. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  120. package/lib/cjs/LocalhostIpcHost.js +81 -81
  121. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  122. package/lib/cjs/Material.d.ts +103 -103
  123. package/lib/cjs/Material.js +147 -147
  124. package/lib/cjs/Material.js.map +1 -1
  125. package/lib/cjs/Model.d.ts +386 -386
  126. package/lib/cjs/Model.js +471 -471
  127. package/lib/cjs/Model.js.map +1 -1
  128. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  129. package/lib/cjs/NativeAppStorage.js +202 -202
  130. package/lib/cjs/NativeAppStorage.js.map +1 -1
  131. package/lib/cjs/NativeHost.d.ts +52 -52
  132. package/lib/cjs/NativeHost.js +168 -168
  133. package/lib/cjs/NativeHost.js.map +1 -1
  134. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  135. package/lib/cjs/NavigationRelationship.js +225 -225
  136. package/lib/cjs/NavigationRelationship.js.map +1 -1
  137. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  138. package/lib/cjs/PromiseMemoizer.js +101 -101
  139. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  140. package/lib/cjs/PropertyStore.d.ts +132 -132
  141. package/lib/cjs/PropertyStore.js +11 -11
  142. package/lib/cjs/PropertyStore.js.map +1 -1
  143. package/lib/cjs/Relationship.d.ts +400 -400
  144. package/lib/cjs/Relationship.js +465 -465
  145. package/lib/cjs/Relationship.js.map +1 -1
  146. package/lib/cjs/RpcBackend.d.ts +28 -28
  147. package/lib/cjs/RpcBackend.js +126 -126
  148. package/lib/cjs/RpcBackend.js.map +1 -1
  149. package/lib/cjs/SQLiteDb.d.ts +219 -219
  150. package/lib/cjs/SQLiteDb.js +214 -214
  151. package/lib/cjs/SQLiteDb.js.map +1 -1
  152. package/lib/cjs/Schema.d.ts +55 -55
  153. package/lib/cjs/Schema.js +83 -83
  154. package/lib/cjs/Schema.js.map +1 -1
  155. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  156. package/lib/cjs/ServerBasedLocks.js +168 -168
  157. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  158. package/lib/cjs/SqliteStatement.d.ts +283 -283
  159. package/lib/cjs/SqliteStatement.js +448 -448
  160. package/lib/cjs/SqliteStatement.js.map +1 -1
  161. package/lib/cjs/Texture.d.ts +58 -58
  162. package/lib/cjs/Texture.js +82 -82
  163. package/lib/cjs/Texture.js.map +1 -1
  164. package/lib/cjs/TileStorage.d.ts +18 -18
  165. package/lib/cjs/TileStorage.js +90 -90
  166. package/lib/cjs/TileStorage.js.map +1 -1
  167. package/lib/cjs/TxnManager.d.ts +202 -202
  168. package/lib/cjs/TxnManager.js +356 -356
  169. package/lib/cjs/TxnManager.js.map +1 -1
  170. package/lib/cjs/ViewDefinition.d.ts +435 -435
  171. package/lib/cjs/ViewDefinition.js +635 -635
  172. package/lib/cjs/ViewDefinition.js.map +1 -1
  173. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  174. package/lib/cjs/ViewStateHydrator.js +103 -103
  175. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  176. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  177. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  178. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  179. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  180. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  181. package/lib/cjs/core-backend.d.ts +182 -182
  182. package/lib/cjs/core-backend.js +202 -202
  183. package/lib/cjs/core-backend.js.map +1 -1
  184. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  185. package/lib/cjs/domains/FunctionalElements.js +145 -145
  186. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  187. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  188. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  189. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  190. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  191. package/lib/cjs/domains/GenericElements.js +263 -263
  192. package/lib/cjs/domains/GenericElements.js.map +1 -1
  193. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  194. package/lib/cjs/domains/GenericSchema.js +28 -28
  195. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  196. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  197. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  198. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  199. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +45 -45
  200. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +262 -262
  201. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  202. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  203. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +204 -204
  204. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  205. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  206. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  207. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  208. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  209. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  210. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  211. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  212. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  213. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  214. package/lib/cjs/workspace/Settings.d.ts +186 -186
  215. package/lib/cjs/workspace/Settings.js +155 -155
  216. package/lib/cjs/workspace/Settings.js.map +1 -1
  217. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  218. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  219. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  220. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  221. package/lib/cjs/workspace/Workspace.js +543 -543
  222. package/lib/cjs/workspace/Workspace.js.map +1 -1
  223. package/package.json +12 -12
@@ -1,357 +1,357 @@
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 iModels
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.TxnManager = exports.setMaxEntitiesPerEvent = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
13
- const IpcHost_1 = require("./IpcHost");
14
- /** Strictly for tests. @internal */
15
- function setMaxEntitiesPerEvent(max) {
16
- const prevMax = ChangedEntitiesProc.maxPerEvent;
17
- ChangedEntitiesProc.maxPerEvent = max;
18
- return prevMax;
19
- }
20
- exports.setMaxEntitiesPerEvent = setMaxEntitiesPerEvent;
21
- /** Maintains an ordered array of entity Ids and a parallel array containing the index of the corresponding entity's class Id. */
22
- class ChangedEntitiesArray {
23
- constructor(classIds) {
24
- this.entityIds = new core_bentley_1.OrderedId64Array();
25
- this._classIndices = [];
26
- this._classIds = classIds;
27
- }
28
- insert(entityId, classId) {
29
- const entityIndex = this.entityIds.insert(entityId);
30
- const classIndex = this._classIds.insert(classId);
31
- (0, core_bentley_1.assert)(classIndex >= 0);
32
- if (this.entityIds.length !== this._classIndices.length) {
33
- // New entity - insert corresponding class index entry.
34
- this._classIndices.splice(entityIndex, 0, classIndex);
35
- }
36
- else {
37
- // Existing entity - update corresponding class index.
38
- // (We do this because apparently connectors can (very rarely) change the class Id of an existing element).
39
- this._classIndices[entityIndex] = classIndex;
40
- }
41
- (0, core_bentley_1.assert)(this.entityIds.length === this._classIndices.length);
42
- }
43
- clear() {
44
- this.entityIds.clear();
45
- this._classIndices.length = 0;
46
- }
47
- addToChangedEntities(entities, type) {
48
- if (this.entityIds.length > 0)
49
- entities[type] = core_bentley_1.CompressedId64Set.compressIds(this.entityIds);
50
- }
51
- iterable(classIds) {
52
- function* iterator(entityIds, classIndices) {
53
- const entity = { id: "", classId: "" };
54
- for (let i = 0; i < entityIds.length; i++) {
55
- entity.id = entityIds[i];
56
- entity.classId = classIds[classIndices[i]];
57
- yield entity;
58
- }
59
- }
60
- return {
61
- [Symbol.iterator]: () => iterator(this.entityIds.array, this._classIndices),
62
- };
63
- }
64
- }
65
- class ChangedEntitiesProc {
66
- constructor() {
67
- this._classIds = new core_bentley_1.IndexMap((lhs, rhs) => (0, core_bentley_1.compareStrings)(lhs, rhs));
68
- this._inserted = new ChangedEntitiesArray(this._classIds);
69
- this._deleted = new ChangedEntitiesArray(this._classIds);
70
- this._updated = new ChangedEntitiesArray(this._classIds);
71
- this._currSize = 0;
72
- }
73
- static process(iModel, mgr) {
74
- if (mgr.isDisposed) {
75
- // The iModel is being closed. Do not prepare new sqlite statements.
76
- return;
77
- }
78
- this.processChanges(iModel, mgr.onElementsChanged, "notifyElementsChanged");
79
- this.processChanges(iModel, mgr.onModelsChanged, "notifyModelsChanged");
80
- }
81
- sendEvent(iModel, evt, evtName) {
82
- if (this._currSize === 0)
83
- return;
84
- const classIds = this._classIds.toArray();
85
- // Notify backend listeners.
86
- const txnEntities = {
87
- inserts: this._inserted.iterable(classIds),
88
- deletes: this._deleted.iterable(classIds),
89
- updates: this._updated.iterable(classIds),
90
- };
91
- evt.raiseEvent(txnEntities);
92
- // Notify frontend listeners.
93
- const entities = {};
94
- this._inserted.addToChangedEntities(entities, "inserted");
95
- this._deleted.addToChangedEntities(entities, "deleted");
96
- this._updated.addToChangedEntities(entities, "updated");
97
- IpcHost_1.IpcHost.notifyTxns(iModel, evtName, entities);
98
- // Reset state.
99
- this._inserted.clear();
100
- this._deleted.clear();
101
- this._updated.clear();
102
- this._classIds.clear();
103
- this._currSize = 0;
104
- }
105
- static processChanges(iModel, changedEvent, evtName) {
106
- try {
107
- const maxSize = this.maxPerEvent;
108
- const changes = new ChangedEntitiesProc();
109
- const select = "notifyElementsChanged" === evtName
110
- ? "SELECT ElementId, ChangeType, ECClassId FROM temp.txn_Elements"
111
- : "SELECT ModelId, ChangeType, ECClassId FROM temp.txn_Models";
112
- iModel.withPreparedSqliteStatement(select, (sql) => {
113
- const stmt = sql.stmt;
114
- while (sql.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
115
- const id = stmt.getValueId(0);
116
- const classId = stmt.getValueId(2);
117
- switch (stmt.getValueInteger(1)) {
118
- case 0:
119
- changes._inserted.insert(id, classId);
120
- break;
121
- case 1:
122
- changes._updated.insert(id, classId);
123
- break;
124
- case 2:
125
- changes._deleted.insert(id, classId);
126
- break;
127
- }
128
- if (++changes._currSize >= maxSize)
129
- changes.sendEvent(iModel, changedEvent, evtName);
130
- }
131
- });
132
- changes.sendEvent(iModel, changedEvent, evtName);
133
- }
134
- catch (err) {
135
- core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.IModelDb, core_bentley_1.BentleyError.getErrorMessage(err));
136
- }
137
- }
138
- }
139
- ChangedEntitiesProc.maxPerEvent = 1000;
140
- /** Manages local changes to a [[BriefcaseDb]] or [[StandaloneDb]] via [Txns]($docs/learning/InteractiveEditing.md)
141
- * @public
142
- */
143
- class TxnManager {
144
- /** @internal */
145
- constructor(_iModel) {
146
- this._iModel = _iModel;
147
- /** @internal */
148
- this._isDisposed = false;
149
- /** Array of errors from dependency propagation */
150
- this.validationErrors = [];
151
- /** @internal */
152
- this.onEndValidation = new core_bentley_1.BeEvent();
153
- /** Called after validation completes from [[IModelDb.saveChanges]].
154
- * The argument to the event holds the list of elements that were inserted, updated, and deleted.
155
- * @note If there are many changed elements in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
156
- */
157
- this.onElementsChanged = new core_bentley_1.BeEvent();
158
- /** Called after validation completes from [[IModelDb.saveChanges]].
159
- * The argument to the event holds the list of models that were inserted, updated, and deleted.
160
- * @note If there are many changed models in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
161
- */
162
- this.onModelsChanged = new core_bentley_1.BeEvent();
163
- /** Event raised after the geometry within one or more [[GeometricModel]]s is modified by applying a changeset or validation of a transaction.
164
- * A model's geometry can change as a result of:
165
- * - Insertion or deletion of a geometric element within the model; or
166
- * - Modification of an existing element's geometric properties; or
167
- * - An explicit request to flag it as changed via [[IModelDb.Models.updateModel]].
168
- */
169
- this.onModelGeometryChanged = new core_bentley_1.BeEvent();
170
- this.onGeometryChanged = new core_bentley_1.BeEvent();
171
- /** Event raised before a commit operation is performed. Initiated by a call to [[IModelDb.saveChanges]], unless there are no changes to save. */
172
- this.onCommit = new core_bentley_1.BeEvent();
173
- /** Event raised after a commit operation has been performed. Initiated by a call to [[IModelDb.saveChanges]], even if there were no changes to save. */
174
- this.onCommitted = new core_bentley_1.BeEvent();
175
- /** Event raised after a ChangeSet has been applied to this briefcase */
176
- this.onChangesApplied = new core_bentley_1.BeEvent();
177
- /** Event raised before an undo/redo operation is performed. */
178
- this.onBeforeUndoRedo = new core_bentley_1.BeEvent();
179
- /** Event raised after an undo/redo operation has been performed.
180
- * @param _action The action that was performed.
181
- */
182
- this.onAfterUndoRedo = new core_bentley_1.BeEvent();
183
- _iModel.onBeforeClose.addOnce(() => {
184
- this._isDisposed = true;
185
- });
186
- }
187
- /** @internal */
188
- get isDisposed() {
189
- return this._isDisposed;
190
- }
191
- get _nativeDb() { return this._iModel.nativeDb; }
192
- _getElementClass(elClassName) {
193
- return this._iModel.getJsClass(elClassName);
194
- }
195
- _getRelationshipClass(relClassName) {
196
- return this._iModel.getJsClass(relClassName);
197
- }
198
- /** @internal */
199
- _onBeforeOutputsHandled(elClassName, elId) {
200
- this._getElementClass(elClassName).onBeforeOutputsHandled(elId, this._iModel);
201
- }
202
- /** @internal */
203
- _onAllInputsHandled(elClassName, elId) {
204
- this._getElementClass(elClassName).onAllInputsHandled(elId, this._iModel);
205
- }
206
- /** @internal */
207
- _onRootChanged(props) {
208
- this._getRelationshipClass(props.classFullName).onRootChanged(props, this._iModel);
209
- }
210
- /** @internal */
211
- _onDeletedDependency(props) {
212
- this._getRelationshipClass(props.classFullName).onDeletedDependency(props, this._iModel);
213
- }
214
- /** @internal */
215
- _onBeginValidate() { this.validationErrors.length = 0; }
216
- /** called from native code after validation of a Txn, either from saveChanges or apply changeset.
217
- * @internal
218
- */
219
- _onEndValidate() {
220
- ChangedEntitiesProc.process(this._iModel, this);
221
- this.onEndValidation.raiseEvent();
222
- // TODO: if (this.validationErrors.length !== 0) throw new IModelError(validation ...)
223
- }
224
- /** @internal */
225
- _onGeometryChanged(modelProps) {
226
- this.onGeometryChanged.raiseEvent(modelProps);
227
- IpcHost_1.IpcHost.notifyEditingScope(this._iModel, "notifyGeometryChanged", modelProps); // send to frontend
228
- }
229
- /** @internal */
230
- _onGeometryGuidsChanged(changes) {
231
- this.onModelGeometryChanged.raiseEvent(changes);
232
- IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyGeometryGuidsChanged", changes);
233
- }
234
- /** @internal */
235
- _onCommit() {
236
- this.onCommit.raiseEvent();
237
- IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyCommit");
238
- }
239
- /** @internal */
240
- _onCommitted() {
241
- this.onCommitted.raiseEvent();
242
- IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyCommitted", this.hasPendingTxns, Date.now());
243
- }
244
- /** @internal */
245
- _onChangesApplied() {
246
- ChangedEntitiesProc.process(this._iModel, this);
247
- this.onChangesApplied.raiseEvent();
248
- IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyChangesApplied");
249
- }
250
- /** @internal */
251
- _onBeforeUndoRedo(isUndo) {
252
- this.onBeforeUndoRedo.raiseEvent(isUndo);
253
- IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyBeforeUndoRedo", isUndo);
254
- }
255
- /** @internal */
256
- _onAfterUndoRedo(isUndo) {
257
- this.onAfterUndoRedo.raiseEvent(isUndo);
258
- IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyAfterUndoRedo", isUndo);
259
- }
260
- /** Dependency handlers may call method this to report a validation error.
261
- * @param error The error. If error.fatal === true, the transaction will cancel rather than commit.
262
- */
263
- reportError(error) {
264
- this.validationErrors.push(error);
265
- this._nativeDb.logTxnError(error.fatal);
266
- }
267
- /** Determine whether any fatal validation errors have occurred during dependency propagation. */
268
- get hasFatalError() { return this._nativeDb.hasFatalTxnError(); }
269
- /**
270
- * Restart the current TxnManager session. This causes all Txns in the current session to no longer be undoable (as if the file was closed
271
- * and reopened.)
272
- * @note This can be quite disconcerting to the user expecting to be able to undo previously made changes. It should only be used
273
- * under extreme circumstances where damage to the file or session could happen if the currently committed are reversed. Use sparingly and with care.
274
- * Probably a good idea to alert the user it happened.
275
- */
276
- restartSession() {
277
- this._nativeDb.restartTxnSession();
278
- }
279
- /** Determine whether current txn is propagating indirect changes or not. */
280
- get isIndirectChanges() { return this._nativeDb.isIndirectChanges(); }
281
- /** Determine if there are currently any reversible (undoable) changes from this editing session. */
282
- get isUndoPossible() { return this._nativeDb.isUndoPossible(); }
283
- /** Determine if there are currently any reinstatable (redoable) changes */
284
- get isRedoPossible() { return this._nativeDb.isRedoPossible(); }
285
- /** Get the description of the operation that would be reversed by calling reverseTxns(1).
286
- * This is useful for showing the operation that would be undone, for example in a menu.
287
- */
288
- getUndoString() { return this._nativeDb.getUndoString(); }
289
- /** Get a description of the operation that would be reinstated by calling reinstateTxn.
290
- * This is useful for showing the operation that would be redone, in a pull-down menu for example.
291
- */
292
- getRedoString() { return this._nativeDb.getRedoString(); }
293
- /** Begin a new multi-Txn operation. This can be used to cause a series of Txns that would normally
294
- * be considered separate actions for undo to be grouped into a single undoable operation. This means that when reverseTxns(1) is called,
295
- * the entire group of changes are undone together. Multi-Txn operations can be nested and until the outermost operation is closed
296
- * all changes constitute a single operation.
297
- * @note This method must always be paired with a call to endMultiTxnAction.
298
- */
299
- beginMultiTxnOperation() { return this._nativeDb.beginMultiTxnOperation(); }
300
- /** End a multi-Txn operation */
301
- endMultiTxnOperation() { return this._nativeDb.endMultiTxnOperation(); }
302
- /** Return the depth of the multi-Txn stack. Generally for diagnostic use only. */
303
- getMultiTxnOperationDepth() { return this._nativeDb.getMultiTxnOperationDepth(); }
304
- /** Reverse (undo) the most recent operation(s) to this IModelDb.
305
- * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
306
- * be reinstated together when/if ReinstateTxn is called.
307
- * @note If there are any outstanding uncommitted changes, they are reversed.
308
- * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
309
- * even if numOperations is 1, multiple Txns may be reversed if they were grouped together when they were made.
310
- * @note If numOperations is too large only the operations are reversible are reversed.
311
- */
312
- reverseTxns(numOperations) {
313
- return this._iModel.reverseTxns(numOperations);
314
- }
315
- /** Reverse the most recent operation. */
316
- reverseSingleTxn() { return this.reverseTxns(1); }
317
- /** Reverse all changes back to the beginning of the session. */
318
- reverseAll() { return this._nativeDb.reverseAll(); }
319
- /** Reverse all changes back to a previously saved TxnId.
320
- * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
321
- * @returns Success if the transactions were reversed, error status otherwise.
322
- * @see [[getCurrentTxnId]] [[cancelTo]]
323
- */
324
- reverseTo(txnId) { return this._nativeDb.reverseTo(txnId); }
325
- /** Reverse and then cancel (make non-reinstatable) all changes back to a previous TxnId.
326
- * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
327
- * @returns Success if the transactions were reversed and cleared, error status otherwise.
328
- */
329
- cancelTo(txnId) { return this._nativeDb.cancelTo(txnId); }
330
- /** Reinstate the most recently reversed transaction. Since at any time multiple transactions can be reversed, it
331
- * may take multiple calls to this method to reinstate all reversed operations.
332
- * @returns Success if a reversed transaction was reinstated, error status otherwise.
333
- * @note If there are any outstanding uncommitted changes, they are canceled before the Txn is reinstated.
334
- */
335
- reinstateTxn() { return this._iModel.reinstateTxn(); }
336
- /** Get the Id of the first transaction, if any.
337
- */
338
- queryFirstTxnId() { return this._nativeDb.queryFirstTxnId(); }
339
- /** Get the successor of the specified TxnId */
340
- queryNextTxnId(txnId) { return this._nativeDb.queryNextTxnId(txnId); }
341
- /** Get the predecessor of the specified TxnId */
342
- queryPreviousTxnId(txnId) { return this._nativeDb.queryPreviousTxnId(txnId); }
343
- /** Get the Id of the current (tip) transaction. */
344
- getCurrentTxnId() { return this._nativeDb.getCurrentTxnId(); }
345
- /** Get the description that was supplied when the specified transaction was saved. */
346
- getTxnDescription(txnId) { return this._nativeDb.getTxnDescription(txnId); }
347
- /** Test if a TxnId is valid */
348
- isTxnIdValid(txnId) { return this._nativeDb.isTxnIdValid(txnId); }
349
- /** Query if there are any pending Txns in this IModelDb that are waiting to be pushed. */
350
- get hasPendingTxns() { return this._nativeDb.hasPendingTxns(); }
351
- /** Query if there are any changes in memory that have yet to be saved to the IModelDb. */
352
- get hasUnsavedChanges() { return this._nativeDb.hasUnsavedChanges(); }
353
- /** Query if there are un-saved or un-pushed local changes. */
354
- get hasLocalChanges() { return this.hasUnsavedChanges || this.hasPendingTxns; }
355
- }
356
- exports.TxnManager = TxnManager;
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 iModels
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.TxnManager = exports.setMaxEntitiesPerEvent = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
13
+ const IpcHost_1 = require("./IpcHost");
14
+ /** Strictly for tests. @internal */
15
+ function setMaxEntitiesPerEvent(max) {
16
+ const prevMax = ChangedEntitiesProc.maxPerEvent;
17
+ ChangedEntitiesProc.maxPerEvent = max;
18
+ return prevMax;
19
+ }
20
+ exports.setMaxEntitiesPerEvent = setMaxEntitiesPerEvent;
21
+ /** Maintains an ordered array of entity Ids and a parallel array containing the index of the corresponding entity's class Id. */
22
+ class ChangedEntitiesArray {
23
+ constructor(classIds) {
24
+ this.entityIds = new core_bentley_1.OrderedId64Array();
25
+ this._classIndices = [];
26
+ this._classIds = classIds;
27
+ }
28
+ insert(entityId, classId) {
29
+ const entityIndex = this.entityIds.insert(entityId);
30
+ const classIndex = this._classIds.insert(classId);
31
+ (0, core_bentley_1.assert)(classIndex >= 0);
32
+ if (this.entityIds.length !== this._classIndices.length) {
33
+ // New entity - insert corresponding class index entry.
34
+ this._classIndices.splice(entityIndex, 0, classIndex);
35
+ }
36
+ else {
37
+ // Existing entity - update corresponding class index.
38
+ // (We do this because apparently connectors can (very rarely) change the class Id of an existing element).
39
+ this._classIndices[entityIndex] = classIndex;
40
+ }
41
+ (0, core_bentley_1.assert)(this.entityIds.length === this._classIndices.length);
42
+ }
43
+ clear() {
44
+ this.entityIds.clear();
45
+ this._classIndices.length = 0;
46
+ }
47
+ addToChangedEntities(entities, type) {
48
+ if (this.entityIds.length > 0)
49
+ entities[type] = core_bentley_1.CompressedId64Set.compressIds(this.entityIds);
50
+ }
51
+ iterable(classIds) {
52
+ function* iterator(entityIds, classIndices) {
53
+ const entity = { id: "", classId: "" };
54
+ for (let i = 0; i < entityIds.length; i++) {
55
+ entity.id = entityIds[i];
56
+ entity.classId = classIds[classIndices[i]];
57
+ yield entity;
58
+ }
59
+ }
60
+ return {
61
+ [Symbol.iterator]: () => iterator(this.entityIds.array, this._classIndices),
62
+ };
63
+ }
64
+ }
65
+ class ChangedEntitiesProc {
66
+ constructor() {
67
+ this._classIds = new core_bentley_1.IndexMap((lhs, rhs) => (0, core_bentley_1.compareStrings)(lhs, rhs));
68
+ this._inserted = new ChangedEntitiesArray(this._classIds);
69
+ this._deleted = new ChangedEntitiesArray(this._classIds);
70
+ this._updated = new ChangedEntitiesArray(this._classIds);
71
+ this._currSize = 0;
72
+ }
73
+ static process(iModel, mgr) {
74
+ if (mgr.isDisposed) {
75
+ // The iModel is being closed. Do not prepare new sqlite statements.
76
+ return;
77
+ }
78
+ this.processChanges(iModel, mgr.onElementsChanged, "notifyElementsChanged");
79
+ this.processChanges(iModel, mgr.onModelsChanged, "notifyModelsChanged");
80
+ }
81
+ sendEvent(iModel, evt, evtName) {
82
+ if (this._currSize === 0)
83
+ return;
84
+ const classIds = this._classIds.toArray();
85
+ // Notify backend listeners.
86
+ const txnEntities = {
87
+ inserts: this._inserted.iterable(classIds),
88
+ deletes: this._deleted.iterable(classIds),
89
+ updates: this._updated.iterable(classIds),
90
+ };
91
+ evt.raiseEvent(txnEntities);
92
+ // Notify frontend listeners.
93
+ const entities = {};
94
+ this._inserted.addToChangedEntities(entities, "inserted");
95
+ this._deleted.addToChangedEntities(entities, "deleted");
96
+ this._updated.addToChangedEntities(entities, "updated");
97
+ IpcHost_1.IpcHost.notifyTxns(iModel, evtName, entities);
98
+ // Reset state.
99
+ this._inserted.clear();
100
+ this._deleted.clear();
101
+ this._updated.clear();
102
+ this._classIds.clear();
103
+ this._currSize = 0;
104
+ }
105
+ static processChanges(iModel, changedEvent, evtName) {
106
+ try {
107
+ const maxSize = this.maxPerEvent;
108
+ const changes = new ChangedEntitiesProc();
109
+ const select = "notifyElementsChanged" === evtName
110
+ ? "SELECT ElementId, ChangeType, ECClassId FROM temp.txn_Elements"
111
+ : "SELECT ModelId, ChangeType, ECClassId FROM temp.txn_Models";
112
+ iModel.withPreparedSqliteStatement(select, (sql) => {
113
+ const stmt = sql.stmt;
114
+ while (sql.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
115
+ const id = stmt.getValueId(0);
116
+ const classId = stmt.getValueId(2);
117
+ switch (stmt.getValueInteger(1)) {
118
+ case 0:
119
+ changes._inserted.insert(id, classId);
120
+ break;
121
+ case 1:
122
+ changes._updated.insert(id, classId);
123
+ break;
124
+ case 2:
125
+ changes._deleted.insert(id, classId);
126
+ break;
127
+ }
128
+ if (++changes._currSize >= maxSize)
129
+ changes.sendEvent(iModel, changedEvent, evtName);
130
+ }
131
+ });
132
+ changes.sendEvent(iModel, changedEvent, evtName);
133
+ }
134
+ catch (err) {
135
+ core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.IModelDb, core_bentley_1.BentleyError.getErrorMessage(err));
136
+ }
137
+ }
138
+ }
139
+ ChangedEntitiesProc.maxPerEvent = 1000;
140
+ /** Manages local changes to a [[BriefcaseDb]] or [[StandaloneDb]] via [Txns]($docs/learning/InteractiveEditing.md)
141
+ * @public
142
+ */
143
+ class TxnManager {
144
+ /** @internal */
145
+ constructor(_iModel) {
146
+ this._iModel = _iModel;
147
+ /** @internal */
148
+ this._isDisposed = false;
149
+ /** Array of errors from dependency propagation */
150
+ this.validationErrors = [];
151
+ /** @internal */
152
+ this.onEndValidation = new core_bentley_1.BeEvent();
153
+ /** Called after validation completes from [[IModelDb.saveChanges]].
154
+ * The argument to the event holds the list of elements that were inserted, updated, and deleted.
155
+ * @note If there are many changed elements in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
156
+ */
157
+ this.onElementsChanged = new core_bentley_1.BeEvent();
158
+ /** Called after validation completes from [[IModelDb.saveChanges]].
159
+ * The argument to the event holds the list of models that were inserted, updated, and deleted.
160
+ * @note If there are many changed models in a single Txn, the notifications are sent in batches so this event *may be called multiple times* per Txn.
161
+ */
162
+ this.onModelsChanged = new core_bentley_1.BeEvent();
163
+ /** Event raised after the geometry within one or more [[GeometricModel]]s is modified by applying a changeset or validation of a transaction.
164
+ * A model's geometry can change as a result of:
165
+ * - Insertion or deletion of a geometric element within the model; or
166
+ * - Modification of an existing element's geometric properties; or
167
+ * - An explicit request to flag it as changed via [[IModelDb.Models.updateModel]].
168
+ */
169
+ this.onModelGeometryChanged = new core_bentley_1.BeEvent();
170
+ this.onGeometryChanged = new core_bentley_1.BeEvent();
171
+ /** Event raised before a commit operation is performed. Initiated by a call to [[IModelDb.saveChanges]], unless there are no changes to save. */
172
+ this.onCommit = new core_bentley_1.BeEvent();
173
+ /** Event raised after a commit operation has been performed. Initiated by a call to [[IModelDb.saveChanges]], even if there were no changes to save. */
174
+ this.onCommitted = new core_bentley_1.BeEvent();
175
+ /** Event raised after a ChangeSet has been applied to this briefcase */
176
+ this.onChangesApplied = new core_bentley_1.BeEvent();
177
+ /** Event raised before an undo/redo operation is performed. */
178
+ this.onBeforeUndoRedo = new core_bentley_1.BeEvent();
179
+ /** Event raised after an undo/redo operation has been performed.
180
+ * @param _action The action that was performed.
181
+ */
182
+ this.onAfterUndoRedo = new core_bentley_1.BeEvent();
183
+ _iModel.onBeforeClose.addOnce(() => {
184
+ this._isDisposed = true;
185
+ });
186
+ }
187
+ /** @internal */
188
+ get isDisposed() {
189
+ return this._isDisposed;
190
+ }
191
+ get _nativeDb() { return this._iModel.nativeDb; }
192
+ _getElementClass(elClassName) {
193
+ return this._iModel.getJsClass(elClassName);
194
+ }
195
+ _getRelationshipClass(relClassName) {
196
+ return this._iModel.getJsClass(relClassName);
197
+ }
198
+ /** @internal */
199
+ _onBeforeOutputsHandled(elClassName, elId) {
200
+ this._getElementClass(elClassName).onBeforeOutputsHandled(elId, this._iModel);
201
+ }
202
+ /** @internal */
203
+ _onAllInputsHandled(elClassName, elId) {
204
+ this._getElementClass(elClassName).onAllInputsHandled(elId, this._iModel);
205
+ }
206
+ /** @internal */
207
+ _onRootChanged(props) {
208
+ this._getRelationshipClass(props.classFullName).onRootChanged(props, this._iModel);
209
+ }
210
+ /** @internal */
211
+ _onDeletedDependency(props) {
212
+ this._getRelationshipClass(props.classFullName).onDeletedDependency(props, this._iModel);
213
+ }
214
+ /** @internal */
215
+ _onBeginValidate() { this.validationErrors.length = 0; }
216
+ /** called from native code after validation of a Txn, either from saveChanges or apply changeset.
217
+ * @internal
218
+ */
219
+ _onEndValidate() {
220
+ ChangedEntitiesProc.process(this._iModel, this);
221
+ this.onEndValidation.raiseEvent();
222
+ // TODO: if (this.validationErrors.length !== 0) throw new IModelError(validation ...)
223
+ }
224
+ /** @internal */
225
+ _onGeometryChanged(modelProps) {
226
+ this.onGeometryChanged.raiseEvent(modelProps);
227
+ IpcHost_1.IpcHost.notifyEditingScope(this._iModel, "notifyGeometryChanged", modelProps); // send to frontend
228
+ }
229
+ /** @internal */
230
+ _onGeometryGuidsChanged(changes) {
231
+ this.onModelGeometryChanged.raiseEvent(changes);
232
+ IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyGeometryGuidsChanged", changes);
233
+ }
234
+ /** @internal */
235
+ _onCommit() {
236
+ this.onCommit.raiseEvent();
237
+ IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyCommit");
238
+ }
239
+ /** @internal */
240
+ _onCommitted() {
241
+ this.onCommitted.raiseEvent();
242
+ IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyCommitted", this.hasPendingTxns, Date.now());
243
+ }
244
+ /** @internal */
245
+ _onChangesApplied() {
246
+ ChangedEntitiesProc.process(this._iModel, this);
247
+ this.onChangesApplied.raiseEvent();
248
+ IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyChangesApplied");
249
+ }
250
+ /** @internal */
251
+ _onBeforeUndoRedo(isUndo) {
252
+ this.onBeforeUndoRedo.raiseEvent(isUndo);
253
+ IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyBeforeUndoRedo", isUndo);
254
+ }
255
+ /** @internal */
256
+ _onAfterUndoRedo(isUndo) {
257
+ this.onAfterUndoRedo.raiseEvent(isUndo);
258
+ IpcHost_1.IpcHost.notifyTxns(this._iModel, "notifyAfterUndoRedo", isUndo);
259
+ }
260
+ /** Dependency handlers may call method this to report a validation error.
261
+ * @param error The error. If error.fatal === true, the transaction will cancel rather than commit.
262
+ */
263
+ reportError(error) {
264
+ this.validationErrors.push(error);
265
+ this._nativeDb.logTxnError(error.fatal);
266
+ }
267
+ /** Determine whether any fatal validation errors have occurred during dependency propagation. */
268
+ get hasFatalError() { return this._nativeDb.hasFatalTxnError(); }
269
+ /**
270
+ * Restart the current TxnManager session. This causes all Txns in the current session to no longer be undoable (as if the file was closed
271
+ * and reopened.)
272
+ * @note This can be quite disconcerting to the user expecting to be able to undo previously made changes. It should only be used
273
+ * under extreme circumstances where damage to the file or session could happen if the currently committed are reversed. Use sparingly and with care.
274
+ * Probably a good idea to alert the user it happened.
275
+ */
276
+ restartSession() {
277
+ this._nativeDb.restartTxnSession();
278
+ }
279
+ /** Determine whether current txn is propagating indirect changes or not. */
280
+ get isIndirectChanges() { return this._nativeDb.isIndirectChanges(); }
281
+ /** Determine if there are currently any reversible (undoable) changes from this editing session. */
282
+ get isUndoPossible() { return this._nativeDb.isUndoPossible(); }
283
+ /** Determine if there are currently any reinstatable (redoable) changes */
284
+ get isRedoPossible() { return this._nativeDb.isRedoPossible(); }
285
+ /** Get the description of the operation that would be reversed by calling reverseTxns(1).
286
+ * This is useful for showing the operation that would be undone, for example in a menu.
287
+ */
288
+ getUndoString() { return this._nativeDb.getUndoString(); }
289
+ /** Get a description of the operation that would be reinstated by calling reinstateTxn.
290
+ * This is useful for showing the operation that would be redone, in a pull-down menu for example.
291
+ */
292
+ getRedoString() { return this._nativeDb.getRedoString(); }
293
+ /** Begin a new multi-Txn operation. This can be used to cause a series of Txns that would normally
294
+ * be considered separate actions for undo to be grouped into a single undoable operation. This means that when reverseTxns(1) is called,
295
+ * the entire group of changes are undone together. Multi-Txn operations can be nested and until the outermost operation is closed
296
+ * all changes constitute a single operation.
297
+ * @note This method must always be paired with a call to endMultiTxnAction.
298
+ */
299
+ beginMultiTxnOperation() { return this._nativeDb.beginMultiTxnOperation(); }
300
+ /** End a multi-Txn operation */
301
+ endMultiTxnOperation() { return this._nativeDb.endMultiTxnOperation(); }
302
+ /** Return the depth of the multi-Txn stack. Generally for diagnostic use only. */
303
+ getMultiTxnOperationDepth() { return this._nativeDb.getMultiTxnOperationDepth(); }
304
+ /** Reverse (undo) the most recent operation(s) to this IModelDb.
305
+ * @param numOperations the number of operations to reverse. If this is greater than 1, the entire set of operations will
306
+ * be reinstated together when/if ReinstateTxn is called.
307
+ * @note If there are any outstanding uncommitted changes, they are reversed.
308
+ * @note The term "operation" is used rather than Txn, since multiple Txns can be grouped together via [[beginMultiTxnOperation]]. So,
309
+ * even if numOperations is 1, multiple Txns may be reversed if they were grouped together when they were made.
310
+ * @note If numOperations is too large only the operations are reversible are reversed.
311
+ */
312
+ reverseTxns(numOperations) {
313
+ return this._iModel.reverseTxns(numOperations);
314
+ }
315
+ /** Reverse the most recent operation. */
316
+ reverseSingleTxn() { return this.reverseTxns(1); }
317
+ /** Reverse all changes back to the beginning of the session. */
318
+ reverseAll() { return this._nativeDb.reverseAll(); }
319
+ /** Reverse all changes back to a previously saved TxnId.
320
+ * @param txnId a TxnId obtained from a previous call to GetCurrentTxnId.
321
+ * @returns Success if the transactions were reversed, error status otherwise.
322
+ * @see [[getCurrentTxnId]] [[cancelTo]]
323
+ */
324
+ reverseTo(txnId) { return this._nativeDb.reverseTo(txnId); }
325
+ /** Reverse and then cancel (make non-reinstatable) all changes back to a previous TxnId.
326
+ * @param txnId a TxnId obtained from a previous call to [[getCurrentTxnId]]
327
+ * @returns Success if the transactions were reversed and cleared, error status otherwise.
328
+ */
329
+ cancelTo(txnId) { return this._nativeDb.cancelTo(txnId); }
330
+ /** Reinstate the most recently reversed transaction. Since at any time multiple transactions can be reversed, it
331
+ * may take multiple calls to this method to reinstate all reversed operations.
332
+ * @returns Success if a reversed transaction was reinstated, error status otherwise.
333
+ * @note If there are any outstanding uncommitted changes, they are canceled before the Txn is reinstated.
334
+ */
335
+ reinstateTxn() { return this._iModel.reinstateTxn(); }
336
+ /** Get the Id of the first transaction, if any.
337
+ */
338
+ queryFirstTxnId() { return this._nativeDb.queryFirstTxnId(); }
339
+ /** Get the successor of the specified TxnId */
340
+ queryNextTxnId(txnId) { return this._nativeDb.queryNextTxnId(txnId); }
341
+ /** Get the predecessor of the specified TxnId */
342
+ queryPreviousTxnId(txnId) { return this._nativeDb.queryPreviousTxnId(txnId); }
343
+ /** Get the Id of the current (tip) transaction. */
344
+ getCurrentTxnId() { return this._nativeDb.getCurrentTxnId(); }
345
+ /** Get the description that was supplied when the specified transaction was saved. */
346
+ getTxnDescription(txnId) { return this._nativeDb.getTxnDescription(txnId); }
347
+ /** Test if a TxnId is valid */
348
+ isTxnIdValid(txnId) { return this._nativeDb.isTxnIdValid(txnId); }
349
+ /** Query if there are any pending Txns in this IModelDb that are waiting to be pushed. */
350
+ get hasPendingTxns() { return this._nativeDb.hasPendingTxns(); }
351
+ /** Query if there are any changes in memory that have yet to be saved to the IModelDb. */
352
+ get hasUnsavedChanges() { return this._nativeDb.hasUnsavedChanges(); }
353
+ /** Query if there are un-saved or un-pushed local changes. */
354
+ get hasLocalChanges() { return this.hasUnsavedChanges || this.hasPendingTxns; }
355
+ }
356
+ exports.TxnManager = TxnManager;
357
357
  //# sourceMappingURL=TxnManager.js.map