@itwin/core-backend 5.9.0-dev.9 → 5.9.0

package/lib/cjs/ChangesetReader.d.ts

@@ -0,0 +1,186 @@
+/** @packageDocumentation
+ * @module ECDb
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { IModelDb } from "./IModelDb";
+import { ChangeInstance, ChangesetReaderArgs, ChangeSource } from "./ChangesetReaderTypes";
+import { AnyDb, SqliteChangeOp } from "./SqliteChangesetReader";
+/**
+ * Reads EC-typed changeset data natively from a changeset file, changeset group,
+ * in-memory transaction, or local un-pushed changes.
+ *
+ * Implements [ChangeSource]($backend) so rows can be fed directly into
+ * [PartialChangeUnifier]($backend) to merge partial (per-table) instances into
+ * complete EC instances.
+ *
+ * When the current row is a non-EC internal SQLite table, [[isECTable]] is `false`
+ * and both [[inserted]] and [[deleted]] remain `undefined`.
+ *
+ * @note The native reader operates one SQLite table-row at a time. Multi-table EC
+ * instances must be merged using [PartialChangeUnifier]($backend).
+ * @beta
+ */
+export declare class ChangesetReader implements Disposable, ChangeSource {
+    private readonly _nativeReader;
+    private _rowOptions?;
+    private _propFilter;
+    private _changeIndex;
+    private _op?;
+    private _isECTable?;
+    private _tableName?;
+    private _isIndirectChange?;
+    /** The db used for EC schema resolution. */
+    readonly db: AnyDb;
+    /**
+     * `true` when the current row belongs to an EC-mapped table.
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get isECTable(): boolean;
+    /**
+     * Name of the SQLite table for the current change row.
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get tableName(): string;
+    /**
+     * `true` when the current change was applied indirectly
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get isIndirectChange(): boolean;
+    /**
+     * Post-change (inserted or updated-new) EC instance, populated after each [[step]] call.
+     * `undefined` when the current row is a Delete or a non-EC table row or [[step]] returned false.
+     * @beta
+     */
+    inserted?: ChangeInstance;
+    /**
+     * Pre-change (deleted or updated-old) EC instance, populated after each [[step]] call.
+     * `undefined` when the current row is an Insert or a non-EC table row or [[step]] returned false.
+     * @beta
+     */
+    deleted?: ChangeInstance;
+    private constructor();
+    /** Map public RowFormatOptions to the native adaptor options.
+     * @internal */
+    private toNativeRowOptions;
+    /**
+     * Open a changeset file from disk.
+     * @param args.fileName Absolute path to the changeset file.
+     * @param args.db Database at or after the changeset's ending state, used for schema resolution.
+     * @param args.invert When `true`, invert all operations (Insert↔Delete).
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openFile(args: {
+        readonly fileName: string;
+    } & ChangesetReaderArgs): ChangesetReader;
+    /**
+     * Concatenate multiple changeset files and read them as a single logical stream.
+     * @param args.changesetFiles Ordered list of changeset file paths.
+     * @param args.db Database with schema at or ahead of the last changeset.
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openGroup(args: {
+        readonly changesetFiles: string[];
+    } & ChangesetReaderArgs): ChangesetReader;
+    /**
+     * Read pending (not yet pushed) local changes from an open IModelDb.
+     * @param args.db Must be an [IModelDb]($backend) (not [ECDb]($backend)).
+     * @param args.includeInMemoryChanges Also include in-memory (not yet saved to disk) changes.
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openLocalChanges(args: Omit<ChangesetReaderArgs, "db"> & {
+        db: IModelDb;
+        includeInMemoryChanges?: boolean;
+    }): ChangesetReader;
+    /**
+     * Read the in-memory (not yet saved to disk) changes of an open IModelDb.
+     * @param args.db Must be an [IModelDb]($backend).
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openInMemoryChanges(args: Omit<ChangesetReaderArgs, "db"> & {
+        db: IModelDb;
+    }): ChangesetReader;
+    /**
+     * Read a single saved transaction by its id.
+     * @param args.db Must be an [IModelDb]($backend) ([ECDb]($backend) does not support transactions).
+     * @param args.txnId The id of the saved transaction to read.
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openTxn(args: Omit<ChangesetReaderArgs, "db"> & {
+        db: IModelDb;
+        txnId: Id64String;
+    }): ChangesetReader;
+    /**
+     * Restrict iteration to changes from the named SQLite tables.
+     * That means the rows for changes from other tables will be skipped entirely and won't be visible through the reader.
+     * @param tableNames SQLite table names to include.
+     * Note: Table names must be provided in the correct case for proper filtering.
+     * @beta
+     */
+    setTableNameFilters(tableNames: Set<string>): void;
+    /**
+     * Restrict iteration to changes with the given operation types.
+     * That means the rows for changes with other operation types will be skipped entirely and won't be visible through the reader.
+     * @param ops Operations to include.
+     * @beta
+     */
+    setOpCodeFilters(ops: Set<SqliteChangeOp>): void;
+    /**
+     * Restrict iteration to changes for the given EC class names.
+     * That means the rows for changes from other EC classes will be skipped entirely and won't be visible through the reader.
+     * @param classNames EC class names to include. The classNames should be in the full name format(i.e. "SchemaName:ClassName").
+     * Note: Schema names and class names must be provided in the correct case for proper filtering. Derived classes are not automatically included, so they must be specified explicitly if needed.
+     * @beta
+     */
+    setClassNameFilters(classNames: Set<string>): void;
+    /**
+     * Remove the table-name filters
+     * @beta
+     */
+    clearTableNameFilters(): void;
+    /**
+     * Remove the op-code filters
+     * @beta
+     */
+    clearOpCodeFilters(): void;
+    /**
+     * Remove the class-name filters
+     * @beta
+     */
+    clearClassNameFilters(): void;
+    /**
+     * Advance to the next change and populate `inserted` and/or `deleted`.
+     * @returns `true` while positioned on a valid change; `false` when the stream is exhausted.
+     * @beta
+     */
+    step(): boolean;
+    /**
+     * SQLite opcode of the current change.
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get op(): SqliteChangeOp;
+    /**
+     * Close the reader and release all native resources.
+     * @beta
+     */
+    close(): void;
+    /**
+     * Implements the `Disposable` contract — calls [[close]].
+     * @beta
+     */
+    [Symbol.dispose](): void;
+}
+//# sourceMappingURL=ChangesetReader.d.ts.map

