@itwin/core-backend 5.9.0 → 5.9.1
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.
- package/CHANGELOG.md +8 -1
- package/lib/cjs/BriefcaseManager.d.ts +14 -62
- package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
- package/lib/cjs/BriefcaseManager.js +29 -162
- package/lib/cjs/BriefcaseManager.js.map +1 -1
- package/lib/cjs/IModelJsFs.d.ts +2 -0
- package/lib/cjs/IModelJsFs.d.ts.map +1 -1
- package/lib/cjs/IModelJsFs.js +14 -0
- package/lib/cjs/IModelJsFs.js.map +1 -1
- package/lib/cjs/TxnManager.d.ts +3 -0
- package/lib/cjs/TxnManager.d.ts.map +1 -1
- package/lib/cjs/TxnManager.js +95 -13
- package/lib/cjs/TxnManager.js.map +1 -1
- package/lib/esm/BriefcaseManager.d.ts +14 -62
- package/lib/esm/BriefcaseManager.d.ts.map +1 -1
- package/lib/esm/BriefcaseManager.js +30 -163
- package/lib/esm/BriefcaseManager.js.map +1 -1
- package/lib/esm/IModelJsFs.d.ts +2 -0
- package/lib/esm/IModelJsFs.d.ts.map +1 -1
- package/lib/esm/IModelJsFs.js +14 -0
- package/lib/esm/IModelJsFs.js.map +1 -1
- package/lib/esm/TxnManager.d.ts +3 -0
- package/lib/esm/TxnManager.d.ts.map +1 -1
- package/lib/esm/TxnManager.js +96 -14
- package/lib/esm/TxnManager.js.map +1 -1
- package/lib/esm/test/hubaccess/SemanticRebase.test.js +2242 -68
- package/lib/esm/test/hubaccess/SemanticRebase.test.js.map +1 -1
- package/package.json +13 -13
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
# Change Log - @itwin/core-backend
|
|
2
2
|
|
|
3
|
-
This log was last generated on
|
|
3
|
+
This log was last generated on Tue, 05 May 2026 17:43:30 GMT and should not be manually modified.
|
|
4
|
+
|
|
5
|
+
## 5.9.1
|
|
6
|
+
Tue, 05 May 2026 17:43:30 GMT
|
|
7
|
+
|
|
8
|
+
### Updates
|
|
9
|
+
|
|
10
|
+
- Semantic Rebase uses the new ChangesetReader api. Also while doing semantic rebase we now stream the changed instances onto the temp file while writing as well as stream changed instances from the file while reading.
|
|
4
11
|
|
|
5
12
|
## 5.9.0
|
|
6
13
|
Mon, 04 May 2026 16:32:08 GMT
|
|
@@ -1,30 +1,13 @@
|
|
|
1
1
|
/** @packageDocumentation
|
|
2
2
|
* @module iModels
|
|
3
3
|
*/
|
|
4
|
-
import { AccessToken, BeDuration, GuidString,
|
|
4
|
+
import { AccessToken, BeDuration, GuidString, Optional } from "@itwin/core-bentley";
|
|
5
5
|
import { BriefcaseId, BriefcaseProps, ChangesetFileProps, ChangesetIndex, ChangesetIndexOrId, ChangesetProps, ChangesetRange, LocalBriefcaseProps, LocalDirName, LocalFileName, RequestNewBriefcaseProps } from "@itwin/core-common";
|
|
6
6
|
import { AcquireNewBriefcaseIdArg, DownloadChangesetArg, DownloadChangesetRangeArg, IModelNameArg } from "./BackendHubAccess";
|
|
7
7
|
import { ProgressFunction } from "./CheckpointManager";
|
|
8
8
|
import { BriefcaseDb, IModelDb, TokenArg } from "./IModelDb";
|
|
9
9
|
import { StashProps } from "./StashManager";
|
|
10
|
-
import {
|
|
11
|
-
/**
|
|
12
|
-
* The argument for identifying an Patch Instance Key
|
|
13
|
-
* @internal
|
|
14
|
-
*/
|
|
15
|
-
interface PatchInstanceKey {
|
|
16
|
-
id: Id64String;
|
|
17
|
-
classFullName: string;
|
|
18
|
-
}
|
|
19
|
-
/** The argument for patch instances during high level rebase application
|
|
20
|
-
* @internal
|
|
21
|
-
*/
|
|
22
|
-
export interface InstancePatch {
|
|
23
|
-
key: PatchInstanceKey;
|
|
24
|
-
op: "Inserted" | "Updated" | "Deleted";
|
|
25
|
-
isIndirect: boolean;
|
|
26
|
-
props?: ECSqlRow;
|
|
27
|
-
}
|
|
10
|
+
import { ChangeInstance } from "./ChangesetReaderTypes";
|
|
28
11
|
/** The argument for [[BriefcaseManager.downloadBriefcase]]
|
|
29
12
|
* @public
|
|
30
13
|
*/
|
|
@@ -294,44 +277,14 @@ export declare class BriefcaseManager {
|
|
|
294
277
|
private static readonly SCHEMAS_FOLDER;
|
|
295
278
|
private static readonly DATA_FOLDER;
|
|
296
279
|
private static readonly DATA_FILE_NAME;
|
|
297
|
-
/**
|
|
298
|
-
* Captures the changed instances as patch instances from each data txn in the briefcase db for semantic rebase
|
|
299
|
-
* @param db The {@link BriefcaseDb} instance for which to capture the changed instances as patch instances for all data txns
|
|
300
|
-
* @internal
|
|
301
|
-
*/
|
|
302
|
-
private static capturePatchInstances;
|
|
303
|
-
/**
|
|
304
|
-
* Captures changed instances from a txn as JSON
|
|
305
|
-
* @param txnId The txn id for which to capture changed instances
|
|
306
|
-
* @param db The {@link BriefcaseDb} instance from which to capture changed instances as json
|
|
307
|
-
* @returns changed instances for semantic rebase
|
|
308
|
-
* @internal
|
|
309
|
-
*/
|
|
310
|
-
private static captureChangedInstancesAsJSON;
|
|
311
|
-
/**
|
|
312
|
-
* Constructs patch instances from changed instances
|
|
313
|
-
* @param changedInstances The changed instances from which to construct the patch instances
|
|
314
|
-
* @param db The {@link BriefcaseDb} instance for which to construct the patch instances
|
|
315
|
-
* @returns The {@link InstancePatch} instance patches for semantic rebase
|
|
316
|
-
* @internal
|
|
317
|
-
*/
|
|
318
|
-
private static constructPatchInstances;
|
|
319
|
-
/**
|
|
320
|
-
* Constructs a single patch instance from changed instance
|
|
321
|
-
* @param changedInstance The changed instance from which to construct the patch instance
|
|
322
|
-
* @param db The {@link BriefcaseDb} instance for which to construct the single patch instance
|
|
323
|
-
* @returns a single instance patch {@link InstancePatch}
|
|
324
|
-
* @throws IModelError If cannot determine classId or unknown operation encountered
|
|
325
|
-
*/
|
|
326
|
-
private static constructPatchInstance;
|
|
327
280
|
/**
|
|
328
281
|
* Stores changed instances for semantic rebase locally in appropriate json file in a folder structure
|
|
329
|
-
* @param db The
|
|
282
|
+
* @param db The [BriefcaseDb]($backend) instance for storing the changed instances against a txn
|
|
330
283
|
* @param txnId The txn id for which we are storing the changed instances
|
|
331
|
-
* @param instancePatches The
|
|
284
|
+
* @param instancePatches The [ChangeInstance]($backend) instance patches to be stored
|
|
332
285
|
* @internal
|
|
333
286
|
*/
|
|
334
|
-
|
|
287
|
+
static storeChangedInstancesForSemanticRebase(db: BriefcaseDb, txnId: string, instancePatches: IterableIterator<ChangeInstance>): void;
|
|
335
288
|
/**
|
|
336
289
|
* Gets the base path for semantic rebase local files
|
|
337
290
|
* @param db The {@link BriefcaseDb} instance for which to get the base path
|
|
@@ -341,7 +294,7 @@ export declare class BriefcaseManager {
|
|
|
341
294
|
static getBasePathForSemanticRebaseLocalFiles(db: BriefcaseDb): string;
|
|
342
295
|
/**
|
|
343
296
|
* Stores schemas for semantic rebase locally in appropriate folder structure
|
|
344
|
-
* @param db The
|
|
297
|
+
* @param db The [BriefcaseDb]($backend) instance for storing the schemas against a txn
|
|
345
298
|
* @param txnId The txn id for which we are storing the schemas
|
|
346
299
|
* @param schemaFileNames The schema file paths or schema xml strings to be stored
|
|
347
300
|
* @internal
|
|
@@ -349,7 +302,7 @@ export declare class BriefcaseManager {
|
|
|
349
302
|
static storeSchemasForSemanticRebase<T extends LocalFileName[] | string[]>(db: BriefcaseDb, txnId: string, schemaFileNames: T): void;
|
|
350
303
|
/**
|
|
351
304
|
* Gets schemas for semantic rebase for a txn
|
|
352
|
-
* @param db The
|
|
305
|
+
* @param db The [BriefcaseDb]($backend) instance for getting the locally stored schemas against a txn
|
|
353
306
|
* @param txnId The txn id for which we are getting the schemas
|
|
354
307
|
* @returns the schema file paths
|
|
355
308
|
* @internal
|
|
@@ -357,15 +310,15 @@ export declare class BriefcaseManager {
|
|
|
357
310
|
static getSchemasForTxn(db: BriefcaseDb, txnId: string): string[];
|
|
358
311
|
/**
|
|
359
312
|
* Get the changed instances data for semantic rebase for a txn
|
|
360
|
-
* @param db - The
|
|
313
|
+
* @param db - The [BriefcaseDb]($backend) instance for getting the locally stored changed instances against a txn
|
|
361
314
|
* @param txnId - The txn id for which we are getting the changed instances
|
|
362
315
|
* @returns Instance patches
|
|
363
316
|
* @internal
|
|
364
317
|
*/
|
|
365
|
-
static getChangedInstancesDataForTxn(db: BriefcaseDb, txnId: string):
|
|
318
|
+
static getChangedInstancesDataForTxn(db: BriefcaseDb, txnId: string): AsyncGenerator<ChangeInstance>;
|
|
366
319
|
/**
|
|
367
320
|
* Checks if schema folder exists for semantic rebase for a txn
|
|
368
|
-
* @param db - The
|
|
321
|
+
* @param db - The [BriefcaseDb]($backend) instance for which TO check the schema folder
|
|
369
322
|
* @param txnId - The txn id for which we are check the schema folder
|
|
370
323
|
* @returns true if exists, false otherwise
|
|
371
324
|
* @internal
|
|
@@ -373,7 +326,7 @@ export declare class BriefcaseManager {
|
|
|
373
326
|
static semanticRebaseSchemaFolderExists(db: BriefcaseDb, txnId: string): boolean;
|
|
374
327
|
/**
|
|
375
328
|
* Checks if data folder exists for semantic rebase for a txn
|
|
376
|
-
* @param db The
|
|
329
|
+
* @param db The [BriefcaseDb]($backend) instance for which to check the data folder.
|
|
377
330
|
* @param txnId The txn id for which to check the data folder
|
|
378
331
|
* @returns true if exists, false otherwise
|
|
379
332
|
* @internal
|
|
@@ -381,21 +334,21 @@ export declare class BriefcaseManager {
|
|
|
381
334
|
static semanticRebaseDataFolderExists(db: BriefcaseDb, txnId: string): boolean;
|
|
382
335
|
/**
|
|
383
336
|
* Deletes the schema folder for semantic rebase for a txn
|
|
384
|
-
* @param db The
|
|
337
|
+
* @param db The [BriefcaseDb]($backend) instance for which to delete the schema folder.
|
|
385
338
|
* @param txnId The txn id for which to delete the schema folder
|
|
386
339
|
* @internal
|
|
387
340
|
*/
|
|
388
341
|
static deleteTxnSchemaFolder(db: BriefcaseDb, txnId: string): void;
|
|
389
342
|
/**
|
|
390
343
|
* Deletes the data folder for semantic rebase for a txn
|
|
391
|
-
* @param db The
|
|
344
|
+
* @param db The [BriefcaseDb]($backend) instance for which to delete the data folder.
|
|
392
345
|
* @param txnId The txn id for which to delete the data folder
|
|
393
346
|
* @internal
|
|
394
347
|
*/
|
|
395
348
|
static deleteTxnDataFolder(db: BriefcaseDb, txnId: string): void;
|
|
396
349
|
/**
|
|
397
350
|
* Deletes rebase folders for semantic rebase
|
|
398
|
-
* @param db The
|
|
351
|
+
* @param db The [BriefcaseDb]($backend) instance for which to delete the rebase folders.
|
|
399
352
|
* @param checkIfEmpty If true, only deletes the base folder if it is empty, default is false
|
|
400
353
|
* @internal
|
|
401
354
|
*/
|
|
@@ -408,5 +361,4 @@ export declare class BriefcaseManager {
|
|
|
408
361
|
*/
|
|
409
362
|
private static cleanupRebaseFolders;
|
|
410
363
|
}
|
|
411
|
-
export {};
|
|
412
364
|
//# sourceMappingURL=BriefcaseManager.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EACL,WAAW,EAAE,UAAU,EAA6B,UAAU,
|
|
1
|
+
{"version":3,"file":"BriefcaseManager.d.ts","sourceRoot":"","sources":["../../src/BriefcaseManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,EACL,WAAW,EAAE,UAAU,EAA6B,UAAU,EAAmD,QAAQ,EAC1H,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,WAAW,EAAoB,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,cAAc,EAA6C,mBAAmB,EACrM,YAAY,EAAE,aAAa,EAAE,wBAAwB,EAEtD,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE9H,OAAO,EAAsC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAM7D,OAAO,EAAgB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAIxD;;EAEE;AACF,MAAM,WAAW,sBAAuB,SAAQ,QAAQ,EAAE,wBAAwB;IAChF;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,oFAAoF;IACpF,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;;OAIG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,8CAA8C;IAC9C,OAAO,EAAE,cAAc,CAAC;IACxB,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAgB;IAChB,gBAAuB,6BAA6B,+BAA+B;IAEnF,wFAAwF;WAC1E,aAAa,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAE/D,gBAAgB;WACF,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAEnE,gBAAgB;WACF,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAEzE,gBAAgB;WACF,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,aAAa;IAE7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,gGAAgG;WAClF,oBAAoB,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;IAItE;;;;OAIG;WACW,WAAW,CAAC,SAAS,EAAE,cAAc,GAAG,aAAa;IAInE,OAAO,CAAC,MAAM,CAAC,aAAa;IAK5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAU;IACtC;;;;OAIG;WACW,UAAU,CAAC,YAAY,EAAE,YAAY;IAQnD,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB;;;;OAIG;WACW,mBAAmB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,mBAAmB,EAAE;IA8B/E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAe;IACvC,qDAAqD;IACrD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;OAEG;WACW,kBAAkB,CAAC,EAAE,EAAE,WAAW;IAIhD;;;OAGG;WACiB,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+DhG;;OAEG;WACW,6BAA6B,CAAC,QAAQ,EAAE,MAAM;IAK5D;;;OAGG;WACiB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxG;;;;;;OAMG;WACiB,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuC3G;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAUzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAclC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAenC;;OAEG;WACiB,kBAAkB,CAAC,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAIrG;;OAEG;WACiB,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI7F,4EAA4E;WACxD,cAAc,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzH,gFAAgF;WAC5D,eAAe,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIpH,wEAAwE;WACpD,kBAAkB,CAAC,GAAG,EAAE;QAAE,QAAQ,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9F;;;OAGG;WACiB,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI1F;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;mBAajB,oBAAoB;IAWzC,gBAAgB;WACI,qBAAqB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD9F;;;;;;;;;;;;;;OAcG;WACiB,sBAAsB,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAuI7F;;;;;;;OAOG;WACiB,kBAAkB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAW1F;;;;;;OAMG;WACW,gBAAgB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAanE;;;;;;;OAOG;WACW,oBAAoB,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAiB1E,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAOlC;;;;;;OAMG;WACiB,YAAY,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9E,4EAA4E;mBACvD,WAAW;IAuDhC;;OAEG;WACiB,aAAa,CAAC,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAe;IACtD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAQ;IACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAa;IACnD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAU;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAe;IAErD;;;;;;OAMG;WACW,sCAAsC,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,CAAC,cAAc,CAAC,GAAG,IAAI;IAqB7I;;;;;OAKG;WACW,sCAAsC,CAAC,EAAE,EAAE,WAAW,GAAG,MAAM;IAI7E;;;;;;OAMG;WACW,6BAA6B,CAAC,CAAC,SAAS,aAAa,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,GAAG,IAAI;IAwB3I;;;;;;OAMG;WACW,gBAAgB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;IAMxE;;;;;;OAMG;WACkB,6BAA6B,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,cAAc,CAAC;IAWlH;;;;;;OAMG;WACW,gCAAgC,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAMvF;;;;;;OAMG;WACW,8BAA8B,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAMrF;;;;;OAKG;WACW,qBAAqB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAazE;;;;;MAKE;WACY,mBAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAavE;;;;;OAKG;WACW,mBAAmB,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,GAAE,OAAe,GAAG,IAAI;IAiBvF;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAapC"}
|
|
@@ -6,58 +6,6 @@
|
|
|
6
6
|
/** @packageDocumentation
|
|
7
7
|
* @module iModels
|
|
8
8
|
*/
|
|
9
|
-
var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
|
|
10
|
-
if (value !== null && value !== void 0) {
|
|
11
|
-
if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
|
|
12
|
-
var dispose, inner;
|
|
13
|
-
if (async) {
|
|
14
|
-
if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
|
|
15
|
-
dispose = value[Symbol.asyncDispose];
|
|
16
|
-
}
|
|
17
|
-
if (dispose === void 0) {
|
|
18
|
-
if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
|
|
19
|
-
dispose = value[Symbol.dispose];
|
|
20
|
-
if (async) inner = dispose;
|
|
21
|
-
}
|
|
22
|
-
if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
|
|
23
|
-
if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
|
|
24
|
-
env.stack.push({ value: value, dispose: dispose, async: async });
|
|
25
|
-
}
|
|
26
|
-
else if (async) {
|
|
27
|
-
env.stack.push({ async: true });
|
|
28
|
-
}
|
|
29
|
-
return value;
|
|
30
|
-
};
|
|
31
|
-
var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
|
|
32
|
-
return function (env) {
|
|
33
|
-
function fail(e) {
|
|
34
|
-
env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
|
|
35
|
-
env.hasError = true;
|
|
36
|
-
}
|
|
37
|
-
var r, s = 0;
|
|
38
|
-
function next() {
|
|
39
|
-
while (r = env.stack.pop()) {
|
|
40
|
-
try {
|
|
41
|
-
if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
|
|
42
|
-
if (r.dispose) {
|
|
43
|
-
var result = r.dispose.call(r.value);
|
|
44
|
-
if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
|
|
45
|
-
}
|
|
46
|
-
else s |= 1;
|
|
47
|
-
}
|
|
48
|
-
catch (e) {
|
|
49
|
-
fail(e);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
|
|
53
|
-
if (env.hasError) throw env.error;
|
|
54
|
-
}
|
|
55
|
-
return next();
|
|
56
|
-
};
|
|
57
|
-
})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
|
|
58
|
-
var e = new Error(message);
|
|
59
|
-
return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
|
|
60
|
-
});
|
|
61
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
62
10
|
exports.BriefcaseManager = void 0;
|
|
63
11
|
// cspell:ignore cset csets ecchanges
|
|
@@ -74,8 +22,6 @@ const SchemaSync_1 = require("./SchemaSync");
|
|
|
74
22
|
const Symbols_1 = require("./internal/Symbols");
|
|
75
23
|
const NativePlatform_1 = require("./internal/NativePlatform");
|
|
76
24
|
const StashManager_1 = require("./StashManager");
|
|
77
|
-
const ChangesetECAdaptor_1 = require("./ChangesetECAdaptor");
|
|
78
|
-
const SqliteChangesetReader_1 = require("./SqliteChangesetReader");
|
|
79
25
|
const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelDb;
|
|
80
26
|
/** Manages downloading Briefcases and downloading and uploading changesets.
|
|
81
27
|
* @public
|
|
@@ -531,11 +477,8 @@ class BriefcaseManager {
|
|
|
531
477
|
}
|
|
532
478
|
if (!reverse) {
|
|
533
479
|
if (briefcaseDb) {
|
|
534
|
-
if (useSemanticRebase) {
|
|
535
|
-
this.capturePatchInstances(briefcaseDb);
|
|
536
|
-
}
|
|
537
480
|
briefcaseDb.txns.rebaser.notifyReverseLocalChangesBegin();
|
|
538
|
-
const reversedTxns = nativeDb.pullMergeReverseLocalChanges();
|
|
481
|
+
const reversedTxns = nativeDb.pullMergeReverseLocalChanges(useSemanticRebase);
|
|
539
482
|
if (useSemanticRebase) {
|
|
540
483
|
nativeDb.clearECDbCache(); // Clear the ECDb cache after reversing local changes to ensure consistency during semantic rebase with schema changes.
|
|
541
484
|
}
|
|
@@ -760,101 +703,11 @@ class BriefcaseManager {
|
|
|
760
703
|
static SCHEMAS_FOLDER = "schemas";
|
|
761
704
|
static DATA_FOLDER = "data";
|
|
762
705
|
static DATA_FILE_NAME = "data.json";
|
|
763
|
-
/**
|
|
764
|
-
* Captures the changed instances as patch instances from each data txn in the briefcase db for semantic rebase
|
|
765
|
-
* @param db The {@link BriefcaseDb} instance for which to capture the changed instances as patch instances for all data txns
|
|
766
|
-
* @internal
|
|
767
|
-
*/
|
|
768
|
-
static capturePatchInstances(db) {
|
|
769
|
-
const txns = Array.from(db.txns.queryTxns());
|
|
770
|
-
txns.forEach((txn) => {
|
|
771
|
-
if (txn.type !== "Data")
|
|
772
|
-
return;
|
|
773
|
-
// already captured(This actually shows that first rebase operation is already done but during that while reinstating this txns,
|
|
774
|
-
// some error happened so the folder still exists so we don't want to capture again)
|
|
775
|
-
if (this.semanticRebaseDataFolderExists(db, txn.id))
|
|
776
|
-
return;
|
|
777
|
-
const changedInstances = this.captureChangedInstancesAsJSON(db, txn.id);
|
|
778
|
-
const instancePatches = this.constructPatchInstances(db, changedInstances);
|
|
779
|
-
this.storeChangedInstancesForSemanticRebase(db, txn.id, instancePatches);
|
|
780
|
-
});
|
|
781
|
-
}
|
|
782
|
-
/**
|
|
783
|
-
* Captures changed instances from a txn as JSON
|
|
784
|
-
* @param txnId The txn id for which to capture changed instances
|
|
785
|
-
* @param db The {@link BriefcaseDb} instance from which to capture changed instances as json
|
|
786
|
-
* @returns changed instances for semantic rebase
|
|
787
|
-
* @internal
|
|
788
|
-
*/
|
|
789
|
-
static captureChangedInstancesAsJSON(db, txnId) {
|
|
790
|
-
const env_1 = { stack: [], error: void 0, hasError: false };
|
|
791
|
-
try {
|
|
792
|
-
const reader = SqliteChangesetReader_1.SqliteChangesetReader.openTxn({
|
|
793
|
-
txnId, db, disableSchemaCheck: true
|
|
794
|
-
});
|
|
795
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
796
|
-
const adaptor = new ChangesetECAdaptor_1.ChangesetECAdaptor(reader);
|
|
797
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
798
|
-
const indirectUnifier = __addDisposableResource(env_1, new ChangesetECAdaptor_1.PartialECChangeUnifier(reader.db, ChangesetECAdaptor_1.ECChangeUnifierCache.createInMemoryCache()), false);
|
|
799
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
800
|
-
const directUnifier = __addDisposableResource(env_1, new ChangesetECAdaptor_1.PartialECChangeUnifier(reader.db, ChangesetECAdaptor_1.ECChangeUnifierCache.createInMemoryCache()), false);
|
|
801
|
-
while (adaptor.step()) {
|
|
802
|
-
if (adaptor.reader.isIndirect)
|
|
803
|
-
indirectUnifier.appendFrom(adaptor); // eslint-disable-line @typescript-eslint/no-deprecated
|
|
804
|
-
else
|
|
805
|
-
directUnifier.appendFrom(adaptor); // eslint-disable-line @typescript-eslint/no-deprecated
|
|
806
|
-
}
|
|
807
|
-
return [...Array.from(directUnifier.instances).map((instance) => ({ isIndirect: false, instance })), ...Array.from(indirectUnifier.instances).map((instance) => ({ isIndirect: true, instance }))]; // eslint-disable-line @typescript-eslint/no-deprecated
|
|
808
|
-
}
|
|
809
|
-
catch (e_1) {
|
|
810
|
-
env_1.error = e_1;
|
|
811
|
-
env_1.hasError = true;
|
|
812
|
-
}
|
|
813
|
-
finally {
|
|
814
|
-
__disposeResources(env_1);
|
|
815
|
-
}
|
|
816
|
-
}
|
|
817
|
-
/**
|
|
818
|
-
* Constructs patch instances from changed instances
|
|
819
|
-
* @param changedInstances The changed instances from which to construct the patch instances
|
|
820
|
-
* @param db The {@link BriefcaseDb} instance for which to construct the patch instances
|
|
821
|
-
* @returns The {@link InstancePatch} instance patches for semantic rebase
|
|
822
|
-
* @internal
|
|
823
|
-
*/
|
|
824
|
-
static constructPatchInstances(db, changedInstances) {
|
|
825
|
-
return changedInstances
|
|
826
|
-
.filter((changedInstance) => !(changedInstance.instance.$meta?.op === "Updated" && changedInstance.instance.$meta.stage === "Old")) // we will not take the old stage of updated instances
|
|
827
|
-
.map((changedInstance) => this.constructPatchInstance(db, changedInstance));
|
|
828
|
-
}
|
|
829
|
-
/**
|
|
830
|
-
* Constructs a single patch instance from changed instance
|
|
831
|
-
* @param changedInstance The changed instance from which to construct the patch instance
|
|
832
|
-
* @param db The {@link BriefcaseDb} instance for which to construct the single patch instance
|
|
833
|
-
* @returns a single instance patch {@link InstancePatch}
|
|
834
|
-
* @throws IModelError If cannot determine classId or unknown operation encountered
|
|
835
|
-
*/
|
|
836
|
-
static constructPatchInstance(db, changedInstance) {
|
|
837
|
-
const className = (changedInstance.instance.ECClassId && db.getClassNameFromId(changedInstance.instance.ECClassId))
|
|
838
|
-
?? changedInstance.instance.$meta?.classFullName
|
|
839
|
-
?? (changedInstance.instance.$meta?.fallbackClassId && db.getClassNameFromId(changedInstance.instance.$meta.fallbackClassId));
|
|
840
|
-
if (!className)
|
|
841
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Cannot determine classId of changed instance");
|
|
842
|
-
const instanceKey = { id: changedInstance.instance.ECInstanceId, classFullName: className };
|
|
843
|
-
const op = changedInstance.instance.$meta?.op;
|
|
844
|
-
if (op !== "Inserted" && op !== "Updated" && op !== "Deleted")
|
|
845
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `Unknown operation: ${op}`);
|
|
846
|
-
return {
|
|
847
|
-
key: instanceKey,
|
|
848
|
-
op,
|
|
849
|
-
isIndirect: changedInstance.isIndirect,
|
|
850
|
-
props: op !== "Deleted" ? db[Symbols_1._nativeDb].readInstance(instanceKey, { useJsNames: true }) : undefined,
|
|
851
|
-
};
|
|
852
|
-
}
|
|
853
706
|
/**
|
|
854
707
|
* Stores changed instances for semantic rebase locally in appropriate json file in a folder structure
|
|
855
|
-
* @param db The
|
|
708
|
+
* @param db The [BriefcaseDb]($backend) instance for storing the changed instances against a txn
|
|
856
709
|
* @param txnId The txn id for which we are storing the changed instances
|
|
857
|
-
* @param instancePatches The
|
|
710
|
+
* @param instancePatches The [ChangeInstance]($backend) instance patches to be stored
|
|
858
711
|
* @internal
|
|
859
712
|
*/
|
|
860
713
|
static storeChangedInstancesForSemanticRebase(db, txnId, instancePatches) {
|
|
@@ -864,7 +717,17 @@ class BriefcaseManager {
|
|
|
864
717
|
if (IModelJsFs_1.IModelJsFs.existsSync(targetDir))
|
|
865
718
|
IModelJsFs_1.IModelJsFs.removeSync(targetDir);
|
|
866
719
|
IModelJsFs_1.IModelJsFs.recursiveMkDirSync(targetDir);
|
|
867
|
-
IModelJsFs_1.IModelJsFs.writeFileSync(filePath,
|
|
720
|
+
IModelJsFs_1.IModelJsFs.writeFileSync(filePath, "[");
|
|
721
|
+
let isFirst = true;
|
|
722
|
+
for (const instancePatch of instancePatches) {
|
|
723
|
+
// we will not take the old stage of updated instances for now, because we still don't have conflict resolution on instance level while using semantic rebase.
|
|
724
|
+
// Once we have conflict resolution on instance level, we can consider taking old stage of updated instances as well.
|
|
725
|
+
if (instancePatch.$meta.op === "Updated" && instancePatch.$meta.stage === "Old")
|
|
726
|
+
continue;
|
|
727
|
+
IModelJsFs_1.IModelJsFs.appendFileSync(filePath, `${isFirst ? "" : ","}\n${JSON.stringify(instancePatch, core_common_1.Base64EncodedString.replacer)}`);
|
|
728
|
+
isFirst = false;
|
|
729
|
+
}
|
|
730
|
+
IModelJsFs_1.IModelJsFs.appendFileSync(filePath, "\n]");
|
|
868
731
|
}
|
|
869
732
|
/**
|
|
870
733
|
* Gets the base path for semantic rebase local files
|
|
@@ -877,7 +740,7 @@ class BriefcaseManager {
|
|
|
877
740
|
}
|
|
878
741
|
/**
|
|
879
742
|
* Stores schemas for semantic rebase locally in appropriate folder structure
|
|
880
|
-
* @param db The
|
|
743
|
+
* @param db The [BriefcaseDb]($backend) instance for storing the schemas against a txn
|
|
881
744
|
* @param txnId The txn id for which we are storing the schemas
|
|
882
745
|
* @param schemaFileNames The schema file paths or schema xml strings to be stored
|
|
883
746
|
* @internal
|
|
@@ -903,7 +766,7 @@ class BriefcaseManager {
|
|
|
903
766
|
}
|
|
904
767
|
/**
|
|
905
768
|
* Gets schemas for semantic rebase for a txn
|
|
906
|
-
* @param db The
|
|
769
|
+
* @param db The [BriefcaseDb]($backend) instance for getting the locally stored schemas against a txn
|
|
907
770
|
* @param txnId The txn id for which we are getting the schemas
|
|
908
771
|
* @returns the schema file paths
|
|
909
772
|
* @internal
|
|
@@ -915,21 +778,25 @@ class BriefcaseManager {
|
|
|
915
778
|
}
|
|
916
779
|
/**
|
|
917
780
|
* Get the changed instances data for semantic rebase for a txn
|
|
918
|
-
* @param db - The
|
|
781
|
+
* @param db - The [BriefcaseDb]($backend) instance for getting the locally stored changed instances against a txn
|
|
919
782
|
* @param txnId - The txn id for which we are getting the changed instances
|
|
920
783
|
* @returns Instance patches
|
|
921
784
|
* @internal
|
|
922
785
|
*/
|
|
923
|
-
static getChangedInstancesDataForTxn(db, txnId) {
|
|
786
|
+
static async *getChangedInstancesDataForTxn(db, txnId) {
|
|
924
787
|
const basePath = BriefcaseManager.getBasePathForSemanticRebaseLocalFiles(db);
|
|
925
788
|
const folderPath = path.join(basePath, txnId, BriefcaseManager.DATA_FOLDER);
|
|
926
789
|
const filePath = path.join(folderPath, BriefcaseManager.DATA_FILE_NAME);
|
|
927
|
-
const
|
|
928
|
-
|
|
790
|
+
for await (const line of IModelJsFs_1.IModelJsFs.readLines(filePath)) {
|
|
791
|
+
if (line === "[" || line === "]" || line === "")
|
|
792
|
+
continue;
|
|
793
|
+
const trimmedLine = line.trim().endsWith(",") ? line.trim().slice(0, -1) : line.trim(); // remove trailing comma if exists
|
|
794
|
+
yield JSON.parse(trimmedLine, core_common_1.Base64EncodedString.reviver);
|
|
795
|
+
}
|
|
929
796
|
}
|
|
930
797
|
/**
|
|
931
798
|
* Checks if schema folder exists for semantic rebase for a txn
|
|
932
|
-
* @param db - The
|
|
799
|
+
* @param db - The [BriefcaseDb]($backend) instance for which TO check the schema folder
|
|
933
800
|
* @param txnId - The txn id for which we are check the schema folder
|
|
934
801
|
* @returns true if exists, false otherwise
|
|
935
802
|
* @internal
|
|
@@ -941,7 +808,7 @@ class BriefcaseManager {
|
|
|
941
808
|
}
|
|
942
809
|
/**
|
|
943
810
|
* Checks if data folder exists for semantic rebase for a txn
|
|
944
|
-
* @param db The
|
|
811
|
+
* @param db The [BriefcaseDb]($backend) instance for which to check the data folder.
|
|
945
812
|
* @param txnId The txn id for which to check the data folder
|
|
946
813
|
* @returns true if exists, false otherwise
|
|
947
814
|
* @internal
|
|
@@ -953,7 +820,7 @@ class BriefcaseManager {
|
|
|
953
820
|
}
|
|
954
821
|
/**
|
|
955
822
|
* Deletes the schema folder for semantic rebase for a txn
|
|
956
|
-
* @param db The
|
|
823
|
+
* @param db The [BriefcaseDb]($backend) instance for which to delete the schema folder.
|
|
957
824
|
* @param txnId The txn id for which to delete the schema folder
|
|
958
825
|
* @internal
|
|
959
826
|
*/
|
|
@@ -969,7 +836,7 @@ class BriefcaseManager {
|
|
|
969
836
|
}
|
|
970
837
|
/**
|
|
971
838
|
* Deletes the data folder for semantic rebase for a txn
|
|
972
|
-
* @param db The
|
|
839
|
+
* @param db The [BriefcaseDb]($backend) instance for which to delete the data folder.
|
|
973
840
|
* @param txnId The txn id for which to delete the data folder
|
|
974
841
|
* @internal
|
|
975
842
|
*/
|
|
@@ -985,7 +852,7 @@ class BriefcaseManager {
|
|
|
985
852
|
}
|
|
986
853
|
/**
|
|
987
854
|
* Deletes rebase folders for semantic rebase
|
|
988
|
-
* @param db The
|
|
855
|
+
* @param db The [BriefcaseDb]($backend) instance for which to delete the rebase folders.
|
|
989
856
|
* @param checkIfEmpty If true, only deletes the base folder if it is empty, default is false
|
|
990
857
|
* @internal
|
|
991
858
|
*/
|