@itwin/core-backend 4.0.0-dev.94 → 4.0.0-dev.95

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

@@ -1 +1 @@
-{"version":3,"file":"PropertyStore.d.ts","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;;;YAOY;AACZ,MAAM,WAAW,aAAa;IAE5B,sGAAsG;IACtG,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;IAEtC,mFAAmF;IACnF,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,gBAAgB,CAAC;IAElD;;;OAGG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;;;OAOG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,IAAI,WAAW,CAAC,aAAa,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,YAAY,EAAE,KAAK,EAAE,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjG;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1E;AAED,aAAa;AACb,yBAAiB,aAAa,CAAC;IAC7B,gBAAgB;IACT,IAAI,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,oBAAoB,KAAK,aAAa,CAAC,GAAG,SAAS,CAAC;IAEvG,gEAAgE;IAChE,KAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,CAAC;IAClF,uHAAuH;IACvH,KAAY,YAAY,GAAG,MAAM,CAAC;IAClC,mFAAmF;IACnF,KAAY,aAAa,GAAG;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,EAAE,CAAC;IAC1E,sGAAsG;IACtG,KAAY,eAAe,GAAG,IAAI,GAAG,MAAM,CAAC;IAC5C,+GAA+G;IAC/G,KAAY,iBAAiB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,eAAe,CAAC;IAElE,8EAA8E;IAC9E,UAAiB,cAAc;QAC7B,6EAA6E;QAC7E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QACxB,0DAA0D;QAC1D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;QACpF,kGAAkG;QAClG,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QAClC,8JAA8J;QAC9J,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;KACjC;IAED;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,CAAC;QAC1D;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;QAClD;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;QAC5D;;UAEE;QACF,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,CAAC;QACpD;;UAEE;QACF,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC;QAC/D;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;QAClD;;UAEE;QACF,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;QAC5D;;UAEE;QACF,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS,CAAC;QACpD;;UAEE;QACF,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,GAAG,UAAU,CAAC;QAClE;;UAEE;QACF,SAAS,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,YAAY,GAAG,CAAC,GAAG,SAAS,CAAC;QACtE;;UAEE;QACF,SAAS,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3E,iFAAiF;QACjF,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;KAC1E;CACF"}
+{"version":3,"file":"PropertyStore.d.ts","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,YAAY;AACZ,yBAAiB,aAAa,CAAC;IAE7B,gEAAgE;IAChE,KAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,aAAa,CAAC;IAClF,sIAAsI;IACtI,KAAY,YAAY,GAAG,MAAM,CAAC;IAClC,mFAAmF;IACnF,KAAY,aAAa,GAAG;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,EAAE,CAAC;IAC1E,sGAAsG;IACtG,KAAY,eAAe,GAAG,IAAI,GAAG,MAAM,CAAC;IAC5C,+GAA+G;IAC/G,KAAY,iBAAiB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,eAAe,CAAC;IAElE,8EAA8E;IAC9E,UAAiB,cAAc;QAC7B,6EAA6E;QAC7E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QACxB,0DAA0D;QAC1D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,CAAC;QAC3F,kGAAkG;QAClG,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QAClC,8JAA8J;QAC9J,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;KACjC;IAED;;OAEG;IACH,MAAa,UAAW,SAAQ,iBAAiB;QAC/C,SAAyB,SAAS,WAAW;kBAE1B,SAAS;QAI5B;;WAEG;QACI,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;QAoBhE;;UAEE;QACK,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;QAClE;;UAEE;QACK,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;QAKxD;;UAEE;QACK,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS;QAC1D;;UAEE;QACK,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO;QAKrE;;UAEE;QACK,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;QACxD;;UAEE;QACK,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;QAKlE;;UAEE;QACK,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS;QAC1D;;UAEE;QACK,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,GAAG,UAAU;QAKxE;;UAEE;QACK,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,aAAa,GAAG,SAAS;QAC/D;;UAEE;QACK,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,GAAG,aAAa;QAMhF,iFAAiF;QAC1E,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,cAAc;QAoBxE;;WAEG;QACU,cAAc,CAAC,QAAQ,EAAE,YAAY;QAMlD;;WAEG;QACU,gBAAgB,CAAC,SAAS,EAAE,YAAY,EAAE;QAIvD,OAAO,CAAC,YAAY;QAKpB;;WAEG;QACU,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY;QAoCjE;;WAEG;QACU,cAAc,CAAC,KAAK,EAAE,aAAa;KAIjD;IAID;;;;;;;;OAQG;IACH,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC;oBAC5C,KAAK,EAAE,WAAW,CAAC,oBAAoB;QAI1D;;;;WAIG;eACiB,YAAY,CAAC,IAAI,EAAE;YAAE,KAAK,EAAE,WAAW,CAAC,oBAAoB,CAAC;YAAC,aAAa,CAAC,EAAE;gBAAE,SAAS,CAAC,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE;KAG3H;CACF"}

package/lib/cjs/PropertyStore.js

@@ -5,8 +5,176 @@
 *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PropertyStore = void 0;
-/** @alpha */
+/** @packageDocumentation
+ * @module SQLiteDb
+ */
+const core_bentley_1 = require("@itwin/core-bentley");
+const CloudSqlite_1 = require("./CloudSqlite");
+const SQLiteDb_1 = require("./SQLiteDb");
+/** @beta */
 var PropertyStore;
 (function (PropertyStore) {
+    /**
+     * A SQLite database for storing PropertyName/PropertyValue pairs.
+     */
+    class PropertyDb extends SQLiteDb_1.VersionedSqliteDb {
+        constructor() {
+            super(...arguments);
+            this.myVersion = "3.0.0";
+        }
+        createDDL() {
+            this.createTable({ tableName: "properties", columns: "name TEXT NOT NULL PRIMARY KEY,type,value", addTimestamp: true });
+        }
+        /** get the value of a Property by name.
+         * @returns the property's value if it exists, `undefined` otherwise.
+         */
+        getProperty(name) {
+            return this.withPreparedSqliteStatement("SELECT type,value from properties WHERE name=?", (stmt) => {
+                stmt.bindString(1, name);
+                if (!stmt.nextRow())
+                    return undefined;
+                switch (stmt.getValueString(0)) {
+                    case "string":
+                        return stmt.getValueString(1);
+                    case "boolean":
+                        return stmt.getValueInteger(1) !== 0;
+                    case "blob":
+                        return stmt.getValueBlob(1);
+                    case "number":
+                        return stmt.getValueDouble(1);
+                    case "object":
+                        return JSON.parse(stmt.getValueString(1));
+                }
+                return undefined;
+            });
+        }
+        getString(name, defaultValue) {
+            const out = this.getProperty(name);
+            return typeof out === "string" ? out : defaultValue;
+        }
+        getBoolean(name, defaultValue) {
+            const out = this.getProperty(name);
+            return typeof out === "boolean" ? out : defaultValue;
+        }
+        getNumber(name, defaultValue) {
+            const out = this.getProperty(name);
+            return typeof out === "number" ? out : defaultValue;
+        }
+        getBlob(name, defaultValue) {
+            const out = this.getProperty(name);
+            return out instanceof Uint8Array ? out : defaultValue;
+        }
+        getObject(name, defaultValue) {
+            const out = this.getProperty(name);
+            return typeof out === "object" ? out : defaultValue;
+        }
+        /** call an iteration function for each property, optionally applying a filter */
+        forAllProperties(iter, filter) {
+            let sql = "SELECT name FROM properties WHERE name IS NOT NULL";
+            if (filter?.sqlExpression)
+                sql += ` AND ${filter.sqlExpression} `;
+            if (filter?.value)
+                sql += ` AND name ${filter.valueCompare ?? "="} @val`;
+            if (filter?.orderBy)
+                sql += ` ORDER BY name ${filter.orderBy} `;
+            this.withSqliteStatement(sql, (stmt) => {
+                if (filter?.value)
+                    stmt.bindString("@val", filter.value);
+                while (stmt.nextRow()) {
+                    if (iter(stmt.getValueString(0)) === "stop")
+                        return;
+                }
+            });
+        }
+        /** Delete a single property from this PropertyDb. If the value does not exist, this method does nothing.
+         * @note the database must be opened for write
+         */
+        async deleteProperty(propName) {
+            this.withSqliteStatement("DELETE from properties WHERE name=?", (stmt) => {
+                stmt.bindString(1, propName);
+                stmt.step();
+            });
+        }
+        /** Delete an array of properties from this PropertyDb. Any value that does not exist is ignored.
+         * @note the database must be opened for write
+         */
+        async deleteProperties(propNames) {
+            propNames.forEach(async (name) => this.deleteProperty(name));
+        }
+        validateName(name) {
+            if (typeof name !== "string" || name.trim() !== name || name.length > 2 * 1024 || name.length < 2)
+                throw new Error(`illegal property name[${name}]`);
+        }
+        /** Save a single property in this PropertyDb. If the property already exists, its value is overwritten.
+         * @note the database must be opened for write
+         */
+        async saveProperty(name, value) {
+            this.validateName(name);
+            this.withSqliteStatement("INSERT OR REPLACE INTO properties(name,type,value) VALUES (?,?,?)", (stmt) => {
+                stmt.bindString(1, name);
+                switch (typeof value) {
+                    case "string":
+                        stmt.bindString(2, "string");
+                        stmt.bindString(3, value);
+                        break;
+                    case "boolean":
+                        stmt.bindString(2, "boolean");
+                        stmt.bindInteger(3, value ? 1 : 0);
+                        break;
+                    case "number":
+                        stmt.bindString(2, "number");
+                        stmt.bindDouble(3, value);
+                        break;
+                    case "object":
+                        if (value instanceof Uint8Array) {
+                            stmt.bindString(2, "blob");
+                            stmt.bindBlob(3, value);
+                        }
+                        else {
+                            stmt.bindString(2, "object");
+                            stmt.bindString(3, JSON.stringify(value));
+                        }
+                        break;
+                    default:
+                        throw new Error("illegal property value type");
+                }
+                const rc = stmt.step();
+                if (rc !== core_bentley_1.DbResult.BE_SQLITE_DONE)
+                    throw new core_bentley_1.BentleyError(rc, "error saving property");
+            });
+        }
+        /** Save an array of properties in this PropertyDb. If a property already exists, its value is overwritten.
+         * @note the database must be opened for write
+         */
+        async saveProperties(props) {
+            for (const prop of props)
+                await this.saveProperty(prop.name, prop.value);
+        }
+    }
+    PropertyStore.PropertyDb = PropertyDb;
+    const defaultDbName = "PropertyDb";
+    /**
+     * Provides access to a cloud-based `PropertyDb` to hold a set of values of type `PropertyType`, each with a unique `PropertyName`.
+     * `PropertyStore.PropertyDb`s that are stored in cloud containers require an access token that grants permission to read and/or write them.
+     * All write operations will fail without an access token that grants write permission.
+     *
+     * The database is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.
+     * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes
+     * made by others, as appropriate (see [[synchronizeWithCloud]]).
+     */
+    class CloudAccess extends CloudSqlite_1.CloudSqlite.DbAccess {
+        constructor(props) {
+            super({ dbType: PropertyDb, props, dbName: defaultDbName });
+        }
+        /**
+         * Initialize a cloud container for use as a PropertyStore. The container must first be created via its storage supplier api (e.g. Azure, or AWS).
+         * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty PropertyDb into the container.
+         * @note this deletes any existing content in the container.
+         */
+        static async initializeDb(args) {
+            return super._initializeDb({ ...args, dbType: PropertyDb, dbName: defaultDbName });
+        }
+    }
+    PropertyStore.CloudAccess = CloudAccess;
 })(PropertyStore = exports.PropertyStore || (exports.PropertyStore = {}));
 //# sourceMappingURL=PropertyStore.js.map

