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

package/lib/cjs/PartialChangeUnifier.js

@@ -0,0 +1,234 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PartialChangeUnifier = exports.ChangeUnifierCache = 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 SQLiteDb_1 = require("./SQLiteDb");
+/** @beta */
+var ChangeUnifierCache;
+(function (ChangeUnifierCache) {
+    /**
+     * Creates an in-memory cache backed by a `Map`.
+     * Fast, but may exhaust memory for very large changesets.
+     * @returns An [[ChangeCache]] backed by an in-memory `Map`.
+     * @beta
+     */
+    function createInMemoryCache() {
+        return new InMemoryCache();
+    }
+    ChangeUnifierCache.createInMemoryCache = createInMemoryCache;
+    /**
+     * Creates a SQLite-backed cache stored in a temporary SQlite database.
+     * Slower than in-memory but useful in handling large changesets.
+     * Temporary SQlite database is first created in memory and
+     * parts of a temporary database might be flushed to disk if the database becomes large or
+     * if SQLite comes under memory pressure.
+     * @param bufferedReadInstanceSizeInBytes Read-batch size in bytes (default 10 MB).
+     * @returns An [[ChangeCache]] backed by a SQLite temp table.
+     * @beta
+     */
+    function createSqliteBackedCache(bufferedReadInstanceSizeInBytes = 1024 * 1024 * 10) {
+        return new SqliteBackedCache(bufferedReadInstanceSizeInBytes);
+    }
+    ChangeUnifierCache.createSqliteBackedCache = createSqliteBackedCache;
+})(ChangeUnifierCache || (exports.ChangeUnifierCache = ChangeUnifierCache = {}));
+// ---------------------------------------------------------------------------
+// Private: InMemoryCache
+// ---------------------------------------------------------------------------
+class InMemoryCache {
+    _cache = new Map();
+    get(key) {
+        return this._cache.get(key);
+    }
+    set(key, value) {
+        // Remove undefined meta keys to keep serialised form compact.
+        const meta = value.$meta;
+        if (meta) {
+            Object.keys(meta).forEach((k) => meta[k] === undefined && delete meta[k]);
+        }
+        this._cache.set(key, value);
+    }
+    *all() {
+        for (const key of Array.from(this._cache.keys()).sort()) {
+            const instance = this._cache.get(key);
+            if (instance)
+                yield instance;
+        }
+    }
+    count() {
+        return this._cache.size;
+    }
+    [Symbol.dispose]() {
+        this._cache.clear();
+    }
+}
+// ---------------------------------------------------------------------------
+// Private: NativeSqliteBackedInstanceCache
+// ---------------------------------------------------------------------------
+class SqliteBackedCache {
+    bufferedReadInstanceSizeInBytes;
+    _cacheTable = `[${core_bentley_1.Guid.createValue()}]`;
+    static defaultBufferSize = 1024 * 1024 * 10; // 10 MB
+    _db;
+    constructor(bufferedReadInstanceSizeInBytes = SqliteBackedCache.defaultBufferSize) {
+        this.bufferedReadInstanceSizeInBytes = bufferedReadInstanceSizeInBytes;
+        this._db = new SQLiteDb_1.SQLiteDb();
+        this._db.openDb("", { skipFileCheck: true, rawSQLite: true, openMode: core_bentley_1.OpenMode.ReadWrite }); // creating temp sqlite db https://sqlite.org/inmemorydb.html#:~:text=Temporary%20Databases,under%20the%20default%20SQLite%20configuration.
+        if (bufferedReadInstanceSizeInBytes <= 0)
+            throw new Error("bufferedReadInstanceSizeInBytes must be greater than 0");
+        this.createTempTable();
+    }
+    createTempTable() {
+        this._db.withSqliteStatement(`CREATE TABLE ${this._cacheTable} ([key] text primary key, [value] text)`, (stmt) => {
+            if (core_bentley_1.DbResult.BE_SQLITE_DONE !== stmt.step())
+                throw new Error("unable to create temp cache table");
+        });
+    }
+    get(key) {
+        return this._db.withPreparedSqliteStatement(`SELECT [value] FROM ${this._cacheTable} WHERE [key]=?`, (stmt) => {
+            stmt.reset();
+            stmt.clearBindings();
+            stmt.bindString(1, key);
+            if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
+                return JSON.parse(stmt.getValueString(0), core_common_1.Base64EncodedString.reviver);
+            return undefined;
+        });
+    }
+    set(key, value) {
+        const shallowCopy = Object.assign({}, value);
+        this._db.withPreparedSqliteStatement(`INSERT INTO ${this._cacheTable} ([key], [value]) VALUES (?, ?) ON CONFLICT ([key]) DO UPDATE SET [value] = [excluded].[value]`, (stmt) => {
+            stmt.reset();
+            stmt.clearBindings();
+            stmt.bindString(1, key);
+            stmt.bindString(2, JSON.stringify(shallowCopy, core_common_1.Base64EncodedString.replacer));
+            stmt.step();
+        });
+    }
+    *all() {
+        const sql = `
+      SELECT JSON_GROUP_ARRAY(JSON([value]))
+      FROM (
+        SELECT [value],
+               SUM(LENGTH([value])) OVER (ORDER BY [key] ROWS UNBOUNDED PRECEDING) / ${this.bufferedReadInstanceSizeInBytes} AS [bucket]
+        FROM ${this._cacheTable}
+      )
+      GROUP BY [bucket]`;
+        const stmt = this._db.prepareSqliteStatement(sql);
+        try {
+            while (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+                const bucket = JSON.parse(stmt.getValueString(0), core_common_1.Base64EncodedString.reviver);
+                for (const instance of bucket)
+                    yield instance;
+            }
+        }
+        finally {
+            stmt[Symbol.dispose]();
+        }
+    }
+    count() {
+        return this._db.withPreparedSqliteStatement(`SELECT COUNT(*) FROM ${this._cacheTable}`, (stmt) => {
+            stmt.reset();
+            if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
+                return stmt.getValue(0).getInteger();
+            return 0;
+        });
+    }
+    [Symbol.dispose]() {
+        this._db.closeDb();
+    }
+}
+// ---------------------------------------------------------------------------
+// PartialChangeUnifier
+// ---------------------------------------------------------------------------
+/**
+ * Combines partial EC change instances (one per SQLite table row) into complete
+ * instances that span all tables mapping to a single EC entity.
+ *
+ * The merge key is derived from the `instanceKey` and `stage` stored in `$meta.instanceKey` and `$meta.stage`.
+ *
+ * **Usage:**
+ * ```ts
+ * using reader = ChangesetReader.openFile({ fileName, db });
+ * using unifier = new PartialChangeUnifier();
+ * while (reader.step()) {
+ *   unifier.appendFrom(reader);
+ * }
+ * for (const instance of unifier.instances) { ... }
+ * ```
+ * @beta
+ */
+class PartialChangeUnifier {
+    _cache;
+    constructor(_cache = new InMemoryCache()) {
+        this._cache = _cache;
+    }
+    /** Releases the underlying cache. */
+    [Symbol.dispose]() {
+        this._cache[Symbol.dispose]();
+    }
+    /** Number of complete (merged) instances currently accumulated. */
+    get instanceCount() {
+        return this._cache.count();
+    }
+    /**
+     * Append partial changes from the current reader row and merge them into the cache.
+     *
+     * @param source Any [ChangeSource]($backend) positioned on a valid row.
+     * @beta
+     */
+    appendFrom(source) {
+        if (source.op === "Updated") {
+            if (source.inserted)
+                this.combine(source.inserted);
+            if (source.deleted)
+                this.combine(source.deleted);
+        }
+        else if (source.op === "Inserted" && source.inserted) {
+            this.combine(source.inserted);
+        }
+        else if (source.op === "Deleted" && source.deleted) {
+            this.combine(source.deleted);
+        }
+    }
+    /**
+     * Iterator over all fully-merged EC change instances.
+     * @beta
+     */
+    get instances() {
+        return this._cache.all();
+    }
+    // ---------------------------------------------------------------------------
+    // Private helpers
+    // ---------------------------------------------------------------------------
+    buildKey(instance) {
+        const { instanceKey, stage } = instance.$meta;
+        return `${instanceKey}-${stage}`.toLowerCase();
+    }
+    combine(rhs) {
+        const key = this.buildKey(rhs);
+        const lhs = this._cache.get(key);
+        if (lhs) {
+            // Merge data fields — rhs wins for any overlapping columns.
+            const { $meta: _rhsMeta, ...rhsData } = rhs;
+            Object.assign(lhs, rhsData);
+            // Accumulate per-table metadata lists.
+            lhs.$meta.tables = [...lhs.$meta.tables, ...rhs.$meta.tables];
+            lhs.$meta.changeIndexes = [...lhs.$meta.changeIndexes, ...rhs.$meta.changeIndexes];
+            // ECInstanceId will be part of changeset fetchedProps for every table, so we should not include multiple of those in the final list
+            lhs.$meta.changeFetchedPropNames = [...new Set([...lhs.$meta.changeFetchedPropNames, ...rhs.$meta.changeFetchedPropNames])];
+            this._cache.set(key, lhs);
+        }
+        else {
+            this._cache.set(key, rhs);
+        }
+    }
+}
+exports.PartialChangeUnifier = PartialChangeUnifier;
+//# sourceMappingURL=PartialChangeUnifier.js.map