package/lib/cjs/ChangesetReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetReader.d.ts","sourceRoot":"","sources":["../../src/ChangesetReader.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAA2B,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAExF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,YAAY,EAAoC,MAAM,wBAAwB,CAAC;AAC7H,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAOhE;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAgB,YAAW,UAAU,EAAE,YAAY;IAC9D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA+E;IAE7G,OAAO,CAAC,WAAW,CAAC,CAAmB;IACvC,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,GAAG,CAAC,CAAiB;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAU;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,iBAAiB,CAAC,CAAU;IAEpC,4CAA4C;IAC5C,SAAgB,EAAE,EAAE,KAAK,CAAC;IAE1B;;;;OAIG;IACH,IAAW,SAAS,IAAI,OAAO,CAI9B;IAED;;;;OAIG;IACH,IAAW,SAAS,IAAI,MAAM,CAI7B;IAED;;;;OAIG;IACH,IAAW,gBAAgB,IAAI,OAAO,CAIrC;IAED;;;;OAIG;IACI,QAAQ,CAAC,EAAE,cAAc,CAAC;IAEjC;;;;OAIG;IACI,OAAO,CAAC,EAAE,cAAc,CAAC;IAGhC,OAAO;IAIP;mBACe;IACf,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;WACW,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,mBAAmB,GAAG,eAAe;IAelG;;;;;;;OAOG;WACW,SAAS,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,mBAAmB,GAAG,eAAe;IAiB3G;;;;;;;OAOG;WACW,gBAAgB,CAC5B,IAAI,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAE,GACzF,eAAe;IAclB;;;;;;OAMG;WACW,mBAAmB,CAC/B,IAAI,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG;QAAE,EAAE,EAAE,QAAQ,CAAA;KAAE,GACvD,eAAe;IAclB;;;;;;;OAOG;WACW,OAAO,CACnB,IAAI,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG;QAAE,EAAE,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,GAC1E,eAAe;IAkBlB;;;;;;OAMG;IACI,mBAAmB,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI;IAIzD;;;;;OAKG;IACI,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,cAAc,CAAC,GAAG,IAAI;IAIvD;;;;;;OAMG;IACI,mBAAmB,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI;IAIzD;;;OAGG;IACI,qBAAqB,IAAI,IAAI;IAIpC;;;OAGG;IACI,kBAAkB,IAAI,IAAI;IAIjC;;;OAGG;IACI,qBAAqB,IAAI,IAAI;IAQpC;;;;OAIG;IACI,IAAI,IAAI,OAAO;IAmEtB;;;;OAIG;IACH,IAAW,EAAE,IAAI,cAAc,CAI9B;IAMD;;;OAGG;IACI,KAAK,IAAI,IAAI;IAWpB;;;OAGG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAGhC"}

package/lib/cjs/ChangesetReader.js