package/lib/cjs/PropertyStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyStore.js","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AA6D/F,aAAa;AACb,IAAiB,aAAa,CA+E7B;AA/ED,WAAiB,aAAa;AA+E9B,CAAC,EA/EgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA+E7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { AccessToken } from \"@itwin/core-bentley\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\n\r\n/**\r\n * A persistent storage for a set of values of type `PropertyType`, each with a unique `PropertyName`.\r\n * `PropertyStore`s are stored in cloud containers, and require an access token that grants permission to read and/or write them.\r\n * All write operations will fail without an access token that grants write permission.\r\n * A `PropertyStore` is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.\r\n * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes\r\n * made by others, as appropriate (see [[synchronizeWithCloud]]).\r\n * @alpha */\r\nexport interface PropertyStore {\r\n\r\n  /** The collection of property values in the PropertyStore as of the last time it was synchronized. */\r\n  readonly values: PropertyStore.Values;\r\n\r\n  /** Parameters for obtaining the write lock on the container for a PropertyStore.*/\r\n  readonly lockParams: CloudSqlite.ObtainLockParams;\r\n\r\n  /**\r\n   * The token that grants access to the cloud container for this PropertyStore. If it does not grant write permissions, all\r\n   * write operations will fail. It should be refreshed (via a timer) before it expires.\r\n   */\r\n  sasToken: AccessToken;\r\n\r\n  /**\r\n   * Synchronize the local values in this PropertyStore with any changes by made by others.\r\n   * @note This is called automatically whenever any write operation is performed on the PropertyStore. It is only necessary to\r\n   * call this directly if you have not changed the PropertyStore recently, but wish to perform a readonly operation and want to\r\n   * ensure it is up-to-date as of now.\r\n   * @note There is no guarantee that the Values are up-to-date even immediately after calling this method, since others\r\n   * may be modifying them at any time.\r\n   */\r\n  synchronizeWithCloud(): void;\r\n\r\n  /** initiate a prefetch operation on this PropertyStore\r\n   * @internal\r\n   */\r\n  startPrefetch(): CloudSqlite.CloudPrefetch;\r\n\r\n  /** Save a single property in this PropertyStore. If the property already exists, its value is overwritten.\r\n   * @note This will obtain the write lock, save the value, and then release the write lock.\r\n   */\r\n  saveProperty(name: PropertyStore.PropertyName, value: PropertyStore.PropertyType): Promise<void>;\r\n  /** Save an array of properties in this PropertyStore. If a property already exists, its value is overwritten.\r\n   * @note This will obtain the write lock, save the values, and then release the write lock.\r\n   */\r\n  saveProperties(props: PropertyStore.PropertyArray): Promise<void>;\r\n  /** Delete a single property from this PropertyStore. If the value does not exist, this method does nothing.\r\n   * @note This will obtain the write lock, delete the value, and then release the write lock.\r\n   */\r\n  deleteProperty(propName: PropertyStore.PropertyName): Promise<void>;\r\n  /** Delete an array of properties from this PropertyStore. Any value that does not exist is ignored.\r\n   * @note This will obtain the write lock, delete the values, and then release the write lock.\r\n   */\r\n  deleteProperties(propNames: PropertyStore.PropertyName[]): Promise<void>;\r\n}\r\n\r\n/** @alpha */\r\nexport namespace PropertyStore {\r\n  /** @internal */\r\n  export let openPropertyStore: ((props: CloudSqlite.ContainerAccessProps) => PropertyStore) | undefined;\r\n\r\n  /** The set of valid types for properties in a PropertyStore. */\r\n  export type PropertyType = string | number | boolean | Uint8Array | SettingObject;\r\n  /** The name of a Property. May not have leading or trailing spaces, and must be between 3 and 2048 characters long. */\r\n  export type PropertyName = string;\r\n  /** An array of PropertyName/PropertyType pairs to be stored in a PropertyStore. */\r\n  export type PropertyArray = { name: PropertyName, value: PropertyType }[];\r\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\r\n  export type IterationReturn = void | \"stop\";\r\n  /** An iteration function over Properties in a PropertyStore. It is called with the name of a each Property. */\r\n  export type PropertyIteration = (name: string) => IterationReturn;\r\n\r\n  /** A filter used to limit and/or sort the values returned by an iteration. */\r\n  export interface PropertyFilter {\r\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\r\n    readonly value?: string;\r\n    /** The comparison operator for `value`. Default is `=` */\r\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"<\" | \">\";\r\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\r\n    readonly orderBy?: \"ASC\" | \"DESC\";\r\n    /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */\r\n    readonly sqlExpression?: string;\r\n  }\r\n\r\n  /**\r\n   * A readonly set of Property values in a PropertyStore.\r\n   * @alpha\r\n   */\r\n  export interface Values {\r\n    /** get the value of a Property by name.\r\n     * @returns the property's value if it exists, `undefined` otherwise.\r\n     */\r\n    getProperty(name: PropertyName): PropertyType | undefined;\r\n    /** Get the value of a string property by name.\r\n    * @returns the property's value if it exists and is a string, `undefined` otherwise.\r\n    */\r\n    getString(name: PropertyName): string | undefined;\r\n    /** Get the value of a string property by name.\r\n    * @returns the property's value if it exists and is a string, otherwise the supplied default value.\r\n    */\r\n    getString(name: PropertyName, defaultValue: string): string;\r\n    /** Get the value of a boolean property by name.\r\n    * @returns the property's value if it exists and is a boolean, `undefined` otherwise.\r\n    */\r\n    getBoolean(name: PropertyName): boolean | undefined;\r\n    /** Get the value of a boolean property by name.\r\n    * @returns the property's value if it exists and is a boolean, otherwise the supplied default value.\r\n    */\r\n    getBoolean(name: PropertyName, defaultValue: boolean): boolean;\r\n    /** Get the value of a number property by name.\r\n    * @returns the property's value if it exists and is a number, `undefined` otherwise.\r\n    */\r\n    getNumber(name: PropertyName): number | undefined;\r\n    /** Get the value of a number property by name.\r\n    * @returns the property's value if it exists and is a number, otherwise the supplied default value.\r\n    */\r\n    getNumber(name: PropertyName, defaultValue: number): number;\r\n    /** Get the value of a blob property by name.\r\n    * @returns the property's value if it exists and is a blob, `undefined` otherwise.\r\n    */\r\n    getBlob(name: PropertyName): Uint8Array | undefined;\r\n    /** Get the value of a blob property by name.\r\n    * @returns the property's value if it exists and is a blob, otherwise the supplied default value.\r\n    */\r\n    getBlob(name: PropertyName, defaultValue: Uint8Array): Uint8Array;\r\n    /** Get the value of an object property by name.\r\n    * @returns the property's value if it exists and is an object, `undefined` otherwise.\r\n    */\r\n    getObject<T extends SettingObject>(name: PropertyName): T | undefined;\r\n    /** Get the value of an object property by name.\r\n    * @returns the property's value if it exists and is an object, otherwise the supplied default value.\r\n    */\r\n    getObject<T extends SettingObject>(name: PropertyName, defaultValue: T): T;\r\n    /** call an iteration function for each property, optionally applying a filter */\r\n    forAllProperties(iter: PropertyIteration, filter?: PropertyFilter): void;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PropertyStore.js","sourceRoot":"","sources":["../../src/PropertyStore.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAA6D;AAC7D,+CAA4C;AAC5C,yCAA+C;AAG/C,YAAY;AACZ,IAAiB,aAAa,CA0O7B;AA1OD,WAAiB,aAAa;IAyB5B;;OAEG;IACH,MAAa,UAAW,SAAQ,4BAAiB;QAAjD;;YAC2B,cAAS,GAAG,OAAO,CAAC;QAkL/C,CAAC;QAhLoB,SAAS;YAC1B,IAAI,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,2CAA2C,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1H,CAAC;QAED;;WAEG;QACI,WAAW,CAAC,IAAkB;YACnC,OAAO,IAAI,CAAC,2BAA2B,CAAC,gDAAgD,EAAE,CAAC,IAAI,EAAE,EAAE;gBACjG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;oBACjB,OAAO,SAAS,CAAC;gBACnB,QAAQ,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE;oBAC9B,KAAK,QAAQ;wBACX,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;oBAChC,KAAK,SAAS;wBACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBACvC,KAAK,MAAM;wBACT,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;oBAC9B,KAAK,QAAQ;wBACX,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;oBAChC,KAAK,QAAQ;wBACX,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAkB,CAAC;iBAC9D;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;QASM,SAAS,CAAC,IAAkB,EAAE,YAAqB;YACxD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;QACtD,CAAC;QASM,UAAU,CAAC,IAAkB,EAAE,YAAsB;YAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;QACvD,CAAC;QASM,SAAS,CAAC,IAAkB,EAAE,YAAqB;YACxD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;QACtD,CAAC;QASM,OAAO,CAAC,IAAkB,EAAE,YAAyB;YAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,GAAG,YAAY,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC;QACxD,CAAC;QASM,SAAS,CAAC,IAAkB,EAAE,YAA4B;YAC/D,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAoB,CAAC,CAAC,CAAC,YAAY,CAAC;QACvE,CAAC;QAED,iFAAiF;QAC1E,gBAAgB,CAAC,IAAuB,EAAE,MAAuB;YACtE,IAAI,GAAG,GAAG,oDAAoD,CAAC;YAC/D,IAAI,MAAM,EAAE,aAAa;gBACvB,GAAG,IAAI,QAAQ,MAAM,CAAC,aAAa,GAAG,CAAC;YACzC,IAAI,MAAM,EAAE,KAAK;gBACf,GAAG,IAAI,aAAa,MAAM,CAAC,YAAY,IAAI,GAAG,OAAO,CAAC;YACxD,IAAI,MAAM,EAAE,OAAO;gBACjB,GAAG,IAAI,kBAAkB,MAAM,CAAC,OAAO,GAAG,CAAC;YAE7C,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;gBACrC,IAAI,MAAM,EAAE,KAAK;oBACf,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;gBAExC,OAAO,IAAI,CAAC,OAAO,EAAE,EAAE;oBACrB,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM;wBACzC,OAAO;iBACV;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;WAEG;QACI,KAAK,CAAC,cAAc,CAAC,QAAsB;YAChD,IAAI,CAAC,mBAAmB,CAAC,qCAAqC,EAAE,CAAC,IAAI,EAAE,EAAE;gBACvE,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC;QACD;;WAEG;QACI,KAAK,CAAC,gBAAgB,CAAC,SAAyB;YACrD,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,CAAC;QAEO,YAAY,CAAC,IAAkB;YACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;gBAC/F,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,GAAG,CAAC,CAAC;QACtD,CAAC;QAED;;WAEG;QACI,KAAK,CAAC,YAAY,CAAC,IAAkB,EAAE,KAAmB;YAC/D,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,CAAC,mBAAmB,CAAC,mEAAmE,EAAE,CAAC,IAAI,EAAE,EAAE;gBACrG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,QAAQ,OAAO,KAAK,EAAE;oBACpB,KAAK,QAAQ;wBACX,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;wBAC7B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;wBAC1B,MAAM;oBACR,KAAK,SAAS;wBACZ,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;wBAC9B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;wBACnC,MAAM;oBACR,KAAK,QAAQ;wBACX,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;wBAC7B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;wBAC1B,MAAM;oBACR,KAAK,QAAQ;wBACX,IAAI,KAAK,YAAY,UAAU,EAAE;4BAC/B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;4BAC3B,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;yBACzB;6BAAM;4BACL,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;4BAC7B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;yBAC3C;wBACD,MAAM;oBACR;wBACE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;iBAClD;gBAED,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvB,IAAI,EAAE,KAAK,uBAAQ,CAAC,cAAc;oBAChC,MAAM,IAAI,2BAAY,CAAC,EAAE,EAAE,uBAAuB,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;WAEG;QACI,KAAK,CAAC,cAAc,CAAC,KAAoB;YAC9C,KAAK,MAAM,IAAI,IAAI,KAAK;gBACtB,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;KACF;IAnLY,wBAAU,aAmLtB,CAAA;IAED,MAAM,aAAa,GAAG,YAAqB,CAAC;IAE5C;;;;;;;;OAQG;IACH,MAAa,WAAY,SAAQ,yBAAW,CAAC,QAAoB;QAC/D,YAAmB,KAAuC;YACxD,KAAK,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED;;;;WAIG;QACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAyF;YACxH,OAAO,KAAK,CAAC,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,CAAC;KACF;IAbY,yBAAW,cAavB,CAAA;AACH,CAAC,EA1OgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA0O7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module SQLiteDb\r\n */\r\n\r\nimport { BentleyError, DbResult } from \"@itwin/core-bentley\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\r\nimport { SettingObject } from \"./workspace/Settings\";\r\n\r\n/** @beta */\r\nexport namespace PropertyStore {\r\n\r\n  /** The set of valid types for properties in a PropertyStore. */\r\n  export type PropertyType = string | number | boolean | Uint8Array | SettingObject;\r\n  /** The case-sensitive name of a Property. May not have leading or trailing spaces, and must be between 3 and 2048 characters long. */\r\n  export type PropertyName = string;\r\n  /** An array of PropertyName/PropertyType pairs to be stored in a PropertyStore. */\r\n  export type PropertyArray = { name: PropertyName, value: PropertyType }[];\r\n  /** The return status of an iteration function. The value \"stop\" causes the iteration to terminate. */\r\n  export type IterationReturn = void | \"stop\";\r\n  /** An iteration function over Properties in a PropertyStore. It is called with the name of a each Property. */\r\n  export type PropertyIteration = (name: string) => IterationReturn;\r\n\r\n  /** A filter used to limit and/or sort the values returned by an iteration. */\r\n  export interface PropertyFilter {\r\n    /** A value filter. May include wild cards when used with `GLOB` or `LIKE` */\r\n    readonly value?: string;\r\n    /** The comparison operator for `value`. Default is `=` */\r\n    readonly valueCompare?: \"GLOB\" | \"LIKE\" | \"NOT GLOB\" | \"NOT LIKE\" | \"=\" | \"!=\" | \"<\" | \">\";\r\n    /** Order results ascending or descending. If not supplied, the results are unordered (random). */\r\n    readonly orderBy?: \"ASC\" | \"DESC\";\r\n    /** An SQL expression to further filter results. This string is appended to the `WHERE` clause with an `AND` (that should not be part of the sqlExpression) */\r\n    readonly sqlExpression?: string;\r\n  }\r\n\r\n  /**\r\n   * A SQLite database for storing PropertyName/PropertyValue pairs.\r\n   */\r\n  export class PropertyDb extends VersionedSqliteDb {\r\n    public override readonly myVersion = \"3.0.0\";\r\n\r\n    protected override createDDL() {\r\n      this.createTable({ tableName: \"properties\", columns: \"name TEXT NOT NULL PRIMARY KEY,type,value\", addTimestamp: true });\r\n    }\r\n\r\n    /** get the value of a Property by name.\r\n     * @returns the property's value if it exists, `undefined` otherwise.\r\n     */\r\n    public getProperty(name: PropertyName): PropertyType | undefined {\r\n      return this.withPreparedSqliteStatement(\"SELECT type,value from properties WHERE name=?\", (stmt) => {\r\n        stmt.bindString(1, name);\r\n        if (!stmt.nextRow())\r\n          return undefined;\r\n        switch (stmt.getValueString(0)) {\r\n          case \"string\":\r\n            return stmt.getValueString(1);\r\n          case \"boolean\":\r\n            return stmt.getValueInteger(1) !== 0;\r\n          case \"blob\":\r\n            return stmt.getValueBlob(1);\r\n          case \"number\":\r\n            return stmt.getValueDouble(1);\r\n          case \"object\":\r\n            return JSON.parse(stmt.getValueString(1)) as SettingObject;\r\n        }\r\n        return undefined;\r\n      });\r\n    }\r\n    /** Get the value of a string property by name.\r\n    * @returns the property's value if it exists and is a string, `undefined` otherwise.\r\n    */\r\n    public getString(name: PropertyName, defaultValue: string): string;\r\n    /** Get the value of a string property by name.\r\n    * @returns the property's value if it exists and is a string, otherwise the supplied default value.\r\n    */\r\n    public getString(name: PropertyName): string | undefined;\r\n    public getString(name: PropertyName, defaultValue?: string): string | undefined {\r\n      const out = this.getProperty(name);\r\n      return typeof out === \"string\" ? out : defaultValue;\r\n    }\r\n    /** Get the value of a boolean property by name.\r\n    * @returns the property's value if it exists and is a boolean, `undefined` otherwise.\r\n    */\r\n    public getBoolean(name: PropertyName): boolean | undefined;\r\n    /** Get the value of a boolean property by name.\r\n    * @returns the property's value if it exists and is a boolean, otherwise the supplied default value.\r\n    */\r\n    public getBoolean(name: PropertyName, defaultValue: boolean): boolean;\r\n    public getBoolean(name: PropertyName, defaultValue?: boolean): boolean | undefined {\r\n      const out = this.getProperty(name);\r\n      return typeof out === \"boolean\" ? out : defaultValue;\r\n    }\r\n    /** Get the value of a number property by name.\r\n    * @returns the property's value if it exists and is a number, `undefined` otherwise.\r\n    */\r\n    public getNumber(name: PropertyName): number | undefined;\r\n    /** Get the value of a number property by name.\r\n    * @returns the property's value if it exists and is a number, otherwise the supplied default value.\r\n    */\r\n    public getNumber(name: PropertyName, defaultValue: number): number;\r\n    public getNumber(name: PropertyName, defaultValue?: number): number | undefined {\r\n      const out = this.getProperty(name);\r\n      return typeof out === \"number\" ? out : defaultValue;\r\n    }\r\n    /** Get the value of a blob property by name.\r\n    * @returns the property's value if it exists and is a blob, `undefined` otherwise.\r\n    */\r\n    public getBlob(name: PropertyName): Uint8Array | undefined;\r\n    /** Get the value of a blob property by name.\r\n    * @returns the property's value if it exists and is a blob, otherwise the supplied default value.\r\n    */\r\n    public getBlob(name: PropertyName, defaultValue: Uint8Array): Uint8Array;\r\n    public getBlob(name: PropertyName, defaultValue?: Uint8Array): Uint8Array | undefined {\r\n      const out = this.getProperty(name);\r\n      return out instanceof Uint8Array ? out : defaultValue;\r\n    }\r\n    /** Get the value of an object property by name.\r\n    * @returns the property's value if it exists and is an object, `undefined` otherwise.\r\n    */\r\n    public getObject(name: PropertyName): SettingObject | undefined;\r\n    /** Get the value of an object property by name.\r\n    * @returns the property's value if it exists and is an object, otherwise the supplied default value.\r\n    */\r\n    public getObject(name: PropertyName, defaultValue: SettingObject): SettingObject;\r\n    public getObject(name: PropertyName, defaultValue?: SettingObject): SettingObject | undefined {\r\n      const out = this.getProperty(name);\r\n      return typeof out === \"object\" ? out as SettingObject : defaultValue;\r\n    }\r\n\r\n    /** call an iteration function for each property, optionally applying a filter */\r\n    public forAllProperties(iter: PropertyIteration, filter?: PropertyFilter) {\r\n      let sql = \"SELECT name FROM properties WHERE name IS NOT NULL\";\r\n      if (filter?.sqlExpression)\r\n        sql += ` AND ${filter.sqlExpression} `;\r\n      if (filter?.value)\r\n        sql += ` AND name ${filter.valueCompare ?? \"=\"} @val`;\r\n      if (filter?.orderBy)\r\n        sql += ` ORDER BY name ${filter.orderBy} `;\r\n\r\n      this.withSqliteStatement(sql, (stmt) => {\r\n        if (filter?.value)\r\n          stmt.bindString(\"@val\", filter.value);\r\n\r\n        while (stmt.nextRow()) {\r\n          if (iter(stmt.getValueString(0)) === \"stop\")\r\n            return;\r\n        }\r\n      });\r\n    }\r\n\r\n    /** Delete a single property from this PropertyDb. If the value does not exist, this method does nothing.\r\n     * @note the database must be opened for write\r\n     */\r\n    public async deleteProperty(propName: PropertyName) {\r\n      this.withSqliteStatement(\"DELETE from properties WHERE name=?\", (stmt) => {\r\n        stmt.bindString(1, propName);\r\n        stmt.step();\r\n      });\r\n    }\r\n    /** Delete an array of properties from this PropertyDb. Any value that does not exist is ignored.\r\n     * @note the database must be opened for write\r\n     */\r\n    public async deleteProperties(propNames: PropertyName[]) {\r\n      propNames.forEach(async (name) => this.deleteProperty(name));\r\n    }\r\n\r\n    private validateName(name: PropertyName) {\r\n      if (typeof name !== \"string\" || name.trim() !== name || name.length > 2 * 1024 || name.length < 2)\r\n        throw new Error(`illegal property name[${name}]`);\r\n    }\r\n\r\n    /** Save a single property in this PropertyDb. If the property already exists, its value is overwritten.\r\n     * @note the database must be opened for write\r\n     */\r\n    public async saveProperty(name: PropertyName, value: PropertyType) {\r\n      this.validateName(name);\r\n      this.withSqliteStatement(\"INSERT OR REPLACE INTO properties(name,type,value) VALUES (?,?,?)\", (stmt) => {\r\n        stmt.bindString(1, name);\r\n        switch (typeof value) {\r\n          case \"string\":\r\n            stmt.bindString(2, \"string\");\r\n            stmt.bindString(3, value);\r\n            break;\r\n          case \"boolean\":\r\n            stmt.bindString(2, \"boolean\");\r\n            stmt.bindInteger(3, value ? 1 : 0);\r\n            break;\r\n          case \"number\":\r\n            stmt.bindString(2, \"number\");\r\n            stmt.bindDouble(3, value);\r\n            break;\r\n          case \"object\":\r\n            if (value instanceof Uint8Array) {\r\n              stmt.bindString(2, \"blob\");\r\n              stmt.bindBlob(3, value);\r\n            } else {\r\n              stmt.bindString(2, \"object\");\r\n              stmt.bindString(3, JSON.stringify(value));\r\n            }\r\n            break;\r\n          default:\r\n            throw new Error(\"illegal property value type\");\r\n        }\r\n\r\n        const rc = stmt.step();\r\n        if (rc !== DbResult.BE_SQLITE_DONE)\r\n          throw new BentleyError(rc, \"error saving property\");\r\n      });\r\n    }\r\n\r\n    /** Save an array of properties in this PropertyDb. If a property already exists, its value is overwritten.\r\n     * @note the database must be opened for write\r\n     */\r\n    public async saveProperties(props: PropertyArray) {\r\n      for (const prop of props)\r\n        await this.saveProperty(prop.name, prop.value);\r\n    }\r\n  }\r\n\r\n  const defaultDbName = \"PropertyDb\" as const;\r\n\r\n  /**\r\n   * Provides access to a cloud-based `PropertyDb` to hold a set of values of type `PropertyType`, each with a unique `PropertyName`.\r\n   * `PropertyStore.PropertyDb`s that are stored in cloud containers require an access token that grants permission to read and/or write them.\r\n   * All write operations will fail without an access token that grants write permission.\r\n   *\r\n   * The database is cached on a local drive so reads are fast and inexpensive, and may even be done offline after a prefetch.\r\n   * However, that means that callers are responsible for synchronizing the local cache to ensure it includes changes\r\n   * made by others, as appropriate (see [[synchronizeWithCloud]]).\r\n   */\r\n  export class CloudAccess extends CloudSqlite.DbAccess<PropertyDb> {\r\n    public constructor(props: CloudSqlite.ContainerAccessProps) {\r\n      super({ dbType: PropertyDb, props, dbName: defaultDbName });\r\n    }\r\n\r\n    /**\r\n     * Initialize a cloud container for use as a PropertyStore. The container must first be created via its storage supplier api (e.g. Azure, or AWS).\r\n     * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty PropertyDb into the container.\r\n     * @note this deletes any existing content in the container.\r\n     */\r\n    public static async initializeDb(args: { props: CloudSqlite.ContainerAccessProps, initContainer?: { blockSize?: number } }) {\r\n      return super._initializeDb({ ...args, dbType: PropertyDb, dbName: defaultDbName });\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/Relationship.d.ts

@@ -61,8 +61,7 @@ export declare class ElementRefersToElements extends Relationship {
      * @return The Id of the inserted Relationship.
      */
     static insert<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** Relates a [[DrawingGraphic]] to the [[Element]] that it represents
  * @public
@@ -342,11 +341,10 @@ export declare class ElementDrivesElement extends Relationship {
     constructor(props: ElementDrivesElementProps, iModel: IModelDb);
     static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority?: number): T;
     toJSON(): ElementDrivesElementProps;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** The third (and last) possible link-table relationship base class in an iModel.
- * Has no external use, but is included for completeness of the [Entity.collectReferenceConcreteIds]($backend)
+ * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)
  * implementations for link-table relationships. Generating the types of the source and target automatically would require
  * coupling this package with ecschema-metadata which we do not want to do.
  * @internal
@@ -354,8 +352,7 @@ export declare class ElementDrivesElement extends Relationship {
 export declare class ModelSelectorRefersToModels extends Relationship {
     /** @internal */
     static get className(): string;
-    /** @internal */
-    protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
 }
 /** Manages [[Relationship]]s.
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"Relationship.d.ts","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAA6B,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEvH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE7E;;GAEG;AACH,qBAAa,YAAa,SAAQ,MAAM;IACtC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,SAAgB,QAAQ,EAAE,UAAU,CAAC;IACrC,SAAgB,QAAQ,EAAE,UAAU,CAAC;IAErC,gBAAgB;gBACJ,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAMtD,gBAAgB;IACA,MAAM,IAAI,iBAAiB;IAO3C;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAE/E;;;;;OAKG;WACW,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAErF,gDAAgD;IACzC,MAAM,IAAI,UAAU;IAC3B,8CAA8C;IACvC,MAAM;IACb,gDAAgD;IACzC,MAAM;WAEC,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;CAC/G;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAsC;IACpF;;;;;OAKG;WACW,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,CAAC;IAGxH;;;;;OAKG;WACW,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU;IAKjI,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAI,IAAI;CAKxF;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,uBAAuB;IAC1E,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8C;CAC7F;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,uBAAuB;IAC9E,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkD;CACjG;AAED;;;;GAIG;AACH,qBAAa,qCAAsC,SAAQ,uBAAuB;IAChF,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoD;CACnG;AAED;;;GAGG;AACH,qBAAa,yCAA0C,SAAQ,qCAAqC;IAClG,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwD;CACvG;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAC1E,cAAc,EAAE,MAAM,CAAC;gBAElB,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAKvC,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,GAAE,MAAU,GAAG,CAAC;CAI9J;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;OAIG;IACI,MAAM,EAAE,MAAM,CAAC;IACtB,uHAAuH;IAChH,QAAQ,EAAE,MAAM,CAAC;IAExB,gBAAgB;gBACJ,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAMhD,MAAM,CAAC,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,GAAE,MAAU,GAAG,CAAC;IAK3H,MAAM,IAAI,yBAAyB;IAOnD,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAI,IAAI;CAKxF;AAED;;;;;GAKG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA0C;IACxF,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAKvF;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAW;IAE1B,gBAAgB;gBACJ,MAAM,EAAE,QAAQ;IAE5B;;;OAGG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY;IAE7D,2EAA2E;IAC3E,OAAO,CAAC,sBAAsB;IAM9B;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU;IAK3D;;OAEG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD,wDAAwD;IACjD,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD;;;;;OAKG;IACI,gBAAgB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAQzH;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;IAoBxI;;;;;OAKG;IACI,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAI9G;;;;;;OAMG;IACI,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;CAI/H"}
+{"version":3,"file":"Relationship.d.ts","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAA6B,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEvH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE7E;;GAEG;AACH,qBAAa,YAAa,SAAQ,MAAM;IACtC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA2B;IACzE,SAAgB,QAAQ,EAAE,UAAU,CAAC;IACrC,SAAgB,QAAQ,EAAE,UAAU,CAAC;IAErC,gBAAgB;gBACJ,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ;IAMtD,gBAAgB;IACA,MAAM,IAAI,iBAAiB;IAO3C;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAE/E;;;;;OAKG;WACW,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAErF,gDAAgD;IACzC,MAAM,IAAI,UAAU;IAC3B,8CAA8C;IACvC,MAAM;IACb,gDAAgD;IACzC,MAAM;WAEC,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;CAC/G;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAsC;IACpF;;;;;OAKG;WACW,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,CAAC;IAGxH;;;;;OAKG;WACW,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,UAAU;cAK9G,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAI,IAAI;CAKhF;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,uBAAuB;IAC1E,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA8C;CAC7F;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,uBAAuB;IAC9E,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkD;CACjG;AAED;;;;GAIG;AACH,qBAAa,qCAAsC,SAAQ,uBAAuB;IAChF,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoD;CACnG;AAED;;;GAGG;AACH,qBAAa,yCAA0C,SAAQ,qCAAqC;IAClG,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAwD;CACvG;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,uBAAuB;IAC/D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAC1E,cAAc,EAAE,MAAM,CAAC;gBAElB,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAKvC,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,GAAE,MAAU,GAAG,CAAC;CAI9J;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+C;CAC9F;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;OAIG;IACI,MAAM,EAAE,MAAM,CAAC;IACtB,uHAAuH;IAChH,QAAQ,EAAE,MAAM,CAAC;IAExB,gBAAgB;gBACJ,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;WAMhD,MAAM,CAAC,CAAC,SAAS,oBAAoB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,GAAE,MAAU,GAAG,CAAC;IAK3H,MAAM,IAAI,yBAAyB;cAOhC,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAI,IAAI;CAKhF;AAED;;;;;GAKG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA0C;cACrE,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAW;IAE1B,gBAAgB;gBACJ,MAAM,EAAE,QAAQ;IAE5B;;;OAGG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY;IAE7D,2EAA2E;IAC3E,OAAO,CAAC,sBAAsB;IAM9B;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,UAAU;IAK3D;;OAEG;IACI,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD,wDAAwD;IACjD,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAIrD;;;;;OAKG;IACI,gBAAgB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAQzH;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;IAoBxI;;;;;OAKG;IACI,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC;IAI9G;;;;;;OAMG;IACI,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,CAAC,GAAG,SAAS;CAI/H"}

package/lib/cjs/Relationship.js

@@ -79,9 +79,8 @@ class ElementRefersToElements extends Relationship {
         const relationship = this.create(iModel, sourceId, targetId);
         return iModel.relationships.insertInstance(relationship.toJSON());
     }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         referenceIds.addElement(this.sourceId);
         referenceIds.addElement(this.targetId);
     }
@@ -369,16 +368,15 @@ class ElementDrivesElement extends Relationship {
         props.priority = this.priority;
         return props;
     }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         referenceIds.addElement(this.sourceId);
         referenceIds.addElement(this.targetId);
     }
 }
 exports.ElementDrivesElement = ElementDrivesElement;
 /** The third (and last) possible link-table relationship base class in an iModel.
- * Has no external use, but is included for completeness of the [Entity.collectReferenceConcreteIds]($backend)
+ * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)
  * implementations for link-table relationships. Generating the types of the source and target automatically would require
  * coupling this package with ecschema-metadata which we do not want to do.
  * @internal
@@ -386,9 +384,8 @@ exports.ElementDrivesElement = ElementDrivesElement;
 class ModelSelectorRefersToModels extends Relationship {
     /** @internal */
     static get className() { return "ModelSelectorRefersToModels"; }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         referenceIds.addElement(this.sourceId);
         referenceIds.addModel(this.targetId);
     }

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,sDAAiE;AACjE,oDAAuH;AAEvH,qCAAkC;AAKlC;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAM;IACtC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAIzE,gBAAgB;IAChB,YAAY,KAAwB,EAAE,MAAgB;QACpD,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;IAED,gBAAgB;IACA,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;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEzF,gDAAgD;IACzC,MAAM,KAAiB,OAAO,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACzG,8CAA8C;IACvC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5E,gDAAgD;IACzC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAErE,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;AA9CD,oCA8CC;AAED;;GAEG;AACH,MAAa,uBAAwB,SAAQ,YAAY;IACvD,gBAAgB;IACT,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;IACD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,MAAM,YAAY,GAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAChE,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IACG,2BAA2B,CAAC,YAAgC;QAC7E,KAAK,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAChD,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AA7BD,0DA6BC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,uBAAuB;IAC1E,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAHD,0EAGC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,uBAAuB;IAC9E,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAHD,kFAGC;AAED;;;;GAIG;AACH,MAAa,qCAAsC,SAAQ,uBAAuB;IAChF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAHD,sFAGC;AAED;;;GAGG;AACH,MAAa,yCAA0C,SAAQ,qCAAqC;IAClG,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AAHD,8FAGC;AASD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,uBAAuB;IAC/D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAGjF,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;AAdD,oDAcC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAHD,4EAGC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAHD,sDAGC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAHD,4EAGC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAUjF,gBAAgB;IAChB,YAAY,KAAgC,EAAE,MAAgB;QAC5D,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;IAED,gBAAgB;IACG,2BAA2B,CAAC,YAAgC;QAC7E,KAAK,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAChD,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AArCD,oDAqCC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,YAAY;IAC3D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IACxF,gBAAgB;IACG,2BAA2B,CAAC,YAAgC;QAC7E,KAAK,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;QAChD,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;CACF;AATD,kEASC;AAED;;GAEG;AACH,MAAa,aAAa;IAGxB,gBAAgB;IAChB,YAAY,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAExD;;;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,QAAQ,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE;YACnF,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;SACxM;IACH,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,wDAAwD;IACjD,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAC3D,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;YACnC,MAAM,IAAI,yBAAW,CAAC,0BAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;SACxE;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;YAChC,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;SACJ;aAAM;YACL,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;SACJ;QACD,IAAI,SAAS,KAAK,KAAK,EAAE;YACvB,KAAK,CAAC,aAAa,GAAI,KAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;SAClE;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;AAvGD,sCAuGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Relationships\r\n */\r\n\r\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { EntityReferenceSet, IModelError, IModelStatus, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\r\n\r\n/** Base class for all link table ECRelationships\r\n * @public\r\n */\r\nexport class Relationship extends Entity {\r\n  /** @internal */\r\n  public static override get className(): string { return \"Relationship\"; }\r\n  public readonly sourceId: Id64String;\r\n  public readonly targetId: Id64String;\r\n\r\n  /** @internal */\r\n  constructor(props: RelationshipProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.sourceId = Id64.fromJSON(props.sourceId);\r\n    this.targetId = Id64.fromJSON(props.targetId);\r\n  }\r\n\r\n  /** @internal */\r\n  public override toJSON(): RelationshipProps {\r\n    const val = super.toJSON() as RelationshipProps;\r\n    val.sourceId = this.sourceId;\r\n    val.targetId = this.targetId;\r\n    return val;\r\n  }\r\n\r\n  /**\r\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.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @param _props The ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   */\r\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @param _props The deleted ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   */\r\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /** Insert this Relationship into the iModel. */\r\n  public insert(): Id64String { return this.id = this.iModel.relationships.insertInstance(this.toJSON()); }\r\n  /** Update this Relationship in the iModel. */\r\n  public update() { this.iModel.relationships.updateInstance(this.toJSON()); }\r\n  /** Delete this Relationship from the iModel. */\r\n  public delete() { this.iModel.relationships.deleteInstance(this.toJSON()); }\r\n\r\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\r\n}\r\n\r\n/** A Relationship where one Element refers to another Element\r\n * @public\r\n */\r\nexport class ElementRefersToElements extends Relationship {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementRefersToElements\"; }\r\n  /** Create an instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return an instance of the specified class.\r\n   */\r\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\r\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\r\n  }\r\n  /** Insert a new instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return The Id of the inserted Relationship.\r\n   */\r\n  public static insert<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\r\n    const relationship: T = this.create(iModel, sourceId, targetId);\r\n    return iModel.relationships.insertInstance(relationship.toJSON());\r\n  }\r\n\r\n  /** @internal */\r\n  protected override collectReferenceConcreteIds(referenceIds: EntityReferenceSet,): void {\r\n    super.collectReferenceConcreteIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\r\n * Each relationship instance represents an external source processed by the synchronization configuration.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface ElementGroupsMembersProps extends RelationshipProps {\r\n  memberPriority: number;\r\n}\r\n\r\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\r\n * @public\r\n */\r\nexport class ElementGroupsMembers extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\r\n  public memberPriority: number;\r\n\r\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.memberPriority = props.memberPriority;\r\n  }\r\n\r\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\r\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n}\r\n\r\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\r\n * @public\r\n */\r\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\r\n}\r\n\r\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\r\n * Implies that properties of the group should be considered as properties of its members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\r\n * @public\r\n */\r\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\r\n}\r\n\r\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of ElementDrivesElements\r\n * @beta\r\n */\r\nexport interface ElementDrivesElementProps extends RelationshipProps {\r\n  status: number;\r\n  priority: number;\r\n}\r\n\r\n/** A Relationship indicating that one Element *drives* another Element.\r\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\r\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.\r\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\r\n *\r\n * # Defining dependencies\r\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\r\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\r\n * ```ts\r\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  ede.insert();\r\n * ```\r\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\r\n *\r\n * # Defining dependency graphs\r\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\r\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\r\n *\r\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  ede12.insert();\r\n *  ede23.insert();\r\n * ```\r\n * Those two relationships create this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * Where the \"-->\" is meant to represent a driving relationship.\r\n *\r\n * The order in which you create the relationships does not matter.\r\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\r\n *\r\n * An ElementDrivesElement relationship is between one source element and one target element.\r\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\r\n * Thus, you can define many:many relationships.\r\n * For example:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\r\n *  ede12.insert();\r\n *  ede112.insert();\r\n *  ede23.insert();\r\n *  ede231.insert();\r\n * ```\r\n * Creates this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\r\n *\r\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\r\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\r\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\r\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\r\n *\r\n * # Subgraph Processing\r\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\r\n * suppose we have this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\r\n *\r\n * If only e2 changes, then the subgraph to be processed is just:\r\n * ```\r\n *       e2 --> e3\r\n * ```\r\n * If only e3 changes, then the subgraph consists of e3 by itself.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed, the affected subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * If e2 is changed, the affected subgraph is:\r\n * ```\r\n *           e3\r\n *         /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * # Callbacks\r\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\r\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\r\n *\r\n * ## ElementDrivesElement Callbacks\r\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\r\n * * onRootChanged\r\n * * onDeletedDependency\r\n *\r\n * Note that these are static methods. Their default implementations do nothing.\r\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\r\n * The subclass should then implement the callbacks that it would like to act on.\r\n *\r\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\r\n *\r\n * ## Element Callbacks\r\n * The following callbacks are invoked on Element classes (nodes):\r\n * * Element.onBeforeOutputsHandled\r\n * * Element.onAllInputsHandled\r\n *\r\n * ## Order\r\n * Callbacks are invoked by BriefcaseDb.saveChanges.\r\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\r\n *\r\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\r\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\r\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\r\n * invoked only once.\r\n *\r\n * For example, suppose we have a graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n *\r\n * Suppose that e1 is directly modified. No callbacks are made at that time.\r\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n *\r\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\r\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * The callbacks are:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n * 1. ElementDrivesElement.onRootChanged e2->e31\r\n * 1. Element.onAllInputsHandled e31\r\n *\r\n * (The ElementDrivesElement.)\r\n *\r\n * #Errors\r\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\r\n * involved in a cycle will have their status set to 1, indicating a failure.\r\n *\r\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\r\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\r\n *\r\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\r\n *\r\n * @beta\r\n */\r\nexport class ElementDrivesElement extends Relationship {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementDrivesElement\"; }\r\n  /** Relationship status\r\n   * * 0 indicates no errors. Set after a successful evaluation.\r\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.\r\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\r\n   */\r\n  public status: number;\r\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\r\n  public priority: number;\r\n\r\n  /** @internal */\r\n  constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.status = props.status;\r\n    this.priority = props.priority;\r\n  }\r\n\r\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\r\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n\r\n  public override toJSON(): ElementDrivesElementProps {\r\n    const props = super.toJSON() as ElementDrivesElementProps;\r\n    props.status = this.status;\r\n    props.priority = this.priority;\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  protected override collectReferenceConcreteIds(referenceIds: EntityReferenceSet,): void {\r\n    super.collectReferenceConcreteIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** The third (and last) possible link-table relationship base class in an iModel.\r\n * Has no external use, but is included for completeness of the [Entity.collectReferenceConcreteIds]($backend)\r\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\r\n * coupling this package with ecschema-metadata which we do not want to do.\r\n * @internal\r\n */\r\nexport class ModelSelectorRefersToModels extends Relationship {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\r\n  /** @internal */\r\n  protected override collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceConcreteIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addModel(this.targetId);\r\n  }\r\n}\r\n\r\n/** Manages [[Relationship]]s.\r\n * @public\r\n */\r\nexport class Relationships {\r\n  private _iModel: IModelDb;\r\n\r\n  /** @internal */\r\n  constructor(iModel: IModelDb) { this._iModel = iModel; }\r\n\r\n  /** Create a new instance of a Relationship.\r\n   * @param props The properties of the new Relationship.\r\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\r\n   */\r\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\r\n\r\n  /** Check classFullName to ensure it is a link table relationship class. */\r\n  private checkRelationshipClass(classFullName: string) {\r\n    if (!this._iModel.nativeDb.isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\r\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.`);\r\n    }\r\n  }\r\n\r\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\r\n   * @param props The properties of the new relationship.\r\n   * @returns The Id of the newly inserted relationship.\r\n   * @note The id property of the props object is set as a side effect of this function.\r\n   */\r\n  public insertInstance(props: RelationshipProps): Id64String {\r\n    this.checkRelationshipClass(props.classFullName);\r\n    return props.id = this._iModel.nativeDb.insertLinkTableRelationship(props);\r\n  }\r\n\r\n  /** Update the properties of an existing relationship instance in the iModel.\r\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\r\n   */\r\n  public updateInstance(props: RelationshipProps): void {\r\n    this._iModel.nativeDb.updateLinkTableRelationship(props);\r\n  }\r\n\r\n  /** Delete an Relationship instance from this iModel. */\r\n  public deleteInstance(props: RelationshipProps): void {\r\n    this._iModel.nativeDb.deleteLinkTableRelationship(props);\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstanceProps\r\n   */\r\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\r\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\r\n    if (undefined === relationshipProps) {\r\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\r\n    }\r\n    return relationshipProps;\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstanceProps\r\n   */\r\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    let props: T | undefined;\r\n    if (typeof criteria === \"string\") {\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    } else {\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria.sourceId);\r\n        stmt.bindId(2, criteria.targetId);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    }\r\n    if (undefined !== props) {\r\n      props.classFullName = (props as any).className.replace(\".\", \":\");\r\n    }\r\n    return props;\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstance\r\n   */\r\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\r\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The relationship or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstance\r\n   */\r\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\r\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Relationship.js","sourceRoot":"","sources":["../../src/Relationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiE;AACjE,oDAAuH;AAEvH,qCAAkC;AAKlC;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAM;IACtC,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAIzE,gBAAgB;IAChB,YAAY,KAAwB,EAAE,MAAgB;QACpD,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;IAED,gBAAgB;IACA,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;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEnF;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAyB,EAAE,OAAiB,IAAU,CAAC;IAEzF,gDAAgD;IACzC,MAAM,KAAiB,OAAO,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACzG,8CAA8C;IACvC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5E,gDAAgD;IACzC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAErE,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;AA9CD,oCA8CC;AAED;;GAEG;AACH,MAAa,uBAAwB,SAAQ,YAAY;IACvD,gBAAgB;IACT,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;IACD;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAoC,MAAgB,EAAE,QAAoB,EAAE,QAAoB;QAClH,MAAM,YAAY,GAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAChE,OAAO,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,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;AA5BD,0DA4BC;AAED;;GAEG;AACH,MAAa,+BAAgC,SAAQ,uBAAuB;IAC1E,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,iCAAiC,CAAC,CAAC,CAAC;CAC7F;AAHD,0EAGC;AAED;;GAEG;AACH,MAAa,mCAAoC,SAAQ,uBAAuB;IAC9E,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,qCAAqC,CAAC,CAAC,CAAC;CACjG;AAHD,kFAGC;AAED;;;;GAIG;AACH,MAAa,qCAAsC,SAAQ,uBAAuB;IAChF,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uCAAuC,CAAC,CAAC,CAAC;CACnG;AAHD,sFAGC;AAED;;;GAGG;AACH,MAAa,yCAA0C,SAAQ,qCAAqC;IAClG,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,2CAA2C,CAAC,CAAC,CAAC;CACvG;AAHD,8FAGC;AASD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,uBAAuB;IAC/D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAGjF,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;AAdD,oDAcC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAHD,4EAGC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,oBAAoB;IAC7D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,uBAAuB,CAAC,CAAC,CAAC;CACnF;AAHD,sDAGC;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,oBAAoB;IACxE,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kCAAkC,CAAC,CAAC,CAAC;CAC9F;AAHD,4EAGC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuLG;AACH,MAAa,oBAAqB,SAAQ,YAAY;IACpD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,sBAAsB,CAAC,CAAC,CAAC;IAUjF,gBAAgB;IAChB,YAAY,KAAgC,EAAE,MAAgB;QAC5D,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;AApCD,oDAoCC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,YAAY;IAC3D,gBAAgB;IACT,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;AARD,kEAQC;AAED;;GAEG;AACH,MAAa,aAAa;IAGxB,gBAAgB;IAChB,YAAY,MAAgB,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAExD;;;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,QAAQ,CAAC,uBAAuB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE;YACnF,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,UAAU,aAAa,8HAA8H,CAAC,CAAC;SACxM;IACH,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,wDAAwD;IACjD,cAAc,CAAC,KAAwB;QAC5C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAC3D,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;YACnC,MAAM,IAAI,yBAAW,CAAC,0BAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;SACxE;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;YAChC,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;SACJ;aAAM;YACL,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;SACJ;QACD,IAAI,SAAS,KAAK,KAAK,EAAE;YACvB,KAAK,CAAC,aAAa,GAAI,KAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;SAClE;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;AAvGD,sCAuGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Relationships\r\n */\r\n\r\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { EntityReferenceSet, IModelError, IModelStatus, RelationshipProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { Entity } from \"./Entity\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\nexport type { SourceAndTarget, RelationshipProps } from \"@itwin/core-common\"; // for backwards compatibility\r\n\r\n/** Base class for all link table ECRelationships\r\n * @public\r\n */\r\nexport class Relationship extends Entity {\r\n  /** @internal */\r\n  public static override get className(): string { return \"Relationship\"; }\r\n  public readonly sourceId: Id64String;\r\n  public readonly targetId: Id64String;\r\n\r\n  /** @internal */\r\n  constructor(props: RelationshipProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.sourceId = Id64.fromJSON(props.sourceId);\r\n    this.targetId = Id64.fromJSON(props.targetId);\r\n  }\r\n\r\n  /** @internal */\r\n  public override toJSON(): RelationshipProps {\r\n    const val = super.toJSON() as RelationshipProps;\r\n    val.sourceId = this.sourceId;\r\n    val.targetId = this.targetId;\r\n    return val;\r\n  }\r\n\r\n  /**\r\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.\r\n   * This callback is invoked after the input element has been processed by upstream relationships.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.\r\n   * @param _props The ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   */\r\n  public static onRootChanged(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /**\r\n   * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.\r\n   * A subclass of ElementDrivesElement can re-implement this static method to take some action.\r\n   * @param _props The deleted ElementDrivesElement relationship instance.\r\n   * @param _iModel The iModel\r\n   */\r\n  public static onDeletedDependency(_props: RelationshipProps, _iModel: IModelDb): void { }\r\n\r\n  /** Insert this Relationship into the iModel. */\r\n  public insert(): Id64String { return this.id = this.iModel.relationships.insertInstance(this.toJSON()); }\r\n  /** Update this Relationship in the iModel. */\r\n  public update() { this.iModel.relationships.updateInstance(this.toJSON()); }\r\n  /** Delete this Relationship from the iModel. */\r\n  public delete() { this.iModel.relationships.deleteInstance(this.toJSON()); }\r\n\r\n  public static getInstance<T extends Relationship>(iModel: IModelDb, criteria: Id64String | SourceAndTarget): T { return iModel.relationships.getInstance(this.classFullName, criteria); }\r\n}\r\n\r\n/** A Relationship where one Element refers to another Element\r\n * @public\r\n */\r\nexport class ElementRefersToElements extends Relationship {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementRefersToElements\"; }\r\n  /** Create an instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return an instance of the specified class.\r\n   */\r\n  public static create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): T {\r\n    return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName }) as T;\r\n  }\r\n  /** Insert a new instance of the Relationship.\r\n   * @param iModel The iModel that will contain the relationship\r\n   * @param sourceId The sourceId of the relationship, that is, the driver element\r\n   * @param targetId The targetId of the relationship, that is, the driven element\r\n   * @return The Id of the inserted Relationship.\r\n   */\r\n  public static insert<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String): Id64String {\r\n    const relationship: T = this.create(iModel, sourceId, targetId);\r\n    return iModel.relationships.insertInstance(relationship.toJSON());\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet,): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class DrawingGraphicRepresentsElement extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DrawingGraphicRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents\r\n * @public\r\n */\r\nexport class GraphicalElement3dRepresentsElement extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GraphicalElement3dRepresentsElement\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.\r\n * Each relationship instance represents an external source processed by the synchronization configuration.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigProcessesSources extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SynchronizationConfigProcessesSources\"; }\r\n}\r\n\r\n/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {\r\n  /** @internal */\r\n  public static override get className(): string { return \"SynchronizationConfigSpecifiesRootSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n */\r\nexport interface ElementGroupsMembersProps extends RelationshipProps {\r\n  memberPriority: number;\r\n}\r\n\r\n/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.\r\n * @public\r\n */\r\nexport class ElementGroupsMembers extends ElementRefersToElements {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementGroupsMembers\"; }\r\n  public memberPriority: number;\r\n\r\n  constructor(props: ElementGroupsMembersProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.memberPriority = props.memberPriority;\r\n  }\r\n\r\n  public static override create<T extends ElementRefersToElements>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, memberPriority: number = 0): T {\r\n    const props: ElementGroupsMembersProps = { sourceId, targetId, memberPriority, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n}\r\n\r\n/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.10\r\n * @public\r\n */\r\nexport class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DefinitionGroupGroupsDefinitions\"; }\r\n}\r\n\r\n/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.\r\n * Implies that properties of the group should be considered as properties of its members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.11\r\n * @public\r\n */\r\nexport class GroupImpartsToMembers extends ElementGroupsMembers {\r\n  /** @internal */\r\n  public static override get className(): string { return \"GroupImpartsToMembers\"; }\r\n}\r\n\r\n/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.\r\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\r\n * @beta\r\n */\r\nexport class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ExternalSourceGroupGroupsSources\"; }\r\n}\r\n\r\n/** Properties that are common to all types of ElementDrivesElements\r\n * @beta\r\n */\r\nexport interface ElementDrivesElementProps extends RelationshipProps {\r\n  status: number;\r\n  priority: number;\r\n}\r\n\r\n/** A Relationship indicating that one Element *drives* another Element.\r\n * An ElementDrivesElement relationship defines a one-way \"driving\" relationship from the source to the target.\r\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.\r\n * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.\r\n *\r\n * # Defining dependencies\r\n * Create an ElementDrivesElement relationship to specify that the source element drives the target element.\r\n * For example, to specify that element e1 drives element e2, create a relationship between them like this:\r\n * ```ts\r\n *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  ede.insert();\r\n * ```\r\n * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.\r\n *\r\n * # Defining dependency graphs\r\n * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.\r\n * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.\r\n *\r\n * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  ede12.insert();\r\n *  ede23.insert();\r\n * ```\r\n * Those two relationships create this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * Where the \"-->\" is meant to represent a driving relationship.\r\n *\r\n * The order in which you create the relationships does not matter.\r\n * The graph indicates that e3 depends on e2 and e2 depends on e1.\r\n *\r\n * An ElementDrivesElement relationship is between one source element and one target element.\r\n * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.\r\n * Thus, you can define many:many relationships.\r\n * For example:\r\n * ```ts\r\n *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);\r\n *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);\r\n *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);\r\n *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);\r\n *  ede12.insert();\r\n *  ede112.insert();\r\n *  ede23.insert();\r\n *  ede231.insert();\r\n * ```\r\n * Creates this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * e2 depends on both e1 and e11. e2 then drives e3 and e31.\r\n *\r\n * In an ElementDrivesElement dependency graph, the relationships are the \"edges\" and the Elements are the \"nodes\".\r\n * The following terms are used when referring to the elements (nodes) in a dependency graph:\r\n * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.\r\n * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.\r\n *\r\n * # Subgraph Processing\r\n * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,\r\n * suppose we have this graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.\r\n *\r\n * If only e2 changes, then the subgraph to be processed is just:\r\n * ```\r\n *       e2 --> e3\r\n * ```\r\n * If only e3 changes, then the subgraph consists of e3 by itself.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed, the affected subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * If e2 is changed, the affected subgraph is:\r\n * ```\r\n *           e3\r\n *         /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * # Callbacks\r\n * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.\r\n * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.\r\n *\r\n * ## ElementDrivesElement Callbacks\r\n * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):\r\n * * onRootChanged\r\n * * onDeletedDependency\r\n *\r\n * Note that these are static methods. Their default implementations do nothing.\r\n * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.\r\n * The subclass should then implement the callbacks that it would like to act on.\r\n *\r\n * A ElementDrivesElement subclass callback is expected to make changes to the output element only!\r\n *\r\n * ## Element Callbacks\r\n * The following callbacks are invoked on Element classes (nodes):\r\n * * Element.onBeforeOutputsHandled\r\n * * Element.onAllInputsHandled\r\n *\r\n * ## Order\r\n * Callbacks are invoked by BriefcaseDb.saveChanges.\r\n * They are invoked in dependency (topological) order: driving elements first, then driven elements.\r\n *\r\n * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,\r\n * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.\r\n * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be\r\n * invoked only once.\r\n *\r\n * For example, suppose we have a graph:\r\n * ```\r\n * e1 --> e2 --> e3\r\n * ```\r\n *\r\n * Suppose that e1 is directly modified. No callbacks are made at that time.\r\n * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n *\r\n * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.\r\n * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.\r\n *\r\n * Returning to the second example above, suppose we have this graph:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *    /    \\\r\n * e11       e31\r\n * ```\r\n * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:\r\n * ```\r\n * e1        e3\r\n *    \\    /\r\n *      e2\r\n *         \\\r\n *           e31\r\n * ```\r\n * The callbacks are:\r\n * 1. Element.onBeforeOutputsHandled e1\r\n * 1. ElementDrivesElement.onRootChanged e1->e2\r\n * 1. Element.onAllInputsHandled e2\r\n * 1. ElementDrivesElement.onRootChanged e2->e3\r\n * 1. Element.onAllInputsHandled e3\r\n * 1. ElementDrivesElement.onRootChanged e2->e31\r\n * 1. Element.onAllInputsHandled e31\r\n *\r\n * (The ElementDrivesElement.)\r\n *\r\n * #Errors\r\n * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships\r\n * involved in a cycle will have their status set to 1, indicating a failure.\r\n *\r\n * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.\r\n * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.\r\n *\r\n * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.\r\n *\r\n * @beta\r\n */\r\nexport class ElementDrivesElement extends Relationship {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ElementDrivesElement\"; }\r\n  /** Relationship status\r\n   * * 0 indicates no errors. Set after a successful evaluation.\r\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.\r\n   * * 0x80 The app or callback can set this to indicate to not propagate changes through this relationship.\r\n   */\r\n  public status: number;\r\n  /** Affects the order in which relationships are processed in the case where two relationships have the same output. */\r\n  public priority: number;\r\n\r\n  /** @internal */\r\n  constructor(props: ElementDrivesElementProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.status = props.status;\r\n    this.priority = props.priority;\r\n  }\r\n\r\n  public static create<T extends ElementDrivesElement>(iModel: IModelDb, sourceId: Id64String, targetId: Id64String, priority: number = 0): T {\r\n    const props: ElementDrivesElementProps = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };\r\n    return iModel.relationships.createInstance(props) as T;\r\n  }\r\n\r\n  public override toJSON(): ElementDrivesElementProps {\r\n    const props = super.toJSON() as ElementDrivesElementProps;\r\n    props.status = this.status;\r\n    props.priority = this.priority;\r\n    return props;\r\n  }\r\n\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet,): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addElement(this.targetId);\r\n  }\r\n}\r\n\r\n/** The third (and last) possible link-table relationship base class in an iModel.\r\n * Has no external use, but is included for completeness of the [Entity.collectReferenceIds]($backend)\r\n * implementations for link-table relationships. Generating the types of the source and target automatically would require\r\n * coupling this package with ecschema-metadata which we do not want to do.\r\n * @internal\r\n */\r\nexport class ModelSelectorRefersToModels extends Relationship {\r\n  /** @internal */\r\n  public static override get className(): string { return \"ModelSelectorRefersToModels\"; }\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    referenceIds.addElement(this.sourceId);\r\n    referenceIds.addModel(this.targetId);\r\n  }\r\n}\r\n\r\n/** Manages [[Relationship]]s.\r\n * @public\r\n */\r\nexport class Relationships {\r\n  private _iModel: IModelDb;\r\n\r\n  /** @internal */\r\n  constructor(iModel: IModelDb) { this._iModel = iModel; }\r\n\r\n  /** Create a new instance of a Relationship.\r\n   * @param props The properties of the new Relationship.\r\n   * @throws [[IModelError]] if there is a problem creating the Relationship.\r\n   */\r\n  public createInstance(props: RelationshipProps): Relationship { return this._iModel.constructEntity<Relationship>(props); }\r\n\r\n  /** Check classFullName to ensure it is a link table relationship class. */\r\n  private checkRelationshipClass(classFullName: string) {\r\n    if (!this._iModel.nativeDb.isLinkTableRelationship(classFullName.replace(\".\", \":\"))) {\r\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.`);\r\n    }\r\n  }\r\n\r\n  /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.\r\n   * @param props The properties of the new relationship.\r\n   * @returns The Id of the newly inserted relationship.\r\n   * @note The id property of the props object is set as a side effect of this function.\r\n   */\r\n  public insertInstance(props: RelationshipProps): Id64String {\r\n    this.checkRelationshipClass(props.classFullName);\r\n    return props.id = this._iModel.nativeDb.insertLinkTableRelationship(props);\r\n  }\r\n\r\n  /** Update the properties of an existing relationship instance in the iModel.\r\n   * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.\r\n   */\r\n  public updateInstance(props: RelationshipProps): void {\r\n    this._iModel.nativeDb.updateLinkTableRelationship(props);\r\n  }\r\n\r\n  /** Delete an Relationship instance from this iModel. */\r\n  public deleteInstance(props: RelationshipProps): void {\r\n    this._iModel.nativeDb.deleteLinkTableRelationship(props);\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstanceProps\r\n   */\r\n  public getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T {\r\n    const relationshipProps = this.tryGetInstanceProps<T>(relClassFullName, criteria);\r\n    if (undefined === relationshipProps) {\r\n      throw new IModelError(IModelStatus.NotFound, \"Relationship not found\");\r\n    }\r\n    return relationshipProps;\r\n  }\r\n\r\n  /** Get the props of a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The RelationshipProps or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstanceProps\r\n   */\r\n  public tryGetInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    let props: T | undefined;\r\n    if (typeof criteria === \"string\") {\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    } else {\r\n      props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt: ECSqlStatement) => {\r\n        stmt.bindId(1, criteria.sourceId);\r\n        stmt.bindId(2, criteria.targetId);\r\n        return DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() as T : undefined;\r\n      });\r\n    }\r\n    if (undefined !== props) {\r\n      props.classFullName = (props as any).className.replace(\".\", \":\");\r\n    }\r\n    return props;\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.\r\n   * @see tryGetInstance\r\n   */\r\n  public getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T {\r\n    return this._iModel.constructEntity<T>(this.getInstanceProps(relClassSqlName, criteria));\r\n  }\r\n\r\n  /** Get a Relationship instance\r\n   * @param relClassFullName The full class name of the relationship in the form of \"schema:class\"\r\n   * @param criteria Either the relationship instanceId or the source and target Ids\r\n   * @returns The relationship or `undefined` if the relationship is not found.\r\n   * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.\r\n   * @see getInstance\r\n   */\r\n  public tryGetInstance<T extends Relationship>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T | undefined {\r\n    const relationshipProps = this.tryGetInstanceProps<RelationshipProps>(relClassFullName, criteria);\r\n    return undefined !== relationshipProps ? this._iModel.constructEntity<T>(relationshipProps) : undefined;\r\n  }\r\n}\r\n"]}