@itwin/core-backend 5.3.0-dev.24 → 5.3.0-dev.25

package/lib/esm/annotations/ElementDrivesTextAnnotation.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElementDrivesTextAnnotation.js","sourceRoot":"","sources":["../../../src/annotations/ElementDrivesTextAnnotation.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAgC,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAC9G,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAGvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAgBrD,2IAA2I;AAC3I,MAAM,iBAAiB,GAAG,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAgBlD;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,OAAO,IAAI,OAAQ,OAAe,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;AACvH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA4B,SAAQ,oBAAoB;IAC5D,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IAExF,gBAAgB;IACT,MAAM,CAAU,aAAa,CAAC,KAAwB,EAAE,MAAgB;QAC7E,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,mBAAmB,CAAC,KAAwB,EAAE,MAAgB;QACnF,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAAgB;QACjD,MAAM,cAAc,GAAG,MAAM,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,OAAO,SAAS,KAAK,cAAc,IAAI,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,uBAAuB,CAAC,mBAA+B,EAAE,MAAgB;QACrF,IAAI,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAU,mBAAmB,CAAC,CAAC;QACtF,IAAI,CAAC,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChE,OAAO;QACT,CAAC;QAED,2IAA2I;QAC3I,SAAS,eAAe,CAAC,EAAc;YACrC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,OAAO,KAAK,CAAC;YACf,CAAC;YAED,4DAA4D;YAC5D,OAAO,MAAM,CAAC,qBAAqB,CAAC,4DAA4D,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACnB,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAiC,CAAC;QACtE,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,EAAE,CAAC;QAEjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,0BAA0B,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpE,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5E,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAc,CAAC;QACjD,4DAA4D;QAC5D,iBAAiB,CAAC,MAAM,CAAC,qBAAqB,CAAC,6GAA6G,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3L,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC1C,IAAI,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,oBAAoB,EAAE,CAAC;YAC9D,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;gBAC5B,2BAA2B,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACxG,CAAC;QACH,CAAC;QAED,KAAK,MAAM,cAAc,IAAI,kBAAkB,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,qCAAqC,EAAE,cAAc,CAAC,CAAC;YAC7H,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,KAAsB,EAAE,OAAkC;QAClF,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1C,IAAI,UAAU,GAAG,KAAK,CAAC;YACvB,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,0BAA0B,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpE,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,KAAK,CAAC,YAAY,CAAC,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;oBACzF,UAAU,GAAG,IAAI,CAAC;gBACpB,CAAC;YACH,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACf,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,cAAc;IAC/D,MAAM,CAAC,aAAa,GAAG,8CAA8C,CAAC;IAC7E,YAAmB,qBAAiC,EAAE,eAAuB,oCAAoC,CAAC,aAAa;QAC7H,KAAK,CAAC,EAAE,EAAE,EAAE,qBAAqB,EAAE,YAAY,EAAE,CAAC,CAAC;IACrD,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { RelatedElement, RelationshipProps, TextBlock, traverseTextBlockComponent } from \"@itwin/core-common\";\nimport { ElementDrivesElement } from \"../Relationship\";\nimport { IModelDb } from \"../IModelDb\";\nimport { Element } from \"../Element\";\nimport { updateElementFields } from \"../internal/annotations/fields\";\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ECVersion } from \"@itwin/ecschema-metadata\";\nimport { IModelElementCloneContext } from \"../IModelElementCloneContext\";\n\n/** Describes one of potentially many [TextBlock]($common)s hosted by an [[ITextAnnotation]].\n * For example, a [[TextAnnotation2d]] hosts only a single text block, but an element representing a table may\n * host one text block for each cell in the table, in which case it might use the combination of row and column\n * as the [[id]] for each text block.\n * @beta\n */\nexport interface TextBlockAndId {\n  /** The text block. */\n  readonly textBlock: TextBlock;\n  /** An opaque identifier that allows the [[ITextAnnotation]] to discern which of its hosted text blocks is being referred to. */\n  readonly id: unknown;\n}\n\n// ElementDrivesTextAnnotation was introduced in this version of BisCore - iModels with earlier versions cannot support field dependencies.\nconst minBisCoreVersion = new ECVersion(1, 0, 22);\n\n/** Interface implemented by [[GeometricElement]] subclasses whose schemas declare them to implement the mix-in `BisCore:ITextAnnotation`.\n * Such elements may host any number of [TextBlock]($common)s. `ITextAnnotation` provides a uniform way to interact with text regardless of\n * the type of element to which it belongs.\n * @beta\n */\nexport interface ITextAnnotation {\n  /** The default [[AnnotationTextStyle]] used by the text annotation. */\n  defaultTextStyle?: TextAnnotationUsesTextStyleByDefault;\n  /** Obtain a collection of all of the [TextBlock]($common)s hosted by this element. */\n  getTextBlocks(): Iterable<TextBlockAndId>;\n  /** Update the element in-memory to replace the contents of the specified [TextBlock]($common)s. */\n  updateTextBlocks(textBlocks: TextBlockAndId[]): void;\n}\n\n/** Returns `true` if the specified `element` implements [[ITextAnnotation]].\n * @beta\n */\nexport function isITextAnnotation(element: Element): element is ITextAnnotation & Element {\n  return [\"getTextBlocks\", \"updateTextBlocks\"].every((x) => x in element && typeof (element as any)[x] === \"function\");\n}\n\n/** A relationship in which the source element hosts one or more properties that are displayed by a target [[ITextAnnotation]] element.\n * This relationship is used to automatically update the [FieldRun]($common)s contained in the target element when the source element is modified.\n * An [[ITextAnnotation]] element should invoke [[updateFieldDependencies]] from its [[Element.onInserted]] and [[Element.onUpdated]] functions to\n * establish or update the relationships required for the [FieldRun]($common)s it contains.\n * @note This relationship was introduced in version 01.00.22 of the BisCore schema. [FieldRun]($common)s created in iModels that have not been upgraded to\n * that version or newer will not automatically update. Use [[isSupportedForIModel]] to check.\n * @beta\n */\nexport class ElementDrivesTextAnnotation extends ElementDrivesElement {\n  public static override get className(): string { return \"ElementDrivesTextAnnotation\"; }\n\n  /** @internal */\n  public static override onRootChanged(props: RelationshipProps, iModel: IModelDb): void {\n    updateElementFields(props, iModel, false);\n  }\n\n  /** @internal */\n  public static override onDeletedDependency(props: RelationshipProps, iModel: IModelDb): void {\n    updateElementFields(props, iModel, true);\n  }\n\n  /** Returns true if `iModel` contains a version of the BisCore schema new enough to support this relationship.\n   * If not, the schema should be updated before inserting any [FieldRun]($common)s, or those runs will not\n   * update when the source element changes.\n   */\n  public static isSupportedForIModel(iModel: IModelDb): boolean {\n    const bisCoreVersion = iModel.querySchemaVersionNumbers(\"BisCore\");\n    return undefined !== bisCoreVersion && bisCoreVersion.compare(minBisCoreVersion) >= 0;\n  }\n\n  /** Examines all of the [FieldRun]($common)s within the specified [[ITextAnnotation]] and ensures that the appropriate\n   * `ElementDrivesTextAnnotation` relationships exist between the fields' source elements and this target element.\n   * It also deletes any stale relationships left over from fields that were deleted or whose source elements changed.\n   */\n  public static updateFieldDependencies(annotationElementId: Id64String, iModel: IModelDb): void {\n    if (!ElementDrivesTextAnnotation.isSupportedForIModel(iModel)) {\n      return;\n    }\n\n    const annotationElement = iModel.elements.tryGetElement<Element>(annotationElementId);\n    if (!annotationElement || !isITextAnnotation(annotationElement)) {\n      return;\n    }\n\n    // The native layer will allow us to insert relationships to invalid or non-existent source elements...errors will arise later. Prevent it.\n    function isValidSourceId(id: Id64String): boolean {\n      if (!Id64.isValidId64(id)) {\n        return false;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      return iModel.withPreparedStatement(\"SELECT CodeValue FROM BisCore.Element WHERE ECInstanceId=?\", (stmt) => {\n        stmt.bindId(1, id);\n        return DbResult.BE_SQLITE_ROW === stmt.step();\n      });\n    }\n\n    const sourceToRelationship = new Map<Id64String, Id64String | null>();\n    const blocks = annotationElement.getTextBlocks();\n\n    for (const block of blocks) {\n      for (const { child } of traverseTextBlockComponent(block.textBlock)) {\n        if (child.type === \"field\" && isValidSourceId(child.propertyHost.elementId)) {\n          sourceToRelationship.set(child.propertyHost.elementId, null);\n        }\n      }\n    }\n\n    const staleRelationships = new Set<Id64String>();\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    annotationElement.iModel.withPreparedStatement(`SELECT ECInstanceId, SourceECInstanceId FROM BisCore.ElementDrivesTextAnnotation WHERE TargetECInstanceId=${annotationElement.id}`, (stmt) => {\n      while (DbResult.BE_SQLITE_ROW === stmt.step()) {\n        const relationshipId = stmt.getValue(0).getId();\n        const sourceId = stmt.getValue(1).getId();\n        if (sourceToRelationship.has(sourceId)) {\n          sourceToRelationship.set(sourceId, relationshipId);\n        } else {\n          staleRelationships.add(relationshipId);\n        }\n      }\n    });\n\n    for (const [sourceId, relationshipId] of sourceToRelationship) {\n      if (relationshipId === null) {\n        ElementDrivesTextAnnotation.create(annotationElement.iModel, sourceId, annotationElement.id).insert();\n      }\n    }\n\n    for (const relationshipId of staleRelationships) {\n      const props = annotationElement.iModel.relationships.getInstanceProps(\"BisCore.ElementDrivesTextAnnotation\", relationshipId);\n      annotationElement.iModel.relationships.deleteInstance(props);\n    }\n  }\n\n  /** When copying an [[ITextAnnotation]] from one iModel into another, remaps the element Ids in any [FieldPropertyHost]($common) within the cloned element\n   * so that they refer to elements in the `context`'s target iModel, and sets any Ids that cannot be remapped to [Id64.invalid]($bentley).\n   * Implementations of `ITextAnnotation` should invoke this function from their implementations of [[Element.onCloned]].\n   */\n  public static remapFields(clone: ITextAnnotation, context: IModelElementCloneContext): void {\n    if (!context.isBetweenIModels) {\n      return;\n    }\n\n    const updatedBlocks = [];\n    for (const block of clone.getTextBlocks()) {\n      let anyUpdated = false;\n      for (const { child } of traverseTextBlockComponent(block.textBlock)) {\n        if (child.type === \"field\") {\n          child.propertyHost.elementId = context.findTargetElementId(child.propertyHost.elementId);\n          anyUpdated = true;\n        }\n      }\n\n      if (anyUpdated) {\n        updatedBlocks.push(block);\n      }\n    }\n\n    if (updatedBlocks.length > 0) {\n      clone.updateTextBlocks(updatedBlocks);\n    }\n  }\n}\n\n/** Relationship indicating that the [[AnnotationTextStyle]] is being used as the default style for the [[ITextAnnotation]].\n * @beta\n */\nexport class TextAnnotationUsesTextStyleByDefault extends RelatedElement {\n  public static classFullName = \"BisCore:TextAnnotationUsesTextStyleByDefault\";\n  public constructor(annotationTextStyleId: Id64String, relClassName: string = TextAnnotationUsesTextStyleByDefault.classFullName) {\n    super({ id: annotationTextStyleId, relClassName });\n  }\n}\n"]}
+{"version":3,"file":"ElementDrivesTextAnnotation.js","sourceRoot":"","sources":["../../../src/annotations/ElementDrivesTextAnnotation.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAgC,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAC9G,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAGvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAgBrD,2IAA2I;AAC3I,MAAM,iBAAiB,GAAG,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAgBlD;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,OAAO,IAAI,OAAQ,OAAe,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;AACvH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,2BAA4B,SAAQ,oBAAoB;IAC5D,MAAM,KAAc,SAAS,KAAa,OAAO,6BAA6B,CAAC,CAAC,CAAC;IAExF,gBAAgB;IACT,MAAM,CAAU,aAAa,CAAC,KAAwB,EAAE,MAAgB;QAC7E,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,mBAAmB,CAAC,KAAwB,EAAE,MAAgB;QACnF,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,oBAAoB,CAAC,MAAgB;QACjD,MAAM,cAAc,GAAG,MAAM,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,OAAO,SAAS,KAAK,cAAc,IAAI,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,uBAAuB,CAAC,mBAA+B,EAAE,MAAgB;QACrF,IAAI,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAU,mBAAmB,CAAC,CAAC;QACtF,IAAI,CAAC,iBAAiB,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChE,OAAO;QACT,CAAC;QAED,2IAA2I;QAC3I,SAAS,eAAe,CAAC,EAAc;YACrC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,OAAO,KAAK,CAAC;YACf,CAAC;YAED,4DAA4D;YAC5D,OAAO,MAAM,CAAC,qBAAqB,CAAC,4DAA4D,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACnB,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAiC,CAAC;QACtE,MAAM,MAAM,GAAG,iBAAiB,CAAC,aAAa,EAAE,CAAC;QAEjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,0BAA0B,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpE,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5E,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAc,CAAC;QACjD,4DAA4D;QAC5D,iBAAiB,CAAC,MAAM,CAAC,qBAAqB,CAAC,6GAA6G,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3L,OAAO,QAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAC9C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC1C,IAAI,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,oBAAoB,EAAE,CAAC;YAC9D,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;gBAC5B,2BAA2B,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACxG,CAAC;QACH,CAAC;QAED,IAAI,kBAAkB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,sBAAsB,GAAG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CACjF,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,qCAAqC,EAAE,cAAc,CAAC,CAC/G,CAAC;YACF,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,KAAsB,EAAE,OAAkC;QAClF,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1C,IAAI,UAAU,GAAG,KAAK,CAAC;YACvB,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,0BAA0B,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpE,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,KAAK,CAAC,YAAY,CAAC,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;oBACzF,UAAU,GAAG,IAAI,CAAC;gBACpB,CAAC;YACH,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACf,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,cAAc;IAC/D,MAAM,CAAC,aAAa,GAAG,8CAA8C,CAAC;IAC7E,YAAmB,qBAAiC,EAAE,eAAuB,oCAAoC,CAAC,aAAa;QAC7H,KAAK,CAAC,EAAE,EAAE,EAAE,qBAAqB,EAAE,YAAY,EAAE,CAAC,CAAC;IACrD,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Elements\n */\n\nimport { RelatedElement, RelationshipProps, TextBlock, traverseTextBlockComponent } from \"@itwin/core-common\";\nimport { ElementDrivesElement } from \"../Relationship\";\nimport { IModelDb } from \"../IModelDb\";\nimport { Element } from \"../Element\";\nimport { updateElementFields } from \"../internal/annotations/fields\";\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\nimport { ECVersion } from \"@itwin/ecschema-metadata\";\nimport { IModelElementCloneContext } from \"../IModelElementCloneContext\";\n\n/** Describes one of potentially many [TextBlock]($common)s hosted by an [[ITextAnnotation]].\n * For example, a [[TextAnnotation2d]] hosts only a single text block, but an element representing a table may\n * host one text block for each cell in the table, in which case it might use the combination of row and column\n * as the [[id]] for each text block.\n * @beta\n */\nexport interface TextBlockAndId {\n  /** The text block. */\n  readonly textBlock: TextBlock;\n  /** An opaque identifier that allows the [[ITextAnnotation]] to discern which of its hosted text blocks is being referred to. */\n  readonly id: unknown;\n}\n\n// ElementDrivesTextAnnotation was introduced in this version of BisCore - iModels with earlier versions cannot support field dependencies.\nconst minBisCoreVersion = new ECVersion(1, 0, 22);\n\n/** Interface implemented by [[GeometricElement]] subclasses whose schemas declare them to implement the mix-in `BisCore:ITextAnnotation`.\n * Such elements may host any number of [TextBlock]($common)s. `ITextAnnotation` provides a uniform way to interact with text regardless of\n * the type of element to which it belongs.\n * @beta\n */\nexport interface ITextAnnotation {\n  /** The default [[AnnotationTextStyle]] used by the text annotation. */\n  defaultTextStyle?: TextAnnotationUsesTextStyleByDefault;\n  /** Obtain a collection of all of the [TextBlock]($common)s hosted by this element. */\n  getTextBlocks(): Iterable<TextBlockAndId>;\n  /** Update the element in-memory to replace the contents of the specified [TextBlock]($common)s. */\n  updateTextBlocks(textBlocks: TextBlockAndId[]): void;\n}\n\n/** Returns `true` if the specified `element` implements [[ITextAnnotation]].\n * @beta\n */\nexport function isITextAnnotation(element: Element): element is ITextAnnotation & Element {\n  return [\"getTextBlocks\", \"updateTextBlocks\"].every((x) => x in element && typeof (element as any)[x] === \"function\");\n}\n\n/** A relationship in which the source element hosts one or more properties that are displayed by a target [[ITextAnnotation]] element.\n * This relationship is used to automatically update the [FieldRun]($common)s contained in the target element when the source element is modified.\n * An [[ITextAnnotation]] element should invoke [[updateFieldDependencies]] from its [[Element.onInserted]] and [[Element.onUpdated]] functions to\n * establish or update the relationships required for the [FieldRun]($common)s it contains.\n * @note This relationship was introduced in version 01.00.22 of the BisCore schema. [FieldRun]($common)s created in iModels that have not been upgraded to\n * that version or newer will not automatically update. Use [[isSupportedForIModel]] to check.\n * @beta\n */\nexport class ElementDrivesTextAnnotation extends ElementDrivesElement {\n  public static override get className(): string { return \"ElementDrivesTextAnnotation\"; }\n\n  /** @internal */\n  public static override onRootChanged(props: RelationshipProps, iModel: IModelDb): void {\n    updateElementFields(props, iModel, false);\n  }\n\n  /** @internal */\n  public static override onDeletedDependency(props: RelationshipProps, iModel: IModelDb): void {\n    updateElementFields(props, iModel, true);\n  }\n\n  /** Returns true if `iModel` contains a version of the BisCore schema new enough to support this relationship.\n   * If not, the schema should be updated before inserting any [FieldRun]($common)s, or those runs will not\n   * update when the source element changes.\n   */\n  public static isSupportedForIModel(iModel: IModelDb): boolean {\n    const bisCoreVersion = iModel.querySchemaVersionNumbers(\"BisCore\");\n    return undefined !== bisCoreVersion && bisCoreVersion.compare(minBisCoreVersion) >= 0;\n  }\n\n  /** Examines all of the [FieldRun]($common)s within the specified [[ITextAnnotation]] and ensures that the appropriate\n   * `ElementDrivesTextAnnotation` relationships exist between the fields' source elements and this target element.\n   * It also deletes any stale relationships left over from fields that were deleted or whose source elements changed.\n   */\n  public static updateFieldDependencies(annotationElementId: Id64String, iModel: IModelDb): void {\n    if (!ElementDrivesTextAnnotation.isSupportedForIModel(iModel)) {\n      return;\n    }\n\n    const annotationElement = iModel.elements.tryGetElement<Element>(annotationElementId);\n    if (!annotationElement || !isITextAnnotation(annotationElement)) {\n      return;\n    }\n\n    // The native layer will allow us to insert relationships to invalid or non-existent source elements...errors will arise later. Prevent it.\n    function isValidSourceId(id: Id64String): boolean {\n      if (!Id64.isValidId64(id)) {\n        return false;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      return iModel.withPreparedStatement(\"SELECT CodeValue FROM BisCore.Element WHERE ECInstanceId=?\", (stmt) => {\n        stmt.bindId(1, id);\n        return DbResult.BE_SQLITE_ROW === stmt.step();\n      });\n    }\n\n    const sourceToRelationship = new Map<Id64String, Id64String | null>();\n    const blocks = annotationElement.getTextBlocks();\n\n    for (const block of blocks) {\n      for (const { child } of traverseTextBlockComponent(block.textBlock)) {\n        if (child.type === \"field\" && isValidSourceId(child.propertyHost.elementId)) {\n          sourceToRelationship.set(child.propertyHost.elementId, null);\n        }\n      }\n    }\n\n    const staleRelationships = new Set<Id64String>();\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    annotationElement.iModel.withPreparedStatement(`SELECT ECInstanceId, SourceECInstanceId FROM BisCore.ElementDrivesTextAnnotation WHERE TargetECInstanceId=${annotationElement.id}`, (stmt) => {\n      while (DbResult.BE_SQLITE_ROW === stmt.step()) {\n        const relationshipId = stmt.getValue(0).getId();\n        const sourceId = stmt.getValue(1).getId();\n        if (sourceToRelationship.has(sourceId)) {\n          sourceToRelationship.set(sourceId, relationshipId);\n        } else {\n          staleRelationships.add(relationshipId);\n        }\n      }\n    });\n\n    for (const [sourceId, relationshipId] of sourceToRelationship) {\n      if (relationshipId === null) {\n        ElementDrivesTextAnnotation.create(annotationElement.iModel, sourceId, annotationElement.id).insert();\n      }\n    }\n\n    if (staleRelationships.size > 0) {\n      const staleRelationshipProps = Array.from(staleRelationships).map(relationshipId =>\n        annotationElement.iModel.relationships.getInstanceProps(\"BisCore.ElementDrivesTextAnnotation\", relationshipId)\n      );\n      annotationElement.iModel.relationships.deleteInstances(staleRelationshipProps);\n    }\n  }\n\n  /** When copying an [[ITextAnnotation]] from one iModel into another, remaps the element Ids in any [FieldPropertyHost]($common) within the cloned element\n   * so that they refer to elements in the `context`'s target iModel, and sets any Ids that cannot be remapped to [Id64.invalid]($bentley).\n   * Implementations of `ITextAnnotation` should invoke this function from their implementations of [[Element.onCloned]].\n   */\n  public static remapFields(clone: ITextAnnotation, context: IModelElementCloneContext): void {\n    if (!context.isBetweenIModels) {\n      return;\n    }\n\n    const updatedBlocks = [];\n    for (const block of clone.getTextBlocks()) {\n      let anyUpdated = false;\n      for (const { child } of traverseTextBlockComponent(block.textBlock)) {\n        if (child.type === \"field\") {\n          child.propertyHost.elementId = context.findTargetElementId(child.propertyHost.elementId);\n          anyUpdated = true;\n        }\n      }\n\n      if (anyUpdated) {\n        updatedBlocks.push(block);\n      }\n    }\n\n    if (updatedBlocks.length > 0) {\n      clone.updateTextBlocks(updatedBlocks);\n    }\n  }\n}\n\n/** Relationship indicating that the [[AnnotationTextStyle]] is being used as the default style for the [[ITextAnnotation]].\n * @beta\n */\nexport class TextAnnotationUsesTextStyleByDefault extends RelatedElement {\n  public static classFullName = \"BisCore:TextAnnotationUsesTextStyleByDefault\";\n  public constructor(annotationTextStyleId: Id64String, relClassName: string = TextAnnotationUsesTextStyleByDefault.classFullName) {\n    super({ id: annotationTextStyleId, relClassName });\n  }\n}\n"]}