@@ -0,0 +1,372 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangesetReader = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ECDb
+ */
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const NativePlatform_1 = require("./internal/NativePlatform");
+const Symbols_1 = require("./internal/Symbols");
+const ChangesetReaderTypes_1 = require("./ChangesetReaderTypes");
+// ---------------------------------------------------------------------------
+// ChangesetReader
+// ---------------------------------------------------------------------------
+/**
+ * Reads EC-typed changeset data natively from a changeset file, changeset group,
+ * in-memory transaction, or local un-pushed changes.
+ *
+ * Implements [ChangeSource]($backend) so rows can be fed directly into
+ * [PartialChangeUnifier]($backend) to merge partial (per-table) instances into
+ * complete EC instances.
+ *
+ * When the current row is a non-EC internal SQLite table, [[isECTable]] is `false`
+ * and both [[inserted]] and [[deleted]] remain `undefined`.
+ *
+ * @note The native reader operates one SQLite table-row at a time. Multi-table EC
+ * instances must be merged using [PartialChangeUnifier]($backend).
+ * @beta
+ */
+class ChangesetReader {
+    _nativeReader = new NativePlatform_1.IModelNative.platform.ChangesetReader();
+    // Internal options — keep ECClassId as raw Id so the unifier can use it as-is.
+    _rowOptions;
+    _propFilter = ChangesetReaderTypes_1.PropertyFilter.All;
+    _changeIndex = 0;
+    _op;
+    _isECTable;
+    _tableName;
+    _isIndirectChange;
+    /** The db used for EC schema resolution. */
+    db;
+    /**
+     * `true` when the current row belongs to an EC-mapped table.
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get isECTable() {
+        if (this._isECTable === undefined)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "ChangesetReader.isECTable is only valid after step() has positioned the reader on a current valid change.");
+        return this._isECTable;
+    }
+    /**
+     * Name of the SQLite table for the current change row.
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get tableName() {
+        if (this._tableName === undefined)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "ChangesetReader.tableName is only valid after step() has positioned the reader on a current valid change.");
+        return this._tableName;
+    }
+    /**
+     * `true` when the current change was applied indirectly
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get isIndirectChange() {
+        if (this._isIndirectChange === undefined)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "ChangesetReader.isIndirectChange is only valid after step() has positioned the reader on a current valid change.");
+        return this._isIndirectChange;
+    }
+    /**
+     * Post-change (inserted or updated-new) EC instance, populated after each [[step]] call.
+     * `undefined` when the current row is a Delete or a non-EC table row or [[step]] returned false.
+     * @beta
+     */
+    inserted;
+    /**
+     * Pre-change (deleted or updated-old) EC instance, populated after each [[step]] call.
+     * `undefined` when the current row is an Insert or a non-EC table row or [[step]] returned false.
+     * @beta
+     */
+    deleted;
+    // Private — callers use static factory methods.
+    constructor(db) {
+        this.db = db;
+    }
+    /** Map public RowFormatOptions to the native adaptor options.
+     * @internal */
+    toNativeRowOptions(opts) {
+        return {
+            abbreviateBlobs: opts.abbreviateBlobs,
+            classIdsToClassNames: opts.classIdsToClassNames,
+            useJsName: opts.useJsName,
+        };
+    }
+    // ---------------------------------------------------------------------------
+    // Static factory methods
+    // ---------------------------------------------------------------------------
+    /**
+     * Open a changeset file from disk.
+     * @param args.fileName Absolute path to the changeset file.
+     * @param args.db Database at or after the changeset's ending state, used for schema resolution.
+     * @param args.invert When `true`, invert all operations (Insert↔Delete).
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openFile(args) {
+        const reader = new ChangesetReader(args.db);
+        reader._rowOptions = args.rowOptions;
+        const propFilter = args.propFilter ?? ChangesetReaderTypes_1.PropertyFilter.All;
+        reader._propFilter = propFilter;
+        try {
+            reader._nativeReader.openFile(args.db[Symbols_1._nativeDb], args.fileName, args.invert ?? false, reader._propFilter);
+        }
+        catch (e) {
+            reader.close();
+            throw e;
+        }
+        return reader;
+    }
+    /**
+     * Concatenate multiple changeset files and read them as a single logical stream.
+     * @param args.changesetFiles Ordered list of changeset file paths.
+     * @param args.db Database with schema at or ahead of the last changeset.
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openGroup(args) {
+        if (args.changesetFiles.length === 0)
+            throw new Error("changesetFiles must contain at least one file.");
+        const reader = new ChangesetReader(args.db);
+        reader._rowOptions = args.rowOptions;
+        const propFilter = args.propFilter ?? ChangesetReaderTypes_1.PropertyFilter.All;
+        reader._propFilter = propFilter;
+        try {
+            reader._nativeReader.openGroup(args.db[Symbols_1._nativeDb], args.changesetFiles, args.invert ?? false, reader._propFilter);
+        }
+        catch (e) {
+            reader.close();
+            throw e;
+        }
+        return reader;
+    }
+    /**
+     * Read pending (not yet pushed) local changes from an open IModelDb.
+     * @param args.db Must be an [IModelDb]($backend) (not [ECDb]($backend)).
+     * @param args.includeInMemoryChanges Also include in-memory (not yet saved to disk) changes.
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openLocalChanges(args) {
+        const reader = new ChangesetReader(args.db);
+        reader._rowOptions = args.rowOptions;
+        const propFilter = args.propFilter ?? ChangesetReaderTypes_1.PropertyFilter.All;
+        reader._propFilter = propFilter;
+        try {
+            reader._nativeReader.openLocalChanges(args.db[Symbols_1._nativeDb], args.includeInMemoryChanges ?? false, args.invert ?? false, reader._propFilter);
+        }
+        catch (e) {
+            reader.close();
+            throw e;
+        }
+        return reader;
+    }
+    /**
+     * Read the in-memory (not yet saved to disk) changes of an open IModelDb.
+     * @param args.db Must be an [IModelDb]($backend).
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openInMemoryChanges(args) {
+        const reader = new ChangesetReader(args.db);
+        reader._rowOptions = args.rowOptions;
+        const propFilter = args.propFilter ?? ChangesetReaderTypes_1.PropertyFilter.All;
+        reader._propFilter = propFilter;
+        try {
+            reader._nativeReader.openInMemoryChanges(args.db[Symbols_1._nativeDb], args.invert ?? false, reader._propFilter);
+        }
+        catch (e) {
+            reader.close();
+            throw e;
+        }
+        return reader;
+    }
+    /**
+     * Read a single saved transaction by its id.
+     * @param args.db Must be an [IModelDb]($backend) ([ECDb]($backend) does not support transactions).
+     * @param args.txnId The id of the saved transaction to read.
+     * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.
+     * @param args.propFilter Controls which properties are included. Defaults to `All`.
+     * @beta
+     */
+    static openTxn(args) {
+        const reader = new ChangesetReader(args.db);
+        reader._rowOptions = args.rowOptions ?? {};
+        const propFilter = args.propFilter ?? ChangesetReaderTypes_1.PropertyFilter.All;
+        reader._propFilter = propFilter;
+        try {
+            reader._nativeReader.openTxn(args.db[Symbols_1._nativeDb], args.txnId, args.invert ?? false, reader._propFilter);
+        }
+        catch (e) {
+            reader.close();
+            throw e;
+        }
+        return reader;
+    }
+    // ---------------------------------------------------------------------------
+    // Filtering
+    // ---------------------------------------------------------------------------
+    /**
+     * Restrict iteration to changes from the named SQLite tables.
+     * That means the rows for changes from other tables will be skipped entirely and won't be visible through the reader.
+     * @param tableNames SQLite table names to include.
+     * Note: Table names must be provided in the correct case for proper filtering.
+     * @beta
+     */
+    setTableNameFilters(tableNames) {
+        this._nativeReader.setTableNameFilters(Array.from(tableNames));
+    }
+    /**
+     * Restrict iteration to changes with the given operation types.
+     * That means the rows for changes with other operation types will be skipped entirely and won't be visible through the reader.
+     * @param ops Operations to include.
+     * @beta
+     */
+    setOpCodeFilters(ops) {
+        this._nativeReader.setOpCodeFilters(Array.from(ops));
+    }
+    /**
+     * Restrict iteration to changes for the given EC class names.
+     * That means the rows for changes from other EC classes will be skipped entirely and won't be visible through the reader.
+     * @param classNames EC class names to include. The classNames should be in the full name format(i.e. "SchemaName:ClassName").
+     * Note: Schema names and class names must be provided in the correct case for proper filtering. Derived classes are not automatically included, so they must be specified explicitly if needed.
+     * @beta
+     */
+    setClassNameFilters(classNames) {
+        this._nativeReader.setClassNameFilters(Array.from(classNames));
+    }
+    /**
+     * Remove the table-name filters
+     * @beta
+     */
+    clearTableNameFilters() {
+        this._nativeReader.clearTableNameFilters();
+    }
+    /**
+     * Remove the op-code filters
+     * @beta
+     */
+    clearOpCodeFilters() {
+        this._nativeReader.clearOpCodeFilters();
+    }
+    /**
+     * Remove the class-name filters
+     * @beta
+     */
+    clearClassNameFilters() {
+        this._nativeReader.clearClassNameFilters();
+    }
+    // ---------------------------------------------------------------------------
+    // Iteration
+    // ---------------------------------------------------------------------------
+    /**
+     * Advance to the next change and populate `inserted` and/or `deleted`.
+     * @returns `true` while positioned on a valid change; `false` when the stream is exhausted.
+     * @beta
+     */
+    step() {
+        this.inserted = undefined;
+        this.deleted = undefined;
+        this._op = undefined;
+        this._isECTable = undefined;
+        this._tableName = undefined;
+        this._isIndirectChange = undefined;
+        if (this._nativeReader.step()) {
+            this._changeIndex++;
+            const meta = this._nativeReader.getChangeMetadata();
+            const nativeOp = meta.opCode;
+            const op = nativeOp === core_bentley_1.DbOpcode.Insert ? "Inserted" : nativeOp === core_bentley_1.DbOpcode.Update ? "Updated" : "Deleted";
+            this._op = op;
+            this._tableName = meta.tableName;
+            this._isIndirectChange = meta.isIndirectChange;
+            this._isECTable = meta.isECTable;
+            const nativeRowOpts = this._rowOptions ? this.toNativeRowOptions(this._rowOptions) : {};
+            if (op === "Inserted" || op === "Updated") {
+                const rowValue = this._nativeReader.getValue(core_bentley_1.DbChangeStage.New, nativeRowOpts);
+                if (rowValue !== undefined) {
+                    this.inserted = {
+                        ...rowValue.data,
+                        $meta: {
+                            op,
+                            tables: [this._tableName],
+                            changeIndexes: [this._changeIndex],
+                            stage: "New",
+                            instanceKey: rowValue.key,
+                            propFilter: this._propFilter,
+                            changeFetchedPropNames: rowValue.changeFetchedPropNames,
+                            rowOptions: this._rowOptions,
+                            isIndirectChange: this._isIndirectChange,
+                        },
+                    };
+                }
+            }
+            if (op === "Deleted" || op === "Updated") {
+                const rowValue = this._nativeReader.getValue(core_bentley_1.DbChangeStage.Old, nativeRowOpts);
+                if (rowValue !== undefined) {
+                    this.deleted = {
+                        ...rowValue.data,
+                        $meta: {
+                            op,
+                            tables: [this._tableName],
+                            changeIndexes: [this._changeIndex],
+                            stage: "Old",
+                            instanceKey: rowValue.key,
+                            propFilter: this._propFilter,
+                            changeFetchedPropNames: rowValue.changeFetchedPropNames,
+                            rowOptions: this._rowOptions,
+                            isIndirectChange: this._isIndirectChange,
+                        },
+                    };
+                }
+            }
+            return true;
+        }
+        return false;
+    }
+    /**
+     * SQLite opcode of the current change.
+     * Valid only after a successful call to [[step]].
+     * @beta
+     */
+    get op() {
+        if (this._op === undefined)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "ChangesetReader.op is only valid after step() has positioned the reader on a current valid change.");
+        return this._op;
+    }
+    // ---------------------------------------------------------------------------
+    // Lifecycle
+    // ---------------------------------------------------------------------------
+    /**
+     * Close the reader and release all native resources.
+     * @beta
+     */
+    close() {
+        this._changeIndex = 0;
+        this._op = undefined;
+        this._isECTable = undefined;
+        this._tableName = undefined;
+        this._isIndirectChange = undefined;
+        this.inserted = undefined;
+        this.deleted = undefined;
+        this._nativeReader.close();
+    }
+    /**
+     * Implements the `Disposable` contract — calls [[close]].
+     * @beta
+     */
+    [Symbol.dispose]() {
+        this.close();
+    }
+}
+exports.ChangesetReader = ChangesetReader;
+//# sourceMappingURL=ChangesetReader.js.map

