@itwin/core-backend 3.4.3 → 3.4.4

package/lib/cjs/Relationship.js

@@ -1,495 +1,495 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Relationships
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Relationships = exports.ModelSelectorRefersToModels = exports.ElementDrivesElement = exports.ExternalSourceGroupGroupsSources = exports.GroupImpartsToMembers = exports.DefinitionGroupGroupsDefinitions = exports.ElementGroupsMembers = exports.SynchronizationConfigSpecifiesRootSources = exports.SynchronizationConfigProcessesSources = exports.GraphicalElement3dRepresentsElement = exports.DrawingGraphicRepresentsElement = exports.ElementRefersToElements = exports.Relationship = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const Entity_1 = require("./Entity");
-/** Base class for all link table ECRelationships
- * @public
- */
-class Relationship extends Entity_1.Entity {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.sourceId = core_bentley_1.Id64.fromJSON(props.sourceId);
-        this.targetId = core_bentley_1.Id64.fromJSON(props.targetId);
-    }
-    /** @internal */
-    static get className() { return "Relationship"; }
-    /** @internal */
-    toJSON() {
-        const val = super.toJSON();
-        val.sourceId = this.sourceId;
-        val.targetId = this.targetId;
-        return val;
-    }
-    /**
-     * 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.
-     * This callback is invoked after the input element has been processed by upstream relationships.
-     * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.
-     * @param _props The ElementDrivesElement relationship instance.
-     * @param _iModel The iModel
-     */
-    static onRootChanged(_props, _iModel) { }
-    /**
-     * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.
-     * A subclass of ElementDrivesElement can re-implement this static method to take some action.
-     * @param _props The deleted ElementDrivesElement relationship instance.
-     * @param _iModel The iModel
-     */
-    static onDeletedDependency(_props, _iModel) { }
-    /** Insert this Relationship into the iModel. */
-    insert() { return this.id = this.iModel.relationships.insertInstance(this.toJSON()); }
-    /** Update this Relationship in the iModel. */
-    update() { this.iModel.relationships.updateInstance(this.toJSON()); }
-    /** Delete this Relationship from the iModel. */
-    delete() { this.iModel.relationships.deleteInstance(this.toJSON()); }
-    static getInstance(iModel, criteria) { return iModel.relationships.getInstance(this.classFullName, criteria); }
-}
-exports.Relationship = Relationship;
-/** A Relationship where one Element refers to another Element
- * @public
- */
-class ElementRefersToElements extends Relationship {
-    /** @internal */
-    static get className() { return "ElementRefersToElements"; }
-    /** Create an instance of the Relationship.
-     * @param iModel The iModel that will contain the relationship
-     * @param sourceId The sourceId of the relationship, that is, the driver element
-     * @param targetId The targetId of the relationship, that is, the driven element
-     * @return an instance of the specified class.
-     */
-    static create(iModel, sourceId, targetId) {
-        return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName });
-    }
-    /** Insert a new instance of the Relationship.
-     * @param iModel The iModel that will contain the relationship
-     * @param sourceId The sourceId of the relationship, that is, the driver element
-     * @param targetId The targetId of the relationship, that is, the driven element
-     * @return The Id of the inserted Relationship.
-     */
-    static insert(iModel, sourceId, targetId) {
-        const relationship = this.create(iModel, sourceId, targetId);
-        return iModel.relationships.insertInstance(relationship.toJSON());
-    }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
-        referenceIds.addElement(this.sourceId);
-        referenceIds.addElement(this.targetId);
-    }
-}
-exports.ElementRefersToElements = ElementRefersToElements;
-/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents
- * @public
- */
-class DrawingGraphicRepresentsElement extends ElementRefersToElements {
-    /** @internal */
-    static get className() { return "DrawingGraphicRepresentsElement"; }
-}
-exports.DrawingGraphicRepresentsElement = DrawingGraphicRepresentsElement;
-/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents
- * @public
- */
-class GraphicalElement3dRepresentsElement extends ElementRefersToElements {
-    /** @internal */
-    static get className() { return "GraphicalElement3dRepresentsElement"; }
-}
-exports.GraphicalElement3dRepresentsElement = GraphicalElement3dRepresentsElement;
-/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.
- * Each relationship instance represents an external source processed by the synchronization configuration.
- * @note The associated ECClass was added to the BisCore schema in version 1.0.13
- * @beta
- */
-class SynchronizationConfigProcessesSources extends ElementRefersToElements {
-    /** @internal */
-    static get className() { return "SynchronizationConfigProcessesSources"; }
-}
-exports.SynchronizationConfigProcessesSources = SynchronizationConfigProcessesSources;
-/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.
- * @note The associated ECClass was added to the BisCore schema in version 1.0.13
- * @beta
- */
-class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {
-    /** @internal */
-    static get className() { return "SynchronizationConfigSpecifiesRootSources"; }
-}
-exports.SynchronizationConfigSpecifiesRootSources = SynchronizationConfigSpecifiesRootSources;
-/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.
- * @public
- */
-class ElementGroupsMembers extends ElementRefersToElements {
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.memberPriority = props.memberPriority;
-    }
-    /** @internal */
-    static get className() { return "ElementGroupsMembers"; }
-    static create(iModel, sourceId, targetId, memberPriority = 0) {
-        const props = { sourceId, targetId, memberPriority, classFullName: this.classFullName };
-        return iModel.relationships.createInstance(props);
-    }
-}
-exports.ElementGroupsMembers = ElementGroupsMembers;
-/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.
- * @note The associated ECClass was added to the BisCore schema in version 1.0.10
- * @public
- */
-class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {
-    /** @internal */
-    static get className() { return "DefinitionGroupGroupsDefinitions"; }
-}
-exports.DefinitionGroupGroupsDefinitions = DefinitionGroupGroupsDefinitions;
-/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.
- * Implies that properties of the group should be considered as properties of its members.
- * @note The associated ECClass was added to the BisCore schema in version 1.0.11
- * @public
- */
-class GroupImpartsToMembers extends ElementGroupsMembers {
-    /** @internal */
-    static get className() { return "GroupImpartsToMembers"; }
-}
-exports.GroupImpartsToMembers = GroupImpartsToMembers;
-/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.
- * @note The associated ECClass was added to the BisCore schema in version 1.0.13
- * @beta
- */
-class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {
-    /** @internal */
-    static get className() { return "ExternalSourceGroupGroupsSources"; }
-}
-exports.ExternalSourceGroupGroupsSources = ExternalSourceGroupGroupsSources;
-/** A Relationship indicating that one Element *drives* another Element.
- * An ElementDrivesElement relationship defines a one-way "driving" relationship from the source to the target.
- * 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.
- * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.
- *
- * # Defining dependencies
- * Create an ElementDrivesElement relationship to specify that the source element drives the target element.
- * For example, to specify that element e1 drives element e2, create a relationship between them like this:
- * ```ts
- *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);
- *  ede.insert();
- * ```
- * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.
- *
- * # Defining dependency graphs
- * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.
- * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.
- *
- * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:
- * ```ts
- *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);
- *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);
- *  ede12.insert();
- *  ede23.insert();
- * ```
- * Those two relationships create this graph:
- * ```
- * e1 --> e2 --> e3
- * ```
- * Where the "-->" is meant to represent a driving relationship.
- *
- * The order in which you create the relationships does not matter.
- * The graph indicates that e3 depends on e2 and e2 depends on e1.
- *
- * An ElementDrivesElement relationship is between one source element and one target element.
- * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.
- * Thus, you can define many:many relationships.
- * For example:
- * ```ts
- *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);
- *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);
- *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);
- *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);
- *  ede12.insert();
- *  ede112.insert();
- *  ede23.insert();
- *  ede231.insert();
- * ```
- * Creates this graph:
- * ```
- * e1        e3
- *    \    /
- *      e2
- *    /    \
- * e11       e31
- * ```
- * e2 depends on both e1 and e11. e2 then drives e3 and e31.
- *
- * In an ElementDrivesElement dependency graph, the relationships are the "edges" and the Elements are the "nodes".
- * The following terms are used when referring to the elements (nodes) in a dependency graph:
- * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.
- * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.
- *
- * # Subgraph Processing
- * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,
- * suppose we have this graph:
- * ```
- * e1 --> e2 --> e3
- * ```
- * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.
- *
- * If only e2 changes, then the subgraph to be processed is just:
- * ```
- *       e2 --> e3
- * ```
- * If only e3 changes, then the subgraph consists of e3 by itself.
- *
- * Returning to the second example above, suppose we have this graph:
- * ```
- * e1        e3
- *    \    /
- *      e2
- *    /    \
- * e11       e31
- * ```
- * If e1 is changed, the affected subgraph is:
- * ```
- * e1        e3
- *    \    /
- *      e2
- *         \
- *           e31
- * ```
- * If e2 is changed, the affected subgraph is:
- * ```
- *           e3
- *         /
- *      e2
- *         \
- *           e31
- * ```
- * # Callbacks
- * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.
- * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.
- *
- * ## ElementDrivesElement Callbacks
- * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):
- * * onRootChanged
- * * onDeletedDependency
- *
- * Note that these are static methods. Their default implementations do nothing.
- * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.
- * The subclass should then implement the callbacks that it would like to act on.
- *
- * A ElementDrivesElement subclass callback is expected to make changes to the output element only!
- *
- * ## Element Callbacks
- * The following callbacks are invoked on Element classes (nodes):
- * * Element.onBeforeOutputsHandled
- * * Element.onAllInputsHandled
- *
- * ## Order
- * Callbacks are invoked by BriefcaseDb.saveChanges.
- * They are invoked in dependency (topological) order: driving elements first, then driven elements.
- *
- * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,
- * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.
- * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be
- * invoked only once.
- *
- * For example, suppose we have a graph:
- * ```
- * e1 --> e2 --> e3
- * ```
- *
- * Suppose that e1 is directly modified. No callbacks are made at that time.
- * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:
- * 1. Element.onBeforeOutputsHandled e1
- * 1. ElementDrivesElement.onRootChanged e1->e2
- * 1. Element.onAllInputsHandled e2
- * 1. ElementDrivesElement.onRootChanged e2->e3
- * 1. Element.onAllInputsHandled e3
- *
- * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.
- * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.
- *
- * Returning to the second example above, suppose we have this graph:
- * ```
- * e1        e3
- *    \    /
- *      e2
- *    /    \
- * e11       e31
- * ```
- * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:
- * ```
- * e1        e3
- *    \    /
- *      e2
- *         \
- *           e31
- * ```
- * The callbacks are:
- * 1. Element.onBeforeOutputsHandled e1
- * 1. ElementDrivesElement.onRootChanged e1->e2
- * 1. Element.onAllInputsHandled e2
- * 1. ElementDrivesElement.onRootChanged e2->e3
- * 1. Element.onAllInputsHandled e3
- * 1. ElementDrivesElement.onRootChanged e2->e31
- * 1. Element.onAllInputsHandled e31
- *
- * (The ElementDrivesElement.)
- *
- * #Errors
- * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships
- * involved in a cycle will have their status set to 1, indicating a failure.
- *
- * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.
- * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.
- *
- * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.
- *
- * @beta
- */
-class ElementDrivesElement extends Relationship {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.status = props.status;
-        this.priority = props.priority;
-    }
-    /** @internal */
-    static get className() { return "ElementDrivesElement"; }
-    static create(iModel, sourceId, targetId, priority = 0) {
-        const props = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };
-        return iModel.relationships.createInstance(props);
-    }
-    toJSON() {
-        const props = super.toJSON();
-        props.status = this.status;
-        props.priority = this.priority;
-        return props;
-    }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(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)
- * 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
- */
-class ModelSelectorRefersToModels extends Relationship {
-    /** @internal */
-    static get className() { return "ModelSelectorRefersToModels"; }
-    /** @internal */
-    collectReferenceConcreteIds(referenceIds) {
-        super.collectReferenceConcreteIds(referenceIds);
-        referenceIds.addElement(this.sourceId);
-        referenceIds.addModel(this.targetId);
-    }
-}
-exports.ModelSelectorRefersToModels = ModelSelectorRefersToModels;
-/** Manages [[Relationship]]s.
- * @public
- */
-class Relationships {
-    /** @internal */
-    constructor(iModel) { this._iModel = iModel; }
-    /** Create a new instance of a Relationship.
-     * @param props The properties of the new Relationship.
-     * @throws [[IModelError]] if there is a problem creating the Relationship.
-     */
-    createInstance(props) { return this._iModel.constructEntity(props); }
-    /** Check classFullName to ensure it is a link table relationship class. */
-    checkRelationshipClass(classFullName) {
-        if (!this._iModel.nativeDb.isLinkTableRelationship(classFullName.replace(".", ":"))) {
-            throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);
-        }
-    }
-    /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.
-     * @param props The properties of the new relationship.
-     * @returns The Id of the newly inserted relationship.
-     * @note The id property of the props object is set as a side effect of this function.
-     */
-    insertInstance(props) {
-        this.checkRelationshipClass(props.classFullName);
-        return props.id = this._iModel.nativeDb.insertLinkTableRelationship(props);
-    }
-    /** Update the properties of an existing relationship instance in the iModel.
-     * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.
-     */
-    updateInstance(props) {
-        this._iModel.nativeDb.updateLinkTableRelationship(props);
-    }
-    /** Delete an Relationship instance from this iModel. */
-    deleteInstance(props) {
-        this._iModel.nativeDb.deleteLinkTableRelationship(props);
-    }
-    /** Get the props of a Relationship instance
-     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
-     * @param criteria Either the relationship instanceId or the source and target Ids
-     * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.
-     * @see tryGetInstanceProps
-     */
-    getInstanceProps(relClassFullName, criteria) {
-        const relationshipProps = this.tryGetInstanceProps(relClassFullName, criteria);
-        if (undefined === relationshipProps) {
-            throw new core_common_1.IModelError(core_common_1.IModelStatus.NotFound, "Relationship not found");
-        }
-        return relationshipProps;
-    }
-    /** Get the props of a Relationship instance
-     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
-     * @param criteria Either the relationship instanceId or the source and target Ids
-     * @returns The RelationshipProps or `undefined` if the relationship is not found.
-     * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.
-     * @see getInstanceProps
-     */
-    tryGetInstanceProps(relClassFullName, criteria) {
-        let props;
-        if (typeof criteria === "string") {
-            props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt) => {
-                stmt.bindId(1, criteria);
-                return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() : undefined;
-            });
-        }
-        else {
-            props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt) => {
-                stmt.bindId(1, criteria.sourceId);
-                stmt.bindId(2, criteria.targetId);
-                return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() : undefined;
-            });
-        }
-        if (undefined !== props) {
-            props.classFullName = props.className.replace(".", ":");
-        }
-        return props;
-    }
-    /** Get a Relationship instance
-     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
-     * @param criteria Either the relationship instanceId or the source and target Ids
-     * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.
-     * @see tryGetInstance
-     */
-    getInstance(relClassSqlName, criteria) {
-        return this._iModel.constructEntity(this.getInstanceProps(relClassSqlName, criteria));
-    }
-    /** Get a Relationship instance
-     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
-     * @param criteria Either the relationship instanceId or the source and target Ids
-     * @returns The relationship or `undefined` if the relationship is not found.
-     * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.
-     * @see getInstance
-     */
-    tryGetInstance(relClassFullName, criteria) {
-        const relationshipProps = this.tryGetInstanceProps(relClassFullName, criteria);
-        return undefined !== relationshipProps ? this._iModel.constructEntity(relationshipProps) : undefined;
-    }
-}
-exports.Relationships = Relationships;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Relationships
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Relationships = exports.ModelSelectorRefersToModels = exports.ElementDrivesElement = exports.ExternalSourceGroupGroupsSources = exports.GroupImpartsToMembers = exports.DefinitionGroupGroupsDefinitions = exports.ElementGroupsMembers = exports.SynchronizationConfigSpecifiesRootSources = exports.SynchronizationConfigProcessesSources = exports.GraphicalElement3dRepresentsElement = exports.DrawingGraphicRepresentsElement = exports.ElementRefersToElements = exports.Relationship = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const Entity_1 = require("./Entity");
+/** Base class for all link table ECRelationships
+ * @public
+ */
+class Relationship extends Entity_1.Entity {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.sourceId = core_bentley_1.Id64.fromJSON(props.sourceId);
+        this.targetId = core_bentley_1.Id64.fromJSON(props.targetId);
+    }
+    /** @internal */
+    static get className() { return "Relationship"; }
+    /** @internal */
+    toJSON() {
+        const val = super.toJSON();
+        val.sourceId = this.sourceId;
+        val.targetId = this.targetId;
+        return val;
+    }
+    /**
+     * 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.
+     * This callback is invoked after the input element has been processed by upstream relationships.
+     * A subclass of ElementDrivesElement can re-implement this static method to take some action. onRootChanged may modify the output element only.
+     * @param _props The ElementDrivesElement relationship instance.
+     * @param _iModel The iModel
+     */
+    static onRootChanged(_props, _iModel) { }
+    /**
+     * Callback invoked by saveChanges on an ElementDrivesElement relationship when the relationship instance has been deleted.
+     * A subclass of ElementDrivesElement can re-implement this static method to take some action.
+     * @param _props The deleted ElementDrivesElement relationship instance.
+     * @param _iModel The iModel
+     */
+    static onDeletedDependency(_props, _iModel) { }
+    /** Insert this Relationship into the iModel. */
+    insert() { return this.id = this.iModel.relationships.insertInstance(this.toJSON()); }
+    /** Update this Relationship in the iModel. */
+    update() { this.iModel.relationships.updateInstance(this.toJSON()); }
+    /** Delete this Relationship from the iModel. */
+    delete() { this.iModel.relationships.deleteInstance(this.toJSON()); }
+    static getInstance(iModel, criteria) { return iModel.relationships.getInstance(this.classFullName, criteria); }
+}
+exports.Relationship = Relationship;
+/** A Relationship where one Element refers to another Element
+ * @public
+ */
+class ElementRefersToElements extends Relationship {
+    /** @internal */
+    static get className() { return "ElementRefersToElements"; }
+    /** Create an instance of the Relationship.
+     * @param iModel The iModel that will contain the relationship
+     * @param sourceId The sourceId of the relationship, that is, the driver element
+     * @param targetId The targetId of the relationship, that is, the driven element
+     * @return an instance of the specified class.
+     */
+    static create(iModel, sourceId, targetId) {
+        return iModel.relationships.createInstance({ sourceId, targetId, classFullName: this.classFullName });
+    }
+    /** Insert a new instance of the Relationship.
+     * @param iModel The iModel that will contain the relationship
+     * @param sourceId The sourceId of the relationship, that is, the driver element
+     * @param targetId The targetId of the relationship, that is, the driven element
+     * @return The Id of the inserted Relationship.
+     */
+    static insert(iModel, sourceId, targetId) {
+        const relationship = this.create(iModel, sourceId, targetId);
+        return iModel.relationships.insertInstance(relationship.toJSON());
+    }
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
+        referenceIds.addElement(this.sourceId);
+        referenceIds.addElement(this.targetId);
+    }
+}
+exports.ElementRefersToElements = ElementRefersToElements;
+/** Relates a [[DrawingGraphic]] to the [[Element]] that it represents
+ * @public
+ */
+class DrawingGraphicRepresentsElement extends ElementRefersToElements {
+    /** @internal */
+    static get className() { return "DrawingGraphicRepresentsElement"; }
+}
+exports.DrawingGraphicRepresentsElement = DrawingGraphicRepresentsElement;
+/** Relates a [[GraphicalElement3d]] to the [[Element]] that it represents
+ * @public
+ */
+class GraphicalElement3dRepresentsElement extends ElementRefersToElements {
+    /** @internal */
+    static get className() { return "GraphicalElement3dRepresentsElement"; }
+}
+exports.GraphicalElement3dRepresentsElement = GraphicalElement3dRepresentsElement;
+/** Relates a [[SynchronizationConfigLink]] to N [[ExternalSource]] instances.
+ * Each relationship instance represents an external source processed by the synchronization configuration.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+class SynchronizationConfigProcessesSources extends ElementRefersToElements {
+    /** @internal */
+    static get className() { return "SynchronizationConfigProcessesSources"; }
+}
+exports.SynchronizationConfigProcessesSources = SynchronizationConfigProcessesSources;
+/** Relates a [[SynchronizationConfigLink]] to *root* [[ExternalSource]] instances.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+class SynchronizationConfigSpecifiesRootSources extends SynchronizationConfigProcessesSources {
+    /** @internal */
+    static get className() { return "SynchronizationConfigSpecifiesRootSources"; }
+}
+exports.SynchronizationConfigSpecifiesRootSources = SynchronizationConfigSpecifiesRootSources;
+/** An ElementRefersToElements relationship where one Element *groups* a set of other Elements.
+ * @public
+ */
+class ElementGroupsMembers extends ElementRefersToElements {
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.memberPriority = props.memberPriority;
+    }
+    /** @internal */
+    static get className() { return "ElementGroupsMembers"; }
+    static create(iModel, sourceId, targetId, memberPriority = 0) {
+        const props = { sourceId, targetId, memberPriority, classFullName: this.classFullName };
+        return iModel.relationships.createInstance(props);
+    }
+}
+exports.ElementGroupsMembers = ElementGroupsMembers;
+/** Relates a [[DefinitionGroup]] to its [[DefinitionElement]] members.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.10
+ * @public
+ */
+class DefinitionGroupGroupsDefinitions extends ElementGroupsMembers {
+    /** @internal */
+    static get className() { return "DefinitionGroupGroupsDefinitions"; }
+}
+exports.DefinitionGroupGroupsDefinitions = DefinitionGroupGroupsDefinitions;
+/** Represents group membership where the group Element (and its properties) impart information about the member Elements above mere membership.
+ * Implies that properties of the group should be considered as properties of its members.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.11
+ * @public
+ */
+class GroupImpartsToMembers extends ElementGroupsMembers {
+    /** @internal */
+    static get className() { return "GroupImpartsToMembers"; }
+}
+exports.GroupImpartsToMembers = GroupImpartsToMembers;
+/** Relates an [[ExternalSourceGroup]] to its [[ExternalSource]] members.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+class ExternalSourceGroupGroupsSources extends ElementGroupsMembers {
+    /** @internal */
+    static get className() { return "ExternalSourceGroupGroupsSources"; }
+}
+exports.ExternalSourceGroupGroupsSources = ExternalSourceGroupGroupsSources;
+/** A Relationship indicating that one Element *drives* another Element.
+ * An ElementDrivesElement relationship defines a one-way "driving" relationship from the source to the target.
+ * 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.
+ * By inserting ElementDrivesElement relationships, an app can create and store an acyclic directed graph of dependencies between elements.
+ *
+ * # Defining dependencies
+ * Create an ElementDrivesElement relationship to specify that the source element drives the target element.
+ * For example, to specify that element e1 drives element e2, create a relationship between them like this:
+ * ```ts
+ *  const ede = ElementDrivesElement.create(iModel, e1id, e2id);
+ *  ede.insert();
+ * ```
+ * This creates a persistent relationship. The fact that e1 drives e2 is persisted in the iModel.
+ *
+ * # Defining dependency graphs
+ * When you create multiple ElementDrivesElement relationships, you create a network of dependencies. The target of one may be the source of another.
+ * A change in the content of an DgnElement can therefore trigger changes to many downstream elements.
+ *
+ * For example, to make element e1 drive element e2 and e2 drive another element, e3, create two relationships like this:
+ * ```ts
+ *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);
+ *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);
+ *  ede12.insert();
+ *  ede23.insert();
+ * ```
+ * Those two relationships create this graph:
+ * ```
+ * e1 --> e2 --> e3
+ * ```
+ * Where the "-->" is meant to represent a driving relationship.
+ *
+ * The order in which you create the relationships does not matter.
+ * The graph indicates that e3 depends on e2 and e2 depends on e1.
+ *
+ * An ElementDrivesElement relationship is between one source element and one target element.
+ * Many ElementDrivesElement relationships can point to a given element, and many can point out of it.
+ * Thus, you can define many:many relationships.
+ * For example:
+ * ```ts
+ *  const ede12 = ElementDrivesElement.create(iModel, e1id, e2id);
+ *  const ede112 = ElementDrivesElement.create(iModel, e11id, e2id);
+ *  const ede23 = ElementDrivesElement.create(iModel, e2id, e3id);
+ *  const ede231 = ElementDrivesElement.create(iModel, e2id, e31id);
+ *  ede12.insert();
+ *  ede112.insert();
+ *  ede23.insert();
+ *  ede231.insert();
+ * ```
+ * Creates this graph:
+ * ```
+ * e1        e3
+ *    \    /
+ *      e2
+ *    /    \
+ * e11       e31
+ * ```
+ * e2 depends on both e1 and e11. e2 then drives e3 and e31.
+ *
+ * In an ElementDrivesElement dependency graph, the relationships are the "edges" and the Elements are the "nodes".
+ * The following terms are used when referring to the elements (nodes) in a dependency graph:
+ * * Inputs - The sources of all edges that point to the element. This includes all upstream elements that flow into the element.
+ * * Outputs - The targets of all edges that point out of the element. This includes all downstream elements.
+ *
+ * # Subgraph Processing
+ * When changes are made, only the part of the overall graph that is affected will be processed. So, for example,
+ * suppose we have this graph:
+ * ```
+ * e1 --> e2 --> e3
+ * ```
+ * If e1 changes, then the subgraph to be processed is equal to the full graph, as shown.
+ *
+ * If only e2 changes, then the subgraph to be processed is just:
+ * ```
+ *       e2 --> e3
+ * ```
+ * If only e3 changes, then the subgraph consists of e3 by itself.
+ *
+ * Returning to the second example above, suppose we have this graph:
+ * ```
+ * e1        e3
+ *    \    /
+ *      e2
+ *    /    \
+ * e11       e31
+ * ```
+ * If e1 is changed, the affected subgraph is:
+ * ```
+ * e1        e3
+ *    \    /
+ *      e2
+ *         \
+ *           e31
+ * ```
+ * If e2 is changed, the affected subgraph is:
+ * ```
+ *           e3
+ *         /
+ *      e2
+ *         \
+ *           e31
+ * ```
+ * # Callbacks
+ * Once the affected subgraph to process is found, it propagates changes through it by making callbacks.
+ * Classes for both elements (nodes) and ElementDrivesElements relationships (edges) can receive callbacks.
+ *
+ * ## ElementDrivesElement Callbacks
+ * The following callbacks are invoked on ElementDrivesElement relationship classes (edges):
+ * * onRootChanged
+ * * onDeletedDependency
+ *
+ * Note that these are static methods. Their default implementations do nothing.
+ * To receive and act on these callbacks, a domain should define a subclass of ElementDrivesElement and use that to create relationships.
+ * The subclass should then implement the callbacks that it would like to act on.
+ *
+ * A ElementDrivesElement subclass callback is expected to make changes to the output element only!
+ *
+ * ## Element Callbacks
+ * The following callbacks are invoked on Element classes (nodes):
+ * * Element.onBeforeOutputsHandled
+ * * Element.onAllInputsHandled
+ *
+ * ## Order
+ * Callbacks are invoked by BriefcaseDb.saveChanges.
+ * They are invoked in dependency (topological) order: driving elements first, then driven elements.
+ *
+ * Each callback is invoked only once. No matter how many times a given element was changed during the transaction,
+ * a callback such as ElementDrivesElement.onRootChanged will be invoked only once.
+ * In the same way, no matter how many of its inputs were changed, a callback such as Element.onAllInputsHandled will be
+ * invoked only once.
+ *
+ * For example, suppose we have a graph:
+ * ```
+ * e1 --> e2 --> e3
+ * ```
+ *
+ * Suppose that e1 is directly modified. No callbacks are made at that time.
+ * Later, when BriefcaseDb.saveChanges is called, the following callbacks are made, in order:
+ * 1. Element.onBeforeOutputsHandled e1
+ * 1. ElementDrivesElement.onRootChanged e1->e2
+ * 1. Element.onAllInputsHandled e2
+ * 1. ElementDrivesElement.onRootChanged e2->e3
+ * 1. Element.onAllInputsHandled e3
+ *
+ * Suppose that e3 is modified directly and BriefcaseDb.saveChanges is called.
+ * Since no input to a relationship was changed, the sub-graph will be empty, and no callbacks will be made.
+ *
+ * Returning to the second example above, suppose we have this graph:
+ * ```
+ * e1        e3
+ *    \    /
+ *      e2
+ *    /    \
+ * e11       e31
+ * ```
+ * If e1 is changed and BriefcaseDb.saveChanges is called, the subgraph is:
+ * ```
+ * e1        e3
+ *    \    /
+ *      e2
+ *         \
+ *           e31
+ * ```
+ * The callbacks are:
+ * 1. Element.onBeforeOutputsHandled e1
+ * 1. ElementDrivesElement.onRootChanged e1->e2
+ * 1. Element.onAllInputsHandled e2
+ * 1. ElementDrivesElement.onRootChanged e2->e3
+ * 1. Element.onAllInputsHandled e3
+ * 1. ElementDrivesElement.onRootChanged e2->e31
+ * 1. Element.onAllInputsHandled e31
+ *
+ * (The ElementDrivesElement.)
+ *
+ * #Errors
+ * Circular dependencies are not permitted. If a cycle is detected, that is treated as a fatal error. All ElementDrivesElement relationships
+ * involved in a cycle will have their status set to 1, indicating a failure.
+ *
+ * A callback may call txnManager.reportError to reject an invalid change. It can classify the error as fatal or just a warning.
+ * A callback make set the status value of an ElementDrivesElement instance to 1 to indicate a processing failure in that edge.
+ *
+ * After BriefcaseDb.saveChanges is called, an app should check db.txns.validationErrors and db.txns.hasFatalError to find out if graph-evaluation failed.
+ *
+ * @beta
+ */
+class ElementDrivesElement extends Relationship {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.status = props.status;
+        this.priority = props.priority;
+    }
+    /** @internal */
+    static get className() { return "ElementDrivesElement"; }
+    static create(iModel, sourceId, targetId, priority = 0) {
+        const props = { sourceId, targetId, priority, status: 0, classFullName: this.classFullName };
+        return iModel.relationships.createInstance(props);
+    }
+    toJSON() {
+        const props = super.toJSON();
+        props.status = this.status;
+        props.priority = this.priority;
+        return props;
+    }
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(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)
+ * 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
+ */
+class ModelSelectorRefersToModels extends Relationship {
+    /** @internal */
+    static get className() { return "ModelSelectorRefersToModels"; }
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
+        referenceIds.addElement(this.sourceId);
+        referenceIds.addModel(this.targetId);
+    }
+}
+exports.ModelSelectorRefersToModels = ModelSelectorRefersToModels;
+/** Manages [[Relationship]]s.
+ * @public
+ */
+class Relationships {
+    /** @internal */
+    constructor(iModel) { this._iModel = iModel; }
+    /** Create a new instance of a Relationship.
+     * @param props The properties of the new Relationship.
+     * @throws [[IModelError]] if there is a problem creating the Relationship.
+     */
+    createInstance(props) { return this._iModel.constructEntity(props); }
+    /** Check classFullName to ensure it is a link table relationship class. */
+    checkRelationshipClass(classFullName) {
+        if (!this._iModel.nativeDb.isLinkTableRelationship(classFullName.replace(".", ":"))) {
+            throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, `Class '${classFullName}' must be a relationship class and it should be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.`);
+        }
+    }
+    /** Insert a new relationship instance into the iModel. The relationship provided must be subclass of BisCore:ElementRefersToElements or BisCore:ElementDrivesElement.
+     * @param props The properties of the new relationship.
+     * @returns The Id of the newly inserted relationship.
+     * @note The id property of the props object is set as a side effect of this function.
+     */
+    insertInstance(props) {
+        this.checkRelationshipClass(props.classFullName);
+        return props.id = this._iModel.nativeDb.insertLinkTableRelationship(props);
+    }
+    /** Update the properties of an existing relationship instance in the iModel.
+     * @param props the properties of the relationship instance to update. Any properties that are not present will be left unchanged.
+     */
+    updateInstance(props) {
+        this._iModel.nativeDb.updateLinkTableRelationship(props);
+    }
+    /** Delete an Relationship instance from this iModel. */
+    deleteInstance(props) {
+        this._iModel.nativeDb.deleteLinkTableRelationship(props);
+    }
+    /** Get the props of a Relationship instance
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria Either the relationship instanceId or the source and target Ids
+     * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.
+     * @see tryGetInstanceProps
+     */
+    getInstanceProps(relClassFullName, criteria) {
+        const relationshipProps = this.tryGetInstanceProps(relClassFullName, criteria);
+        if (undefined === relationshipProps) {
+            throw new core_common_1.IModelError(core_common_1.IModelStatus.NotFound, "Relationship not found");
+        }
+        return relationshipProps;
+    }
+    /** Get the props of a Relationship instance
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria Either the relationship instanceId or the source and target Ids
+     * @returns The RelationshipProps or `undefined` if the relationship is not found.
+     * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.
+     * @see getInstanceProps
+     */
+    tryGetInstanceProps(relClassFullName, criteria) {
+        let props;
+        if (typeof criteria === "string") {
+            props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE ecinstanceid=?`, (stmt) => {
+                stmt.bindId(1, criteria);
+                return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() : undefined;
+            });
+        }
+        else {
+            props = this._iModel.withPreparedStatement(`SELECT * FROM ${relClassFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, (stmt) => {
+                stmt.bindId(1, criteria.sourceId);
+                stmt.bindId(2, criteria.targetId);
+                return core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step() ? stmt.getRow() : undefined;
+            });
+        }
+        if (undefined !== props) {
+            props.classFullName = props.className.replace(".", ":");
+        }
+        return props;
+    }
+    /** Get a Relationship instance
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria Either the relationship instanceId or the source and target Ids
+     * @throws [IModelError]($common) if the relationship is not found or cannot be loaded.
+     * @see tryGetInstance
+     */
+    getInstance(relClassSqlName, criteria) {
+        return this._iModel.constructEntity(this.getInstanceProps(relClassSqlName, criteria));
+    }
+    /** Get a Relationship instance
+     * @param relClassFullName The full class name of the relationship in the form of "schema:class"
+     * @param criteria Either the relationship instanceId or the source and target Ids
+     * @returns The relationship or `undefined` if the relationship is not found.
+     * @note Useful for cases when a relationship may or may not exist and throwing an `Error` would be overkill.
+     * @see getInstance
+     */
+    tryGetInstance(relClassFullName, criteria) {
+        const relationshipProps = this.tryGetInstanceProps(relClassFullName, criteria);
+        return undefined !== relationshipProps ? this._iModel.constructEntity(relationshipProps) : undefined;
+    }
+}
+exports.Relationships = Relationships;
 //# sourceMappingURL=Relationship.js.map