package/lib/esm/test/imodel/IModel.test.js

@@ -59,7 +59,7 @@ import * as path from "path";
 import * as semver from "semver";
 import * as sinon from "sinon";
 import { DbResult, Guid, Id64, IModelStatus, Logger, OpenMode, ProcessDetector } from "@itwin/core-bentley";
-import { BisCodeSpec, BriefcaseIdValue, Code, CodeScopeSpec, CodeSpec, ColorByName, ColorDef, DisplayStyleSettings, EcefLocation, FontMap, FontType, GeoCoordStatus, GeographicCRS, GeometryParams, GeometryStreamBuilder, ImageSourceFormat, IModel, IModelError, RelatedElement, RenderMode, SchemaState, SubCategoryAppearance, TextureMapping, TextureMapUnits, ViewFlags, } from "@itwin/core-common";
+import { BisCodeSpec, BriefcaseIdValue, Code, CodeScopeSpec, CodeSpec, ColorByName, ColorDef, DisplayStyleSettings, EcefLocation, FontMap, FontType, GeoCoordStatus, GeographicCRS, GeometryParams, GeometryStreamBuilder, ImageSourceFormat, IModel, IModelError, QueryBinder, RelatedElement, RenderMode, SchemaState, SubCategoryAppearance, TextureMapping, TextureMapUnits, ViewFlags, } from "@itwin/core-common";
 import { Geometry, LineString3d, Loop, Matrix4d, Point3d, PolyfaceBuilder, Range3d, StrokeOptions, Transform, YawPitchRollAngles, } from "@itwin/core-geometry";
 import { V2CheckpointManager } from "../../CheckpointManager";
 import { _nativeDb, BisCoreSchema, Category, ClassRegistry, DefinitionContainer, DefinitionGroup, DefinitionGroupGroupsDefinitions, DefinitionModel, DefinitionPartition, DictionaryModel, DisplayStyle3d, DocumentPartition, DrawingGraphic, Element, ElementDrivesElement, ElementGroupsMembers, ElementOwnsChildElements, GenericGraphicalType2d, GeometricElement2d, GeometricElement3d, GeometricModel, GroupInformationPartition, IModelDb, IModelHost, IModelJsFs, InformationPartitionElement, InformationRecordElement, LinkPartition, Model, PhysicalElement, PhysicalModel, PhysicalObject, PhysicalPartition, RenderMaterialElement, SnapshotDb, SpatialCategory, SqliteValueType, StandaloneDb, SubCategory, Subject, Texture, } from "../../core-backend";