package/lib/cjs/PartialChangeUnifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PartialChangeUnifier.js","sourceRoot":"","sources":["../../src/PartialChangeUnifier.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAA+D;AAC/D,oDAAyD;AAIzD,yCAAsC;AAsBtC,YAAY;AACZ,IAAiB,kBAAkB,CA0BlC;AA1BD,WAAiB,kBAAkB;IACjC;;;;;OAKG;IACH,SAAgB,mBAAmB;QACjC,OAAO,IAAI,aAAa,EAAE,CAAC;IAC7B,CAAC;IAFe,sCAAmB,sBAElC,CAAA;IAED;;;;;;;;;OASG;IACH,SAAgB,uBAAuB,CACrC,+BAA+B,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE;QAElD,OAAO,IAAI,iBAAiB,CAAC,+BAA+B,CAAC,CAAC;IAChE,CAAC;IAJe,0CAAuB,0BAItC,CAAA;AACH,CAAC,EA1BgB,kBAAkB,kCAAlB,kBAAkB,QA0BlC;AAED,8EAA8E;AAC9E,yBAAyB;AACzB,8EAA8E;AAE9E,MAAM,aAAa;IACA,MAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;IAErD,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAqB;QAC3C,8DAA8D;QAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAY,CAAC;QAChC,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC;IAEM,CAAC,GAAG;QACT,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,QAAQ;gBACV,MAAM,QAAQ,CAAC;QACnB,CAAC;IACH,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;CACF;AAED,8EAA8E;AAC9E,2CAA2C;AAC3C,8EAA8E;AAE9E,MAAM,iBAAiB;IAKH;IAJD,WAAW,GAAG,IAAI,mBAAI,CAAC,WAAW,EAAE,GAAG,CAAC;IAClD,MAAM,CAAU,iBAAiB,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,QAAQ;IAC7D,GAAG,CAAW;IACtB,YACkB,kCAA0C,iBAAiB,CAAC,iBAAiB;QAA7E,oCAA+B,GAA/B,+BAA+B,CAA8C;QAE7F,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,2IAA2I;QACxO,IAAI,+BAA+B,IAAI,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,gBAAgB,IAAI,CAAC,WAAW,yCAAyC,EAAE,CAAC,IAAqB,EAAE,EAAE;YAChI,IAAI,uBAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,IAAI,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,CACzC,uBAAuB,IAAI,CAAC,WAAW,gBAAgB,EACvD,CAAC,IAAqB,EAAE,EAAE;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACxB,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,iCAAmB,CAAC,OAAO,CAAmB,CAAC;YAC3F,OAAO,SAAS,CAAC;QACnB,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAqB;QAC3C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAClC,eAAe,IAAI,CAAC,WAAW,gGAAgG,EAC/H,CAAC,IAAqB,EAAE,EAAE;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,iCAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9E,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,CAAC,GAAG;QACT,MAAM,GAAG,GAAG;;;;uFAIuE,IAAI,CAAC,+BAA+B;eAC5G,IAAI,CAAC,WAAW;;wBAEP,CAAC;QAErB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,iCAAmB,CAAC,OAAO,CAAqB,CAAC;gBACnG,KAAK,MAAM,QAAQ,IAAI,MAAM;oBAC3B,MAAM,QAAQ,CAAC;YACnB,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,CACzC,wBAAwB,IAAI,CAAC,WAAW,EAAE,EAC1C,CAAC,IAAqB,EAAE,EAAE;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa;gBACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;YACvC,OAAO,CAAC,CAAC;QACX,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;;AAGH,8EAA8E;AAC9E,uBAAuB;AACvB,8EAA8E;AAE9E;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,oBAAoB;IAEZ;IADnB,YACmB,SAAsB,IAAI,aAAa,EAAE;QAAzC,WAAM,GAAN,MAAM,CAAmC;IACxD,CAAC;IAEL,qCAAqC;IAC9B,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAChC,CAAC;IAED,mEAAmE;IACnE,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,MAAoB;QACpC,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,MAAM,CAAC,QAAQ;gBACjB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,MAAM,CAAC,OAAO;gBAChB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,MAAM,CAAC,EAAE,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED,8EAA8E;IAC9E,kBAAkB;IAClB,8EAA8E;IAEtE,QAAQ,CAAC,QAAwB;QACvC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC9C,OAAO,GAAG,WAAW,IAAI,KAAK,EAAE,CAAC,WAAW,EAAE,CAAC;IACjD,CAAC;IAEO,OAAO,CAAC,GAAmB;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,GAAG,EAAE,CAAC;YACR,4DAA4D;YAC5D,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC5B,uCAAuC;YACvC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC9D,GAAG,CAAC,KAAK,CAAC,aAAa,GAAG,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACnF,oIAAoI;YACpI,GAAG,CAAC,KAAK,CAAC,sBAAsB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;YAC5H,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;CACF;AApED,oDAoEC","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 { DbResult, Guid, OpenMode } from \"@itwin/core-bentley\";\nimport { Base64EncodedString } from \"@itwin/core-common\";\nimport { SqliteStatement } from \"./SqliteStatement\";\nimport { ChangeInstance, ChangeSource } from \"./ChangesetReaderTypes\";\nimport { _nativeDb } from \"./internal/Symbols\";\nimport { SQLiteDb } from \"./SQLiteDb\";\n\n// ---------------------------------------------------------------------------\n// ChangeCache — interface + factory\n// ---------------------------------------------------------------------------\n\n/**\n * Cache used by [[PartialChangeUnifier]] to accumulate and merge\n * partial EC change instances.\n * @beta\n */\nexport interface ChangeCache extends Disposable {\n  /** Retrieve a cached instance by key, or `undefined` if absent. */\n  get(key: string): ChangeInstance | undefined;\n  /** Insert or replace a cached instance. */\n  set(key: string, value: ChangeInstance): void;\n  /** Iterate over all cached instances. */\n  all(): IterableIterator<ChangeInstance>;\n  /** Number of instances currently in the cache. */\n  count(): number;\n}\n\n/** @beta */\nexport namespace ChangeUnifierCache {\n  /**\n   * Creates an in-memory cache backed by a `Map`.\n   * Fast, but may exhaust memory for very large changesets.\n   * @returns An [[ChangeCache]] backed by an in-memory `Map`.\n   * @beta\n   */\n  export function createInMemoryCache(): ChangeCache {\n    return new InMemoryCache();\n  }\n\n  /**\n   * Creates a SQLite-backed cache stored in a temporary SQlite database.\n   * Slower than in-memory but useful in handling large changesets.\n   * Temporary SQlite database is first created in memory and\n   * parts of a temporary database might be flushed to disk if the database becomes large or\n   * if SQLite comes under memory pressure.\n   * @param bufferedReadInstanceSizeInBytes Read-batch size in bytes (default 10 MB).\n   * @returns An [[ChangeCache]] backed by a SQLite temp table.\n   * @beta\n   */\n  export function createSqliteBackedCache(\n    bufferedReadInstanceSizeInBytes = 1024 * 1024 * 10,\n  ): ChangeCache {\n    return new SqliteBackedCache(bufferedReadInstanceSizeInBytes);\n  }\n}\n\n// ---------------------------------------------------------------------------\n// Private: InMemoryCache\n// ---------------------------------------------------------------------------\n\nclass InMemoryCache implements ChangeCache {\n  private readonly _cache = new Map<string, ChangeInstance>();\n\n  public get(key: string): ChangeInstance | undefined {\n    return this._cache.get(key);\n  }\n\n  public set(key: string, value: ChangeInstance): void {\n    // Remove undefined meta keys to keep serialised form compact.\n    const meta = value.$meta as any;\n    if (meta) {\n      Object.keys(meta).forEach((k) => meta[k] === undefined && delete meta[k]);\n    }\n    this._cache.set(key, value);\n  }\n\n  public *all(): IterableIterator<ChangeInstance> {\n    for (const key of Array.from(this._cache.keys()).sort()) {\n      const instance = this._cache.get(key);\n      if (instance)\n        yield instance;\n    }\n  }\n\n  public count(): number {\n    return this._cache.size;\n  }\n\n  public [Symbol.dispose](): void {\n    this._cache.clear();\n  }\n}\n\n// ---------------------------------------------------------------------------\n// Private: NativeSqliteBackedInstanceCache\n// ---------------------------------------------------------------------------\n\nclass SqliteBackedCache implements ChangeCache {\n  private readonly _cacheTable = `[${Guid.createValue()}]`;\n  public static readonly defaultBufferSize = 1024 * 1024 * 10; // 10 MB\n  private _db: SQLiteDb;\n  public constructor(\n    public readonly bufferedReadInstanceSizeInBytes: number = SqliteBackedCache.defaultBufferSize,\n  ) {\n    this._db = new SQLiteDb();\n    this._db.openDb(\"\", { skipFileCheck: true, rawSQLite: true, openMode: OpenMode.ReadWrite }); // creating temp sqlite db https://sqlite.org/inmemorydb.html#:~:text=Temporary%20Databases,under%20the%20default%20SQLite%20configuration.\n    if (bufferedReadInstanceSizeInBytes <= 0)\n      throw new Error(\"bufferedReadInstanceSizeInBytes must be greater than 0\");\n    this.createTempTable();\n  }\n\n  private createTempTable(): void {\n    this._db.withSqliteStatement(`CREATE TABLE ${this._cacheTable} ([key] text primary key, [value] text)`, (stmt: SqliteStatement) => {\n      if (DbResult.BE_SQLITE_DONE !== stmt.step())\n        throw new Error(\"unable to create temp cache table\");\n    });\n  }\n\n  public get(key: string): ChangeInstance | undefined {\n    return this._db.withPreparedSqliteStatement(\n      `SELECT [value] FROM ${this._cacheTable} WHERE [key]=?`,\n      (stmt: SqliteStatement) => {\n        stmt.reset();\n        stmt.clearBindings();\n        stmt.bindString(1, key);\n        if (stmt.step() === DbResult.BE_SQLITE_ROW)\n          return JSON.parse(stmt.getValueString(0), Base64EncodedString.reviver) as ChangeInstance;\n        return undefined;\n      },\n    );\n  }\n\n  public set(key: string, value: ChangeInstance): void {\n    const shallowCopy = Object.assign({}, value);\n    this._db.withPreparedSqliteStatement(\n      `INSERT INTO ${this._cacheTable} ([key], [value]) VALUES (?, ?) ON CONFLICT ([key]) DO UPDATE SET [value] = [excluded].[value]`,\n      (stmt: SqliteStatement) => {\n        stmt.reset();\n        stmt.clearBindings();\n        stmt.bindString(1, key);\n        stmt.bindString(2, JSON.stringify(shallowCopy, Base64EncodedString.replacer));\n        stmt.step();\n      },\n    );\n  }\n\n  public *all(): IterableIterator<ChangeInstance> {\n    const sql = `\n      SELECT JSON_GROUP_ARRAY(JSON([value]))\n      FROM (\n        SELECT [value],\n               SUM(LENGTH([value])) OVER (ORDER BY [key] ROWS UNBOUNDED PRECEDING) / ${this.bufferedReadInstanceSizeInBytes} AS [bucket]\n        FROM ${this._cacheTable}\n      )\n      GROUP BY [bucket]`;\n\n    const stmt = this._db.prepareSqliteStatement(sql);\n    try {\n      while (stmt.step() === DbResult.BE_SQLITE_ROW) {\n        const bucket = JSON.parse(stmt.getValueString(0), Base64EncodedString.reviver) as ChangeInstance[];\n        for (const instance of bucket)\n          yield instance;\n      }\n    } finally {\n      stmt[Symbol.dispose]();\n    }\n  }\n\n  public count(): number {\n    return this._db.withPreparedSqliteStatement(\n      `SELECT COUNT(*) FROM ${this._cacheTable}`,\n      (stmt: SqliteStatement) => {\n        stmt.reset();\n        if (stmt.step() === DbResult.BE_SQLITE_ROW)\n          return stmt.getValue(0).getInteger();\n        return 0;\n      },\n    );\n  }\n\n  public [Symbol.dispose](): void {\n    this._db.closeDb();\n  }\n}\n\n// ---------------------------------------------------------------------------\n// PartialChangeUnifier\n// ---------------------------------------------------------------------------\n\n/**\n * Combines partial EC change instances (one per SQLite table row) into complete\n * instances that span all tables mapping to a single EC entity.\n *\n * The merge key is derived from the `instanceKey` and `stage` stored in `$meta.instanceKey` and `$meta.stage`.\n *\n * **Usage:**\n * ```ts\n * using reader = ChangesetReader.openFile({ fileName, db });\n * using unifier = new PartialChangeUnifier();\n * while (reader.step()) {\n *   unifier.appendFrom(reader);\n * }\n * for (const instance of unifier.instances) { ... }\n * ```\n * @beta\n */\nexport class PartialChangeUnifier implements Disposable {\n  public constructor(\n    private readonly _cache: ChangeCache = new InMemoryCache(),\n  ) { }\n\n  /** Releases the underlying cache. */\n  public [Symbol.dispose](): void {\n    this._cache[Symbol.dispose]();\n  }\n\n  /** Number of complete (merged) instances currently accumulated. */\n  public get instanceCount(): number {\n    return this._cache.count();\n  }\n\n  /**\n   * Append partial changes from the current reader row and merge them into the cache.\n   *\n   * @param source Any [ChangeSource]($backend) positioned on a valid row.\n   * @beta\n   */\n  public appendFrom(source: ChangeSource): void {\n    if (source.op === \"Updated\") {\n      if (source.inserted)\n        this.combine(source.inserted);\n      if (source.deleted)\n        this.combine(source.deleted);\n    } else if (source.op === \"Inserted\" && source.inserted) {\n      this.combine(source.inserted);\n    } else if (source.op === \"Deleted\" && source.deleted) {\n      this.combine(source.deleted);\n    }\n  }\n\n  /**\n   * Iterator over all fully-merged EC change instances.\n   * @beta\n   */\n  public get instances(): IterableIterator<ChangeInstance> {\n    return this._cache.all();\n  }\n\n  // ---------------------------------------------------------------------------\n  // Private helpers\n  // ---------------------------------------------------------------------------\n\n  private buildKey(instance: ChangeInstance): string {\n    const { instanceKey, stage } = instance.$meta;\n    return `${instanceKey}-${stage}`.toLowerCase();\n  }\n\n  private combine(rhs: ChangeInstance): void {\n    const key = this.buildKey(rhs);\n    const lhs = this._cache.get(key);\n    if (lhs) {\n      // Merge data fields — rhs wins for any overlapping columns.\n      const { $meta: _rhsMeta, ...rhsData } = rhs;\n      Object.assign(lhs, rhsData);\n      // Accumulate per-table metadata lists.\n      lhs.$meta.tables = [...lhs.$meta.tables, ...rhs.$meta.tables];\n      lhs.$meta.changeIndexes = [...lhs.$meta.changeIndexes, ...rhs.$meta.changeIndexes];\n      // ECInstanceId will be part of changeset fetchedProps for every table, so we should not include multiple of those in the final list\n      lhs.$meta.changeFetchedPropNames = [...new Set([...lhs.$meta.changeFetchedPropNames, ...rhs.$meta.changeFetchedPropNames])];\n      this._cache.set(key, lhs);\n    } else {\n      this._cache.set(key, rhs);\n    }\n  }\n}\n"]}

