@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/ChangedElementsDb.js

@@ -0,0 +1,165 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ChangedElementsDb
+ */
+import { DbResult, IModelStatus, OpenMode } from "@itwin/core-bentley";
+import { IModelError } from "@itwin/core-common";
+import { BriefcaseManager } from "./BriefcaseManager";
+import { ECDbOpenMode } from "./ECDb";
+import { IModelHost } from "./IModelHost";
+import { IModelNative } from "./internal/NativePlatform";
+import { _hubAccess, _nativeDb } from "./internal/Symbols";
+/** An ChangedElementsDb file
+ * @internal
+ */
+export class ChangedElementsDb {
+    _nativeDb;
+    constructor() {
+        this._nativeDb = new IModelNative.platform.ChangedElementsECDb();
+    }
+    [Symbol.dispose]() {
+        if (!this._nativeDb)
+            return;
+        this.closeDb();
+        this._nativeDb.dispose();
+        this._nativeDb = undefined;
+    }
+    /** Create a ChangedElementsDb
+     * @param pathName The path to the ECDb file to create.
+     * @throws [IModelError]($common) if the operation failed.
+     */
+    _createDb(briefcase, pathName) {
+        const status = this.nativeDb.createDb(briefcase[_nativeDb], pathName);
+        if (status !== DbResult.BE_SQLITE_OK)
+            throw new IModelError(status, "Failed to created ECDb");
+    }
+    /** Open the Changed Elements Db.
+     * @param pathName The path to the ECDb file to open
+     * @param openMode Open mode
+     * @throws [IModelError]($common) if the operation failed.
+     */
+    _openDb(pathName, openMode = ECDbOpenMode.Readonly) {
+        const nativeOpenMode = openMode === ECDbOpenMode.Readonly ? OpenMode.Readonly : OpenMode.ReadWrite;
+        const tryUpgrade = openMode === ECDbOpenMode.FileUpgrade;
+        const status = this.nativeDb.openDb(pathName, nativeOpenMode, tryUpgrade);
+        if (status !== DbResult.BE_SQLITE_OK)
+            throw new IModelError(status, "Failed to open ECDb");
+    }
+    /** Open the Changed Elements Db.
+     * @param pathName The path to the ECDb file to open
+     * @param openMode Open mode
+     * @returns ChangedElementsDb
+     */
+    static openDb(pathName, openMode = ECDbOpenMode.Readonly) {
+        const cacheDb = new ChangedElementsDb();
+        cacheDb._openDb(pathName, openMode);
+        return cacheDb;
+    }
+    /** Create the changed elements cache db
+     * @param briefcase IModelDb to use
+     * @param pathName The path to the ECDb file to create.
+     * @returns The new cache db
+     */
+    static createDb(briefcase, pathName) {
+        const cacheDb = new ChangedElementsDb();
+        cacheDb._createDb(briefcase, pathName);
+        return cacheDb;
+    }
+    /** Processes a range of changesets and adds it to the changed elements cache
+     * @param briefcase iModel briefcase to use
+     * @param options Options for processing
+     */
+    async processChangesets(accessToken, briefcase, options) {
+        const iModelId = briefcase.iModelId;
+        const first = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.startChangesetId }, accessToken })).index;
+        const end = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.endChangesetId }, accessToken })).index;
+        const changesets = await IModelHost[_hubAccess].downloadChangesets({ accessToken, iModelId, range: { first, end }, targetDir: BriefcaseManager.getChangeSetsPath(iModelId) });
+        // ChangeSets need to be processed from newest to oldest
+        changesets.reverse();
+        const status = this.nativeDb.processChangesets(briefcase[_nativeDb], changesets, options.rulesetId, options.filterSpatial, options.wantParents, options.wantPropertyChecksums, options.rulesetDir, options.tempDir, options.wantChunkTraversal);
+        if (status !== DbResult.BE_SQLITE_OK)
+            throw new IModelError(status, "Failed to process changesets");
+        return status;
+    }
+    /** Processes a range of changesets and adds it to the changed elements cache
+     * This call will close the IModelDb object as it is required for processing and applying changesets
+     * @param briefcase iModel briefcase to use
+     * @param options options for processing
+     */
+    async processChangesetsAndRoll(accessToken, briefcase, options) {
+        const iModelId = briefcase.iModelId;
+        const first = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.startChangesetId }, accessToken })).index;
+        const end = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.endChangesetId }, accessToken })).index;
+        const changesets = await IModelHost[_hubAccess].downloadChangesets({ accessToken, iModelId, range: { first, end }, targetDir: BriefcaseManager.getChangeSetsPath(iModelId) });
+        // ChangeSets need to be processed from newest to oldest
+        changesets.reverse();
+        // Close briefcase before doing processing and rolling briefcase
+        const dbFilename = briefcase.pathName;
+        const dbGuid = briefcase.iModelId;
+        briefcase.close();
+        // Process changesets
+        const status = this.nativeDb.processChangesetsAndRoll(dbFilename, dbGuid, changesets, options.rulesetId, options.filterSpatial, options.wantParents, options.wantPropertyChecksums, options.rulesetDir, options.tempDir, options.wantRelationshipCaching, options.relationshipCacheSize, options.wantChunkTraversal, options.wantBoundingBoxes);
+        if (status !== DbResult.BE_SQLITE_OK)
+            throw new IModelError(status, "Failed to process changesets");
+        return status;
+    }
+    /** Get changed elements between two changesets
+     * @param startChangesetId Start Changeset Id
+     * @param endChangesetId End Changeset Id
+     * @returns Returns the changed elements between the changesets provided
+     * @throws [IModelError]($common) if the operation failed.
+     */
+    getChangedElements(startChangesetId, endChangesetId) {
+        const result = this.nativeDb.getChangedElements(startChangesetId, endChangesetId);
+        if (result.error || !result.result)
+            throw new IModelError(result.error ? result.error.status : -1, result.error ? result.error.message : "Problem getting changed elements");
+        return (result.result.changedElements);
+    }
+    /** Get changed models between two changesets
+     * @param startChangesetId Start Changeset Id
+     * @param endChangesetId End Changeset Id
+     * @returns Returns the changed models between the changesets provided
+     * @throws [IModelError]($common) if the operation failed.
+     */
+    getChangedModels(startChangesetId, endChangesetId) {
+        const result = this.nativeDb.getChangedElements(startChangesetId, endChangesetId);
+        if (result.error || !result.result)
+            throw new IModelError(result.error ? result.error.status : -1, result.error ? result.error.message : "Problem getting changed models");
+        return (result.result.changedModels);
+    }
+    /** Get changed models between two changesets
+     * @param startChangesetId Start Changeset Id
+     * @param endChangesetId End Changeset Id
+     * @returns Returns the changed models between the changesets provided
+     * @throws [IModelError]($common) if the operation failed.
+     */
+    getChangeData(startChangesetId, endChangesetId) {
+        const result = this.nativeDb.getChangedElements(startChangesetId, endChangesetId);
+        if (result.error)
+            throw new IModelError(result.error.status, result.error.message);
+        return result.result;
+    }
+    /** Returns true if the Changed Elements Db is open */
+    get isOpen() { return this.nativeDb.isOpen(); }
+    /** Returns true if the cache already contains this changeset Id */
+    isProcessed(changesetId) { return this.nativeDb.isProcessed(changesetId); }
+    /** Close the Db after saving any uncommitted changes.
+     * @throws [IModelError]($common) if the database is not open.
+     */
+    closeDb() {
+        this.nativeDb.closeDb();
+    }
+    cleanCaches() {
+        this.nativeDb.cleanCaches();
+    }
+    /** @internal */
+    get nativeDb() {
+        if (!this._nativeDb)
+            throw new IModelError(IModelStatus.BadRequest, "ChangedElementsDb object has already been disposed.");
+        return this._nativeDb;
+    }
+}
+//# sourceMappingURL=ChangedElementsDb.js.map

