@itwin/core-backend 5.5.0-dev.1 → 5.5.0-dev.2

package/lib/cjs/Relationship.js.map

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

package/lib/cjs/RpcBackend.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcBackend.js","sourceRoot":"","sources":["../../src/RpcBackend.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAWH,oDAgBC;AAzBD,oDAAsF;AACtF,+CAAsG;AACtG,2CAAkD;AAClD,+CAA4D;AAC5D,+CAAiD;AACjD,iDAAkD;AAElD,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,gBAAgB;AAChB,SAAgB,oBAAoB,CAAC,sBAA+B,KAAK;IACvE,IAAI,WAAW;QACb,OAAO;IAET,IAAA,2BAAiB,EAAC,mBAAmB,CAAC,CAAC;IAEvC,0BAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,iCAAqB,CAAC;IAC3D,0BAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,iCAAqB,CAAC;IAC3D,0BAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,iCAAqB,CAAC;IAE3D,8BAAgB,CAAC,OAAO,CAAC,YAAY,GAAG,uBAAY,CAAC;IACrD,8BAAgB,CAAC,OAAO,CAAC,YAAY,GAAG,sBAAY,CAAC;IAErD,8BAAgB,CAAC,iBAAiB,CAAC,IAAI,iCAAuB,EAAE,CAAC,CAAC;IAElE,WAAW,GAAG,IAAI,CAAC;AACrB,CAAC","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 RpcInterface\r\n */\r\n\r\nimport { RpcMultipart, WebAppRpcLogging, WebAppRpcRequest } from \"@itwin/core-common\";\r\nimport { appendToMultipartForm, createMultipartStream, parseMultipartRequest } from \"./rpc/multipart\";\r\nimport { initializeTracing } from \"./rpc/tracing\";\r\nimport { WebAppRpcLoggingBackend } from \"./rpc/web/logging\";\r\nimport { parseRequest } from \"./rpc/web/request\";\r\nimport { sendResponse } from \"./rpc/web/response\";\r\n\r\nlet initialized = false;\r\n/** @internal */\r\nexport function initializeRpcBackend(enableOpenTelemetry: boolean = false) {\r\n  if (initialized)\r\n    return;\r\n\r\n  initializeTracing(enableOpenTelemetry);\r\n\r\n  RpcMultipart.platform.createStream = createMultipartStream;\r\n  RpcMultipart.platform.parseRequest = parseMultipartRequest;\r\n  RpcMultipart.platform.appendToForm = appendToMultipartForm;\r\n\r\n  WebAppRpcRequest.backend.sendResponse = sendResponse;\r\n  WebAppRpcRequest.backend.parseRequest = parseRequest;\r\n\r\n  WebAppRpcLogging.initializeBackend(new WebAppRpcLoggingBackend());\r\n\r\n  initialized = true;\r\n}\r\n"]}
+{"version":3,"file":"RpcBackend.js","sourceRoot":"","sources":["../../src/RpcBackend.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAWH,oDAgBC;AAzBD,oDAAsF;AACtF,+CAAsG;AACtG,2CAAkD;AAClD,+CAA4D;AAC5D,+CAAiD;AACjD,iDAAkD;AAElD,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,gBAAgB;AAChB,SAAgB,oBAAoB,CAAC,sBAA+B,KAAK;IACvE,IAAI,WAAW;QACb,OAAO;IAET,IAAA,2BAAiB,EAAC,mBAAmB,CAAC,CAAC;IAEvC,0BAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,iCAAqB,CAAC;IAC3D,0BAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,iCAAqB,CAAC;IAC3D,0BAAY,CAAC,QAAQ,CAAC,YAAY,GAAG,iCAAqB,CAAC;IAE3D,8BAAgB,CAAC,OAAO,CAAC,YAAY,GAAG,uBAAY,CAAC;IACrD,8BAAgB,CAAC,OAAO,CAAC,YAAY,GAAG,sBAAY,CAAC;IAErD,8BAAgB,CAAC,iBAAiB,CAAC,IAAI,iCAAuB,EAAE,CAAC,CAAC;IAElE,WAAW,GAAG,IAAI,CAAC;AACrB,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 RpcInterface\n */\n\nimport { RpcMultipart, WebAppRpcLogging, WebAppRpcRequest } from \"@itwin/core-common\";\nimport { appendToMultipartForm, createMultipartStream, parseMultipartRequest } from \"./rpc/multipart\";\nimport { initializeTracing } from \"./rpc/tracing\";\nimport { WebAppRpcLoggingBackend } from \"./rpc/web/logging\";\nimport { parseRequest } from \"./rpc/web/request\";\nimport { sendResponse } from \"./rpc/web/response\";\n\nlet initialized = false;\n/** @internal */\nexport function initializeRpcBackend(enableOpenTelemetry: boolean = false) {\n  if (initialized)\n    return;\n\n  initializeTracing(enableOpenTelemetry);\n\n  RpcMultipart.platform.createStream = createMultipartStream;\n  RpcMultipart.platform.parseRequest = parseMultipartRequest;\n  RpcMultipart.platform.appendToForm = appendToMultipartForm;\n\n  WebAppRpcRequest.backend.sendResponse = sendResponse;\n  WebAppRpcRequest.backend.parseRequest = parseRequest;\n\n  WebAppRpcLogging.initializeBackend(new WebAppRpcLoggingBackend());\n\n  initialized = true;\n}\n"]}