package/lib/cjs/Relationship.d.ts

@@ -43,7 +43,7 @@ export declare class Relationship extends Entity {
      * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.
      * @param _props The ElementDrivesElement relationship instance.
      * @param _iModel The iModel
-     * @deprecated Use onRootChangedArg instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.
      */
     static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void;
     /**
@@ -57,7 +57,7 @@ export declare class Relationship extends Entity {
      * A subclass of ElementDrivesElement can re-implement this static method to take some action.
      * @param _props The deleted ElementDrivesElement relationship instance.
      * @param _iModel The iModel
-     * @deprecated Use onDeletedDependencyArg instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.
      */
     static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void;
     /**
@@ -67,7 +67,7 @@ export declare class Relationship extends Entity {
     insert(txn: EditTxn): Id64String;
     /**
      * Insert this Relationship into the iModel.
-     * @deprecated Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     insert(): Id64String;
     /**
@@ -77,7 +77,7 @@ export declare class Relationship extends Entity {
     update(txn: EditTxn): void;
     /**
      * Update this Relationship in the iModel.
-     * @deprecated Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     update(): void;
     /**
@@ -87,7 +87,7 @@ export declare class Relationship extends Entity {
     delete(txn: EditTxn): void;
     /**
      * Delete this Relationship from the iModel.
-     * @deprecated Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     delete(): void;
     static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T;
@@ -117,7 +117,7 @@ export declare class ElementRefersToElements extends Relationship {
      * @param sourceId The sourceId of the relationship, that is, the driver element.
      * @param targetId The targetId of the relationship, that is, the driven element.
      * @return The Id of the inserted Relationship.
-     * @deprecated Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
      */
     static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
@@ -420,22 +420,22 @@ export declare class Relationships {
      * @param props The properties of the new relationship.
      * @returns The Id of the newly inserted relationship.
      * @note The id property of the props object is set as a side effect of this function.
-     * @deprecated Use EditTxn.insertRelationship instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.
      */
     insertInstance(props: RelationshipProps): Id64String;
     /** Update the properties of an existing relationship instance in the iModel.
      * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.
-     * @deprecated Use EditTxn.updateRelationship instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.
      */
     updateInstance(props: RelationshipProps): void;
     /** Delete an Relationship instance from this iModel.
-     * @deprecated Use EditTxn.deleteRelationship instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.
      */
     deleteInstance(props: RelationshipProps): void;
     /** Delete multiple Relationship instances from this iModel.
      * @param props The properties of the relationship instances to delete.
      * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.
-     * @deprecated Use EditTxn.deleteRelationships instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.
      */
     deleteInstances(props: ReadonlyArray<RelationshipProps>): void;
     /** Get the props of a Relationship instance

package/lib/cjs/Relationship.js

@@ -62,7 +62,7 @@ class Relationship extends Entity_1.Entity {
      * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.
      * @param _props The ElementDrivesElement relationship instance.
      * @param _iModel The iModel
-     * @deprecated Use onRootChangedArg instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.
      */
     static onRootChanged(_props, _iModel) { }
     /**
@@ -79,7 +79,7 @@ class Relationship extends Entity_1.Entity {
      * A subclass of ElementDrivesElement can re-implement this static method to take some action.
      * @param _props The deleted ElementDrivesElement relationship instance.
      * @param _iModel The iModel
-     * @deprecated Use onDeletedDependencyArg instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.
      */
     static onDeletedDependency(_props, _iModel) { }
     insert(txn) { return this.id = (txn ?? this.iModel[Symbols_1._implicitTxn]).insertRelationship(this.toJSON()); }
@@ -439,20 +439,20 @@ class Relationships {
      * @param props The properties of the new relationship.
      * @returns The Id of the newly inserted relationship.
      * @note The id property of the props object is set as a side effect of this function.
-     * @deprecated Use EditTxn.insertRelationship instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.
      */
     insertInstance(props) {
         return this._iModel[Symbols_1._implicitTxn].insertRelationship(props);
     }
     /** Update the properties of an existing relationship instance in the iModel.
      * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.
-     * @deprecated Use EditTxn.updateRelationship instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.
      */
     updateInstance(props) {
         this._iModel[Symbols_1._implicitTxn].updateRelationship(props);
     }
     /** Delete an Relationship instance from this iModel.
-     * @deprecated Use EditTxn.deleteRelationship instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.
      */
     deleteInstance(props) {
         this._iModel[Symbols_1._implicitTxn].deleteRelationship(props);
@@ -460,7 +460,7 @@ class Relationships {
     /** Delete multiple Relationship instances from this iModel.
      * @param props The properties of the relationship instances to delete.
      * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.
-     * @deprecated Use EditTxn.deleteRelationships instead.
+     * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.
      */
     deleteInstances(props) {
         this._iModel[Symbols_1._implicitTxn].deleteRelationships(props);

package/lib/cjs/Relationship.js.map

@@ -1 +1 @@
-{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+E;AAC/E,oDAAyG;AAEzG,qCAAkC;AAClC,uCAAoC;AAEpC,gDAA6D;AAC7D,gEAA6D;AAgB7D;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAM;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAa;IACrB,QAAQ,CAAa;IAErC,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAChD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,gHAAgH;IAChG,KAAK,CAAC,WAAW;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,qCAAiB,CAAC,CAAC;QAC1G,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB;QACjD,4DAA4D;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,GAAoB;QACvD,4DAA4D;QAC5D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAYlF,MAAM,CAAC,GAAa,IAAgB,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY5H,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY/F,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/F,MAAM,CAAC,WAAW,CAAyB,MAAgB,EAAE,QAAsC,IAAO,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1L;AA9GD,oCA8GC;AAED;;GAEG;AACH,MAAa,uBAAwB,SAAQ,YAAY;IAChD,MAAM,KAAc,SAAS,KAAa,OAAO,yBAAyB,CAAC,CAAC,CAAC;IACpF;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAM,CAAC;IAC7G,CAAC;IAkBM,MAAM,CAAC,MAAM,CAAC,WAA+B,EAAE,QAAoB,EAAE,QAAoB;QAC9F,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAvCD,0DAuCC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,uBAAuB;IACnE,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAFD,0EAEC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,uBAAuB;IACvE,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAFD,kFAEC;AAED;;;;GAIG;AACH,MAAa,qCAAsC,SAAQ,uBAAuB;IACzE,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAFD,sFAEC;AAED;;;GAGG;AACH,MAAa,yCAA0C,SAAQ,qCAAqC;IAC3F,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AAFD,8FAEC;AASD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,uBAAuB;IACxD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,cAAc,CAAS;IAE9B,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAU,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,iBAAyB,CAAC;QACvJ,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;CACF;AAbD,oDAaC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,oBAAoB;IACtD,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAFD,sDAEC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;OAIG;IACI,MAAM,CAAS;IACtB,uHAAuH;IAChH,QAAQ,CAAS;IAExB,YAAsB,KAAgC,EAAE,MAAgB;QACtE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAiC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,WAAmB,CAAC;QACrI,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACxH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;IAEe,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QAC1D,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAlCD,oDAkCC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,YAAY;IACpD,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACrE,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAPD,kEAOC;AAED;;GAEG;AACH,MAAa,aAAa;IAChB,OAAO,CAAW;IAE1B,gBAAgB;IAChB,YAAmB,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/D;;;OAGG;IACI,cAAc,CAAC,KAAwB,IAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAe,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3H,2EAA2E;IACnE,sBAAsB,CAAC,aAAqB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAS,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;QACzM,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAuC;QAC5D,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAA8B,gBAAwB,EAAE,QAAsC;QACnH,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAI,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAA8B,gBAAwB,EAAE,QAAsC;QACtH,IAAI,KAAoB,CAAC;QACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,uBAAuB,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC5H,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzB,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,sDAAsD,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC3J,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAI,KAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAyB,eAAuB,EAAE,QAAsC;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAyB,gBAAwB,EAAE,QAAsC;QAC5G,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClG,OAAO,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;CACF;AArHD,sCAqHC","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 Relationships\n */\n\nimport { DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { EntityReferenceSet, IModelError, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\nimport { ECSqlStatement } from \"./ECSqlStatement\";\nimport { Entity } from \"./Entity\";\nimport { EditTxn } from \"./EditTxn\";\nimport { IModelDb } from \"./IModelDb\";\nimport { _implicitTxn, _nativeDb } from \"./internal/Symbols\";\nimport { RelationshipClass } from \"@itwin/ecschema-metadata\";\n\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\n\n/** Argument for relationship dependency callbacks.\n * @beta\n */\nexport interface OnDependencyArg {\n  /** The iModel for the relationship affected by this method. */\n  iModel: IModelDb;\n  /** The ElementDrivesElement relationship instance affected by this method. */\n  props: RelationshipProps;\n  /** The transaction for indirect processing. */\n  indirectEditTxn: EditTxn;\n}\n\n/** Base class for all link table ECRelationships\n * @public\n */\nexport class Relationship extends Entity {\n  public static override get className(): string { return \"Relationship\"; }\n  public readonly sourceId: Id64String;\n  public readonly targetId: Id64String;\n\n  protected constructor(props: RelationshipProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.sourceId = Id64.fromJSON(props.sourceId);\n    this.targetId = Id64.fromJSON(props.targetId);\n  }\n\n  public override toJSON(): RelationshipProps {\n    const val = super.toJSON() as RelationshipProps;\n    val.sourceId = this.sourceId;\n    val.targetId = this.targetId;\n    return val;\n  }\n\n  /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.*/\n  public override async getMetaData(): Promise<RelationshipClass> {\n    if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {\n      return this._metadata;\n    }\n\n    const relationship = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, RelationshipClass);\n    if (relationship !== undefined) {\n      this._metadata = relationship;\n      return this._metadata;\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n  }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\n   * This callback is invoked after the input element has been processed by upstream relationships.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\n   * @beta\n   */\n  public static onRootChangedArg(arg: OnDependencyArg): void {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.onRootChanged(arg.props, arg.iModel);\n  }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\n   * This callback is invoked after the input element has been processed by upstream relationships.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\n   * @param _props The ElementDrivesElement relationship instance.\n   * @param _iModel The iModel\n   * @deprecated Use onRootChangedArg instead.\n   */\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\n   * @beta\n   */\n  public static onDeletedDependencyArg(arg: OnDependencyArg): void {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.onDeletedDependency(arg.props, arg.iModel);\n  }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\n   * @param _props The deleted ElementDrivesElement relationship instance.\n   * @param _iModel The iModel\n   * @deprecated Use onDeletedDependencyArg instead.\n   */\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\n\n  /**\n   * Insert this Relationship into the iModel using the supplied EditTxn.\n   * @beta\n   */\n  public insert(txn: EditTxn): Id64String;\n  /**\n   * Insert this Relationship into the iModel.\n   * @deprecated Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public insert(): Id64String;\n  public insert(txn?: EditTxn): Id64String { return this.id = (txn ?? this.iModel[_implicitTxn]).insertRelationship(this.toJSON()); }\n\n  /**\n   * Update this Relationship in the iModel using the supplied EditTxn.\n   * @beta\n   */\n  public update(txn: EditTxn): void;\n  /**\n   * Update this Relationship in the iModel.\n   * @deprecated Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public update(): void;\n  public update(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).updateRelationship(this.toJSON()); }\n\n  /**\n   * Delete this Relationship from the iModel using the supplied EditTxn.\n   * @beta\n   */\n  public delete(txn: EditTxn): void;\n  /**\n   * Delete this Relationship from the iModel.\n   * @deprecated Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public delete(): void;\n  public delete(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).deleteRelationship(this.toJSON()); }\n\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\n}\n\n/** A Relationship where one Element refers to another Element\n * @public\n */\nexport class ElementRefersToElements extends Relationship {\n  public static override get className(): string { return \"ElementRefersToElements\"; }\n  /** Create an instance of the Relationship.\n   * @param iModel The iModel that will contain the relationship\n   * @param sourceId The sourceId of the relationship, that is, the driver element\n   * @param targetId The targetId of the relationship, that is, the driven element\n   * @return an instance of the specified class.\n   */\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\n  }\n\n  /** Insert a new instance of the Relationship using an explicit transaction.\n   * @param txn The EditTxn used to perform the insert.\n   * @param sourceId The sourceId of the relationship, that is, the driver element\n   * @param targetId The targetId of the relationship, that is, the driven element\n   * @return The Id of the inserted Relationship.\n   * @beta\n   */\n  public static insert(txn: EditTxn, sourceId: Id64String, targetId: Id64String): Id64String;\n  /** Insert a new instance of the Relationship.\n   * @param iModel The iModel that will contain the relationship.\n   * @param sourceId The sourceId of the relationship, that is, the driver element.\n   * @param targetId The targetId of the relationship, that is, the driven element.\n   * @return The Id of the inserted Relationship.\n   * @deprecated Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;\n  public static insert(txnOrIModel: EditTxn | IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\n    const relationship = this.create(txn.iModel, sourceId, targetId);\n    return txn.insertRelationship(relationship.toJSON());\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    referenceIds.addElement(this.sourceId);\n    referenceIds.addElement(this.targetId);\n  }\n}\n\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\n * @public\n */\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\n}\n\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\n * @public\n */\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\n}\n\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\n * Each relationship instance represents an external source processed by the synchronization configuration.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\n}\n\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\n}\n\n/** Properties that are common to all types of link table ECRelationships\n * @public\n */\nexport interface ElementGroupsMembersProps extends RelationshipProps {\n  memberPriority: number;\n}\n\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\n * @public\n */\nexport class ElementGroupsMembers extends ElementRefersToElements {\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\n  public memberPriority: number;\n\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.memberPriority = props.memberPriority;\n  }\n\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\n    return iModel.relationships.createInstance(props) as T;\n  }\n}\n\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\n * @public\n */\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\n}\n\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\n * Implies that properties of the group should be considered as properties of its members.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\n * @public\n */\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\n}\n\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\n}\n\n/** Properties that are common to all types of ElementDrivesElements\n * @beta\n */\nexport interface ElementDrivesElementProps extends RelationshipProps {\n  status: number;\n  priority: number;\n}\n\n/** A Relationship indicating that one Element *drives* another Element.\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\n * When the source of an ElementDrivesElement relationship changes, the ElementDrivesElement itself can get a callback, and both the source and target elements can get callbacks.\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\n *\n * # Defining dependencies\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\n * ```ts\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\n *  ede.insert();\n * ```\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\n *\n * # Defining dependency graphs\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\n *\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\n * ```ts\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\n *  ede12.insert();\n *  ede23.insert();\n * ```\n * Those two relationships create this graph:\n * ```\n * e1 --> e2 --> e3\n * ```\n * Where the \"-->\" is meant to represent a driving relationship.\n *\n * The order in which you create the relationships does not matter.\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\n *\n * An ElementDrivesElement relationship is between one source element and one target element.\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\n * Thus, you can define many:many relationships.\n * For example:\n * ```ts\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\n *  ede12.insert();\n *  ede112.insert();\n *  ede23.insert();\n *  ede231.insert();\n * ```\n * Creates this graph:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *    /    \\\n * e11       e31\n * ```\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\n *\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\n *\n * # Subgraph Processing\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\n * suppose we have this graph:\n * ```\n * e1 --> e2 --> e3\n * ```\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\n *\n * If only e2 changes, then the subgraph to be processed is just:\n * ```\n *       e2 --> e3\n * ```\n * If only e3 changes, then the subgraph consists of e3 by itself.\n *\n * Returning to the second example above, suppose we have this graph:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *    /    \\\n * e11       e31\n * ```\n * If e1 is changed, the affected subgraph is:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *         \\\n *           e31\n * ```\n * If e2 is changed, the affected subgraph is:\n * ```\n *           e3\n *         /\n *      e2\n *         \\\n *           e31\n * ```\n * # Callbacks\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\n *\n * ## ElementDrivesElement Callbacks\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\n * * onRootChanged\n * * onDeletedDependency\n *\n * Note that these are static methods. Their default implementations do nothing.\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\n * The subclass should then implement the callbacks that it would like to act on.\n *\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\n *\n * ## Element Callbacks\n * The following callbacks are invoked on Element classes (nodes):\n * * Element.onBeforeOutputsHandled\n * * Element.onAllInputsHandled\n *\n * ## Order\n * Callbacks are invoked by BriefcaseDb.saveChanges.\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\n *\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\n * invoked only once.\n *\n * For example, suppose we have a graph:\n * ```\n * e1 --> e2 --> e3\n * ```\n *\n * Suppose that e1 is directly modified. No callbacks are made at that time.\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\n * 1. Element.onBeforeOutputsHandled e1\n * 1. ElementDrivesElement.onRootChanged e1->e2\n * 1. Element.onAllInputsHandled e2\n * 1. ElementDrivesElement.onRootChanged e2->e3\n * 1. Element.onAllInputsHandled e3\n *\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\n *\n * Returning to the second example above, suppose we have this graph:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *    /    \\\n * e11       e31\n * ```\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *         \\\n *           e31\n * ```\n * The callbacks are:\n * 1. Element.onBeforeOutputsHandled e1\n * 1. ElementDrivesElement.onRootChanged e1->e2\n * 1. Element.onAllInputsHandled e2\n * 1. ElementDrivesElement.onRootChanged e2->e3\n * 1. Element.onAllInputsHandled e3\n * 1. ElementDrivesElement.onRootChanged e2->e31\n * 1. Element.onAllInputsHandled e31\n *\n * (The ElementDrivesElement.)\n *\n * #Errors\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\n * involved in a cycle will have their status set to 1, indicating a failure.\n *\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\n *\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\n *\n * @beta\n */\nexport class ElementDrivesElement extends Relationship {\n  public static override get className(): string { return \"ElementDrivesElement\"; }\n  /** Relationship status\n   * * 0 indicates no errors. Set after a successful evaluation.\n   * * 1 indicates that this driving relationship could not be evaluated. The callback itself can set this to indicate that it failed to process the input changes. Also, it is set if the relationship is part of a circular dependency.\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\n   */\n  public status: number;\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\n  public priority: number;\n\n  protected constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.status = props.status;\n    this.priority = props.priority;\n  }\n\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\n    return iModel.relationships.createInstance(props) as T;\n  }\n\n  public override toJSON(): ElementDrivesElementProps {\n    const props = super.toJSON() as ElementDrivesElementProps;\n    props.status = this.status;\n    props.priority = this.priority;\n    return props;\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    referenceIds.addElement(this.sourceId);\n    referenceIds.addElement(this.targetId);\n  }\n}\n\n/** The third (and last) possible link-table relationship base class in an iModel.\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\n * coupling this package with ecschema-metadata which we do not want to do.\n * @internal\n */\nexport class ModelSelectorRefersToModels extends Relationship {\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    referenceIds.addElement(this.sourceId);\n    referenceIds.addModel(this.targetId);\n  }\n}\n\n/** Manages [[Relationship]]s.\n * @public\n */\nexport class Relationships {\n  private _iModel: IModelDb;\n\n  /** @internal */\n  public constructor(iModel: IModelDb) { this._iModel = iModel; }\n\n  /** Create a new instance of a Relationship.\n   * @param props The properties of the new Relationship.\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\n   */\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\n\n  /** Check classFullName to ensure it is a link table relationship class. */\n  private checkRelationshipClass(classFullName: string) {\n    if (!this._iModel[_nativeDb].isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);\n    }\n  }\n\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\n   * @param props The properties of the new relationship.\n   * @returns The Id of the newly inserted relationship.\n   * @note The id property of the props object is set as a side effect of this function.\n   * @deprecated Use EditTxn.insertRelationship instead.\n   */\n  public insertInstance(props: RelationshipProps): Id64String {\n    return this._iModel[_implicitTxn].insertRelationship(props);\n  }\n\n  /** Update the properties of an existing relationship instance in the iModel.\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\n   * @deprecated Use EditTxn.updateRelationship instead.\n   */\n  public updateInstance(props: RelationshipProps): void {\n    this._iModel[_implicitTxn].updateRelationship(props);\n  }\n\n  /** Delete an Relationship instance from this iModel.\n   * @deprecated Use EditTxn.deleteRelationship instead.\n   */\n  public deleteInstance(props: RelationshipProps): void {\n    this._iModel[_implicitTxn].deleteRelationship(props);\n  }\n\n  /** Delete multiple Relationship instances from this iModel.\n   * @param props The properties of the relationship instances to delete.\n   * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.\n   * @deprecated Use EditTxn.deleteRelationships instead.\n   */\n  public deleteInstances(props: ReadonlyArray<RelationshipProps>): void {\n    this._iModel[_implicitTxn].deleteRelationships(props);\n  }\n\n  /** Get the props of a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\n   * @see tryGetInstanceProps\n   */\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\n    if (undefined === relationshipProps) {\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\n    }\n    return relationshipProps;\n  }\n\n  /** Get the props of a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\n   * @see getInstanceProps\n   */\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\n    let props: T | undefined;\n    if (typeof criteria === \"string\") {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt: ECSqlStatement) => {\n        stmt.bindId(1, criteria);\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\n      });\n    } else {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt: ECSqlStatement) => {\n        stmt.bindId(1, criteria.sourceId);\n        stmt.bindId(2, criteria.targetId);\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\n      });\n    }\n    if (undefined !== props) {\n      props.classFullName = (props as any).className.replace(\".\", \":\");\n    }\n    return props;\n  }\n\n  /** Get a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\n   * @see tryGetInstance\n   */\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\n  }\n\n  /** Get a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @returns The relationship or `undefined` if the relationship is not found.\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\n   * @see getInstance\n   */\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\n  }\n}\n"]}
+{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+E;AAC/E,oDAAyG;AAEzG,qCAAkC;AAClC,uCAAoC;AAEpC,gDAA6D;AAC7D,gEAA6D;AAgB7D;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAM;IAC/B,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAa;IACrB,QAAQ,CAAa;IAErC,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAuB,CAAC;QAChD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,gHAAgH;IAChG,KAAK,CAAC,WAAW;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,qCAAiB,CAAC,CAAC;QAC1G,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAC9B,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAoB;QACjD,4DAA4D;QAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,GAAoB;QACvD,4DAA4D;QAC5D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAYlF,MAAM,CAAC,GAAa,IAAgB,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY5H,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAY/F,MAAM,CAAC,GAAa,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAE/F,MAAM,CAAC,WAAW,CAAyB,MAAgB,EAAE,QAAsC,IAAO,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC1L;AA9GD,oCA8GC;AAED;;GAEG;AACH,MAAa,uBAAwB,SAAQ,YAAY;IAChD,MAAM,KAAc,SAAS,KAAa,OAAO,yBAAyB,CAAC,CAAC,CAAC;IACpF;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAM,CAAC;IAC7G,CAAC;IAkBM,MAAM,CAAC,MAAM,CAAC,WAA+B,EAAE,QAAoB,EAAE,QAAoB;QAC9F,MAAM,GAAG,GAAG,WAAW,YAAY,iBAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,sBAAY,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjE,OAAO,GAAG,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAvCD,0DAuCC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,uBAAuB;IACnE,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAFD,0EAEC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,uBAAuB;IACvE,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAFD,kFAEC;AAED;;;;GAIG;AACH,MAAa,qCAAsC,SAAQ,uBAAuB;IACzE,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAFD,sFAEC;AAED;;;GAGG;AACH,MAAa,yCAA0C,SAAQ,qCAAqC;IAC3F,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AAFD,8FAEC;AASD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,uBAAuB;IACxD,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAC1E,cAAc,CAAS;IAE9B,YAAY,KAAgC,EAAE,MAAgB;QAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAU,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,iBAAyB,CAAC;QACvJ,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;CACF;AAbD,oDAaC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,oBAAoB;IACtD,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAFD,sDAEC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACjE,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAFD,4EAEC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IAC7C,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACjF;;;;OAIG;IACI,MAAM,CAAS;IACtB,uHAAuH;IAChH,QAAQ,CAAS;IAExB,YAAsB,KAAgC,EAAE,MAAgB;QACtE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAiC,MAAgB,EAAE,QAAoB,EAAE,QAAoB,EAAE,WAAmB,CAAC;QACrI,MAAM,KAAK,GAA8B,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;QACxH,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAM,CAAC;IACzD,CAAC;IAEe,MAAM;QACpB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAA+B,CAAC;QAC1D,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAEkB,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAlCD,oDAkCC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,YAAY;IACpD,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACrE,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AAPD,kEAOC;AAED;;GAEG;AACH,MAAa,aAAa;IAChB,OAAO,CAAW;IAE1B,gBAAgB;IAChB,YAAmB,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAE/D;;;OAGG;IACI,cAAc,CAAC,KAAwB,IAAkB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAe,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3H,2EAA2E;IACnE,sBAAsB,CAAC,aAAqB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAS,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtF,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;QACzM,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,KAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAuC;QAC5D,IAAI,CAAC,OAAO,CAAC,sBAAY,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAA8B,gBAAwB,EAAE,QAAsC;QACnH,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAI,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAA8B,gBAAwB,EAAE,QAAsC;QACtH,IAAI,KAAoB,CAAC;QACzB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,uBAAuB,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC5H,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACzB,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,4DAA4D;YAC5D,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,iBAAiB,gBAAgB,sDAAsD,EAAE,CAAC,IAAoB,EAAE,EAAE;gBAC3J,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAClC,OAAO,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,aAAa,GAAI,KAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAyB,eAAuB,EAAE,QAAsC;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAyB,gBAAwB,EAAE,QAAsC;QAC5G,MAAM,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAoB,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAClG,OAAO,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,CAAC;CACF;AArHD,sCAqHC","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 Relationships\n */\n\nimport { DbResult, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { EntityReferenceSet, IModelError, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\nimport { ECSqlStatement } from \"./ECSqlStatement\";\nimport { Entity } from \"./Entity\";\nimport { EditTxn } from \"./EditTxn\";\nimport { IModelDb } from \"./IModelDb\";\nimport { _implicitTxn, _nativeDb } from \"./internal/Symbols\";\nimport { RelationshipClass } from \"@itwin/ecschema-metadata\";\n\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\n\n/** Argument for relationship dependency callbacks.\n * @beta\n */\nexport interface OnDependencyArg {\n  /** The iModel for the relationship affected by this method. */\n  iModel: IModelDb;\n  /** The ElementDrivesElement relationship instance affected by this method. */\n  props: RelationshipProps;\n  /** The transaction for indirect processing. */\n  indirectEditTxn: EditTxn;\n}\n\n/** Base class for all link table ECRelationships\n * @public\n */\nexport class Relationship extends Entity {\n  public static override get className(): string { return \"Relationship\"; }\n  public readonly sourceId: Id64String;\n  public readonly targetId: Id64String;\n\n  protected constructor(props: RelationshipProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.sourceId = Id64.fromJSON(props.sourceId);\n    this.targetId = Id64.fromJSON(props.targetId);\n  }\n\n  public override toJSON(): RelationshipProps {\n    const val = super.toJSON() as RelationshipProps;\n    val.sourceId = this.sourceId;\n    val.targetId = this.targetId;\n    return val;\n  }\n\n  /** Query metadata for this relationship class from the iModel's schema. Returns cached metadata if available.*/\n  public override async getMetaData(): Promise<RelationshipClass> {\n    if (this._metadata && RelationshipClass.isRelationshipClass(this._metadata)) {\n      return this._metadata;\n    }\n\n    const relationship = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, RelationshipClass);\n    if (relationship !== undefined) {\n      this._metadata = relationship;\n      return this._metadata;\n    } else {\n      throw new Error(`Cannot get metadata for ${this.classFullName}`);\n    }\n  }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\n   * This callback is invoked after the input element has been processed by upstream relationships.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\n   * @beta\n   */\n  public static onRootChangedArg(arg: OnDependencyArg): void {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.onRootChanged(arg.props, arg.iModel);\n  }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when its input has changed or is the output of some upstream relationship whose input has changed.\n   * This callback is invoked after the input element has been processed by upstream relationships.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\n   * @param _props The ElementDrivesElement relationship instance.\n   * @param _iModel The iModel\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use onRootChangedArg instead.\n   */\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\n   * @beta\n   */\n  public static onDeletedDependencyArg(arg: OnDependencyArg): void {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    this.onDeletedDependency(arg.props, arg.iModel);\n  }\n\n  /**\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\n   * @param _props The deleted ElementDrivesElement relationship instance.\n   * @param _iModel The iModel\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use onDeletedDependencyArg instead.\n   */\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\n\n  /**\n   * Insert this Relationship into the iModel using the supplied EditTxn.\n   * @beta\n   */\n  public insert(txn: EditTxn): Id64String;\n  /**\n   * Insert this Relationship into the iModel.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use Relationship.insert(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public insert(): Id64String;\n  public insert(txn?: EditTxn): Id64String { return this.id = (txn ?? this.iModel[_implicitTxn]).insertRelationship(this.toJSON()); }\n\n  /**\n   * Update this Relationship in the iModel using the supplied EditTxn.\n   * @beta\n   */\n  public update(txn: EditTxn): void;\n  /**\n   * Update this Relationship in the iModel.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use Relationship.update(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public update(): void;\n  public update(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).updateRelationship(this.toJSON()); }\n\n  /**\n   * Delete this Relationship from the iModel using the supplied EditTxn.\n   * @beta\n   */\n  public delete(txn: EditTxn): void;\n  /**\n   * Delete this Relationship from the iModel.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use Relationship.delete(txn) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public delete(): void;\n  public delete(txn?: EditTxn) { (txn ?? this.iModel[_implicitTxn]).deleteRelationship(this.toJSON()); }\n\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\n}\n\n/** A Relationship where one Element refers to another Element\n * @public\n */\nexport class ElementRefersToElements extends Relationship {\n  public static override get className(): string { return \"ElementRefersToElements\"; }\n  /** Create an instance of the Relationship.\n   * @param iModel The iModel that will contain the relationship\n   * @param sourceId The sourceId of the relationship, that is, the driver element\n   * @param targetId The targetId of the relationship, that is, the driven element\n   * @return an instance of the specified class.\n   */\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\n  }\n\n  /** Insert a new instance of the Relationship using an explicit transaction.\n   * @param txn The EditTxn used to perform the insert.\n   * @param sourceId The sourceId of the relationship, that is, the driver element\n   * @param targetId The targetId of the relationship, that is, the driven element\n   * @return The Id of the inserted Relationship.\n   * @beta\n   */\n  public static insert(txn: EditTxn, sourceId: Id64String, targetId: Id64String): Id64String;\n  /** Insert a new instance of the Relationship.\n   * @param iModel The iModel that will contain the relationship.\n   * @param sourceId The sourceId of the relationship, that is, the driver element.\n   * @param targetId The targetId of the relationship, that is, the driven element.\n   * @return The Id of the inserted Relationship.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use ElementRefersToElements.insert(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.\n   */\n  public static insert(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;\n  public static insert(txnOrIModel: EditTxn | IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\n    const txn = txnOrIModel instanceof EditTxn ? txnOrIModel : txnOrIModel[_implicitTxn];\n    const relationship = this.create(txn.iModel, sourceId, targetId);\n    return txn.insertRelationship(relationship.toJSON());\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    referenceIds.addElement(this.sourceId);\n    referenceIds.addElement(this.targetId);\n  }\n}\n\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\n * @public\n */\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\n}\n\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\n * @public\n */\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\n}\n\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\n * Each relationship instance represents an external source processed by the synchronization configuration.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\n}\n\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\n}\n\n/** Properties that are common to all types of link table ECRelationships\n * @public\n */\nexport interface ElementGroupsMembersProps extends RelationshipProps {\n  memberPriority: number;\n}\n\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\n * @public\n */\nexport class ElementGroupsMembers extends ElementRefersToElements {\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\n  public memberPriority: number;\n\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.memberPriority = props.memberPriority;\n  }\n\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\n    return iModel.relationships.createInstance(props) as T;\n  }\n}\n\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\n * @public\n */\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\n}\n\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\n * Implies that properties of the group should be considered as properties of its members.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\n * @public\n */\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\n}\n\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\n}\n\n/** Properties that are common to all types of ElementDrivesElements\n * @beta\n */\nexport interface ElementDrivesElementProps extends RelationshipProps {\n  status: number;\n  priority: number;\n}\n\n/** A Relationship indicating that one Element *drives* another Element.\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\n * When the source of an ElementDrivesElement relationship changes, the ElementDrivesElement itself can get a callback, and both the source and target elements can get callbacks.\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\n *\n * # Defining dependencies\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\n * ```ts\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\n *  ede.insert();\n * ```\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\n *\n * # Defining dependency graphs\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\n *\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\n * ```ts\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\n *  ede12.insert();\n *  ede23.insert();\n * ```\n * Those two relationships create this graph:\n * ```\n * e1 --> e2 --> e3\n * ```\n * Where the \"-->\" is meant to represent a driving relationship.\n *\n * The order in which you create the relationships does not matter.\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\n *\n * An ElementDrivesElement relationship is between one source element and one target element.\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\n * Thus, you can define many:many relationships.\n * For example:\n * ```ts\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\n *  ede12.insert();\n *  ede112.insert();\n *  ede23.insert();\n *  ede231.insert();\n * ```\n * Creates this graph:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *    /    \\\n * e11       e31\n * ```\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\n *\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\n *\n * # Subgraph Processing\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\n * suppose we have this graph:\n * ```\n * e1 --> e2 --> e3\n * ```\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\n *\n * If only e2 changes, then the subgraph to be processed is just:\n * ```\n *       e2 --> e3\n * ```\n * If only e3 changes, then the subgraph consists of e3 by itself.\n *\n * Returning to the second example above, suppose we have this graph:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *    /    \\\n * e11       e31\n * ```\n * If e1 is changed, the affected subgraph is:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *         \\\n *           e31\n * ```\n * If e2 is changed, the affected subgraph is:\n * ```\n *           e3\n *         /\n *      e2\n *         \\\n *           e31\n * ```\n * # Callbacks\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\n *\n * ## ElementDrivesElement Callbacks\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\n * * onRootChanged\n * * onDeletedDependency\n *\n * Note that these are static methods. Their default implementations do nothing.\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\n * The subclass should then implement the callbacks that it would like to act on.\n *\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\n *\n * ## Element Callbacks\n * The following callbacks are invoked on Element classes (nodes):\n * * Element.onBeforeOutputsHandled\n * * Element.onAllInputsHandled\n *\n * ## Order\n * Callbacks are invoked by BriefcaseDb.saveChanges.\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\n *\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\n * invoked only once.\n *\n * For example, suppose we have a graph:\n * ```\n * e1 --> e2 --> e3\n * ```\n *\n * Suppose that e1 is directly modified. No callbacks are made at that time.\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\n * 1. Element.onBeforeOutputsHandled e1\n * 1. ElementDrivesElement.onRootChanged e1->e2\n * 1. Element.onAllInputsHandled e2\n * 1. ElementDrivesElement.onRootChanged e2->e3\n * 1. Element.onAllInputsHandled e3\n *\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\n *\n * Returning to the second example above, suppose we have this graph:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *    /    \\\n * e11       e31\n * ```\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\n * ```\n * e1        e3\n *    \\    /\n *      e2\n *         \\\n *           e31\n * ```\n * The callbacks are:\n * 1. Element.onBeforeOutputsHandled e1\n * 1. ElementDrivesElement.onRootChanged e1->e2\n * 1. Element.onAllInputsHandled e2\n * 1. ElementDrivesElement.onRootChanged e2->e3\n * 1. Element.onAllInputsHandled e3\n * 1. ElementDrivesElement.onRootChanged e2->e31\n * 1. Element.onAllInputsHandled e31\n *\n * (The ElementDrivesElement.)\n *\n * #Errors\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\n * involved in a cycle will have their status set to 1, indicating a failure.\n *\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\n *\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\n *\n * @beta\n */\nexport class ElementDrivesElement extends Relationship {\n  public static override get className(): string { return \"ElementDrivesElement\"; }\n  /** Relationship status\n   * * 0 indicates no errors. Set after a successful evaluation.\n   * * 1 indicates that this driving relationship could not be evaluated. The callback itself can set this to indicate that it failed to process the input changes. Also, it is set if the relationship is part of a circular dependency.\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\n   */\n  public status: number;\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\n  public priority: number;\n\n  protected constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.status = props.status;\n    this.priority = props.priority;\n  }\n\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\n    return iModel.relationships.createInstance(props) as T;\n  }\n\n  public override toJSON(): ElementDrivesElementProps {\n    const props = super.toJSON() as ElementDrivesElementProps;\n    props.status = this.status;\n    props.priority = this.priority;\n    return props;\n  }\n\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    referenceIds.addElement(this.sourceId);\n    referenceIds.addElement(this.targetId);\n  }\n}\n\n/** The third (and last) possible link-table relationship base class in an iModel.\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\n * coupling this package with ecschema-metadata which we do not want to do.\n * @internal\n */\nexport class ModelSelectorRefersToModels extends Relationship {\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    referenceIds.addElement(this.sourceId);\n    referenceIds.addModel(this.targetId);\n  }\n}\n\n/** Manages [[Relationship]]s.\n * @public\n */\nexport class Relationships {\n  private _iModel: IModelDb;\n\n  /** @internal */\n  public constructor(iModel: IModelDb) { this._iModel = iModel; }\n\n  /** Create a new instance of a Relationship.\n   * @param props The properties of the new Relationship.\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\n   */\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\n\n  /** Check classFullName to ensure it is a link table relationship class. */\n  private checkRelationshipClass(classFullName: string) {\n    if (!this._iModel[_nativeDb].isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);\n    }\n  }\n\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\n   * @param props The properties of the new relationship.\n   * @returns The Id of the newly inserted relationship.\n   * @note The id property of the props object is set as a side effect of this function.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.insertRelationship instead.\n   */\n  public insertInstance(props: RelationshipProps): Id64String {\n    return this._iModel[_implicitTxn].insertRelationship(props);\n  }\n\n  /** Update the properties of an existing relationship instance in the iModel.\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.updateRelationship instead.\n   */\n  public updateInstance(props: RelationshipProps): void {\n    this._iModel[_implicitTxn].updateRelationship(props);\n  }\n\n  /** Delete an Relationship instance from this iModel.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationship instead.\n   */\n  public deleteInstance(props: RelationshipProps): void {\n    this._iModel[_implicitTxn].deleteRelationship(props);\n  }\n\n  /** Delete multiple Relationship instances from this iModel.\n   * @param props The properties of the relationship instances to delete.\n   * @remarks This method handles bulk deletion of relationships and supports mixed collections containing instances from different relationship classes.\n   * @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.deleteRelationships instead.\n   */\n  public deleteInstances(props: ReadonlyArray<RelationshipProps>): void {\n    this._iModel[_implicitTxn].deleteRelationships(props);\n  }\n\n  /** Get the props of a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\n   * @see tryGetInstanceProps\n   */\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\n    if (undefined === relationshipProps) {\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\n    }\n    return relationshipProps;\n  }\n\n  /** Get the props of a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\n   * @see getInstanceProps\n   */\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\n    let props: T | undefined;\n    if (typeof criteria === \"string\") {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt: ECSqlStatement) => {\n        stmt.bindId(1, criteria);\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\n      });\n    } else {\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt: ECSqlStatement) => {\n        stmt.bindId(1, criteria.sourceId);\n        stmt.bindId(2, criteria.targetId);\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\n      });\n    }\n    if (undefined !== props) {\n      props.classFullName = (props as any).className.replace(\".\", \":\");\n    }\n    return props;\n  }\n\n  /** Get a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\n   * @see tryGetInstance\n   */\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\n  }\n\n  /** Get a Relationship instance\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\n   * @param criteria Either the relationship instanceId or the source and target Ids\n   * @returns The relationship or `undefined` if the relationship is not found.\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\n   * @see getInstance\n   */\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\n  }\n}\n"]}

package/lib/cjs/SheetIndex.d.ts

@@ -65,7 +65,7 @@ export declare class SheetIndex extends InformationReferenceElement {
      * @throws [[IModelError]] if there is a problem inserting the SheetIndex
      */
     static insert(txn: EditTxn, modelId: Id64String, name: string): Id64String;
-    /** @deprecated Use SheetIndex.insert(txn, ...) instead. */
+    /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use SheetIndex.insert(txn, ...) instead. */
     static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String;
 }
 /** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.
@@ -101,7 +101,7 @@ export declare class SheetIndexFolder extends SheetIndexEntry {
      * @throws [[IModelError]] if unable to create the element.
      */
     static insert(txn: EditTxn, arg: Omit<SheetIndexEntryCreateArgs, "iModelDb">): Id64String;
-    /** @deprecated Use SheetIndexFolder.insert(txn, ...) instead. */
+    /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use SheetIndexFolder.insert(txn, ...) instead. */
     static insert(arg: SheetIndexEntryCreateArgs): Id64String;
 }
 /** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.
@@ -124,7 +124,7 @@ export declare class SheetIndexReference extends SheetIndexEntry {
      * @throws [[IModelError]] if unable to create the element.
      */
     static insert(txn: EditTxn, arg: Omit<SheetIndexReferenceCreateArgs, "iModelDb">): Id64String;
-    /** @deprecated Use SheetIndexReference.insert(txn, ...) instead. */
+    /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use SheetIndexReference.insert(txn, ...) instead. */
     static insert(arg: SheetIndexReferenceCreateArgs): Id64String;
     /** @alpha */
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
@@ -149,7 +149,7 @@ export declare class SheetReference extends SheetIndexEntry {
      * @throws [[IModelError]] if unable to create the element.
      */
     static insert(txn: EditTxn, arg: Omit<SheetReferenceCreateArgs, "iModelDb">): Id64String;
-    /** @deprecated Use SheetReference.insert(txn, ...) instead. */
+    /** @deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use SheetReference.insert(txn, ...) instead. */
     static insert(arg: SheetReferenceCreateArgs): Id64String;
     /** @alpha */
     protected collectReferenceIds(referenceIds: EntityReferenceSet): void;