package/lib/esm/ChangedElementsDb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangedElementsDb.js","sourceRoot":"","sources":["../../src/ChangedElementsDb.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAe,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAA8C,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE7F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAqB3D;;GAEG;AACH,MAAM,OAAO,iBAAiB;IACpB,SAAS,CAAiD;IAElE;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;IACnE,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACK,SAAS,CAAC,SAAmB,EAAE,QAAgB;QACrD,MAAM,MAAM,GAAa,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;QAChF,IAAI,MAAM,KAAK,QAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACK,OAAO,CAAC,QAAgB,EAAE,WAAyB,YAAY,CAAC,QAAQ;QAC9E,MAAM,cAAc,GAAG,QAAQ,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;QACnG,MAAM,UAAU,GAAG,QAAQ,KAAK,YAAY,CAAC,WAAW,CAAC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;QAC1E,IAAI,MAAM,KAAK,QAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,QAAgB,EAAE,WAAyB,YAAY,CAAC,QAAQ;QACnF,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACxC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,SAAmB,EAAE,QAAgB;QAC1D,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACxC,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACvC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,WAAwB,EAAE,SAAmB,EAAE,OAAgC;QAC5G,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QACpC,MAAM,KAAK,GAAG,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,gBAAgB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1I,MAAM,GAAG,GAAG,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACtI,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE9K,wDAAwD;QACxD,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAC5C,SAAS,CAAC,SAAS,CAAC,EACpB,UAAU,EACV,OAAO,CAAC,SAAS,EACjB,OAAO,CAAC,aAAa,EACrB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,qBAAqB,EAC7B,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,kBAAkB,CAC3B,CAAC;QACF,IAAI,MAAM,KAAK,QAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;QAChE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CAAC,WAAwB,EAAE,SAAmB,EAAE,OAAgC;QACnH,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QACpC,MAAM,KAAK,GAAG,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,gBAAgB,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC1I,MAAM,GAAG,GAAG,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACtI,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE9K,wDAAwD;QACxD,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,gEAAgE;QAChE,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC;QACtC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC;QAClC,SAAS,CAAC,KAAK,EAAE,CAAC;QAClB,qBAAqB;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CACnD,UAAU,EACV,MAAM,EACN,UAAU,EACV,OAAO,CAAC,SAAS,EACjB,OAAO,CAAC,aAAa,EACrB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,qBAAqB,EAC7B,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,qBAAqB,EAC7B,OAAO,CAAC,kBAAkB,EAC1B,OAAO,CAAC,iBAAiB,CAC1B,CAAC;QACF,IAAI,MAAM,KAAK,QAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;QAChE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,gBAAwB,EAAE,cAAsB;QACxE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QAClF,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM;YAChC,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,kCAAkC,CAAC,CAAC;QAC3I,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAoB,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,gBAAwB,EAAE,cAAsB;QACtE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QAClF,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM;YAChC,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,gCAAgC,CAAC,CAAC;QACzI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAkB,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,gBAAwB,EAAE,cAAsB;QACnE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QAClF,IAAI,MAAM,CAAC,KAAK;YACd,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC,MAAoB,CAAC;IACrC,CAAC;IAED,sDAAsD;IACtD,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/D,mEAAmE;IAC5D,WAAW,CAAC,WAAmB,IAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAEnG;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEM,WAAW;QAChB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAW,QAAQ;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,qDAAqD,CAAC,CAAC;QAExG,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CACF","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 ChangedElementsDb\n */\n\nimport { AccessToken, DbResult, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\nimport { ChangeData, ChangedElements, ChangedModels, IModelError } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { BriefcaseManager } from \"./BriefcaseManager\";\nimport { ECDbOpenMode } from \"./ECDb\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelHost } from \"./IModelHost\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _hubAccess, _nativeDb } from \"./internal/Symbols\";\n\n/**\n * Options for processChangesets function\n * @internal\n * */\nexport interface ProcessChangesetOptions {\n  startChangesetId: string;\n  endChangesetId: string;\n  rulesetId: string;\n  filterSpatial?: boolean;\n  wantParents?: boolean;\n  wantPropertyChecksums?: boolean;\n  rulesetDir?: string;\n  tempDir?: string;\n  wantRelationshipCaching?: boolean;\n  relationshipCacheSize?: number;\n  wantChunkTraversal?: boolean;\n  wantBoundingBoxes?: boolean;\n}\n\n/** An ChangedElementsDb file\n * @internal\n */\nexport class ChangedElementsDb implements Disposable {\n  private _nativeDb: IModelJsNative.ChangedElementsECDb | undefined;\n\n  constructor() {\n    this._nativeDb = new IModelNative.platform.ChangedElementsECDb();\n  }\n\n  public [Symbol.dispose](): void {\n    if (!this._nativeDb)\n      return;\n\n    this.closeDb();\n    this._nativeDb.dispose();\n    this._nativeDb = undefined;\n  }\n\n  /** Create a ChangedElementsDb\n   * @param pathName The path to the ECDb file to create.\n   * @throws [IModelError]($common) if the operation failed.\n   */\n  private _createDb(briefcase: IModelDb, pathName: string): void {\n    const status: DbResult = this.nativeDb.createDb(briefcase[_nativeDb], pathName);\n    if (status !== DbResult.BE_SQLITE_OK)\n      throw new IModelError(status, \"Failed to created ECDb\");\n  }\n\n  /** Open the Changed Elements Db.\n   * @param pathName The path to the ECDb file to open\n   * @param openMode Open mode\n   * @throws [IModelError]($common) if the operation failed.\n   */\n  private _openDb(pathName: string, openMode: ECDbOpenMode = ECDbOpenMode.Readonly): void {\n    const nativeOpenMode = openMode === ECDbOpenMode.Readonly ? OpenMode.Readonly : OpenMode.ReadWrite;\n    const tryUpgrade = openMode === ECDbOpenMode.FileUpgrade;\n    const status = this.nativeDb.openDb(pathName, nativeOpenMode, tryUpgrade);\n    if (status !== DbResult.BE_SQLITE_OK)\n      throw new IModelError(status, \"Failed to open ECDb\");\n  }\n\n  /** Open the Changed Elements Db.\n   * @param pathName The path to the ECDb file to open\n   * @param openMode Open mode\n   * @returns ChangedElementsDb\n   */\n  public static openDb(pathName: string, openMode: ECDbOpenMode = ECDbOpenMode.Readonly): ChangedElementsDb {\n    const cacheDb = new ChangedElementsDb();\n    cacheDb._openDb(pathName, openMode);\n    return cacheDb;\n  }\n\n  /** Create the changed elements cache db\n   * @param briefcase IModelDb to use\n   * @param pathName The path to the ECDb file to create.\n   * @returns The new cache db\n   */\n  public static createDb(briefcase: IModelDb, pathName: string): ChangedElementsDb {\n    const cacheDb = new ChangedElementsDb();\n    cacheDb._createDb(briefcase, pathName);\n    return cacheDb;\n  }\n\n  /** Processes a range of changesets and adds it to the changed elements cache\n   * @param briefcase iModel briefcase to use\n   * @param options Options for processing\n   */\n  public async processChangesets(accessToken: AccessToken, briefcase: IModelDb, options: ProcessChangesetOptions): Promise<DbResult> {\n    const iModelId = briefcase.iModelId;\n    const first = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.startChangesetId }, accessToken })).index;\n    const end = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.endChangesetId }, accessToken })).index;\n    const changesets = await IModelHost[_hubAccess].downloadChangesets({ accessToken, iModelId, range: { first, end }, targetDir: BriefcaseManager.getChangeSetsPath(iModelId) });\n\n    // ChangeSets need to be processed from newest to oldest\n    changesets.reverse();\n    const status = this.nativeDb.processChangesets(\n      briefcase[_nativeDb],\n      changesets,\n      options.rulesetId,\n      options.filterSpatial,\n      options.wantParents,\n      options.wantPropertyChecksums,\n      options.rulesetDir,\n      options.tempDir,\n      options.wantChunkTraversal,\n    );\n    if (status !== DbResult.BE_SQLITE_OK)\n      throw new IModelError(status, \"Failed to process changesets\");\n    return status;\n  }\n\n  /** Processes a range of changesets and adds it to the changed elements cache\n   * This call will close the IModelDb object as it is required for processing and applying changesets\n   * @param briefcase iModel briefcase to use\n   * @param options options for processing\n   */\n  public async processChangesetsAndRoll(accessToken: AccessToken, briefcase: IModelDb, options: ProcessChangesetOptions): Promise<DbResult> {\n    const iModelId = briefcase.iModelId;\n    const first = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.startChangesetId }, accessToken })).index;\n    const end = (await IModelHost[_hubAccess].queryChangeset({ iModelId, changeset: { id: options.endChangesetId }, accessToken })).index;\n    const changesets = await IModelHost[_hubAccess].downloadChangesets({ accessToken, iModelId, range: { first, end }, targetDir: BriefcaseManager.getChangeSetsPath(iModelId) });\n\n    // ChangeSets need to be processed from newest to oldest\n    changesets.reverse();\n    // Close briefcase before doing processing and rolling briefcase\n    const dbFilename = briefcase.pathName;\n    const dbGuid = briefcase.iModelId;\n    briefcase.close();\n    // Process changesets\n    const status = this.nativeDb.processChangesetsAndRoll(\n      dbFilename,\n      dbGuid,\n      changesets,\n      options.rulesetId,\n      options.filterSpatial,\n      options.wantParents,\n      options.wantPropertyChecksums,\n      options.rulesetDir,\n      options.tempDir,\n      options.wantRelationshipCaching,\n      options.relationshipCacheSize,\n      options.wantChunkTraversal,\n      options.wantBoundingBoxes,\n    );\n    if (status !== DbResult.BE_SQLITE_OK)\n      throw new IModelError(status, \"Failed to process changesets\");\n    return status;\n  }\n\n  /** Get changed elements between two changesets\n   * @param startChangesetId Start Changeset Id\n   * @param endChangesetId End Changeset Id\n   * @returns Returns the changed elements between the changesets provided\n   * @throws [IModelError]($common) if the operation failed.\n   */\n  public getChangedElements(startChangesetId: string, endChangesetId: string): ChangedElements | undefined {\n    const result = this.nativeDb.getChangedElements(startChangesetId, endChangesetId);\n    if (result.error || !result.result)\n      throw new IModelError(result.error ? result.error.status : -1, result.error ? result.error.message : \"Problem getting changed elements\");\n    return (result.result.changedElements) as ChangedElements;\n  }\n\n  /** Get changed models between two changesets\n   * @param startChangesetId Start Changeset Id\n   * @param endChangesetId End Changeset Id\n   * @returns Returns the changed models between the changesets provided\n   * @throws [IModelError]($common) if the operation failed.\n   */\n  public getChangedModels(startChangesetId: string, endChangesetId: string): ChangedModels | undefined {\n    const result = this.nativeDb.getChangedElements(startChangesetId, endChangesetId);\n    if (result.error || !result.result)\n      throw new IModelError(result.error ? result.error.status : -1, result.error ? result.error.message : \"Problem getting changed models\");\n    return (result.result.changedModels) as ChangedModels;\n  }\n\n  /** Get changed models between two changesets\n   * @param startChangesetId Start Changeset Id\n   * @param endChangesetId End Changeset Id\n   * @returns Returns the changed models between the changesets provided\n   * @throws [IModelError]($common) if the operation failed.\n   */\n  public getChangeData(startChangesetId: string, endChangesetId: string): ChangeData | undefined {\n    const result = this.nativeDb.getChangedElements(startChangesetId, endChangesetId);\n    if (result.error)\n      throw new IModelError(result.error.status, result.error.message);\n    return result.result as ChangeData;\n  }\n\n  /** Returns true if the Changed Elements Db is open */\n  public get isOpen(): boolean { return this.nativeDb.isOpen(); }\n\n  /** Returns true if the cache already contains this changeset Id */\n  public isProcessed(changesetId: string): boolean { return this.nativeDb.isProcessed(changesetId); }\n\n  /** Close the Db after saving any uncommitted changes.\n   * @throws [IModelError]($common) if the database is not open.\n   */\n  public closeDb(): void {\n    this.nativeDb.closeDb();\n  }\n\n  public cleanCaches(): void {\n    this.nativeDb.cleanCaches();\n  }\n\n  /** @internal */\n  public get nativeDb(): IModelJsNative.ChangedElementsECDb {\n    if (!this._nativeDb)\n      throw new IModelError(IModelStatus.BadRequest, \"ChangedElementsDb object has already been disposed.\");\n\n    return this._nativeDb;\n  }\n}\n"]}