package/lib/cjs/SQLiteDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,yBAAyB;AACzB,+BAA+B;AAC/B,iCAAiC;AAEjC,sDAAyD;AACzD,oDAAgE;AAChE,+CAA4C;AAC5C,8DAAyD;AACzD,6CAA0C;AAC1C,uDAAoE;AACpE,gDAA+C;AAE/C,0CAA0C;AAE1C,0DAA0D;AAG1D;;;GAGG;AACH,MAAa,QAAQ;IACnB,gBAAgB;IACA,CAAC,mBAAS,CAAC,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3D,qBAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAEtE,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,6BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEzE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,yBAAW,CAAC,UAAU,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAElF,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC;IACxC,CAAC;IAED,+JAA+J;IACxJ,kBAAkB;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,yBAAW,CAAC,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;;;YAC3B,MAAM,IAAI,kCAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAA,CAAC;YAC9C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;;;;;;;;;KACpB;CACF;AA9OD,4BA8OC;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAkB,SAAQ,QAAQ;IAC5C,MAAM,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;IAatF;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAChK,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,yBAAW,CAAC,UAAU,CAAC,2BAA2B,EAAE,yCAAyC,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAChI,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,SAAe;QAChE,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,yBAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnM,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAuH;QAChJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AA7FH,8CA8FC;AAED,cAAc;AACd,WAAiB,QAAQ;IAqEvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjIgB,QAAQ,wBAAR,QAAQ,QAiIxB","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 SQLiteDb\r\n */\r\n\r\nimport * as fs from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName, SqliteError } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n// cspell:ignore savepoint julianday rowid\r\n\r\n/* eslint-disable @typescript-eslint/unified-signatures */\r\n\r\n\r\n/**\r\n * A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\r\n * @public\r\n */\r\nexport class SQLiteDb {\r\n  /** @internal */\r\n  public readonly [_nativeDb] = new IModelNative.platform.SQLiteDb();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** @internal */\r\n  public static createBlobIO(): SQLiteDb.BlobIO {\r\n    return new IModelNative.platform.BlobIO();\r\n  }\r\n\r\n  /** alias for closeDb.\r\n   * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[closeDb]]\r\n   */\r\n  public dispose(): void {\r\n    this.closeDb();\r\n  }\r\n\r\n  /** Create a SQLiteDb\r\n   * @param dbName The path to the SQLiteDb file to create.\r\n   */\r\n  public createDb(dbName: string): void;\r\n  /** @beta */\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\r\n    this[_nativeDb].createDb(dbName, container, params);\r\n  }\r\n\r\n  /** Open a SQLiteDb.\r\n   * @param dbName The path to the SQLiteDb file to open\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\r\n  /**\r\n   * @param container optional CloudContainer holding database\r\n   * @beta\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\r\n    this[_nativeDb].openDb(dbName, openMode, container);\r\n  }\r\n\r\n  /** Close SQLiteDb.\r\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\r\n   */\r\n  public closeDb(saveChanges?: boolean): void {\r\n    if (saveChanges && this.isOpen)\r\n      this.saveChanges();\r\n    this._sqliteStatementCache.clear();\r\n    this[_nativeDb].closeDb();\r\n  }\r\n\r\n  /** Returns true if this SQLiteDb is open */\r\n  public get isOpen(): boolean { return this[_nativeDb].isOpen(); }\r\n\r\n  /** Returns true if this SQLiteDb is open readonly */\r\n  public get isReadonly(): boolean { return this[_nativeDb].isReadonly(); }\r\n\r\n  /** Create a new table in this database. */\r\n  protected createTable(args: {\r\n    /** The name of the table to create. */\r\n    tableName: string;\r\n    /** all of the columns in the table. */\r\n    columns: string;\r\n    /** any unique or foreign key constraints */\r\n    constraints?: string;\r\n    /** if true, add a \"lastMod\" timestamp column and triggers to automatically update it. */\r\n    addTimestamp?: boolean;\r\n  }) {\r\n    const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\r\n    const constraints = args.constraints ? `,${args.constraints}` : \"\";\r\n    this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\r\n    if (args.addTimestamp)\r\n      this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\r\n  }\r\n\r\n  /**\r\n   * Get the last modified date for a row in a table of this database.\r\n   * @note the table must have been created with `addTimestamp: true`\r\n  */\r\n  public readLastModTime(tableName: string, rowId: number): Date {\r\n    return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\r\n      stmt.bindInteger(1, rowId);\r\n      return stmt.getValueDate(0);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Open a database, perform an operation, then close the database.\r\n   *\r\n   * Details:\r\n   * - if database is open, throw an error\r\n   * - open a database\r\n   * - call a function with the database opened. If it is async, await its return.\r\n   * - if function throws, abandon all changes, close database, and rethrow\r\n   * - save all changes\r\n   * - close the database\r\n   * @return value from operation\r\n   */\r\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\r\n    if (this.isOpen)\r\n      SqliteError.throwError(\"already-open\", \"database is already open\", args.dbName);\r\n\r\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\r\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\r\n    try {\r\n      const result = operation();\r\n      result instanceof Promise ? result.then(save, abandon) : save();\r\n      return result;\r\n    } catch (e) {\r\n      abandon();\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /** The cloud container backing this SQLite database, if any.\r\n   * @beta\r\n   */\r\n  public get cloudContainer(): CloudSqlite.CloudContainer | undefined {\r\n    return this[_nativeDb].cloudContainer;\r\n  }\r\n\r\n  /** Returns the Id of the most-recently-inserted row in this database, per [sqlite3_last_insert_rowid](https://www.sqlite.org/c3ref/last_insert_rowid.html). */\r\n  public getLastInsertRowId(): number {\r\n    return this[_nativeDb].getLastInsertRowId();\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on a database in a CloudContainer with the write lock held.\r\n   *\r\n   * Details:\r\n   * - acquire the write lock on a CloudContainer\r\n   * - call `withOpenDb` with openMode `ReadWrite`\r\n   * - upload changes\r\n   * - release the write lock\r\n   * @param args arguments to lock the container and open the database\r\n   * @param operation an operation performed on the database with the write lock held.\r\n   * @return value from operation\r\n   * @internal\r\n   */\r\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => Promise<T>) {\r\n    return CloudSqlite.withWriteLock(args, async () => this.withOpenDb({ ...args, openMode: args.openMode ?? OpenMode.ReadWrite }, operation));\r\n  }\r\n\r\n  /** vacuum this database\r\n   * @see https://www.sqlite.org/lang_vacuum.html\r\n   */\r\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\r\n    this[_nativeDb].vacuum(args);\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */\r\n  public saveChanges(): void {\r\n    this[_nativeDb].saveChanges();\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */\r\n  public abandonChanges(): void {\r\n    this[_nativeDb].abandonChanges();\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    const release = () => stmt[Symbol.dispose]();\r\n    try {\r\n      const val = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\r\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\r\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\r\n   */\r\n  public withSavePoint(savePointName: string, operation: () => void) {\r\n    if (this.isReadonly)\r\n      SqliteError.throwError(\"readonly\", \"database is readonly\", this[_nativeDb].getFilePath());\r\n\r\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\r\n    try {\r\n      operation();\r\n      this.executeSQL(`RELEASE ${savePointName}`);\r\n    } catch (e) {\r\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n     * @param sql The SQLite SQL statement to prepare\r\n     * @param logErrors Determine if errors are logged or not\r\n     * @internal\r\n     */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this[_nativeDb], logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** execute an SQL statement */\r\n  public executeSQL(sql: string): DbResult {\r\n    using stmt = this.prepareSqliteStatement(sql);\r\n    return stmt.step();\r\n  }\r\n}\r\n\r\n/**\r\n * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\r\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\r\n * always used for access.\r\n *\r\n * Notes:\r\n *  - This class may be used either to access a local file, or one stored in a cloud container.\r\n *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\r\n * tables.\r\n * @beta\r\n */\r\nexport abstract class VersionedSqliteDb extends SQLiteDb {\r\n  protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\r\n\r\n  /** The current semver \"persistence version\" of this class.\r\n   * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\r\n   * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\r\n   * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\r\n   * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\r\n   * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\r\n   * supported by it, the user will be informed that they need to upgrade their software.\r\n   * @note this identifier is independent of versions in `package.json` files.\r\n  */\r\n  public abstract myVersion: string;\r\n\r\n  /**\r\n   * Change the \"versions required to open this database\" property stored in this database. After this call,\r\n   * versions of software that don't meet the supplied ranges will fail.\r\n   * @param versions the new versions required for reading and writing this database.\r\n   * @note the database must be opened for write access.\r\n   */\r\n  public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\r\n    // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\r\n    this[_nativeDb].saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\r\n  }\r\n\r\n  /** Get the required version ranges necessary to open this VersionedSqliteDb. */\r\n  public getRequiredVersions() {\r\n    const checkIsString = (value: any) => {\r\n      if (typeof value !== \"string\")\r\n        SqliteError.throwError(\"invalid-versions-property\", `CloudDb has invalid \"versions\" property`, this[_nativeDb].getFilePath());\r\n      return value;\r\n    };\r\n    const versionJson = checkIsString(this[_nativeDb].queryFileProperty(VersionedSqliteDb._versionProps, true));\r\n    const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\r\n    checkIsString(versionRanges.readVersion);\r\n    checkIsString(versionRanges.writeVersion);\r\n    return versionRanges;\r\n  }\r\n\r\n  /**\r\n   * Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\r\n   */\r\n  protected abstract createDDL(args: any): void;\r\n\r\n  /**\r\n   * Create a new database file for the subclass of VersionedSqliteDb.\r\n   * @note The required versions are saved as [[myVersion]] or newer for both read and write.\r\n   */\r\n  public static createNewDb(fileName: LocalFileName, setupArgs?: any) {\r\n    const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\r\n    IModelJsFs.recursiveMkDirSync(dirname(fileName));\r\n    if (fs.existsSync(fileName))\r\n      fs.unlinkSync(fileName);\r\n\r\n    db.createDb(fileName);\r\n    db.createDDL(setupArgs);\r\n    const minVer = `^${db.myVersion}`;\r\n    db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\r\n    db.closeDb(true);\r\n  }\r\n\r\n  /**\r\n   * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n   * Throws otherwise.\r\n   */\r\n  protected verifyVersions() {\r\n    const versions = this.getRequiredVersions();\r\n    const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\r\n    const range = isReadonly ? versions.readVersion : versions.writeVersion;\r\n    if (semver.satisfies(this.myVersion, range))\r\n      return;\r\n\r\n    this.closeDb();\r\n    const tooNew = semver.gtr(this.myVersion, range);\r\n    SqliteError.throwError(\"incompatible-version\", `requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`, this[_nativeDb].getFilePath());\r\n\r\n  }\r\n\r\n  /**\r\n   * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n   * Throws otherwise.\r\n   * @see [[SqliteDb.openDb]] for argument types\r\n   */\r\n  public override openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\r\n    super.openDb(dbName, openMode, container);\r\n    this.verifyVersions();\r\n  }\r\n\r\n  public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }) {\r\n    // can't use \"this\" because it checks for version, which we don't want here\r\n    return (arg.lockContainer) ?\r\n      super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\r\n      super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace SQLiteDb {\r\n  /** A semver version range.\r\n   * @see https://docs.npmjs.com/cli/v6/using-npm/semver\r\n   */\r\n  export type VersionRange = string;\r\n\r\n  /**\r\n   * A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\r\n   * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\r\n   */\r\n  export interface RequiredVersionRanges {\r\n    /** a range of acceptable persistence versions for reading from a VersionedSqliteDb. */\r\n    readonly readVersion: VersionRange;\r\n    /** a range of acceptable persistence versions for writing to a VersionedSqliteDb. */\r\n    readonly writeVersion: VersionRange;\r\n  }\r\n\r\n  /** interface for reading and writing to a blob in a SQLiteDb\r\n   * @internal\r\n   */\r\n  export interface BlobIO {\r\n    /** Close this BlobIO if it is opened.\r\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\r\n      */\r\n    close(): void;\r\n    /** get the total number of bytes in the blob */\r\n    getNumBytes(): number;\r\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\r\n    isValid(): boolean;\r\n    /** Open this BlobIO against a table/row/column in a Db */\r\n    open(\r\n      /** The database for the blob */\r\n      db: IModelJsNative.AnyDb,\r\n      args: {\r\n        /** the name of the table for the blob*/\r\n        tableName: string;\r\n        /** the name of the column for the blob */\r\n        columnName: string;\r\n        /** The rowId of the blob */\r\n        row: number;\r\n        /** If true, open this BlobIO for write access */\r\n        writeable?: boolean;\r\n      }): void;\r\n    /** Read from a blob\r\n       * @returns the contents of the requested byte range\r\n       */\r\n    read(args: {\r\n      /** The number of bytes to read */\r\n      numBytes: number;\r\n      /** starting offset within the blob to read */\r\n      offset: number;\r\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\r\n      blob?: ArrayBuffer;\r\n    }): Uint8Array;\r\n    /** Reposition this BlobIO to a new rowId\r\n       * @note this BlobIO must be valid when this methods is called.\r\n       */\r\n    changeRow(row: number): void;\r\n    /** Write to a blob */\r\n    write(args: {\r\n      /** The number of bytes to write  */\r\n      numBytes: number;\r\n      /** starting offset within the blob to write */\r\n      offset: number;\r\n      /** the value to write */\r\n      blob: ArrayBuffer;\r\n    }): void;\r\n  }\r\n\r\n  /** Default transaction mode for SQLiteDbs.\r\n   * @see https://www.sqlite.org/lang_transaction.html\r\n   */\r\n  export enum DefaultTxnMode {\r\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\r\n    None = 0,\r\n    /** A deferred transaction is started when the file is first opened. This is the default. */\r\n    Deferred = 1,\r\n    /** An immediate transaction is started when the file is first opened. */\r\n    Immediate = 2,\r\n    /** An exclusive transaction is started when the file is first opened. */\r\n    Exclusive = 3\r\n  }\r\n\r\n  /** parameters common to opening or creating a new SQLiteDb */\r\n  export interface OpenOrCreateParams {\r\n    /** If true, do not require that the `be_Prop` table exist */\r\n    rawSQLite?: boolean;\r\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\r\n    immutable?: boolean;\r\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\r\n    skipFileCheck?: boolean;\r\n    /** the default transaction mode\r\n   * @see [[SQLiteDb.DefaultTxnMode]]\r\n  */\r\n    defaultTxn?: 0 | 1 | 2 | 3;\r\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\r\n    queryParam?: string;\r\n  }\r\n\r\n  /** Parameters for opening an existing SQLiteDb */\r\n  export interface OpenParams extends OpenOrCreateParams {\r\n    /** use OpenMode.ReadWrite to open the file with write access */\r\n    openMode: OpenMode;\r\n  }\r\n\r\n  /** Size of a SQLiteDb page in bytes */\r\n  export interface PageSize {\r\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\r\n    pageSize?: number;\r\n  }\r\n\r\n  /** Parameters for creating a new SQLiteDb */\r\n  export type CreateParams = OpenOrCreateParams & PageSize;\r\n\r\n  /** Arguments for `SqliteDb.withOpenDb` */\r\n  export interface WithOpenDbArgs {\r\n    /** The name of the database to open */\r\n    dbName: string;\r\n    /** either an object with the open parameters or just OpenMode value. */\r\n    openMode?: OpenMode | SQLiteDb.OpenParams;\r\n    /** @internal */\r\n    container?: CloudSqlite.CloudContainer;\r\n  }\r\n\r\n  /** Arguments for `SQLiteDb.vacuum` */\r\n  export interface VacuumDbArgs extends PageSize {\r\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\r\n    into?: LocalFileName;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,yBAAyB;AACzB,+BAA+B;AAC/B,iCAAiC;AAEjC,sDAAyD;AACzD,oDAAgE;AAChE,+CAA4C;AAC5C,8DAAyD;AACzD,6CAA0C;AAC1C,uDAAoE;AACpE,gDAA+C;AAE/C,0CAA0C;AAE1C,0DAA0D;AAG1D;;;GAGG;AACH,MAAa,QAAQ;IACnB,gBAAgB;IACA,CAAC,mBAAS,CAAC,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3D,qBAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAEtE,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,6BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEzE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,yBAAW,CAAC,UAAU,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAElF,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC;IACxC,CAAC;IAED,+JAA+J;IACxJ,kBAAkB;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,yBAAW,CAAC,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;;;YAC3B,MAAM,IAAI,kCAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAA,CAAC;YAC9C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;;;;;;;;;KACpB;CACF;AA9OD,4BA8OC;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAkB,SAAQ,QAAQ;IAC5C,MAAM,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;IAatF;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAChK,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,yBAAW,CAAC,UAAU,CAAC,2BAA2B,EAAE,yCAAyC,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAChI,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,SAAe;QAChE,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,yBAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnM,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAuH;QAChJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AA7FH,8CA8FC;AAED,cAAc;AACd,WAAiB,QAAQ;IAqEvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjIgB,QAAQ,wBAAR,QAAQ,QAiIxB","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 SQLiteDb\n */\n\nimport * as fs from \"fs\";\nimport { dirname } from \"path\";\nimport * as semver from \"semver\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\nimport { LocalFileName, SqliteError } from \"@itwin/core-common\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { IModelJsFs } from \"./IModelJsFs\";\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n// cspell:ignore savepoint julianday rowid\n\n/* eslint-disable @typescript-eslint/unified-signatures */\n\n\n/**\n * A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\n * @public\n */\nexport class SQLiteDb {\n  /** @internal */\n  public readonly [_nativeDb] = new IModelNative.platform.SQLiteDb();\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\n\n  /** @internal */\n  public static createBlobIO(): SQLiteDb.BlobIO {\n    return new IModelNative.platform.BlobIO();\n  }\n\n  /** alias for closeDb.\n   * @deprecated in 4.0 - will not be removed until after 2026-06-13. Use [[closeDb]]\n   */\n  public dispose(): void {\n    this.closeDb();\n  }\n\n  /** Create a SQLiteDb\n   * @param dbName The path to the SQLiteDb file to create.\n   */\n  public createDb(dbName: string): void;\n  /** @beta */\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\n    this[_nativeDb].createDb(dbName, container, params);\n  }\n\n  /** Open a SQLiteDb.\n   * @param dbName The path to the SQLiteDb file to open\n   */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\n  /**\n   * @param container optional CloudContainer holding database\n   * @beta\n   */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\n    this[_nativeDb].openDb(dbName, openMode, container);\n  }\n\n  /** Close SQLiteDb.\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\n   */\n  public closeDb(saveChanges?: boolean): void {\n    if (saveChanges && this.isOpen)\n      this.saveChanges();\n    this._sqliteStatementCache.clear();\n    this[_nativeDb].closeDb();\n  }\n\n  /** Returns true if this SQLiteDb is open */\n  public get isOpen(): boolean { return this[_nativeDb].isOpen(); }\n\n  /** Returns true if this SQLiteDb is open readonly */\n  public get isReadonly(): boolean { return this[_nativeDb].isReadonly(); }\n\n  /** Create a new table in this database. */\n  protected createTable(args: {\n    /** The name of the table to create. */\n    tableName: string;\n    /** all of the columns in the table. */\n    columns: string;\n    /** any unique or foreign key constraints */\n    constraints?: string;\n    /** if true, add a \"lastMod\" timestamp column and triggers to automatically update it. */\n    addTimestamp?: boolean;\n  }) {\n    const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\n    const constraints = args.constraints ? `,${args.constraints}` : \"\";\n    this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\n    if (args.addTimestamp)\n      this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\n  }\n\n  /**\n   * Get the last modified date for a row in a table of this database.\n   * @note the table must have been created with `addTimestamp: true`\n  */\n  public readLastModTime(tableName: string, rowId: number): Date {\n    return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\n      stmt.bindInteger(1, rowId);\n      return stmt.getValueDate(0);\n    });\n  }\n\n  /**\n   * Open a database, perform an operation, then close the database.\n   *\n   * Details:\n   * - if database is open, throw an error\n   * - open a database\n   * - call a function with the database opened. If it is async, await its return.\n   * - if function throws, abandon all changes, close database, and rethrow\n   * - save all changes\n   * - close the database\n   * @return value from operation\n   */\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\n    if (this.isOpen)\n      SqliteError.throwError(\"already-open\", \"database is already open\", args.dbName);\n\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\n    try {\n      const result = operation();\n      result instanceof Promise ? result.then(save, abandon) : save();\n      return result;\n    } catch (e) {\n      abandon();\n      throw e;\n    }\n  }\n\n  /** The cloud container backing this SQLite database, if any.\n   * @beta\n   */\n  public get cloudContainer(): CloudSqlite.CloudContainer | undefined {\n    return this[_nativeDb].cloudContainer;\n  }\n\n  /** Returns the Id of the most-recently-inserted row in this database, per [sqlite3_last_insert_rowid](https://www.sqlite.org/c3ref/last_insert_rowid.html). */\n  public getLastInsertRowId(): number {\n    return this[_nativeDb].getLastInsertRowId();\n  }\n\n  /**\n   * Perform an operation on a database in a CloudContainer with the write lock held.\n   *\n   * Details:\n   * - acquire the write lock on a CloudContainer\n   * - call `withOpenDb` with openMode `ReadWrite`\n   * - upload changes\n   * - release the write lock\n   * @param args arguments to lock the container and open the database\n   * @param operation an operation performed on the database with the write lock held.\n   * @return value from operation\n   * @internal\n   */\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => Promise<T>) {\n    return CloudSqlite.withWriteLock(args, async () => this.withOpenDb({ ...args, openMode: args.openMode ?? OpenMode.ReadWrite }, operation));\n  }\n\n  /** vacuum this database\n   * @see https://www.sqlite.org/lang_vacuum.html\n   */\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\n    this[_nativeDb].vacuum(args);\n  }\n\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the default transaction. */\n  public saveChanges(): void {\n    this[_nativeDb].saveChanges();\n  }\n\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the default transaction. */\n  public abandonChanges(): void {\n    this[_nativeDb].abandonChanges();\n  }\n\n  /**\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\n   * @param sql The SQLite SQL statement to execute\n   * @param callback the callback to invoke on the prepared statement\n   * @returns the value returned by `callback`.\n   */\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\n    try {\n      const val = callback(stmt);\n      val instanceof Promise ? val.then(release, release) : release();\n      return val;\n    } catch (err) {\n      release();\n      throw err;\n    }\n  }\n\n  /**\n   * Prepare and execute a callback on a SQL statement. After the callback completes the statement is disposed.\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\n   * @param sql The SQLite SQL statement to execute\n   * @param callback the callback to invoke on the prepared statement\n   * @returns the value returned by `callback`.\n   */\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\n    const stmt = this.prepareSqliteStatement(sql);\n    const release = () => stmt[Symbol.dispose]();\n    try {\n      const val = callback(stmt);\n      val instanceof Promise ? val.then(release, release) : release();\n      return val;\n    } catch (err) {\n      release();\n      throw err;\n    }\n  }\n\n  /**\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\n   */\n  public withSavePoint(savePointName: string, operation: () => void) {\n    if (this.isReadonly)\n      SqliteError.throwError(\"readonly\", \"database is readonly\", this[_nativeDb].getFilePath());\n\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\n    try {\n      operation();\n      this.executeSQL(`RELEASE ${savePointName}`);\n    } catch (e) {\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\n      throw e;\n    }\n  }\n\n  /** Prepare an SQL statement.\n     * @param sql The SQLite SQL statement to prepare\n     * @param logErrors Determine if errors are logged or not\n     * @internal\n     */\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\n    const stmt = new SqliteStatement(sql);\n    stmt.prepare(this[_nativeDb], logErrors);\n    return stmt;\n  }\n\n  /** execute an SQL statement */\n  public executeSQL(sql: string): DbResult {\n    using stmt = this.prepareSqliteStatement(sql);\n    return stmt.step();\n  }\n}\n\n/**\n * Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\n * always used for access.\n *\n * Notes:\n *  - This class may be used either to access a local file, or one stored in a cloud container.\n *  - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\n * tables.\n * @beta\n */\nexport abstract class VersionedSqliteDb extends SQLiteDb {\n  protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\n\n  /** The current semver \"persistence version\" of this class.\n   * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\n   * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\n   * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\n   * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\n   * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\n   * supported by it, the user will be informed that they need to upgrade their software.\n   * @note this identifier is independent of versions in `package.json` files.\n  */\n  public abstract myVersion: string;\n\n  /**\n   * Change the \"versions required to open this database\" property stored in this database. After this call,\n   * versions of software that don't meet the supplied ranges will fail.\n   * @param versions the new versions required for reading and writing this database.\n   * @note the database must be opened for write access.\n   */\n  public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\n    // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\n    this[_nativeDb].saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\n  }\n\n  /** Get the required version ranges necessary to open this VersionedSqliteDb. */\n  public getRequiredVersions() {\n    const checkIsString = (value: any) => {\n      if (typeof value !== \"string\")\n        SqliteError.throwError(\"invalid-versions-property\", `CloudDb has invalid \"versions\" property`, this[_nativeDb].getFilePath());\n      return value;\n    };\n    const versionJson = checkIsString(this[_nativeDb].queryFileProperty(VersionedSqliteDb._versionProps, true));\n    const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\n    checkIsString(versionRanges.readVersion);\n    checkIsString(versionRanges.writeVersion);\n    return versionRanges;\n  }\n\n  /**\n   * Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\n   */\n  protected abstract createDDL(args: any): void;\n\n  /**\n   * Create a new database file for the subclass of VersionedSqliteDb.\n   * @note The required versions are saved as [[myVersion]] or newer for both read and write.\n   */\n  public static createNewDb(fileName: LocalFileName, setupArgs?: any) {\n    const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\n    IModelJsFs.recursiveMkDirSync(dirname(fileName));\n    if (fs.existsSync(fileName))\n      fs.unlinkSync(fileName);\n\n    db.createDb(fileName);\n    db.createDDL(setupArgs);\n    const minVer = `^${db.myVersion}`;\n    db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\n    db.closeDb(true);\n  }\n\n  /**\n   * Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\n   * Throws otherwise.\n   */\n  protected verifyVersions() {\n    const versions = this.getRequiredVersions();\n    const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\n    const range = isReadonly ? versions.readVersion : versions.writeVersion;\n    if (semver.satisfies(this.myVersion, range))\n      return;\n\n    this.closeDb();\n    const tooNew = semver.gtr(this.myVersion, range);\n    SqliteError.throwError(\"incompatible-version\", `requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`, this[_nativeDb].getFilePath());\n\n  }\n\n  /**\n   * Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\n   * Throws otherwise.\n   * @see [[SqliteDb.openDb]] for argument types\n   */\n  public override openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\n    super.openDb(dbName, openMode, container);\n    this.verifyVersions();\n  }\n\n  public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }) {\n    // can't use \"this\" because it checks for version, which we don't want here\n    return (arg.lockContainer) ?\n      super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\n      super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\n  }\n}\n\n/** @public */\nexport namespace SQLiteDb {\n  /** A semver version range.\n   * @see https://docs.npmjs.com/cli/v6/using-npm/semver\n   */\n  export type VersionRange = string;\n\n  /**\n   * A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\n   * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\n   */\n  export interface RequiredVersionRanges {\n    /** a range of acceptable persistence versions for reading from a VersionedSqliteDb. */\n    readonly readVersion: VersionRange;\n    /** a range of acceptable persistence versions for writing to a VersionedSqliteDb. */\n    readonly writeVersion: VersionRange;\n  }\n\n  /** interface for reading and writing to a blob in a SQLiteDb\n   * @internal\n   */\n  export interface BlobIO {\n    /** Close this BlobIO if it is opened.\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\n      */\n    close(): void;\n    /** get the total number of bytes in the blob */\n    getNumBytes(): number;\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\n    isValid(): boolean;\n    /** Open this BlobIO against a table/row/column in a Db */\n    open(\n      /** The database for the blob */\n      db: IModelJsNative.AnyDb,\n      args: {\n        /** the name of the table for the blob*/\n        tableName: string;\n        /** the name of the column for the blob */\n        columnName: string;\n        /** The rowId of the blob */\n        row: number;\n        /** If true, open this BlobIO for write access */\n        writeable?: boolean;\n      }): void;\n    /** Read from a blob\n       * @returns the contents of the requested byte range\n       */\n    read(args: {\n      /** The number of bytes to read */\n      numBytes: number;\n      /** starting offset within the blob to read */\n      offset: number;\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\n      blob?: ArrayBuffer;\n    }): Uint8Array;\n    /** Reposition this BlobIO to a new rowId\n       * @note this BlobIO must be valid when this methods is called.\n       */\n    changeRow(row: number): void;\n    /** Write to a blob */\n    write(args: {\n      /** The number of bytes to write  */\n      numBytes: number;\n      /** starting offset within the blob to write */\n      offset: number;\n      /** the value to write */\n      blob: ArrayBuffer;\n    }): void;\n  }\n\n  /** Default transaction mode for SQLiteDbs.\n   * @see https://www.sqlite.org/lang_transaction.html\n   */\n  export enum DefaultTxnMode {\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\n    None = 0,\n    /** A deferred transaction is started when the file is first opened. This is the default. */\n    Deferred = 1,\n    /** An immediate transaction is started when the file is first opened. */\n    Immediate = 2,\n    /** An exclusive transaction is started when the file is first opened. */\n    Exclusive = 3\n  }\n\n  /** parameters common to opening or creating a new SQLiteDb */\n  export interface OpenOrCreateParams {\n    /** If true, do not require that the `be_Prop` table exist */\n    rawSQLite?: boolean;\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\n    immutable?: boolean;\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\n    skipFileCheck?: boolean;\n    /** the default transaction mode\n   * @see [[SQLiteDb.DefaultTxnMode]]\n  */\n    defaultTxn?: 0 | 1 | 2 | 3;\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\n    queryParam?: string;\n  }\n\n  /** Parameters for opening an existing SQLiteDb */\n  export interface OpenParams extends OpenOrCreateParams {\n    /** use OpenMode.ReadWrite to open the file with write access */\n    openMode: OpenMode;\n  }\n\n  /** Size of a SQLiteDb page in bytes */\n  export interface PageSize {\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\n    pageSize?: number;\n  }\n\n  /** Parameters for creating a new SQLiteDb */\n  export type CreateParams = OpenOrCreateParams & PageSize;\n\n  /** Arguments for `SqliteDb.withOpenDb` */\n  export interface WithOpenDbArgs {\n    /** The name of the database to open */\n    dbName: string;\n    /** either an object with the open parameters or just OpenMode value. */\n    openMode?: OpenMode | SQLiteDb.OpenParams;\n    /** @internal */\n    container?: CloudSqlite.CloudContainer;\n  }\n\n  /** Arguments for `SQLiteDb.vacuum` */\n  export interface VacuumDbArgs extends PageSize {\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\n    into?: LocalFileName;\n  }\n}\n"]}