package/lib/cjs/ChangesetReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangesetReader.js","sourceRoot":"","sources":["../../src/ChangesetReader.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAwF;AACxF,oDAAiD;AAEjD,8DAAyD;AACzD,gDAA+C;AAE/C,iEAA6H;AAI7H,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E;;;;;;;;;;;;;;GAcG;AACH,MAAa,eAAe;IACT,aAAa,GAAmC,IAAI,6BAAY,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;IAC7G,+EAA+E;IACvE,WAAW,CAAoB;IAC/B,WAAW,GAAmB,qCAAc,CAAC,GAAG,CAAC;IACjD,YAAY,GAAG,CAAC,CAAC;IACjB,GAAG,CAAkB;IACrB,UAAU,CAAW;IACrB,UAAU,CAAU;IACpB,iBAAiB,CAAW;IAEpC,4CAA4C;IAC5B,EAAE,CAAQ;IAE1B;;;;OAIG;IACH,IAAW,SAAS;QAClB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAC/B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,2GAA2G,CAAC,CAAC;QAC9J,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAW,SAAS;QAClB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAC/B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,2GAA2G,CAAC,CAAC;QAC9J,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAW,gBAAgB;QACzB,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS;YACtC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,kHAAkH,CAAC,CAAC;QACrK,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAkB;IAEjC;;;;OAIG;IACI,OAAO,CAAkB;IAEhC,gDAAgD;IAChD,YAAoB,EAAS;QAC3B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IAED;mBACe;IACP,kBAAkB,CAAC,IAAsB;QAC/C,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,yBAAyB;IACzB,8EAA8E;IAE9E;;;;;;;;OAQG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyD;QAC9E,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,qCAAc,CAAC,GAAG,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7G,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAAC,IAAiE;QACvF,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,qCAAc,CAAC,GAAG,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAS,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACpH,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAC5B,IAA0F;QAE1F,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,qCAAc,CAAC,GAAG,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAS,CAAC,EAAE,IAAI,CAAC,sBAAsB,IAAI,KAAK,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5I,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAC/B,IAAwD;QAExD,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,qCAAc,CAAC,GAAG,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAS,CAAC,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACzG,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,OAAO,CACnB,IAA2E;QAE3E,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,qCAAc,CAAC,GAAG,CAAC;QACzD,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAS,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACzG,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,8EAA8E;IAC9E,YAAY;IACZ,8EAA8E;IAE9E;;;;;;OAMG;IACI,mBAAmB,CAAC,UAAuB;QAChD,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,GAAwB;QAC9C,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAC,UAAuB;QAChD,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,qBAAqB;QAC1B,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACvB,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,qBAAqB;QAC1B,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;IAC7C,CAAC;IAED,8EAA8E;IAC9E,YAAY;IACZ,8EAA8E;IAE9E;;;;OAIG;IACI,IAAI;QACT,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;YAC7B,MAAM,EAAE,GAAmB,QAAQ,KAAK,uBAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,KAAK,uBAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5H,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;YAEd,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;YACjC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;YAC/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;YAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAExF,IAAI,EAAE,KAAK,UAAU,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,4BAAa,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;gBAC/E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,IAAI,CAAC,QAAQ,GAAG;wBACd,GAAG,QAAQ,CAAC,IAAI;wBAChB,KAAK,EAAE;4BACL,EAAE;4BACF,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;4BACzB,aAAa,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;4BAClC,KAAK,EAAE,KAAK;4BACZ,WAAW,EAAE,QAAQ,CAAC,GAAG;4BACzB,UAAU,EAAE,IAAI,CAAC,WAAW;4BAC5B,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB;4BACvD,UAAU,EAAE,IAAI,CAAC,WAAW;4BAC5B,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;yBACzC;qBACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,4BAAa,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;gBAC/E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,IAAI,CAAC,OAAO,GAAG;wBACb,GAAG,QAAQ,CAAC,IAAI;wBAChB,KAAK,EAAE;4BACL,EAAE;4BACF,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;4BACzB,aAAa,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;4BAClC,KAAK,EAAE,KAAK;4BACZ,WAAW,EAAE,QAAQ,CAAC,GAAG;4BACzB,UAAU,EAAE,IAAI,CAAC,WAAW;4BAC5B,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB;4BACvD,UAAU,EAAE,IAAI,CAAC,WAAW;4BAC5B,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;yBACzC;qBACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,IAAW,EAAE;QACX,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS;YACxB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,oGAAoG,CAAC,CAAC;QACvJ,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,8EAA8E;IAC9E,YAAY;IACZ,8EAA8E;IAE9E;;;OAGG;IACI,KAAK;QACV,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;CACF;AArXD,0CAqXC","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 ECDb\n */\nimport { DbChangeStage, DbOpcode, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _nativeDb } from \"./internal/Symbols\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { ChangeInstance, ChangesetReaderArgs, ChangeSource, PropertyFilter, RowFormatOptions } from \"./ChangesetReaderTypes\";\nimport { AnyDb, SqliteChangeOp } from \"./SqliteChangesetReader\";\n\n\n// ---------------------------------------------------------------------------\n// ChangesetReader\n// ---------------------------------------------------------------------------\n\n/**\n * Reads EC-typed changeset data natively from a changeset file, changeset group,\n * in-memory transaction, or local un-pushed changes.\n *\n * Implements [ChangeSource]($backend) so rows can be fed directly into\n * [PartialChangeUnifier]($backend) to merge partial (per-table) instances into\n * complete EC instances.\n *\n * When the current row is a non-EC internal SQLite table, [[isECTable]] is `false`\n * and both [[inserted]] and [[deleted]] remain `undefined`.\n *\n * @note The native reader operates one SQLite table-row at a time. Multi-table EC\n * instances must be merged using [PartialChangeUnifier]($backend).\n * @beta\n */\nexport class ChangesetReader implements Disposable, ChangeSource {\n  private readonly _nativeReader: IModelJsNative.ChangesetReader = new IModelNative.platform.ChangesetReader();\n  // Internal options — keep ECClassId as raw Id so the unifier can use it as-is.\n  private _rowOptions?: RowFormatOptions;\n  private _propFilter: PropertyFilter = PropertyFilter.All;\n  private _changeIndex = 0;\n  private _op?: SqliteChangeOp;\n  private _isECTable?: boolean;\n  private _tableName?: string;\n  private _isIndirectChange?: boolean;\n\n  /** The db used for EC schema resolution. */\n  public readonly db: AnyDb;\n\n  /**\n   * `true` when the current row belongs to an EC-mapped table.\n   * Valid only after a successful call to [[step]].\n   * @beta\n   */\n  public get isECTable(): boolean {\n    if (this._isECTable === undefined)\n      throw new IModelError(IModelStatus.BadRequest, \"ChangesetReader.isECTable is only valid after step() has positioned the reader on a current valid change.\");\n    return this._isECTable;\n  }\n\n  /**\n   * Name of the SQLite table for the current change row.\n   * Valid only after a successful call to [[step]].\n   * @beta\n   */\n  public get tableName(): string {\n    if (this._tableName === undefined)\n      throw new IModelError(IModelStatus.BadRequest, \"ChangesetReader.tableName is only valid after step() has positioned the reader on a current valid change.\");\n    return this._tableName;\n  }\n\n  /**\n   * `true` when the current change was applied indirectly\n   * Valid only after a successful call to [[step]].\n   * @beta\n   */\n  public get isIndirectChange(): boolean {\n    if (this._isIndirectChange === undefined)\n      throw new IModelError(IModelStatus.BadRequest, \"ChangesetReader.isIndirectChange is only valid after step() has positioned the reader on a current valid change.\");\n    return this._isIndirectChange;\n  }\n\n  /**\n   * Post-change (inserted or updated-new) EC instance, populated after each [[step]] call.\n   * `undefined` when the current row is a Delete or a non-EC table row or [[step]] returned false.\n   * @beta\n   */\n  public inserted?: ChangeInstance;\n\n  /**\n   * Pre-change (deleted or updated-old) EC instance, populated after each [[step]] call.\n   * `undefined` when the current row is an Insert or a non-EC table row or [[step]] returned false.\n   * @beta\n   */\n  public deleted?: ChangeInstance;\n\n  // Private — callers use static factory methods.\n  private constructor(db: AnyDb) {\n    this.db = db;\n  }\n\n  /** Map public RowFormatOptions to the native adaptor options.\n   * @internal */\n  private toNativeRowOptions(opts: RowFormatOptions): IModelJsNative.ECSqlRowAdaptorOptions {\n    return {\n      abbreviateBlobs: opts.abbreviateBlobs,\n      classIdsToClassNames: opts.classIdsToClassNames,\n      useJsName: opts.useJsName,\n    };\n  }\n\n  // ---------------------------------------------------------------------------\n  // Static factory methods\n  // ---------------------------------------------------------------------------\n\n  /**\n   * Open a changeset file from disk.\n   * @param args.fileName Absolute path to the changeset file.\n   * @param args.db Database at or after the changeset's ending state, used for schema resolution.\n   * @param args.invert When `true`, invert all operations (Insert↔Delete).\n   * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.\n   * @param args.propFilter Controls which properties are included. Defaults to `All`.\n   * @beta\n   */\n  public static openFile(args: { readonly fileName: string } & ChangesetReaderArgs): ChangesetReader {\n    const reader = new ChangesetReader(args.db);\n    reader._rowOptions = args.rowOptions;\n    const propFilter = args.propFilter ?? PropertyFilter.All;\n    reader._propFilter = propFilter;\n    try {\n      reader._nativeReader.openFile(args.db[_nativeDb], args.fileName, args.invert ?? false, reader._propFilter);\n    }\n    catch (e) {\n      reader.close();\n      throw e;\n    }\n    return reader;\n  }\n\n  /**\n   * Concatenate multiple changeset files and read them as a single logical stream.\n   * @param args.changesetFiles Ordered list of changeset file paths.\n   * @param args.db Database with schema at or ahead of the last changeset.\n   * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.\n   * @param args.propFilter Controls which properties are included. Defaults to `All`.\n   * @beta\n   */\n  public static openGroup(args: { readonly changesetFiles: string[] } & ChangesetReaderArgs): ChangesetReader {\n    if (args.changesetFiles.length === 0)\n      throw new Error(\"changesetFiles must contain at least one file.\");\n    const reader = new ChangesetReader(args.db);\n    reader._rowOptions = args.rowOptions;\n    const propFilter = args.propFilter ?? PropertyFilter.All;\n    reader._propFilter = propFilter;\n    try {\n      reader._nativeReader.openGroup(args.db[_nativeDb], args.changesetFiles, args.invert ?? false, reader._propFilter);\n    }\n    catch (e) {\n      reader.close();\n      throw e;\n    }\n    return reader;\n  }\n\n  /**\n   * Read pending (not yet pushed) local changes from an open IModelDb.\n   * @param args.db Must be an [IModelDb]($backend) (not [ECDb]($backend)).\n   * @param args.includeInMemoryChanges Also include in-memory (not yet saved to disk) changes.\n   * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.\n   * @param args.propFilter Controls which properties are included. Defaults to `All`.\n   * @beta\n   */\n  public static openLocalChanges(\n    args: Omit<ChangesetReaderArgs, \"db\"> & { db: IModelDb; includeInMemoryChanges?: boolean },\n  ): ChangesetReader {\n    const reader = new ChangesetReader(args.db);\n    reader._rowOptions = args.rowOptions;\n    const propFilter = args.propFilter ?? PropertyFilter.All;\n    reader._propFilter = propFilter;\n    try {\n      reader._nativeReader.openLocalChanges(args.db[_nativeDb], args.includeInMemoryChanges ?? false, args.invert ?? false, reader._propFilter);\n    } catch (e) {\n      reader.close();\n      throw e;\n    }\n    return reader;\n  }\n\n  /**\n   * Read the in-memory (not yet saved to disk) changes of an open IModelDb.\n   * @param args.db Must be an [IModelDb]($backend).\n   * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.\n   * @param args.propFilter Controls which properties are included. Defaults to `All`.\n   * @beta\n   */\n  public static openInMemoryChanges(\n    args: Omit<ChangesetReaderArgs, \"db\"> & { db: IModelDb },\n  ): ChangesetReader {\n    const reader = new ChangesetReader(args.db);\n    reader._rowOptions = args.rowOptions;\n    const propFilter = args.propFilter ?? PropertyFilter.All;\n    reader._propFilter = propFilter;\n    try {\n      reader._nativeReader.openInMemoryChanges(args.db[_nativeDb], args.invert ?? false, reader._propFilter);\n    } catch (e) {\n      reader.close();\n      throw e;\n    }\n    return reader;\n  }\n\n  /**\n   * Read a single saved transaction by its id.\n   * @param args.db Must be an [IModelDb]($backend) ([ECDb]($backend) does not support transactions).\n   * @param args.txnId The id of the saved transaction to read.\n   * @param args.valueOptions Row adaptor options controlling how EC property values are formatted.\n   * @param args.propFilter Controls which properties are included. Defaults to `All`.\n   * @beta\n   */\n  public static openTxn(\n    args: Omit<ChangesetReaderArgs, \"db\"> & { db: IModelDb; txnId: Id64String },\n  ): ChangesetReader {\n    const reader = new ChangesetReader(args.db);\n    reader._rowOptions = args.rowOptions ?? {};\n    const propFilter = args.propFilter ?? PropertyFilter.All;\n    reader._propFilter = propFilter;\n    try {\n      reader._nativeReader.openTxn(args.db[_nativeDb], args.txnId, args.invert ?? false, reader._propFilter);\n    } catch (e) {\n      reader.close();\n      throw e;\n    }\n    return reader;\n  }\n\n  // ---------------------------------------------------------------------------\n  // Filtering\n  // ---------------------------------------------------------------------------\n\n  /**\n   * Restrict iteration to changes from the named SQLite tables.\n   * That means the rows for changes from other tables will be skipped entirely and won't be visible through the reader.\n   * @param tableNames SQLite table names to include.\n   * Note: Table names must be provided in the correct case for proper filtering.\n   * @beta\n   */\n  public setTableNameFilters(tableNames: Set<string>): void {\n    this._nativeReader.setTableNameFilters(Array.from(tableNames));\n  }\n\n  /**\n   * Restrict iteration to changes with the given operation types.\n   * That means the rows for changes with other operation types will be skipped entirely and won't be visible through the reader.\n   * @param ops Operations to include.\n   * @beta\n   */\n  public setOpCodeFilters(ops: Set<SqliteChangeOp>): void {\n    this._nativeReader.setOpCodeFilters(Array.from(ops));\n  }\n\n  /**\n   * Restrict iteration to changes for the given EC class names.\n   * That means the rows for changes from other EC classes will be skipped entirely and won't be visible through the reader.\n   * @param classNames EC class names to include. The classNames should be in the full name format(i.e. \"SchemaName:ClassName\").\n   * Note: Schema names and class names must be provided in the correct case for proper filtering. Derived classes are not automatically included, so they must be specified explicitly if needed.\n   * @beta\n   */\n  public setClassNameFilters(classNames: Set<string>): void {\n    this._nativeReader.setClassNameFilters(Array.from(classNames));\n  }\n\n  /**\n   * Remove the table-name filters\n   * @beta\n   */\n  public clearTableNameFilters(): void {\n    this._nativeReader.clearTableNameFilters();\n  }\n\n  /**\n   * Remove the op-code filters\n   * @beta\n   */\n  public clearOpCodeFilters(): void {\n    this._nativeReader.clearOpCodeFilters();\n  }\n\n  /**\n   * Remove the class-name filters\n   * @beta\n   */\n  public clearClassNameFilters(): void {\n    this._nativeReader.clearClassNameFilters();\n  }\n\n  // ---------------------------------------------------------------------------\n  // Iteration\n  // ---------------------------------------------------------------------------\n\n  /**\n   * Advance to the next change and populate `inserted` and/or `deleted`.\n   * @returns `true` while positioned on a valid change; `false` when the stream is exhausted.\n   * @beta\n   */\n  public step(): boolean {\n    this.inserted = undefined;\n    this.deleted = undefined;\n    this._op = undefined;\n    this._isECTable = undefined;\n    this._tableName = undefined;\n    this._isIndirectChange = undefined;\n\n    if (this._nativeReader.step()) {\n      this._changeIndex++;\n      const meta = this._nativeReader.getChangeMetadata();\n      const nativeOp = meta.opCode;\n      const op: SqliteChangeOp = nativeOp === DbOpcode.Insert ? \"Inserted\" : nativeOp === DbOpcode.Update ? \"Updated\" : \"Deleted\";\n      this._op = op;\n\n      this._tableName = meta.tableName;\n      this._isIndirectChange = meta.isIndirectChange;\n      this._isECTable = meta.isECTable;\n\n      const nativeRowOpts = this._rowOptions ? this.toNativeRowOptions(this._rowOptions) : {};\n\n      if (op === \"Inserted\" || op === \"Updated\") {\n        const rowValue = this._nativeReader.getValue(DbChangeStage.New, nativeRowOpts);\n        if (rowValue !== undefined) {\n          this.inserted = {\n            ...rowValue.data,\n            $meta: {\n              op,\n              tables: [this._tableName],\n              changeIndexes: [this._changeIndex],\n              stage: \"New\",\n              instanceKey: rowValue.key,\n              propFilter: this._propFilter,\n              changeFetchedPropNames: rowValue.changeFetchedPropNames,\n              rowOptions: this._rowOptions,\n              isIndirectChange: this._isIndirectChange,\n            },\n          };\n        }\n      }\n\n      if (op === \"Deleted\" || op === \"Updated\") {\n        const rowValue = this._nativeReader.getValue(DbChangeStage.Old, nativeRowOpts);\n        if (rowValue !== undefined) {\n          this.deleted = {\n            ...rowValue.data,\n            $meta: {\n              op,\n              tables: [this._tableName],\n              changeIndexes: [this._changeIndex],\n              stage: \"Old\",\n              instanceKey: rowValue.key,\n              propFilter: this._propFilter,\n              changeFetchedPropNames: rowValue.changeFetchedPropNames,\n              rowOptions: this._rowOptions,\n              isIndirectChange: this._isIndirectChange,\n            },\n          };\n        }\n      }\n\n      return true;\n    }\n\n    return false;\n  }\n\n  /**\n   * SQLite opcode of the current change.\n   * Valid only after a successful call to [[step]].\n   * @beta\n   */\n  public get op(): SqliteChangeOp {\n    if (this._op === undefined)\n      throw new IModelError(IModelStatus.BadRequest, \"ChangesetReader.op is only valid after step() has positioned the reader on a current valid change.\");\n    return this._op;\n  }\n\n  // ---------------------------------------------------------------------------\n  // Lifecycle\n  // ---------------------------------------------------------------------------\n\n  /**\n   * Close the reader and release all native resources.\n   * @beta\n   */\n  public close(): void {\n    this._changeIndex = 0;\n    this._op = undefined;\n    this._isECTable = undefined;\n    this._tableName = undefined;\n    this._isIndirectChange = undefined;\n    this.inserted = undefined;\n    this.deleted = undefined;\n    this._nativeReader.close();\n  }\n\n  /**\n   * Implements the `Disposable` contract — calls [[close]].\n   * @beta\n   */\n  public [Symbol.dispose](): void {\n    this.close();\n  }\n}\n\n\n"]}