@@ -2975,5 +2975,103 @@ describe("iModel", () => {
         expect(() => testImodel.elements.getAspects("0x1", "WrongSchema:WrongClass")).to.throw("db is not open");
         expect(() => testImodel.createQueryReader("SELECT 1")).to.throw("db not open");
     });
+    describe("Delete relationship instances", () => {
+        let testImodel;
+        const relationshipClasses = [
+            "BisCore:ElementGroupsMembers",
+            "BisCore:ElementDrivesElement",
+            "BisCore:ElementRefersToDocuments"
+        ];
+        afterEach(() => {
+            if (testImodel !== undefined) {
+                const iModelPath = testImodel.pathName;
+                if (testImodel.isOpen)
+                    testImodel.close();
+                IModelJsFs.unlinkSync(iModelPath);
+            }
+        });
+        function setupRelationships(numOfRelationships, multipleClasses = false) {
+            testImodel = SnapshotDb.createEmpty(IModelTestUtils.prepareOutputFile("IModel", "DeleteRelationshipInstances.bim"), { rootSubject: { name: "DeleteRelationshipInstances" } });
+            assert.isTrue(testImodel.isOpen);
+            const [, newModelId] = IModelTestUtils.createAndInsertPhysicalPartitionAndModel(testImodel, Code.createEmpty(), true);
+            let spatialCategoryId = SpatialCategory.queryCategoryIdByName(testImodel, IModel.dictionaryId, "MySpatialCategory");
+            if (!spatialCategoryId) {
+                spatialCategoryId = SpatialCategory.insert(testImodel, IModel.dictionaryId, "MySpatialCategory", new SubCategoryAppearance());
+            }
+            const relationships = [];
+            for (let i = 0; i < numOfRelationships; ++i) {
+                const sourceProps = createElemProps(testImodel, newModelId, spatialCategoryId, "Generic:PhysicalObject");
+                const sourceId = testImodel.elements.insertElement(sourceProps);
+                const targetProps = createElemProps(testImodel, newModelId, spatialCategoryId, "Generic:PhysicalObject");
+                const targetId = testImodel.elements.insertElement(targetProps);
+                let relationshipClass = "BisCore:ElementGroupsMembers";
+                if (multipleClasses)
+                    relationshipClass = relationshipClasses[i % relationshipClasses.length];
+                const relationshipProps = {
+                    classFullName: relationshipClass,
+                    sourceId,
+                    targetId,
+                };
+                relationshipProps.id = testImodel.relationships.insertInstance(relationshipProps);
+                relationships.push(relationshipProps);
+            }
+            testImodel.saveChanges();
+            return relationships;
+        }
+        async function getRelationshipCount(iModel, relationshipClass) {
+            const reader = iModel.createQueryReader(`SELECT COUNT(*) AS [count] FROM ${relationshipClass}`);
+            await reader.step();
+            return reader.current.count;
+        }
+        it("deleteInstances with an empty array", async () => {
+            const relationships = setupRelationships(10);
+            assert.equal(relationships.length, await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers"));
+            testImodel.relationships.deleteInstances([]);
+            testImodel.saveChanges();
+            assert.equal(relationships.length, await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers"));
+        });
+        it("deleteInstances with a single relationship instance", async () => {
+            const relationships = setupRelationships(10);
+            assert.equal(relationships.length, await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers"), "Should delete exactly one relationship");
+            // Delete just one relationship using deleteInstances method
+            testImodel.relationships.deleteInstances([relationships[0]]);
+            testImodel.saveChanges();
+            const remainingCount = await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers");
+            assert.equal(remainingCount, relationships.length - 1, "Should delete exactly one relationship");
+        });
+        it("deleteInstances with different relationship classes", async () => {
+            const relationships = setupRelationships(500, true);
+            // Verify relationships were created across different classes
+            assert.isTrue(await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers") >= Math.floor(relationships.length / 3));
+            assert.isTrue(await getRelationshipCount(testImodel, "BisCore.ElementDrivesElement") >= Math.floor(relationships.length / 3));
+            assert.isTrue(await getRelationshipCount(testImodel, "BisCore.ElementRefersToDocuments") >= Math.floor(relationships.length / 3));
+            // Test deleteInstances with mixed relationship classes
+            testImodel.relationships.deleteInstances(relationships);
+            testImodel.saveChanges();
+            // Verify all relationships were deleted regardless of their class
+            assert.equal(0, await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers"), "All ElementGroupsMembers relationships should be deleted");
+            assert.equal(0, await getRelationshipCount(testImodel, "BisCore.ElementDrivesElement"), "All ElementDrivesElement relationships should be deleted");
+            assert.equal(0, await getRelationshipCount(testImodel, "BisCore.ElementRefersToDocuments"), "All ElementRefersToDocuments relationships should be deleted");
+        });
+        it("deleteInstances for random relationship instances", async () => {
+            const relationships = setupRelationships(1000, true);
+            // Verify relationships exist before deletion
+            assert.isTrue(await getRelationshipCount(testImodel, "BisCore.ElementGroupsMembers") >= Math.floor(relationships.length / 3));
+            assert.isTrue(await getRelationshipCount(testImodel, "BisCore.ElementDrivesElement") >= Math.floor(relationships.length / 3));
+            assert.isTrue(await getRelationshipCount(testImodel, "BisCore.ElementRefersToDocuments") >= Math.floor(relationships.length / 3));
+            // Create a subset of random relationship entries to delete
+            const relationshipsToDelete = [];
+            for (let i = 0; i < 250; ++i) {
+                relationshipsToDelete.push(relationships[Math.floor(Math.random() * (relationships.length + 1))]);
+            }
+            testImodel.relationships.deleteInstances(relationshipsToDelete);
+            testImodel.saveChanges();
+            // Verify all relationships were deleted
+            for (const relClass of relationshipsToDelete) {
+                const reader = testImodel.createQueryReader(`SELECT ECInstanceId FROM ${relClass.classFullName} WHERE SourceECInstanceId=? AND TargetECInstanceId=?`, new QueryBinder().bindId(1, relClass.sourceId).bindId(2, relClass.targetId));
+                assert.isFalse(await reader.step(), `Relationship ${relClass.id} should be deleted`); // No row should be returned
+            }
+        });
+    });
 });
 //# sourceMappingURL=IModel.test.js.map