package/lib/cjs/Schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmD;AACnD,oDAAiD;AACjD,mDAAgD;AAChD,gEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,KAAK,UAAU,KAAa,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAElH;;OAEG;IACI,MAAM,KAAK,SAAS;QACzB,mGAAmG;QACnG,OAAO,IAAI,6BAAS,CAAC,IAAI,CAAC,UAAU,EAAE,6BAAS,CAAC,UAAU,CAAC,CAAC,CAAC,0FAA0F;IACzJ,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,uBAAuB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtE;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,aAAqB;QAChD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,IAAI,cAAc;YAChB,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,gBAA0B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/G;AA1CD,wBA0CC;AAED;;;GAGG;AACH,MAAa,SAAS;IACH,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE7D,gBAAgB;IACT,GAAG,CAAC,UAAkB;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,UAAkB,EAAE,MAAqB;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,MAAqB;QACzC,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YACf,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AA5BD,8BA4BC;AAED;;GAEG;AACH,MAAa,OAAO;IACV,MAAM,CAAU,cAAc,GAAG,IAAI,SAAS,EAAE,CAAC;IACzD,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,MAAqB;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,SAAS,KAAK,MAAM;YACtB,6BAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,UAAkB,IAA+B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;;AA7BhJ,0BA8BC","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 Schema\r\n */\r\n\r\nimport { IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { ClassRegistry } from \"./ClassRegistry\";\r\nimport { ECVersion, SchemaKey } from \"@itwin/ecschema-metadata\";\r\n\r\n/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).\r\n *\r\n * When subclassing from Schema, it is good practice to follow this pattern:\r\n *\r\n * ```typescript\r\n * class MyCustomSchema extends Schema {\r\n *   public static override get schemaName(): string { return \"MyCustomSchema\"; }\r\n *   public static get classes(): typeof Entity[] {\r\n *     return [MyOwnECClass, AnotherECClass];\r\n *   }\r\n *   public static registerSchema() {\r\n *     if (this !== Schemas.getRegisteredSchema(this.schemaName)) {\r\n *       Schemas.unregisterSchema(this.schemaName);\r\n *       Schemas.registerSchema(this);\r\n *       for (const ecClass of this.classes) {\r\n *         ClassRegistry.register(ecClass, this);\r\n *       }\r\n *     }\r\n *   }\r\n *\r\n *   public static unregisterSchema() {\r\n *     Schemas.unregisterSchema(this.schemaName);\r\n *   }\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class Schema {\r\n  /** The name of the BIS schema handled by this Schema.\r\n   * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.\r\n   * Failure to do so will ordinarily result in an error when the schema is registered, since there may only\r\n   * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)\r\n   */\r\n  public static get schemaName(): string { throw new Error(`you must override static schemaName in ${this.name}`); }\r\n\r\n  /** Unique identifier for this schema, typed variant of [[schemaName]].\r\n   * @internal\r\n   */\r\n  public static get schemaKey(): SchemaKey {\r\n    // We cannot cache this here because the schemaName may be overridden without this being overridden\r\n    return new SchemaKey(this.schemaName, ECVersion.NO_VERSION); // backend cares little for versions right now, as only one version can exist in an imodel\r\n  }\r\n\r\n  /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.\r\n   * Classes generated for this Schema will disallow protected operations.\r\n   * @internal\r\n   */\r\n  public static get missingRequiredBehavior(): boolean { return false; }\r\n\r\n  /** Get a semver-compatible string from a padded version string.\r\n   * works on unpadded version strings as well\r\n   * if there is no write version, it will be added\r\n   * @example Schema.toSemverString(\"1.02.03\") === \"1.2.3\"\r\n   * @example Schema.toSemverString(\"1.01\") === \"1.0.1\" // write version was added\r\n   * @beta\r\n   */\r\n  public static toSemverString(paddedVersion: string): string {\r\n    const tuple = paddedVersion.split(\".\").map(Number);\r\n    const noWriteVersion = tuple.length === 2;\r\n    if (noWriteVersion)\r\n      tuple.splice(1, 0, 0); // insert 0 before the second element\r\n    return tuple.join(\".\");\r\n  }\r\n\r\n  /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an\r\n   * error if it is ever called.\r\n   * @internal\r\n   */\r\n  protected constructor() { throw new Error(`cannot create an instance of a Schema ${this.constructor.name}`); }\r\n}\r\n\r\n/**\r\n * Holds a map of registered schemas.\r\n * @public\r\n */\r\nexport class SchemaMap {\r\n  private readonly _schemas = new Map<string, typeof Schema>();\r\n\r\n  /** @internal */\r\n  public get(schemaName: string): typeof Schema | undefined {\r\n    return this._schemas.get(schemaName.toLowerCase());\r\n  }\r\n\r\n  /** @internal */\r\n  public set(schemaName: string, schema: typeof Schema): void {\r\n    this._schemas.set(schemaName.toLowerCase(), schema);\r\n  }\r\n\r\n  /** @internal */\r\n  public delete(schemaName: string): boolean {\r\n    return this._schemas.delete(schemaName.toLowerCase());\r\n  }\r\n\r\n  /** Register a schema prior to using it.\r\n   * @throws [[IModelError]] if a schema of the same name is already registered.\r\n   * @public\r\n   */\r\n  public registerSchema(schema: typeof Schema) {\r\n    const key = schema.schemaName.toLowerCase();\r\n    if (this.get(key))\r\n      throw new IModelError(IModelStatus.DuplicateName, `Schema \"${schema.schemaName}\" is already registered`);\r\n    this.set(key, schema);\r\n  }\r\n}\r\n\r\n/** Manages registered schemas\r\n * @public\r\n */\r\nexport class Schemas {\r\n  private static readonly _globalSchemas = new SchemaMap();\r\n  private constructor() { } // this is a singleton\r\n\r\n  /** Register a schema prior to using it.\r\n   * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.\r\n   * @throws [[IModelError]] if a schema of the same name is already registered.\r\n   */\r\n  public static registerSchema(schema: typeof Schema) {\r\n    this._globalSchemas.registerSchema(schema);\r\n  }\r\n\r\n  /** Unregister a schema, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schemaName Name of the schema to unregister\r\n   * @return true if the schema was unregistered\r\n   */\r\n  public static unregisterSchema(schemaName: string): boolean {\r\n    const schema = this.getRegisteredSchema(schemaName);\r\n    if (undefined !== schema)\r\n      ClassRegistry.unregisterClassesFrom(schema);\r\n\r\n    return this._globalSchemas.delete(schemaName.toLowerCase());\r\n  }\r\n\r\n  /** Look up a previously registered schema\r\n   * @param schemaName The name of the schema\r\n   * @returns the previously registered schema or undefined if not registered.\r\n   */\r\n  public static getRegisteredSchema(schemaName: string): typeof Schema | undefined { return this._globalSchemas.get(schemaName.toLowerCase()); }\r\n}\r\n"]}
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmD;AACnD,oDAAiD;AACjD,mDAAgD;AAChD,gEAAgE;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,MAAM;IACjB;;;;OAIG;IACI,MAAM,KAAK,UAAU,KAAa,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAElH;;OAEG;IACI,MAAM,KAAK,SAAS;QACzB,mGAAmG;QACnG,OAAO,IAAI,6BAAS,CAAC,IAAI,CAAC,UAAU,EAAE,6BAAS,CAAC,UAAU,CAAC,CAAC,CAAC,0FAA0F;IACzJ,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,uBAAuB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEtE;;;;;;OAMG;IACI,MAAM,CAAC,cAAc,CAAC,aAAqB;QAChD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,IAAI,cAAc;YAChB,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qCAAqC;QAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,gBAA0B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/G;AA1CD,wBA0CC;AAED;;;GAGG;AACH,MAAa,SAAS;IACH,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE7D,gBAAgB;IACT,GAAG,CAAC,UAAkB;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,UAAkB,EAAE,MAAqB;QAClD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,MAAqB;QACzC,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YACf,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,aAAa,EAAE,WAAW,MAAM,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAC3G,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;CACF;AA5BD,8BA4BC;AAED;;GAEG;AACH,MAAa,OAAO;IACV,MAAM,CAAU,cAAc,GAAG,IAAI,SAAS,EAAE,CAAC;IACzD,gBAAwB,CAAC,CAAC,sBAAsB;IAEhD;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,MAAqB;QAChD,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,SAAS,KAAK,MAAM;YACtB,6BAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,UAAkB,IAA+B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;;AA7BhJ,0BA8BC","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 Schema\n */\n\nimport { IModelStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport { ECVersion, SchemaKey } from \"@itwin/ecschema-metadata\";\n\n/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).\n *\n * When subclassing from Schema, it is good practice to follow this pattern:\n *\n * ```typescript\n * class MyCustomSchema extends Schema {\n *   public static override get schemaName(): string { return \"MyCustomSchema\"; }\n *   public static get classes(): typeof Entity[] {\n *     return [MyOwnECClass, AnotherECClass];\n *   }\n *   public static registerSchema() {\n *     if (this !== Schemas.getRegisteredSchema(this.schemaName)) {\n *       Schemas.unregisterSchema(this.schemaName);\n *       Schemas.registerSchema(this);\n *       for (const ecClass of this.classes) {\n *         ClassRegistry.register(ecClass, this);\n *       }\n *     }\n *   }\n *\n *   public static unregisterSchema() {\n *     Schemas.unregisterSchema(this.schemaName);\n *   }\n * }\n * ```\n *\n * @public\n */\nexport class Schema {\n  /** The name of the BIS schema handled by this Schema.\n   * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.\n   * Failure to do so will ordinarily result in an error when the schema is registered, since there may only\n   * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)\n   */\n  public static get schemaName(): string { throw new Error(`you must override static schemaName in ${this.name}`); }\n\n  /** Unique identifier for this schema, typed variant of [[schemaName]].\n   * @internal\n   */\n  public static get schemaKey(): SchemaKey {\n    // We cannot cache this here because the schemaName may be overridden without this being overridden\n    return new SchemaKey(this.schemaName, ECVersion.NO_VERSION); // backend cares little for versions right now, as only one version can exist in an imodel\n  }\n\n  /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.\n   * Classes generated for this Schema will disallow protected operations.\n   * @internal\n   */\n  public static get missingRequiredBehavior(): boolean { return false; }\n\n  /** Get a semver-compatible string from a padded version string.\n   * works on unpadded version strings as well\n   * if there is no write version, it will be added\n   * @example Schema.toSemverString(\"1.02.03\") === \"1.2.3\"\n   * @example Schema.toSemverString(\"1.01\") === \"1.0.1\" // write version was added\n   * @beta\n   */\n  public static toSemverString(paddedVersion: string): string {\n    const tuple = paddedVersion.split(\".\").map(Number);\n    const noWriteVersion = tuple.length === 2;\n    if (noWriteVersion)\n      tuple.splice(1, 0, 0); // insert 0 before the second element\n    return tuple.join(\".\");\n  }\n\n  /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an\n   * error if it is ever called.\n   * @internal\n   */\n  protected constructor() { throw new Error(`cannot create an instance of a Schema ${this.constructor.name}`); }\n}\n\n/**\n * Holds a map of registered schemas.\n * @public\n */\nexport class SchemaMap {\n  private readonly _schemas = new Map<string, typeof Schema>();\n\n  /** @internal */\n  public get(schemaName: string): typeof Schema | undefined {\n    return this._schemas.get(schemaName.toLowerCase());\n  }\n\n  /** @internal */\n  public set(schemaName: string, schema: typeof Schema): void {\n    this._schemas.set(schemaName.toLowerCase(), schema);\n  }\n\n  /** @internal */\n  public delete(schemaName: string): boolean {\n    return this._schemas.delete(schemaName.toLowerCase());\n  }\n\n  /** Register a schema prior to using it.\n   * @throws [[IModelError]] if a schema of the same name is already registered.\n   * @public\n   */\n  public registerSchema(schema: typeof Schema) {\n    const key = schema.schemaName.toLowerCase();\n    if (this.get(key))\n      throw new IModelError(IModelStatus.DuplicateName, `Schema \"${schema.schemaName}\" is already registered`);\n    this.set(key, schema);\n  }\n}\n\n/** Manages registered schemas\n * @public\n */\nexport class Schemas {\n  private static readonly _globalSchemas = new SchemaMap();\n  private constructor() { } // this is a singleton\n\n  /** Register a schema prior to using it.\n   * This method registers the schema globally, to register a schema within the scope of a single iModel, use `IModelDb.schemaMap`.\n   * @throws [[IModelError]] if a schema of the same name is already registered.\n   */\n  public static registerSchema(schema: typeof Schema) {\n    this._globalSchemas.registerSchema(schema);\n  }\n\n  /** Unregister a schema, by name, if one is already registered.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\n   * @param schemaName Name of the schema to unregister\n   * @return true if the schema was unregistered\n   */\n  public static unregisterSchema(schemaName: string): boolean {\n    const schema = this.getRegisteredSchema(schemaName);\n    if (undefined !== schema)\n      ClassRegistry.unregisterClassesFrom(schema);\n\n    return this._globalSchemas.delete(schemaName.toLowerCase());\n  }\n\n  /** Look up a previously registered schema\n   * @param schemaName The name of the schema\n   * @returns the previously registered schema or undefined if not registered.\n   */\n  public static getRegisteredSchema(schemaName: string): typeof Schema | undefined { return this._globalSchemas.get(schemaName.toLowerCase()); }\n}\n"]}