package/lib/esm/ChangesetECAdaptor.d.ts

@@ -0,0 +1,203 @@
+/** @packageDocumentation
+ * @module ECDb
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { SqliteChangeOp, SqliteChangesetReader, SqliteValueStage } from "./SqliteChangesetReader";
+/**
+ * Record meta data for the change.
+ * @beta
+ * */
+export interface ChangeMetaData {
+    /** list of tables making up this EC change */
+    tables: string[];
+    /** full name of the class of this EC change */
+    classFullName?: string;
+    /** sqlite operation that caused the change */
+    op: SqliteChangeOp;
+    /** version of the value read from sqlite change */
+    stage: SqliteValueStage;
+    /** if classId for the change was not found in db then fallback class for the table */
+    fallbackClassId?: Id64String;
+    /** list of change index making up this change (one per table) */
+    changeIndexes: number[];
+}
+/**
+ * Represent EC change derived from low level sqlite change
+ * @beta
+ */
+export interface ChangedECInstance {
+    ECInstanceId: Id64String;
+    ECClassId?: Id64String;
+    $meta?: ChangeMetaData;
+    [key: string]: any;
+}
+/**
+ * Combine partial changed instance into single instance.
+ * Partial changes is per table and a single instance can
+ * span multiple tables.
+ * @beta
+ */
+export declare class PartialECChangeUnifier {
+    private _cache;
+    private _readonly;
+    /**
+     * Get root class id for a given class
+     * @param classId given class id
+     * @param db use to find root class
+     * @returns return root class id
+     */
+    private static getRootClassId;
+    /**
+     * Combine partial instance with instance with same key if already exists.
+     * @param rhs partial instance
+     */
+    private combine;
+    /**
+     * Build key from EC change.
+     * @param change EC change
+     * @returns key created from EC change.
+     */
+    private static buildKey;
+    /**
+     * Append partial changes which will be combine using there instance key.
+     * @note $meta property must be present on partial change as information
+     * in it is used to combine partial instances.
+     * @param adaptor changeset adaptor is use to read the partial EC change.
+     * @beta
+     */
+    appendFrom(adaptor: ChangesetECAdaptor): void;
+    /**
+     * Delete $meta from all the instances.
+     */
+    stripMetaData(): void;
+    /**
+     * Returns complete EC change instances.
+     * @beta
+     */
+    get instances(): IterableIterator<ChangedECInstance>;
+}
+/**
+ * Transform sqlite change to ec change. EC change is partial change as
+ * it is per table while a single instance can span multiple table.
+ * @note PrimitiveArray and StructArray are not supported types.
+ * @beta
+ *
+*/
+export declare class ChangesetECAdaptor implements Disposable {
+    readonly reader: SqliteChangesetReader;
+    readonly disableMetaData: boolean;
+    private readonly _mapCache;
+    private readonly _tableFilter;
+    private readonly _opFilter;
+    private readonly _classFilter;
+    private _allowedClasses;
+    /**
+     * set debug flags
+     */
+    readonly debugFlags: {
+        replaceBlobWithEllipsis: boolean;
+        replaceGeomWithEllipsis: boolean;
+        replaceGuidWithEllipsis: boolean;
+    };
+    /**
+     * Return partial inserted instance
+     * For updates inserted represent new version of instance after update.
+     */
+    inserted?: ChangedECInstance;
+    /**
+     * Return partial deleted instance.
+     * For updates deleted represent old version of instance before update.
+     */
+    deleted?: ChangedECInstance;
+    /**
+     * Setup filter that will result in change enumeration restricted to
+     * list of tables added by acceptTable().
+     * @param table Name of the table
+     * @returns Fluent reference to ChangesetAdaptor.
+     */
+    acceptTable(table: string): ChangesetECAdaptor;
+    /**
+     * Setup filter that will result in change enumeration restricted to
+     * list of op added by acceptOp().
+     * @param op
+     * @returns Fluent reference to ChangesetAdaptor.
+     */
+    acceptOp(op: SqliteChangeOp): ChangesetECAdaptor;
+    /**
+     * Setup filter that will result in change enumeration restricted to
+     * list of class and its derived classes added by acceptClass().
+     * @param classFullName
+     * @returns
+     */
+    acceptClass(classFullName: string): ChangesetECAdaptor;
+    private buildClassFilter;
+    /**
+     * Construct adaptor with a initialized reader.
+     * @note the changeset reader must have disableSchemaCheck
+     * set to false and db must also be set.
+     * @param reader wrap changeset reader.
+     */
+    constructor(reader: SqliteChangesetReader, disableMetaData?: boolean);
+    /**
+     * dispose current instance and it will also dispose the changeset reader.
+     */
+    [Symbol.dispose](): void;
+    /**
+     * close current instance and it will also close the changeset reader.
+     */
+    close(): void;
+    /**
+     * Convert binary GUID into string GUID.
+     * @param binaryGUID binary version of guid.
+     * @returns GUID string.
+     */
+    private static convertBinaryToGuid;
+    /**
+     * Set value use access string in a JS object.
+     * @param targetObj object that will be updated.
+     * @param accessString access string token separated by '.'.
+     */
+    private static setValue;
+    /**
+     * Check if sqlite change table is a EC data table
+     * @param tableName name of the table.
+     * @returns true if table has EC data.
+     */
+    isECTable(tableName: string): boolean;
+    /**
+     * Attempt find ECClassId from ECInstanceId for a change of type 'updated'.
+     * @param tableName name of the table to find ECClassId from given ECInstanceId
+     * @param instanceId instance id for which we need ECClassId for.
+     * @returns if successful returns ECClassId else return undefined.
+     */
+    private getClassIdFromDb;
+    /** helper method around reader.op */
+    get op(): SqliteChangeOp;
+    /** Return true if current change is of type "Inserted" */
+    get isInserted(): boolean;
+    /** Return true if current change is of type "Deleted" */
+    get isDeleted(): boolean;
+    /** Return true if current change is of type "Updated" */
+    get isUpdated(): boolean;
+    /**
+     * Advance reader to next change or a change that meets the filter set in the current adaptor
+     * @returns return false if no more changes to read.
+     */
+    step(): boolean;
+    /**
+     * Transform nav change column into navigation EC property
+     * @param prop navigation property definition.
+     * @param change sqlite change.
+     * @param out ec instance that will be updated with navigation property.
+     */
+    private transformNavigationProperty;
+    /**
+     * Transform sqlite change into EC change.
+     * @param classMap classMap use to deserialize sqlite change into EC change.
+     * @param change sqlite change from changeset.
+     * @param table table definition of sqlite change provided.
+     * @param out EC changeset that will be updated with properties.
+     */
+    private transform;
+}
+//# sourceMappingURL=ChangesetECAdaptor.d.ts.map