package/lib/cjs/SchemaSync.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,+CAA4C;AAC5C,yCAA+C;AAC/C,yCAAmD;AACnD,sDAAyD;AACzD,oDAAgE;AAEhE,8DAAyD;AACzD,gDAA+C;AAE/C,gBAAgB;AAChB,IAAiB,UAAU,CAsI1B;AAtID,WAAiB,UAAU;IACzB,MAAM,UAAU,GAAiC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEtF,kFAAkF;IAClF,MAAa,YAAa,SAAQ,4BAAiB;QACxB,SAAS,GAAG,OAAO,CAAC;QAC1B,SAAS,KAAK,CAAC;KACnC;IAHY,uBAAY,eAGxB,CAAA;IAED,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAClE,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,MAAM,oBAAoB,GAAG,6BAA6B,CAAC;IAC3D,iBAAiB;IACJ,uBAAY,GAAG,CAAC,MAAgB,EAAE,SAAkB,EAAE,EAAE;QACnE,IAAI,SAAS;YACX,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,KAAK,EAAE,GAAoD,EAAE,EAAE;QACpF,IAAI,QAA0C,CAAC;QAC/C,MAAM,aAAa,GAAG,GAAG,YAAY,mBAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,mBAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAuB,CAAC;QACzF,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAA+B,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,yBAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;YACrE,IAAI,aAAa;gBACf,MAAM,CAAC,QAAQ,CAAC,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAClF,OAAO,MAAM,CAAC;QAChB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEW,2BAAgB,GAAG,KAAK,EAAE,MAAuD,EAAE,IAAmE,EAAE,SAAiD,EAAiB,EAAE;QACvO,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,6BAAkB,GAAG,KAAK,EAAE,MAAuD,EAAE,SAAiD,EAAiB,EAAE;QACpK,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAC9B,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,oBAAS,GAAG,CAAC,MAAgB,EAAE,EAAE;QAC5C,OAAO,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAChE,MAAM,UAAU,CAAC,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC5C,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAClD,MAAM,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEW,8BAAmB,GAAG,KAAK,EAAE,GAAkG,EAAE,EAAE;QAC9I,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,oCAAoC;QACrL,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,MAAM,YAAY,sBAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACjC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBACnC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,sFAAsF,CAAC,CAAC;YAC1I,CAAC;YACD,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,MAAM,WAAA,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,uBAAuB,EAAE,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;gBACzG,MAAM,CAAC,WAAW,CAAC,qCAAqC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,GAAG,CAAC,iBAAiB;gBACvB,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,uDAAuD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;;gBAEzH,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,mDAAmD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACzH,CAAC;IACH,CAAC,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,yBAAW,CAAC,QAAsB;QACjE,YAAmB,KAAuC;YACxD,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAChE,CAAC;QAEM,MAAM;YACX,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,aAAa,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1I,CAAC;QACD;;;;SAIC;QACM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAiC;YAChE,OAAO,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,CAAC;KACF;IAhBY,sBAAW,cAgBvB,CAAA;AACH,CAAC,EAtIgB,UAAU,0BAAV,UAAU,QAsI1B","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 { CloudSqlite } from \"./CloudSqlite\";\r\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\r\nimport { BriefcaseDb, IModelDb } from \"./IModelDb\";\r\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModelError, LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n/** @internal */\r\nexport namespace SchemaSync {\r\n  const lockParams: CloudSqlite.ObtainLockParams = { retryDelayMs: 1000, nRetries: 30 };\r\n\r\n  /** A CloudSqlite database for synchronizing schema changes across briefcases.  */\r\n  export class SchemaSyncDb extends VersionedSqliteDb {\r\n    public override readonly myVersion = \"4.0.0\";\r\n    protected override createDDL() { }\r\n  }\r\n\r\n  const syncProperty = { namespace: \"itwinjs\", name: \"SchemaSync\" };\r\n  const defaultDbName = \"SchemaSyncDb\";\r\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\";\r\n  // for tests only\r\n  export const setTestCache = (iModel: IModelDb, cacheName?: string) => {\r\n    if (cacheName)\r\n      iModel[_nativeDb].saveLocalValue(testSyncCachePropKey, cacheName);\r\n    else\r\n      iModel[_nativeDb].deleteLocalValue(testSyncCachePropKey);\r\n  };\r\n\r\n  const getCloudAccess = async (arg: IModelDb | { readonly fileName: LocalFileName }) => {\r\n    let nativeDb: IModelJsNative.DgnDb | undefined;\r\n    const argIsIModelDb = arg instanceof IModelDb;\r\n    if (argIsIModelDb) {\r\n      nativeDb = arg[_nativeDb];\r\n    } else {\r\n      nativeDb = new IModelNative.platform.DgnDb();\r\n      nativeDb.openIModel(arg.fileName, OpenMode.Readonly);\r\n    }\r\n\r\n    const propsString = nativeDb.queryFileProperty(syncProperty, true) as string | undefined;\r\n    if (!propsString)\r\n      throw new Error(\"iModel does not have a SchemaSyncDb\");\r\n    try {\r\n      const props = JSON.parse(propsString) as CloudSqlite.ContainerProps;\r\n      const accessToken = await CloudSqlite.requestToken(props);\r\n      const access = new CloudAccess({ ...props, accessToken });\r\n      Object.assign(access.lockParams, lockParams);\r\n      const testSyncCache = nativeDb.queryLocalValue(testSyncCachePropKey);\r\n      if (testSyncCache)\r\n        access.setCache(CloudSqlite.CloudCaches.getCache({ cacheName: testSyncCache }));\r\n      return access;\r\n    } finally {\r\n      if (!argIsIModelDb) {\r\n        nativeDb.closeFile();\r\n      }\r\n    }\r\n  };\r\n\r\n  export const withLockedAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, args: { operationName: string, openMode?: OpenMode, user?: string }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\r\n    const access = await getCloudAccess(iModel);\r\n    try {\r\n      await access.withLockedDb(args, async () => operation(access));\r\n    } finally {\r\n      access.close();\r\n    }\r\n  };\r\n\r\n  export const withReadonlyAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\r\n    const access = await getCloudAccess(iModel);\r\n    access.synchronizeWithCloud();\r\n    access.openForRead();\r\n    try {\r\n      await operation(access);\r\n    } finally {\r\n      access.close();\r\n    }\r\n  };\r\n\r\n  export const isEnabled = (iModel: IModelDb) => {\r\n    return iModel[_nativeDb].schemaSyncEnabled();\r\n  };\r\n\r\n  /** Synchronize local briefcase schemas with cloud container */\r\n  export const pull = async (iModel: IModelDb) => {\r\n    if (iModel[_nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {\r\n      await SchemaSync.withReadonlyAccess(iModel, async (syncAccess) => {\r\n        const schemaSyncDbUri = syncAccess.getUri();\r\n        iModel.clearCaches();\r\n        iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);\r\n        iModel.saveChanges(\"schema synchronized with cloud container\");\r\n      });\r\n    }\r\n  };\r\n\r\n  export const initializeForIModel = async (arg: { iModel: IModelDb, containerProps: CloudSqlite.ContainerProps, overrideContainer?: boolean }) => {\r\n    const props = { baseUri: arg.containerProps.baseUri, containerId: arg.containerProps.containerId, storageType: arg.containerProps.storageType }; // sanitize to only known properties\r\n    const iModel = arg.iModel;\r\n    const briefcase = iModel instanceof BriefcaseDb ? iModel : undefined;\r\n    await iModel.acquireSchemaLock();\r\n    if (briefcase) {\r\n      if (briefcase.txns.hasLocalChanges) {\r\n        throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Enabling SchemaSync for iModel failed. There are unsaved or un-pushed local changes.\");\r\n      }\r\n      await briefcase.pullChanges();\r\n    }\r\n    try {\r\n      iModel.saveFileProperty(syncProperty, JSON.stringify(props));\r\n      await withLockedAccess(arg.iModel, { operationName: \"initialize schemaSync\", openMode: OpenMode.Readonly }, async (syncAccess) => {\r\n        iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);\r\n        iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);\r\n      });\r\n    } catch (err) {\r\n      throw err;\r\n    } finally {\r\n      iModel.abandonChanges();\r\n    }\r\n\r\n    if (briefcase) {\r\n      if (arg.overrideContainer)\r\n        await briefcase.pushChanges({ description: `Overriding SchemaSync for iModel with container-id: ${props.containerId}` });\r\n      else\r\n        await briefcase.pushChanges({ description: `Enable SchemaSync for iModel with container-id: ${props.containerId}` });\r\n    }\r\n  };\r\n\r\n  /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */\r\n  export class CloudAccess extends CloudSqlite.DbAccess<SchemaSyncDb> {\r\n    public constructor(props: CloudSqlite.ContainerAccessProps) {\r\n      super({ dbType: SchemaSyncDb, props, dbName: defaultDbName });\r\n    }\r\n\r\n    public getUri() {\r\n      return `${this.getCloudDb()[_nativeDb].getFilePath()}?vfs=${this.container.cache?.name}&writable=${this.container.isWriteable ? 1 : 0}`;\r\n    }\r\n    /**\r\n   * Initialize a cloud container for use as a SchemaSync. 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 ChannelDb into the container.\r\n   * @note this deletes any existing content in the container.\r\n   */\r\n    public static async initializeDb(props: CloudSqlite.ContainerProps) {\r\n      return super._initializeDb({ props, dbType: SchemaSyncDb, dbName: defaultDbName });\r\n    }\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"SchemaSync.js","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,+CAA4C;AAC5C,yCAA+C;AAC/C,yCAAmD;AACnD,sDAAyD;AACzD,oDAAgE;AAEhE,8DAAyD;AACzD,gDAA+C;AAE/C,gBAAgB;AAChB,IAAiB,UAAU,CAsI1B;AAtID,WAAiB,UAAU;IACzB,MAAM,UAAU,GAAiC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEtF,kFAAkF;IAClF,MAAa,YAAa,SAAQ,4BAAiB;QACxB,SAAS,GAAG,OAAO,CAAC;QAC1B,SAAS,KAAK,CAAC;KACnC;IAHY,uBAAY,eAGxB,CAAA;IAED,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAClE,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,MAAM,oBAAoB,GAAG,6BAA6B,CAAC;IAC3D,iBAAiB;IACJ,uBAAY,GAAG,CAAC,MAAgB,EAAE,SAAkB,EAAE,EAAE;QACnE,IAAI,SAAS;YACX,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;;YAElE,MAAM,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,KAAK,EAAE,GAAoD,EAAE,EAAE;QACpF,IAAI,QAA0C,CAAC;QAC/C,MAAM,aAAa,GAAG,GAAG,YAAY,mBAAQ,CAAC;QAC9C,IAAI,aAAa,EAAE,CAAC;YAClB,QAAQ,GAAG,GAAG,CAAC,mBAAS,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC7C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,CAAuB,CAAC;QACzF,IAAI,CAAC,WAAW;YACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAA+B,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,yBAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;YACrE,IAAI,aAAa;gBACf,MAAM,CAAC,QAAQ,CAAC,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YAClF,OAAO,MAAM,CAAC;QAChB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEW,2BAAgB,GAAG,KAAK,EAAE,MAAuD,EAAE,IAAmE,EAAE,SAAiD,EAAiB,EAAE;QACvO,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,6BAAkB,GAAG,KAAK,EAAE,MAAuD,EAAE,SAAiD,EAAiB,EAAE;QACpK,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAC9B,MAAM,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEW,oBAAS,GAAG,CAAC,MAAgB,EAAE,EAAE;QAC5C,OAAO,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC,CAAC;IAEF,+DAA+D;IAClD,eAAI,GAAG,KAAK,EAAE,MAAgB,EAAE,EAAE;QAC7C,IAAI,MAAM,CAAC,mBAAS,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAChE,MAAM,UAAU,CAAC,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC5C,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;gBAClD,MAAM,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEW,8BAAmB,GAAG,KAAK,EAAE,GAAkG,EAAE,EAAE;QAC9I,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,oCAAoC;QACrL,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,MAAM,YAAY,sBAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACjC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBACnC,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,sFAAsF,CAAC,CAAC;YAC1I,CAAC;YACD,MAAM,SAAS,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,MAAM,WAAA,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,uBAAuB,EAAE,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/H,MAAM,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;gBACzG,MAAM,CAAC,WAAW,CAAC,qCAAqC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,cAAc,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,GAAG,CAAC,iBAAiB;gBACvB,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,uDAAuD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;;gBAEzH,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,mDAAmD,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACzH,CAAC;IACH,CAAC,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,yBAAW,CAAC,QAAsB;QACjE,YAAmB,KAAuC;YACxD,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAChE,CAAC;QAEM,MAAM;YACX,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,aAAa,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1I,CAAC;QACD;;;;SAIC;QACM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAiC;YAChE,OAAO,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QACrF,CAAC;KACF;IAhBY,sBAAW,cAgBvB,CAAA;AACH,CAAC,EAtIgB,UAAU,0BAAV,UAAU,QAsI1B","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\n/** @packageDocumentation\n * @module SQLiteDb\n */\n\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { VersionedSqliteDb } from \"./SQLiteDb\";\nimport { BriefcaseDb, IModelDb } from \"./IModelDb\";\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\nimport { IModelError, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** @internal */\nexport namespace SchemaSync {\n  const lockParams: CloudSqlite.ObtainLockParams = { retryDelayMs: 1000, nRetries: 30 };\n\n  /** A CloudSqlite database for synchronizing schema changes across briefcases.  */\n  export class SchemaSyncDb extends VersionedSqliteDb {\n    public override readonly myVersion = \"4.0.0\";\n    protected override createDDL() { }\n  }\n\n  const syncProperty = { namespace: \"itwinjs\", name: \"SchemaSync\" };\n  const defaultDbName = \"SchemaSyncDb\";\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\";\n  // for tests only\n  export const setTestCache = (iModel: IModelDb, cacheName?: string) => {\n    if (cacheName)\n      iModel[_nativeDb].saveLocalValue(testSyncCachePropKey, cacheName);\n    else\n      iModel[_nativeDb].deleteLocalValue(testSyncCachePropKey);\n  };\n\n  const getCloudAccess = async (arg: IModelDb | { readonly fileName: LocalFileName }) => {\n    let nativeDb: IModelJsNative.DgnDb | undefined;\n    const argIsIModelDb = arg instanceof IModelDb;\n    if (argIsIModelDb) {\n      nativeDb = arg[_nativeDb];\n    } else {\n      nativeDb = new IModelNative.platform.DgnDb();\n      nativeDb.openIModel(arg.fileName, OpenMode.Readonly);\n    }\n\n    const propsString = nativeDb.queryFileProperty(syncProperty, true) as string | undefined;\n    if (!propsString)\n      throw new Error(\"iModel does not have a SchemaSyncDb\");\n    try {\n      const props = JSON.parse(propsString) as CloudSqlite.ContainerProps;\n      const accessToken = await CloudSqlite.requestToken(props);\n      const access = new CloudAccess({ ...props, accessToken });\n      Object.assign(access.lockParams, lockParams);\n      const testSyncCache = nativeDb.queryLocalValue(testSyncCachePropKey);\n      if (testSyncCache)\n        access.setCache(CloudSqlite.CloudCaches.getCache({ cacheName: testSyncCache }));\n      return access;\n    } finally {\n      if (!argIsIModelDb) {\n        nativeDb.closeFile();\n      }\n    }\n  };\n\n  export const withLockedAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, args: { operationName: string, openMode?: OpenMode, user?: string }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\n    const access = await getCloudAccess(iModel);\n    try {\n      await access.withLockedDb(args, async () => operation(access));\n    } finally {\n      access.close();\n    }\n  };\n\n  export const withReadonlyAccess = async (iModel: IModelDb | { readonly fileName: LocalFileName }, operation: (access: CloudAccess) => Promise<void>): Promise<void> => {\n    const access = await getCloudAccess(iModel);\n    access.synchronizeWithCloud();\n    access.openForRead();\n    try {\n      await operation(access);\n    } finally {\n      access.close();\n    }\n  };\n\n  export const isEnabled = (iModel: IModelDb) => {\n    return iModel[_nativeDb].schemaSyncEnabled();\n  };\n\n  /** Synchronize local briefcase schemas with cloud container */\n  export const pull = async (iModel: IModelDb) => {\n    if (iModel[_nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {\n      await SchemaSync.withReadonlyAccess(iModel, async (syncAccess) => {\n        const schemaSyncDbUri = syncAccess.getUri();\n        iModel.clearCaches();\n        iModel[_nativeDb].schemaSyncPull(schemaSyncDbUri);\n        iModel.saveChanges(\"schema synchronized with cloud container\");\n      });\n    }\n  };\n\n  export const initializeForIModel = async (arg: { iModel: IModelDb, containerProps: CloudSqlite.ContainerProps, overrideContainer?: boolean }) => {\n    const props = { baseUri: arg.containerProps.baseUri, containerId: arg.containerProps.containerId, storageType: arg.containerProps.storageType }; // sanitize to only known properties\n    const iModel = arg.iModel;\n    const briefcase = iModel instanceof BriefcaseDb ? iModel : undefined;\n    await iModel.acquireSchemaLock();\n    if (briefcase) {\n      if (briefcase.txns.hasLocalChanges) {\n        throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Enabling SchemaSync for iModel failed. There are unsaved or un-pushed local changes.\");\n      }\n      await briefcase.pullChanges();\n    }\n    try {\n      iModel.saveFileProperty(syncProperty, JSON.stringify(props));\n      await withLockedAccess(arg.iModel, { operationName: \"initialize schemaSync\", openMode: OpenMode.Readonly }, async (syncAccess) => {\n        iModel[_nativeDb].schemaSyncInit(syncAccess.getUri(), props.containerId, arg.overrideContainer ?? false);\n        iModel.saveChanges(`Enable SchemaSync  (container id: ${props.containerId})`);\n      });\n    } catch (err) {\n      throw err;\n    } finally {\n      iModel.abandonChanges();\n    }\n\n    if (briefcase) {\n      if (arg.overrideContainer)\n        await briefcase.pushChanges({ description: `Overriding SchemaSync for iModel with container-id: ${props.containerId}` });\n      else\n        await briefcase.pushChanges({ description: `Enable SchemaSync for iModel with container-id: ${props.containerId}` });\n    }\n  };\n\n  /** Provides access to a cloud-based `SchemaSyncDb` to hold ECSchemas.  */\n  export class CloudAccess extends CloudSqlite.DbAccess<SchemaSyncDb> {\n    public constructor(props: CloudSqlite.ContainerAccessProps) {\n      super({ dbType: SchemaSyncDb, props, dbName: defaultDbName });\n    }\n\n    public getUri() {\n      return `${this.getCloudDb()[_nativeDb].getFilePath()}?vfs=${this.container.cache?.name}&writable=${this.container.isWriteable ? 1 : 0}`;\n    }\n    /**\n   * Initialize a cloud container for use as a SchemaSync. The container must first be created via its storage supplier api (e.g. Azure, or AWS).\n   * A valid sasToken that grants write access must be supplied. This function creates and uploads an empty ChannelDb into the container.\n   * @note this deletes any existing content in the container.\n   */\n    public static async initializeDb(props: CloudSqlite.ContainerProps) {\n      return super._initializeDb({ props, dbType: SchemaSyncDb, dbName: defaultDbName });\n    }\n  }\n}\n\n"]}