package/lib/esm/ChangesetECAdaptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetECAdaptor.d.ts","sourceRoot":"","sources":["../../src/ChangesetECAdaptor.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAwB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAuB,cAAc,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAoVvH;;;KAGK;AACL,MAAM,WAAW,cAAc;IAC7B,8CAA8C;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,EAAE,EAAE,cAAc,CAAC;IACnB,mDAAmD;IACnD,KAAK,EAAE,gBAAgB,CAAC;IACxB,sFAAsF;IACtF,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,iEAAiE;IACjE,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEhC,YAAY,EAAE,UAAU,CAAC;IAEzB,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AA4BD;;;;;GAKG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAwC;IACtD,OAAO,CAAC,SAAS,CAAS;IAC1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAgC7B;;;OAGG;IACH,OAAO,CAAC,OAAO;IAiCf;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAYvB;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAiBpD;;OAEG;IACI,aAAa,IAAI,IAAI;IAQ5B;;;OAGG;IACH,IAAW,SAAS,IAAI,gBAAgB,CAAC,iBAAiB,CAAC,CAAiC;CAC7F;AAED;;;;;;EAME;AACF,qBAAa,kBAAmB,YAAW,UAAU;aA4EhB,MAAM,EAAE,qBAAqB;aAAkB,eAAe;IA3EjG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,eAAe,CAAqB;IAC5C;;OAEG;IACH,SAAgB,UAAU;;;;MAIxB;IACF;;;OAGG;IACI,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;OAGG;IACI,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAEnC;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB;IAKrD;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,kBAAkB;IAKvD;;;;;OAKG;IACI,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,kBAAkB;IAO7D,OAAO,CAAC,gBAAgB;IAUxB;;;;;OAKG;gBACgC,MAAM,EAAE,qBAAqB,EAAkB,eAAe,UAAQ;IAMzG;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAG/B;;OAEG;IACI,KAAK,IAAI,IAAI;IAGpB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAoBvB;;;;OAIG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM;IAGlC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAUxB,qCAAqC;IACrC,IAAW,EAAE,mBAA6B;IAC1C,0DAA0D;IAC1D,IAAW,UAAU,YAAqC;IAC1D,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IACxD,yDAAyD;IACzD,IAAW,SAAS,YAAoC;IAExD;;;OAGG;IACI,IAAI,IAAI,OAAO;IA2GtB;;;;;OAKG;IACH,OAAO,CAAC,2BAA2B;IAuBnC;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;CA6ClB"}