package/lib/cjs/SchemaUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAaH,sEAOC;AAQD,oEAOC;AAjCD,sDAAoD;AACpD,oDAAiD;AAEjD,8DAAyD;AAEzD;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,mDAAmD,CAAC,CAAC;IAElG,OAAO,sBAAsB,CAAC;AAChC,CAAC","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 Schema\r\n */\r\n\r\nimport { BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { ECSchemaXmlContext } from \"./ECSchemaXmlContext\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\n\r\n/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.\r\n * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.\r\n * @returns EC3.2 Xml ECSchema(s).\r\n * @throws [[IModelError]] if there is a problem converting the EC2 schemas.\r\n * @beta\r\n */\r\nexport function convertEC2SchemasToEC3Schemas(ec2XmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\r\n  const maybeNativeContext = schemaContext?.nativeContext;\r\n  const ec3XmlSchemas: string[] = IModelNative.platform.SchemaUtility.convertEC2XmlSchemas(ec2XmlSchemas, maybeNativeContext);\r\n  if (ec2XmlSchemas.length === 0)\r\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting EC2 Xml schemas\");\r\n\r\n  return ec3XmlSchemas;\r\n}\r\n\r\n/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName\r\n * @param xmlSchemas The ECSchema Xml string(s).\r\n * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.\r\n * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.\r\n * @beta\r\n */\r\nexport function upgradeCustomAttributesToEC3(xmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\r\n  const maybeNativeContext = schemaContext?.nativeContext;\r\n  const schemasWithConvertedCA: string[] = IModelNative.platform.SchemaUtility.convertCustomAttributes(xmlSchemas, maybeNativeContext);\r\n  if (schemasWithConvertedCA.length === 0)\r\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting custom attributes of Xml schemas\");\r\n\r\n  return schemasWithConvertedCA;\r\n}\r\n"]}
+{"version":3,"file":"SchemaUtils.js","sourceRoot":"","sources":["../../src/SchemaUtils.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;AAaH,sEAOC;AAQD,oEAOC;AAjCD,sDAAoD;AACpD,oDAAiD;AAEjD,8DAAyD;AAEzD;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAC,aAAuB,EAAE,aAAkC;IACvG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,aAAa,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,oBAAoB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC5H,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,kCAAkC,CAAC,CAAC;IAEjF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAC,UAAoB,EAAE,aAAkC;IACnG,MAAM,kBAAkB,GAAG,aAAa,EAAE,aAAa,CAAC;IACxD,MAAM,sBAAsB,GAAa,6BAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;IACrI,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC;QACrC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,mDAAmD,CAAC,CAAC;IAElG,OAAO,sBAAsB,CAAC;AAChC,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 Schema\n */\n\nimport { BentleyStatus } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { ECSchemaXmlContext } from \"./ECSchemaXmlContext\";\nimport { IModelNative } from \"./internal/NativePlatform\";\n\n/** Converts EC2 Xml ECSchema(s). On success, the `EC2 Xml schemas` are converted into `EC3.2 Xml schemas`.\n * @param ec2XmlSchemas The EC2 Xml string(s) created from a serialized ECSchema.\n * @returns EC3.2 Xml ECSchema(s).\n * @throws [[IModelError]] if there is a problem converting the EC2 schemas.\n * @beta\n */\nexport function convertEC2SchemasToEC3Schemas(ec2XmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\n  const maybeNativeContext = schemaContext?.nativeContext;\n  const ec3XmlSchemas: string[] = IModelNative.platform.SchemaUtility.convertEC2XmlSchemas(ec2XmlSchemas, maybeNativeContext);\n  if (ec2XmlSchemas.length === 0)\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting EC2 Xml schemas\");\n\n  return ec3XmlSchemas;\n}\n\n/** Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName\n * @param xmlSchemas The ECSchema Xml string(s).\n * @returns EC3.2 Xml ECSchema(s) with converted custom attributes.\n * @throws [[IModelError]] if there is a problem converting the custom attributes of a schema.\n * @beta\n */\nexport function upgradeCustomAttributesToEC3(xmlSchemas: string[], schemaContext?: ECSchemaXmlContext): string[] {\n  const maybeNativeContext = schemaContext?.nativeContext;\n  const schemasWithConvertedCA: string[] = IModelNative.platform.SchemaUtility.convertCustomAttributes(xmlSchemas, maybeNativeContext);\n  if (schemasWithConvertedCA.length === 0)\n    throw new IModelError(BentleyStatus.ERROR, \"Error converting custom attributes of Xml schemas\");\n\n  return schemasWithConvertedCA;\n}\n"]}

package/lib/cjs/SheetIndex.js.map

@@ -1 +1 @@
-{"version":3,"file":"SheetIndex.js","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAiP;AACjP,uCAA+D;AAE/D,sDAA+D;AAC/D,qEAAkK;AAkClK;;;;GAIG;AACH,MAAa,UAAW,SAAQ,qCAA2B;IAClD,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,sBAAsC,EAAE,SAAiB;QAClG,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,UAAU,CAAC,CAAC;QAC9E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,KAAK,GAAiB;YAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE;YACvD,KAAK,EAAE,OAAO;SACf,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AA1CD,gCA0CC;AAED;;EAEE;AACF,MAAsB,eAAgB,SAAQ,qCAA2B;IAChE,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,0FAA0F;IACnF,aAAa,CAAS;IAE7B,YAAsB,KAA2B,EAAE,MAAgB;QACjE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAC3C,CAAC;IAEe,MAAM;QACpB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,YAA4B,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,eAAe,CAAC,CAAC;QACrF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAES,MAAM,CAAC,6BAA6B,CAAC,QAAkB,EAAE,EAAc;QAC/E,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,aAAa,KAAK,gBAAgB,CAAC,aAAa,CAAC;QACrF,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,oDAA2B,CAAC,CAAC,CAAC,8CAAqB,CAAC;QAChF,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC;IAES,MAAM,CAAC,WAAW,CAAC,GAA8B;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAyB;YAClC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,GAAG,CAAC,iBAAiB;YAC5B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC;YACpE,aAAa,EAAE,GAAG,CAAC,QAAQ;YAC3B,MAAM;SACP,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA1CD,0CA0CC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,eAAe;IAC5C,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAE7E;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,KAAK,GAA0B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC3D,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAtBD,4CAsBC;AAED;;EAEE;AACF,MAAa,mBAAoB,SAAQ,eAAe;IAC/C,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAEhF,2EAA2E;IACpE,UAAU,CAAyC;IAE1D,YAAsB,KAA+B,EAAE,MAAgB;QACrE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAa,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAEvE,IAAI,CAAC,UAAU,GAAG,IAAI,8DAAqC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SACvC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,KAAK,GAA6B;YACtC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SACnG,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU;YACjB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAzDD,kDAyDC;AAED;;EAEE;AACF,MAAa,cAAe,SAAQ,eAAe;IAC1C,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,iEAAiE;IAC1D,KAAK,CAA0C;IAEtD,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAQ,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK;gBACR,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAElE,IAAI,CAAC,KAAK,GAAG,IAAI,oDAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SAC7B,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,KAAK,GAAwB;YACjC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC;CACF;AAzDD,wCAyDC","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 Elements\r\n */\r\n\r\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, ElementProps, EntityReferenceSet, IModelError, RelatedElementProps, SheetIndexEntryProps, SheetIndexFolderProps, SheetIndexReferenceProps, SheetReferenceProps } from \"@itwin/core-common\";\r\nimport { InformationReferenceElement, Sheet } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { SheetIndexFolderOwnsEntries, SheetIndexOwnsEntries, SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from \"./NavigationRelationship\";\r\n\r\n/** Arguments used to create a [[SheetIndexEntry]].\r\n * @beta\r\n */\r\nexport interface SheetIndexEntryCreateArgs {\r\n  /** The iModel that will contain the sheet index entry. */\r\n  iModelDb: IModelDb;\r\n  /** The Id of the [[SheetIndexModel]] that will contain the sheet index entry. */\r\n  sheetIndexModelId: Id64String;\r\n  /** The [[SheetIndex]] or [[SheetIndexFolder]] that is parent to this SheetIndexEntry */\r\n  parentId: Id64String;\r\n  /** The name of the SheetIndexEntry */\r\n  name: string;\r\n  /** The priority of the SheetIndexEntry */\r\n  priority: number;\r\n}\r\n\r\n/** Arguments supplied when creating a [[SheetIndexReference]].\r\n * @beta\r\n */\r\nexport interface SheetIndexReferenceCreateArgs extends SheetIndexEntryCreateArgs {\r\n  /** The [[SheetIndex]] to which the reference refers. */\r\n  sheetIndexId?: Id64String;\r\n}\r\n\r\n/** Arguments supplied when creating a [[SheetReference]].\r\n * @beta\r\n */\r\nexport interface SheetReferenceCreateArgs extends SheetIndexEntryCreateArgs {\r\n  /** The [[Sheet]] to which the reference refers. */\r\n  sheetId?: Id64String;\r\n}\r\n\r\n/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.\r\n * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating\r\n * sub-trees via [[SheetIndexReference]]s.\r\n * @beta\r\n */\r\nexport class SheetIndex extends InformationReferenceElement {\r\n  public static override get className(): string { return \"SheetIndex\"; }\r\n\r\n  /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.\r\n   * @param codeValue The SheetIndex name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeSheetIndexModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.sheetIndex);\r\n    return new Code({ spec: codeSpec.id, scope: scopeSheetIndexModelId, value: codeValue });\r\n  }\r\n\r\n  /** Create a SheetIndex\r\n   * @param iModelDb The IModelDb\r\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\r\n   * @param name The name (codeValue) of the SheetIndex\r\n   * @returns The newly constructed SheetIndex\r\n   * @throws [[IModelError]] if there is a problem creating the SheetIndex\r\n   */\r\n  public static create(iModelDb: IModelDb, modelId: Id64String, name: string): SheetIndex {\r\n    const props: ElementProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, modelId, name).toJSON(),\r\n      model: modelId,\r\n    };\r\n    return new this(props, iModelDb);\r\n  }\r\n\r\n  /** Insert a SheetIndex\r\n   * @param iModelDb The IModelDb\r\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\r\n   * @param name The name (codeValue) of the SheetIndex\r\n   * @returns The Id of the newly inserted SheetIndex\r\n   * @throws [[IModelError]] if there is a problem inserting the SheetIndex\r\n   */\r\n  public static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String {\r\n    const instance = this.create(iModelDb, modelId, name);\r\n    const elements = iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n}\r\n\r\n/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.\r\n * @beta\r\n*/\r\nexport abstract class SheetIndexEntry extends InformationReferenceElement {\r\n  public static override get className(): string { return \"SheetIndexEntry\"; }\r\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\r\n  public entryPriority: number;\r\n\r\n  protected constructor(props: SheetIndexEntryProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.entryPriority = props.entryPriority;\r\n  }\r\n\r\n  public override toJSON(): SheetIndexEntryProps {\r\n    return { ...super.toJSON(), entryPriority: this.entryPriority };\r\n  }\r\n\r\n  /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.\r\n   * @param iModel  The IModel\r\n   * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.\r\n   * @param codeValue The name of the entry\r\n   */\r\n  public static createCode(iModelDb: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.sheetIndexEntry);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  protected static createParentRelationshipProps(iModelDb: IModelDb, id: Id64String): RelatedElementProps {\r\n    const parentElementProps = iModelDb.elements.getElementProps(id);\r\n    const isFolder = parentElementProps.classFullName === SheetIndexFolder.classFullName;\r\n    const relClass = isFolder ? SheetIndexFolderOwnsEntries : SheetIndexOwnsEntries;\r\n    return { id, relClassName: relClass.classFullName };\r\n  }\r\n\r\n  protected static createProps(arg: SheetIndexEntryCreateArgs) {\r\n    const parent = this.createParentRelationshipProps(arg.iModelDb, arg.parentId);\r\n    const props: SheetIndexEntryProps = {\r\n      classFullName: this.classFullName,\r\n      model: arg.sheetIndexModelId,\r\n      code: this.createCode(arg.iModelDb, arg.sheetIndexModelId, arg.name),\r\n      entryPriority: arg.priority,\r\n      parent,\r\n    };\r\n    return props;\r\n  }\r\n}\r\n\r\n/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].\r\n * @beta\r\n */\r\nexport class SheetIndexFolder extends SheetIndexEntry {\r\n  public static override get className(): string { return \"SheetIndexFolder\"; }\r\n\r\n  /** Create a new SheetIndexFolder\r\n   * @returns The newly constructed SheetIndexFolder element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(arg: SheetIndexEntryCreateArgs) {\r\n    const props: SheetIndexFolderProps = this.createProps(arg);\r\n    return new this(props, arg.iModelDb);\r\n  }\r\n\r\n  /** Create a new SheetIndexFolder\r\n   * @returns The Id of the newly inserted SheetIndexFolder element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static insert(arg: SheetIndexEntryCreateArgs): Id64String {\r\n    const instance = this.create(arg);\r\n    const elements = arg.iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n}\r\n\r\n/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.\r\n * @beta\r\n*/\r\nexport class SheetIndexReference extends SheetIndexEntry {\r\n  public static override get className(): string { return \"SheetIndexReference\"; }\r\n\r\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\r\n  public sheetIndex?: SheetIndexReferenceRefersToSheetIndex;\r\n\r\n  protected constructor(props: SheetIndexReferenceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.sheetIndex) {\r\n      const sheetIndex = iModel.elements.tryGetElement<SheetIndex>(props.sheetIndex.id);\r\n      if (!sheetIndex)\r\n        throw new IModelError(IModelStatus.NotFound, \"SheetIndex not found\");\r\n\r\n      this.sheetIndex = new SheetIndexReferenceRefersToSheetIndex(props.sheetIndex.id);\r\n    }\r\n  }\r\n\r\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\r\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\r\n  }\r\n\r\n  public override toJSON(): SheetIndexReferenceProps { // This override only specializes the return type\r\n    return {\r\n      ...super.toJSON(),\r\n      sheetIndex: this.sheetIndex ? this.sheetIndex.toJSON() : undefined,\r\n    } as SheetIndexReferenceProps;\r\n  }\r\n\r\n  /** Create a new SheetIndexReference\r\n   * @returns The newly constructed SheetIndexReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(arg: SheetIndexReferenceCreateArgs) {\r\n    const props: SheetIndexReferenceProps = {\r\n      ...this.createProps(arg),\r\n      sheetIndex: arg.sheetIndexId ? this.createReferenceRelationshipProps(arg.sheetIndexId) : undefined,\r\n    };\r\n    return new this(props, arg.iModelDb);\r\n  }\r\n\r\n  /** Create a new SheetIndexReference\r\n   * @returns The Id of the newly inserted SheetIndexReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static insert(arg: SheetIndexReferenceCreateArgs): Id64String {\r\n    const instance = this.create(arg);\r\n    const elements = arg.iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.sheetIndex)\r\n      referenceIds.addElement(this.sheetIndex.id);\r\n  }\r\n}\r\n\r\n/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].\r\n * @beta\r\n*/\r\nexport class SheetReference extends SheetIndexEntry {\r\n  public static override get className(): string { return \"SheetReference\"; }\r\n\r\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\r\n  public sheet: SheetReferenceRefersToSheet | undefined;\r\n\r\n  protected constructor(props: SheetReferenceProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    if (props.sheet) {\r\n      const sheet = iModel.elements.tryGetElement<Sheet>(props.sheet.id);\r\n      if (!sheet)\r\n        throw new IModelError(IModelStatus.NotFound, \"Sheet not found\");\r\n\r\n      this.sheet = new SheetReferenceRefersToSheet(sheet.id);\r\n    }\r\n  }\r\n\r\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\r\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\r\n  }\r\n\r\n  public override toJSON(): SheetReferenceProps { // This override only specializes the return type\r\n    return {\r\n      ...super.toJSON(),\r\n      sheet: this.sheet ? this.sheet.toJSON() : undefined,\r\n    } as SheetReferenceProps;\r\n  }\r\n\r\n  /** Create a new SheetReference\r\n   * @returns The newly constructed SheetReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(arg: SheetReferenceCreateArgs) {\r\n    const props: SheetReferenceProps = {\r\n      ...this.createProps(arg),\r\n      sheet: arg.sheetId ? this.createReferenceRelationshipProps(arg.sheetId) : undefined,\r\n    };\r\n    return new this(props, arg.iModelDb);\r\n  }\r\n\r\n  /** Insert a new SheetReference\r\n   * @returns The Id of the newly inserted SheetReference element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static insert(arg: SheetReferenceCreateArgs): Id64String {\r\n    const instance = this.create(arg);\r\n    const elements = arg.iModelDb.elements;\r\n    instance.id = elements.insertElement(instance.toJSON());\r\n    return instance.id;\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    if (this.sheet)\r\n      referenceIds.addModel(this.sheet.id);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SheetIndex.js","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAiP;AACjP,uCAA+D;AAE/D,sDAA+D;AAC/D,qEAAkK;AAkClK;;;;GAIG;AACH,MAAa,UAAW,SAAQ,qCAA2B;IAClD,MAAM,KAAc,SAAS,KAAa,OAAO,YAAY,CAAC,CAAC,CAAC;IAEvE;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,sBAAsC,EAAE,SAAiB;QAClG,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,UAAU,CAAC,CAAC;QAC9E,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,KAAK,GAAiB;YAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE;YACvD,KAAK,EAAE,OAAO;SACf,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,OAAmB,EAAE,IAAY;QACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AA1CD,gCA0CC;AAED;;EAEE;AACF,MAAsB,eAAgB,SAAQ,qCAA2B;IAChE,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,0FAA0F;IACnF,aAAa,CAAS;IAE7B,YAAsB,KAA2B,EAAE,MAAgB;QACjE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAC3C,CAAC;IAEe,MAAM;QACpB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAkB,EAAE,YAA4B,EAAE,SAAiB;QAC1F,MAAM,QAAQ,GAAa,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,eAAe,CAAC,CAAC;QACrF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAES,MAAM,CAAC,6BAA6B,CAAC,QAAkB,EAAE,EAAc;QAC/E,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,aAAa,KAAK,gBAAgB,CAAC,aAAa,CAAC;QACrF,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,oDAA2B,CAAC,CAAC,CAAC,8CAAqB,CAAC;QAChF,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC;IAES,MAAM,CAAC,WAAW,CAAC,GAA8B;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAyB;YAClC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,GAAG,CAAC,iBAAiB;YAC5B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC;YACpE,aAAa,EAAE,GAAG,CAAC,QAAQ;YAC3B,MAAM;SACP,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA1CD,0CA0CC;AAED;;GAEG;AACH,MAAa,gBAAiB,SAAQ,eAAe;IAC5C,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAE7E;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,KAAK,GAA0B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC3D,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA8B;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAtBD,4CAsBC;AAED;;EAEE;AACF,MAAa,mBAAoB,SAAQ,eAAe;IAC/C,MAAM,KAAc,SAAS,KAAa,OAAO,qBAAqB,CAAC,CAAC,CAAC;IAEhF,2EAA2E;IACpE,UAAU,CAAyC;IAE1D,YAAsB,KAA+B,EAAE,MAAgB;QACrE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAa,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAEvE,IAAI,CAAC,UAAU,GAAG,IAAI,8DAAqC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SACvC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,KAAK,GAA6B;YACtC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SACnG,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAkC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU;YACjB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAzDD,kDAyDC;AAED;;EAEE;AACF,MAAa,cAAe,SAAQ,eAAe;IAC1C,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,iEAAiE;IAC1D,KAAK,CAA0C;IAEtD,YAAsB,KAA0B,EAAE,MAAgB;QAChE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAQ,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK;gBACR,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAElE,IAAI,CAAC,KAAK,GAAG,IAAI,oDAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAES,MAAM,CAAC,gCAAgC,CAAC,EAAc;QAC9D,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,8DAAqC,CAAC,aAAa,EAAE,CAAC;IACnF,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SAC7B,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,KAAK,GAAwB;YACjC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YACxB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;QACF,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAA6B;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACvC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAgC;QACrE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,KAAK;YACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC;CACF;AAzDD,wCAyDC","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 { BisCodeSpec, Code, CodeScopeProps, CodeSpec, ElementProps, EntityReferenceSet, IModelError, RelatedElementProps, SheetIndexEntryProps, SheetIndexFolderProps, SheetIndexReferenceProps, SheetReferenceProps } from \"@itwin/core-common\";\nimport { InformationReferenceElement, Sheet } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { Id64String, IModelStatus } from \"@itwin/core-bentley\";\nimport { SheetIndexFolderOwnsEntries, SheetIndexOwnsEntries, SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from \"./NavigationRelationship\";\n\n/** Arguments used to create a [[SheetIndexEntry]].\n * @beta\n */\nexport interface SheetIndexEntryCreateArgs {\n  /** The iModel that will contain the sheet index entry. */\n  iModelDb: IModelDb;\n  /** The Id of the [[SheetIndexModel]] that will contain the sheet index entry. */\n  sheetIndexModelId: Id64String;\n  /** The [[SheetIndex]] or [[SheetIndexFolder]] that is parent to this SheetIndexEntry */\n  parentId: Id64String;\n  /** The name of the SheetIndexEntry */\n  name: string;\n  /** The priority of the SheetIndexEntry */\n  priority: number;\n}\n\n/** Arguments supplied when creating a [[SheetIndexReference]].\n * @beta\n */\nexport interface SheetIndexReferenceCreateArgs extends SheetIndexEntryCreateArgs {\n  /** The [[SheetIndex]] to which the reference refers. */\n  sheetIndexId?: Id64String;\n}\n\n/** Arguments supplied when creating a [[SheetReference]].\n * @beta\n */\nexport interface SheetReferenceCreateArgs extends SheetIndexEntryCreateArgs {\n  /** The [[Sheet]] to which the reference refers. */\n  sheetId?: Id64String;\n}\n\n/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.\n * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating\n * sub-trees via [[SheetIndexReference]]s.\n * @beta\n */\nexport class SheetIndex extends InformationReferenceElement {\n  public static override get className(): string { return \"SheetIndex\"; }\n\n  /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.\n   * @param iModel  The IModelDb\n   * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.\n   * @param codeValue The SheetIndex name\n   */\n  public static createCode(iModel: IModelDb, scopeSheetIndexModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.sheetIndex);\n    return new Code({ spec: codeSpec.id, scope: scopeSheetIndexModelId, value: codeValue });\n  }\n\n  /** Create a SheetIndex\n   * @param iModelDb The IModelDb\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\n   * @param name The name (codeValue) of the SheetIndex\n   * @returns The newly constructed SheetIndex\n   * @throws [[IModelError]] if there is a problem creating the SheetIndex\n   */\n  public static create(iModelDb: IModelDb, modelId: Id64String, name: string): SheetIndex {\n    const props: ElementProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, modelId, name).toJSON(),\n      model: modelId,\n    };\n    return new this(props, iModelDb);\n  }\n\n  /** Insert a SheetIndex\n   * @param iModelDb The IModelDb\n   * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.\n   * @param name The name (codeValue) of the SheetIndex\n   * @returns The Id of the newly inserted SheetIndex\n   * @throws [[IModelError]] if there is a problem inserting the SheetIndex\n   */\n  public static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String {\n    const instance = this.create(iModelDb, modelId, name);\n    const elements = iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n}\n\n/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.\n * @beta\n*/\nexport abstract class SheetIndexEntry extends InformationReferenceElement {\n  public static override get className(): string { return \"SheetIndexEntry\"; }\n  /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */\n  public entryPriority: number;\n\n  protected constructor(props: SheetIndexEntryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.entryPriority = props.entryPriority;\n  }\n\n  public override toJSON(): SheetIndexEntryProps {\n    return { ...super.toJSON(), entryPriority: this.entryPriority };\n  }\n\n  /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.\n   * @param codeValue The name of the entry\n   */\n  public static createCode(iModelDb: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModelDb.codeSpecs.getByName(BisCodeSpec.sheetIndexEntry);\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  protected static createParentRelationshipProps(iModelDb: IModelDb, id: Id64String): RelatedElementProps {\n    const parentElementProps = iModelDb.elements.getElementProps(id);\n    const isFolder = parentElementProps.classFullName === SheetIndexFolder.classFullName;\n    const relClass = isFolder ? SheetIndexFolderOwnsEntries : SheetIndexOwnsEntries;\n    return { id, relClassName: relClass.classFullName };\n  }\n\n  protected static createProps(arg: SheetIndexEntryCreateArgs) {\n    const parent = this.createParentRelationshipProps(arg.iModelDb, arg.parentId);\n    const props: SheetIndexEntryProps = {\n      classFullName: this.classFullName,\n      model: arg.sheetIndexModelId,\n      code: this.createCode(arg.iModelDb, arg.sheetIndexModelId, arg.name),\n      entryPriority: arg.priority,\n      parent,\n    };\n    return props;\n  }\n}\n\n/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].\n * @beta\n */\nexport class SheetIndexFolder extends SheetIndexEntry {\n  public static override get className(): string { return \"SheetIndexFolder\"; }\n\n  /** Create a new SheetIndexFolder\n   * @returns The newly constructed SheetIndexFolder element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(arg: SheetIndexEntryCreateArgs) {\n    const props: SheetIndexFolderProps = this.createProps(arg);\n    return new this(props, arg.iModelDb);\n  }\n\n  /** Create a new SheetIndexFolder\n   * @returns The Id of the newly inserted SheetIndexFolder element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static insert(arg: SheetIndexEntryCreateArgs): Id64String {\n    const instance = this.create(arg);\n    const elements = arg.iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n}\n\n/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.\n * @beta\n*/\nexport class SheetIndexReference extends SheetIndexEntry {\n  public static override get className(): string { return \"SheetIndexReference\"; }\n\n  /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */\n  public sheetIndex?: SheetIndexReferenceRefersToSheetIndex;\n\n  protected constructor(props: SheetIndexReferenceProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.sheetIndex) {\n      const sheetIndex = iModel.elements.tryGetElement<SheetIndex>(props.sheetIndex.id);\n      if (!sheetIndex)\n        throw new IModelError(IModelStatus.NotFound, \"SheetIndex not found\");\n\n      this.sheetIndex = new SheetIndexReferenceRefersToSheetIndex(props.sheetIndex.id);\n    }\n  }\n\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\n  }\n\n  public override toJSON(): SheetIndexReferenceProps { // This override only specializes the return type\n    return {\n      ...super.toJSON(),\n      sheetIndex: this.sheetIndex ? this.sheetIndex.toJSON() : undefined,\n    } as SheetIndexReferenceProps;\n  }\n\n  /** Create a new SheetIndexReference\n   * @returns The newly constructed SheetIndexReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(arg: SheetIndexReferenceCreateArgs) {\n    const props: SheetIndexReferenceProps = {\n      ...this.createProps(arg),\n      sheetIndex: arg.sheetIndexId ? this.createReferenceRelationshipProps(arg.sheetIndexId) : undefined,\n    };\n    return new this(props, arg.iModelDb);\n  }\n\n  /** Create a new SheetIndexReference\n   * @returns The Id of the newly inserted SheetIndexReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static insert(arg: SheetIndexReferenceCreateArgs): Id64String {\n    const instance = this.create(arg);\n    const elements = arg.iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n\n  /** @alpha */\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.sheetIndex)\n      referenceIds.addElement(this.sheetIndex.id);\n  }\n}\n\n/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].\n * @beta\n*/\nexport class SheetReference extends SheetIndexEntry {\n  public static override get className(): string { return \"SheetReference\"; }\n\n  /** The bis:Sheet that this bis:SheetReference is pointing to. */\n  public sheet: SheetReferenceRefersToSheet | undefined;\n\n  protected constructor(props: SheetReferenceProps, iModel: IModelDb) {\n    super(props, iModel);\n    if (props.sheet) {\n      const sheet = iModel.elements.tryGetElement<Sheet>(props.sheet.id);\n      if (!sheet)\n        throw new IModelError(IModelStatus.NotFound, \"Sheet not found\");\n\n      this.sheet = new SheetReferenceRefersToSheet(sheet.id);\n    }\n  }\n\n  protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps {\n    return { id, relClassName: SheetIndexReferenceRefersToSheetIndex.classFullName };\n  }\n\n  public override toJSON(): SheetReferenceProps { // This override only specializes the return type\n    return {\n      ...super.toJSON(),\n      sheet: this.sheet ? this.sheet.toJSON() : undefined,\n    } as SheetReferenceProps;\n  }\n\n  /** Create a new SheetReference\n   * @returns The newly constructed SheetReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(arg: SheetReferenceCreateArgs) {\n    const props: SheetReferenceProps = {\n      ...this.createProps(arg),\n      sheet: arg.sheetId ? this.createReferenceRelationshipProps(arg.sheetId) : undefined,\n    };\n    return new this(props, arg.iModelDb);\n  }\n\n  /** Insert a new SheetReference\n   * @returns The Id of the newly inserted SheetReference element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static insert(arg: SheetReferenceCreateArgs): Id64String {\n    const instance = this.create(arg);\n    const elements = arg.iModelDb.elements;\n    instance.id = elements.insertElement(instance.toJSON());\n    return instance.id;\n  }\n\n  /** @alpha */\n  protected override collectReferenceIds(referenceIds: EntityReferenceSet): void {\n    super.collectReferenceIds(referenceIds);\n    if (this.sheet)\n      referenceIds.addModel(this.sheet.id);\n  }\n}\n"]}