@itwin/core-backend 4.10.0-dev.0 → 4.10.0-dev.10

package/lib/cjs/NavigationRelationship.js

@@ -7,7 +7,7 @@
  * @module Relationships
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalSourceAttachmentAttachesSource = exports.ExternalSourceIsInRepository = exports.ElementOwnsExternalSourceAspects = exports.ElementOwnsMultiAspects = exports.ElementOwnsUniqueAspect = exports.PhysicalTypeIsOfPhysicalMaterial = exports.PhysicalElementIsOfPhysicalMaterial = exports.PhysicalElementIsOfType = exports.SpatialLocationIsOfType = exports.GeometricElement3dHasTypeDefinition = exports.GraphicalElement2dIsOfType = exports.GeometricElement2dHasTypeDefinition = exports.FolderContainsRepositories = exports.ExternalSourceOwnsAttachments = exports.PhysicalElementAssemblesElements = exports.ElementEncapsulatesElements = exports.RenderMaterialOwnsRenderMaterials = exports.CategoryOwnsSubCategories = exports.SubjectOwnsPartitionElements = exports.SubjectOwnsSubjects = exports.ElementOwnsChildElements = void 0;
+exports.SheetIndexReferenceRefersToSheetIndex = exports.SheetReferenceRefersToSheet = exports.ExternalSourceAttachmentAttachesSource = exports.ExternalSourceIsInRepository = exports.ElementOwnsExternalSourceAspects = exports.ElementOwnsMultiAspects = exports.ElementOwnsUniqueAspect = exports.PhysicalTypeIsOfPhysicalMaterial = exports.PhysicalElementIsOfPhysicalMaterial = exports.PhysicalElementIsOfType = exports.SpatialLocationIsOfType = exports.GeometricElement3dHasTypeDefinition = exports.GraphicalElement2dIsOfType = exports.GeometricElement2dHasTypeDefinition = exports.SheetIndexOwnsEntries = exports.SheetIndexFolderOwnsEntries = exports.FolderContainsRepositories = exports.ExternalSourceOwnsAttachments = exports.PhysicalElementAssemblesElements = exports.ElementEncapsulatesElements = exports.RenderMaterialOwnsRenderMaterials = exports.CategoryOwnsSubCategories = exports.SubjectOwnsPartitionElements = exports.SubjectOwnsSubjects = exports.ElementOwnsChildElements = void 0;
 const core_common_1 = require("@itwin/core-common");
 /** Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.
  * @public
@@ -101,6 +101,26 @@ class FolderContainsRepositories extends ElementOwnsChildElements {
 }
 exports.FolderContainsRepositories = FolderContainsRepositories;
 FolderContainsRepositories.classFullName = "BisCore:FolderContainsRepositories";
+/** Relates a [[SheetIndexFolder]] to the [[SheetIndexEntry]]'s that it contains.
+ * @beta
+ */
+class SheetIndexFolderOwnsEntries extends ElementOwnsChildElements {
+    constructor(parentId, relClassName = SheetIndexFolderOwnsEntries.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+exports.SheetIndexFolderOwnsEntries = SheetIndexFolderOwnsEntries;
+SheetIndexFolderOwnsEntries.classFullName = "BisCore:SheetIndexFolderOwnsEntries";
+/** Relates a [[SheetIndex]] to the [SheetIndexEntry]]'s that it contains.
+ * @beta
+ */
+class SheetIndexOwnsEntries extends ElementOwnsChildElements {
+    constructor(parentId, relClassName = SheetIndexOwnsEntries.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+exports.SheetIndexOwnsEntries = SheetIndexOwnsEntries;
+SheetIndexOwnsEntries.classFullName = "BisCore:SheetIndexOwnsEntries";
 /** Relates a [[GeometricElement2d]] to its [[TypeDefinitionElement]]
  * @public
  */
@@ -223,4 +243,24 @@ class ExternalSourceAttachmentAttachesSource extends core_common_1.RelatedElemen
 }
 exports.ExternalSourceAttachmentAttachesSource = ExternalSourceAttachmentAttachesSource;
 ExternalSourceAttachmentAttachesSource.classFullName = "BisCore:ExternalSourceAttachmentAttachesSource";
+/** Relates a [[SheetReference]] and [[Sheet]] that it refers.
+ * @beta
+ */
+class SheetReferenceRefersToSheet extends core_common_1.RelatedElement {
+    constructor(sheetId, relClassName = SheetReferenceRefersToSheet.classFullName) {
+        super({ id: sheetId, relClassName });
+    }
+}
+exports.SheetReferenceRefersToSheet = SheetReferenceRefersToSheet;
+SheetReferenceRefersToSheet.classFullName = "BisCore:SheetReferenceRefersToSheet";
+/** Relates a [[SheetIndexReference]] to a [[SheetIndex]] it refers.
+ * @beta
+ */
+class SheetIndexReferenceRefersToSheetIndex extends core_common_1.RelatedElement {
+    constructor(sheetIndexId, relClassName = SheetIndexReferenceRefersToSheetIndex.classFullName) {
+        super({ id: sheetIndexId, relClassName });
+    }
+}
+exports.SheetIndexReferenceRefersToSheetIndex = SheetIndexReferenceRefersToSheetIndex;
+SheetIndexReferenceRefersToSheetIndex.classFullName = "BisCore:SheetIndexReferenceRefersToSheetIndex";
 //# sourceMappingURL=NavigationRelationship.js.map

package/lib/cjs/NavigationRelationship.js.map

@@ -1 +1 @@
-{"version":3,"file":"NavigationRelationship.js","sourceRoot":"","sources":["../../src/NavigationRelationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH,oDAAoE;AAEpE;;GAEG;AACH,MAAa,wBAAyB,SAAQ,4BAAc;IAE1D,YAAmB,QAAoB,EAAE,eAAuB,wBAAwB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IACxC,CAAC;;AAJH,4DAKC;AAJe,sCAAa,GAAG,kCAAkC,CAAC;AAMnE;;GAEG;AACH,MAAa,mBAAoB,SAAQ,wBAAwB;IAE/D,YAAmB,QAAoB,EAAE,eAAuB,mBAAmB,CAAC,aAAa;QAC/F,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,kDAKC;AAJwB,iCAAa,GAAG,6BAA6B,CAAC;AAMvE;;GAEG;AACH,MAAa,4BAA6B,SAAQ,wBAAwB;IAExE,YAAmB,QAAoB,EAAE,eAAuB,4BAA4B,CAAC,aAAa;QACxG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,oEAKC;AAJwB,0CAAa,GAAG,sCAAsC,CAAC;AAMhF;;GAEG;AACH,MAAa,yBAA0B,SAAQ,wBAAwB;IAErE,YAAmB,QAAoB,EAAE,eAAuB,yBAAyB,CAAC,aAAa;QACrG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,8DAKC;AAJwB,uCAAa,GAAG,mCAAmC,CAAC;AAM7E;;GAEG;AACH,MAAa,iCAAkC,SAAQ,wBAAwB;IAE7E,YAAmB,QAAoB,EAAE,eAAuB,iCAAiC,CAAC,aAAa;QAC7G,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,8EAKC;AAJwB,+CAAa,GAAG,2CAA2C,CAAC;AAMrF;;GAEG;AACH,MAAa,2BAA4B,SAAQ,wBAAwB;IAEvE,YAAmB,QAAoB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACvG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,kEAKC;AAJwB,yCAAa,GAAG,qCAAqC,CAAC;AAM/E;;GAEG;AACH,MAAa,gCAAiC,SAAQ,wBAAwB;IAE5E,YAAmB,QAAoB,EAAE,eAAuB,gCAAgC,CAAC,aAAa;QAC5G,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,4EAKC;AAJwB,8CAAa,GAAG,0CAA0C,CAAC;AAMpF;;;GAGG;AACH,MAAa,6BAA8B,SAAQ,wBAAwB;IAEzE,YAAmB,QAAoB,EAAE,eAAuB,6BAA6B,CAAC,aAAa;QACzG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,sEAKC;AAJwB,2CAAa,GAAG,uCAAuC,CAAC;AAMjF;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,wBAAwB;IAEtE,YAAmB,QAAoB,EAAE,eAAuB,0BAA0B,CAAC,aAAa;QACtG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,gEAKC;AAJwB,wCAAa,GAAG,oCAAoC,CAAC;AAM9E;;GAEG;AACH,MAAa,mCAAoC,SAAQ,4BAAc;IAErE,YAAmB,EAAc,EAAE,eAAuB,mCAAmC,CAAC,aAAa;QACzG,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9B,CAAC;;AAJH,kFAKC;AAJe,iDAAa,GAAG,6CAA6C,CAAC;AAM9E;;GAEG;AACH,MAAa,0BAA2B,SAAQ,mCAAmC;IAEjF,YAAmB,EAAc,EAAE,eAAuB,0BAA0B,CAAC,aAAa;QAChG,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAJH,gEAKC;AAJwB,wCAAa,GAAG,oCAAoC,CAAC;AAM9E;;GAEG;AACH,MAAa,mCAAoC,SAAQ,4BAAc;IAErE,YAAmB,EAAc,EAAE,eAAuB,mCAAmC,CAAC,aAAa;QACzG,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9B,CAAC;;AAJH,kFAKC;AAJe,iDAAa,GAAG,6CAA6C,CAAC;AAM9E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,mCAAmC;IAE9E,YAAmB,EAAc,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QAC7F,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAJH,0DAKC;AAJwB,qCAAa,GAAG,iCAAiC,CAAC;AAM3E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,mCAAmC;IAE9E,YAAmB,EAAc,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QAC7F,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAJH,0DAKC;AAJwB,qCAAa,GAAG,iCAAiC,CAAC;AAM3E;;GAEG;AACH,MAAa,mCAAoC,SAAQ,4BAAc;IAErE,YAAmB,EAAc;QAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChB,CAAC;;AAJH,kFAKC;AAJe,iDAAa,GAAG,6CAA6C,CAAC;AAM9E;;GAEG;AACH,MAAa,gCAAiC,SAAQ,4BAAc;IAElE,YAAmB,EAAc;QAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChB,CAAC;;AAJH,4EAKC;AAJe,8CAAa,GAAG,0CAA0C,CAAC;AAM3E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,4BAAc;IAEzD,YAAmB,SAAqB,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IACzC,CAAC;;AAJH,0DAKC;AAJe,qCAAa,GAAG,iCAAiC,CAAC;AAMlE;;GAEG;AACH,MAAa,uBAAwB,SAAQ,4BAAc;IAEzD,YAAmB,SAAqB,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IACzC,CAAC;;AAJH,0DAKC;AAJe,qCAAa,GAAG,iCAAiC,CAAC;AAMlE;;GAEG;AACH,MAAa,gCAAiC,SAAQ,uBAAuB;IAE3E,YAAmB,SAAqB,EAAE,eAAuB,gCAAgC,CAAC,aAAa;QAC7G,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACjC,CAAC;;AAJH,4EAKC;AAJwB,8CAAa,GAAG,0CAA0C,CAAC;AAMpF;;;GAGG;AACH,MAAa,4BAA6B,SAAQ,4BAAc;IAE9D,YAAmB,YAAwB,EAAE,eAAuB,4BAA4B,CAAC,aAAa;QAC5G,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;;AAJH,oEAKC;AAJe,0CAAa,GAAG,sCAAsC,CAAC;AAMvE;;;GAGG;AACH,MAAa,sCAAuC,SAAQ,4BAAc;IAExE,YAAmB,gBAA4B,EAAE,eAAuB,sCAAsC,CAAC,aAAa;QAC1H,KAAK,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,YAAY,EAAE,CAAC,CAAC;IAChD,CAAC;;AAJH,wFAKC;AAJe,oDAAa,GAAG,gDAAgD,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 Relationships\r\n */\r\n\r\n// NOTE: A NavigationRelationship is not an Entity, so is not registered in the ClassRegistry.\r\n// NOTE: It does, however, have a classFullName property for consistency with Entity subclasses.\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { RelatedElement, TypeDefinition } from \"@itwin/core-common\";\r\n\r\n/** Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.\r\n * @public\r\n */\r\nexport class ElementOwnsChildElements extends RelatedElement {\r\n  public static classFullName = \"BisCore:ElementOwnsChildElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = ElementOwnsChildElements.classFullName) {\r\n    super({ id: parentId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a parent [[Subject]] to [[Subject]] child elements.\r\n * @public\r\n */\r\nexport class SubjectOwnsSubjects extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:SubjectOwnsSubjects\";\r\n  public constructor(parentId: Id64String, relClassName: string = SubjectOwnsSubjects.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[Subject]] to [[InformationPartitionElement]] child elements.\r\n * @public\r\n */\r\nexport class SubjectOwnsPartitionElements extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:SubjectOwnsPartitionElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = SubjectOwnsPartitionElements.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[Category]] to [[SubCategory]] child elements.\r\n * @public\r\n */\r\nexport class CategoryOwnsSubCategories extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:CategoryOwnsSubCategories\";\r\n  public constructor(parentId: Id64String, relClassName: string = CategoryOwnsSubCategories.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[RenderMaterial]] to [[RenderMaterial]] child elements.\r\n * @public\r\n */\r\nexport class RenderMaterialOwnsRenderMaterials extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:RenderMaterialOwnsRenderMaterials\";\r\n  public constructor(parentId: Id64String, relClassName: string = RenderMaterialOwnsRenderMaterials.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent Element to child Elements which represent **hidden** parts of the Entity.\r\n * @public\r\n */\r\nexport class ElementEncapsulatesElements extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:ElementEncapsulatesElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = ElementEncapsulatesElements.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[PhysicalElement]] to [[PhysicalElement]] children that it assembles.\r\n * @public\r\n */\r\nexport class PhysicalElementAssemblesElements extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:PhysicalElementAssemblesElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = PhysicalElementAssemblesElements.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[ExternalSource]] to its [[ExternalSourceAttachment]] children.\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 ExternalSourceOwnsAttachments extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:ExternalSourceOwnsAttachments\";\r\n  public constructor(parentId: Id64String, relClassName: string = ExternalSourceOwnsAttachments.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[FolderLink]] to its [[RepositoryLink]] children.\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 FolderContainsRepositories extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:FolderContainsRepositories\";\r\n  public constructor(parentId: Id64String, relClassName: string = FolderContainsRepositories.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[GeometricElement2d]] to its [[TypeDefinitionElement]]\r\n * @public\r\n */\r\nexport class GeometricElement2dHasTypeDefinition extends TypeDefinition {\r\n  public static classFullName = \"BisCore:GeometricElement2dHasTypeDefinition\";\r\n  public constructor(id: Id64String, relClassName: string = GeometricElement2dHasTypeDefinition.classFullName) {\r\n    super({ id, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a [[GraphicalElement2d]] to its [[GraphicalType2d]]\r\n * @public\r\n */\r\nexport class GraphicalElement2dIsOfType extends GeometricElement2dHasTypeDefinition {\r\n  public static override classFullName = \"BisCore:GraphicalElement2dIsOfType\";\r\n  public constructor(id: Id64String, relClassName: string = GraphicalElement2dIsOfType.classFullName) {\r\n    super(id, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[GeometricElement3d]] to its [[TypeDefinitionElement]]\r\n * @public\r\n */\r\nexport class GeometricElement3dHasTypeDefinition extends TypeDefinition {\r\n  public static classFullName = \"BisCore:GeometricElement3dHasTypeDefinition\";\r\n  public constructor(id: Id64String, relClassName: string = GeometricElement3dHasTypeDefinition.classFullName) {\r\n    super({ id, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a [[SpatialLocationElement]] to its [[SpatialLocationType]]\r\n * @public\r\n */\r\nexport class SpatialLocationIsOfType extends GeometricElement3dHasTypeDefinition {\r\n  public static override classFullName = \"BisCore:SpatialLocationIsOfType\";\r\n  public constructor(id: Id64String, relClassName: string = SpatialLocationIsOfType.classFullName) {\r\n    super(id, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[PhysicalElement]] to its [[PhysicalType]]\r\n * @public\r\n */\r\nexport class PhysicalElementIsOfType extends GeometricElement3dHasTypeDefinition {\r\n  public static override classFullName = \"BisCore:PhysicalElementIsOfType\";\r\n  public constructor(id: Id64String, relClassName: string = PhysicalElementIsOfType.classFullName) {\r\n    super(id, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[PhysicalElement]] to its [[PhysicalMaterial]]\r\n * @public\r\n */\r\nexport class PhysicalElementIsOfPhysicalMaterial extends RelatedElement {\r\n  public static classFullName = \"BisCore:PhysicalElementIsOfPhysicalMaterial\";\r\n  public constructor(id: Id64String) {\r\n    super({ id });\r\n  }\r\n}\r\n\r\n/** Relates a [[PhysicalType]] to its [[PhysicalMaterial]]\r\n * @public\r\n */\r\nexport class PhysicalTypeIsOfPhysicalMaterial extends RelatedElement {\r\n  public static classFullName = \"BisCore:PhysicalTypeIsOfPhysicalMaterial\";\r\n  public constructor(id: Id64String) {\r\n    super({ id });\r\n  }\r\n}\r\n\r\n/** Relates an [[Element]] and an [[ElementUniqueAspect]] that it owns.\r\n * @public\r\n */\r\nexport class ElementOwnsUniqueAspect extends RelatedElement {\r\n  public static classFullName = \"BisCore:ElementOwnsUniqueAspect\";\r\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsUniqueAspect.classFullName) {\r\n    super({ id: elementId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates an [[Element]] and an [[ElementMultiAspect]] that it owns.\r\n * @public\r\n */\r\nexport class ElementOwnsMultiAspects extends RelatedElement {\r\n  public static classFullName = \"BisCore:ElementOwnsMultiAspects\";\r\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsMultiAspects.classFullName) {\r\n    super({ id: elementId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates an [[Element]] and an [[ExternalSourceAspect]] that it owns.\r\n * @public\r\n */\r\nexport class ElementOwnsExternalSourceAspects extends ElementOwnsMultiAspects {\r\n  public static override classFullName = \"BisCore:ElementOwnsExternalSourceAspects\";\r\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsExternalSourceAspects.classFullName) {\r\n    super(elementId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.\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 ExternalSourceIsInRepository extends RelatedElement {\r\n  public static classFullName = \"BisCore:ExternalSourceIsInRepository\";\r\n  public constructor(repositoryId: Id64String, relClassName: string = ExternalSourceIsInRepository.classFullName) {\r\n    super({ id: repositoryId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.\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 ExternalSourceAttachmentAttachesSource extends RelatedElement {\r\n  public static classFullName = \"BisCore:ExternalSourceAttachmentAttachesSource\";\r\n  public constructor(externalSourceId: Id64String, relClassName: string = ExternalSourceAttachmentAttachesSource.classFullName) {\r\n    super({ id: externalSourceId, relClassName });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NavigationRelationship.js","sourceRoot":"","sources":["../../src/NavigationRelationship.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH,oDAAoE;AAEpE;;GAEG;AACH,MAAa,wBAAyB,SAAQ,4BAAc;IAE1D,YAAmB,QAAoB,EAAE,eAAuB,wBAAwB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IACxC,CAAC;;AAJH,4DAKC;AAJe,sCAAa,GAAG,kCAAkC,CAAC;AAMnE;;GAEG;AACH,MAAa,mBAAoB,SAAQ,wBAAwB;IAE/D,YAAmB,QAAoB,EAAE,eAAuB,mBAAmB,CAAC,aAAa;QAC/F,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,kDAKC;AAJwB,iCAAa,GAAG,6BAA6B,CAAC;AAMvE;;GAEG;AACH,MAAa,4BAA6B,SAAQ,wBAAwB;IAExE,YAAmB,QAAoB,EAAE,eAAuB,4BAA4B,CAAC,aAAa;QACxG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,oEAKC;AAJwB,0CAAa,GAAG,sCAAsC,CAAC;AAMhF;;GAEG;AACH,MAAa,yBAA0B,SAAQ,wBAAwB;IAErE,YAAmB,QAAoB,EAAE,eAAuB,yBAAyB,CAAC,aAAa;QACrG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,8DAKC;AAJwB,uCAAa,GAAG,mCAAmC,CAAC;AAM7E;;GAEG;AACH,MAAa,iCAAkC,SAAQ,wBAAwB;IAE7E,YAAmB,QAAoB,EAAE,eAAuB,iCAAiC,CAAC,aAAa;QAC7G,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,8EAKC;AAJwB,+CAAa,GAAG,2CAA2C,CAAC;AAMrF;;GAEG;AACH,MAAa,2BAA4B,SAAQ,wBAAwB;IAEvE,YAAmB,QAAoB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACvG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,kEAKC;AAJwB,yCAAa,GAAG,qCAAqC,CAAC;AAM/E;;GAEG;AACH,MAAa,gCAAiC,SAAQ,wBAAwB;IAE5E,YAAmB,QAAoB,EAAE,eAAuB,gCAAgC,CAAC,aAAa;QAC5G,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,4EAKC;AAJwB,8CAAa,GAAG,0CAA0C,CAAC;AAMpF;;;GAGG;AACH,MAAa,6BAA8B,SAAQ,wBAAwB;IAEzE,YAAmB,QAAoB,EAAE,eAAuB,6BAA6B,CAAC,aAAa;QACzG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,sEAKC;AAJwB,2CAAa,GAAG,uCAAuC,CAAC;AAMjF;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,wBAAwB;IAEtE,YAAmB,QAAoB,EAAE,eAAuB,0BAA0B,CAAC,aAAa;QACtG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAJH,gEAKC;AAJwB,wCAAa,GAAG,oCAAoC,CAAC;AAM9E;;GAEG;AACH,MAAa,2BAA4B,SAAQ,wBAAwB;IAEvE,YAAmB,QAAoB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACvG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAE,CAAC;IACjC,CAAC;;AAJH,kEAKC;AAJwB,yCAAa,GAAG,qCAAqC,CAAC;AAM/E;;GAEG;AACH,MAAa,qBAAsB,SAAQ,wBAAwB;IAEjE,YAAmB,QAAoB,EAAE,eAAuB,qBAAqB,CAAC,aAAa;QACjG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAE,CAAC;IACjC,CAAC;;AAJH,sDAKC;AAJwB,mCAAa,GAAG,+BAA+B,CAAC;AAMzE;;GAEG;AACH,MAAa,mCAAoC,SAAQ,4BAAc;IAErE,YAAmB,EAAc,EAAE,eAAuB,mCAAmC,CAAC,aAAa;QACzG,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9B,CAAC;;AAJH,kFAKC;AAJe,iDAAa,GAAG,6CAA6C,CAAC;AAM9E;;GAEG;AACH,MAAa,0BAA2B,SAAQ,mCAAmC;IAEjF,YAAmB,EAAc,EAAE,eAAuB,0BAA0B,CAAC,aAAa;QAChG,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAJH,gEAKC;AAJwB,wCAAa,GAAG,oCAAoC,CAAC;AAM9E;;GAEG;AACH,MAAa,mCAAoC,SAAQ,4BAAc;IAErE,YAAmB,EAAc,EAAE,eAAuB,mCAAmC,CAAC,aAAa;QACzG,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9B,CAAC;;AAJH,kFAKC;AAJe,iDAAa,GAAG,6CAA6C,CAAC;AAM9E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,mCAAmC;IAE9E,YAAmB,EAAc,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QAC7F,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAJH,0DAKC;AAJwB,qCAAa,GAAG,iCAAiC,CAAC;AAM3E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,mCAAmC;IAE9E,YAAmB,EAAc,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QAC7F,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAJH,0DAKC;AAJwB,qCAAa,GAAG,iCAAiC,CAAC;AAM3E;;GAEG;AACH,MAAa,mCAAoC,SAAQ,4BAAc;IAErE,YAAmB,EAAc;QAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChB,CAAC;;AAJH,kFAKC;AAJe,iDAAa,GAAG,6CAA6C,CAAC;AAM9E;;GAEG;AACH,MAAa,gCAAiC,SAAQ,4BAAc;IAElE,YAAmB,EAAc;QAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChB,CAAC;;AAJH,4EAKC;AAJe,8CAAa,GAAG,0CAA0C,CAAC;AAM3E;;GAEG;AACH,MAAa,uBAAwB,SAAQ,4BAAc;IAEzD,YAAmB,SAAqB,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IACzC,CAAC;;AAJH,0DAKC;AAJe,qCAAa,GAAG,iCAAiC,CAAC;AAMlE;;GAEG;AACH,MAAa,uBAAwB,SAAQ,4BAAc;IAEzD,YAAmB,SAAqB,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IACzC,CAAC;;AAJH,0DAKC;AAJe,qCAAa,GAAG,iCAAiC,CAAC;AAMlE;;GAEG;AACH,MAAa,gCAAiC,SAAQ,uBAAuB;IAE3E,YAAmB,SAAqB,EAAE,eAAuB,gCAAgC,CAAC,aAAa;QAC7G,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACjC,CAAC;;AAJH,4EAKC;AAJwB,8CAAa,GAAG,0CAA0C,CAAC;AAMpF;;;GAGG;AACH,MAAa,4BAA6B,SAAQ,4BAAc;IAE9D,YAAmB,YAAwB,EAAE,eAAuB,4BAA4B,CAAC,aAAa;QAC5G,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;;AAJH,oEAKC;AAJe,0CAAa,GAAG,sCAAsC,CAAC;AAMvE;;;GAGG;AACH,MAAa,sCAAuC,SAAQ,4BAAc;IAExE,YAAmB,gBAA4B,EAAE,eAAuB,sCAAsC,CAAC,aAAa;QAC1H,KAAK,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,YAAY,EAAE,CAAC,CAAC;IAChD,CAAC;;AAJH,wFAKC;AAJe,oDAAa,GAAG,gDAAgD,CAAC;AAMjF;;GAEG;AACH,MAAa,2BAA4B,SAAQ,4BAAc;IAE7D,YAAmB,OAAmB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACtG,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IACvC,CAAC;;AAJH,kEAKC;AAJe,yCAAa,GAAG,qCAAqC,CAAC;AAMtE;;GAEG;AACH,MAAa,qCAAsC,SAAQ,4BAAc;IAEvE,YAAmB,YAAwB,EAAE,eAAuB,qCAAqC,CAAC,aAAa;QACrH,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;;AAJH,sFAKC;AAJe,mDAAa,GAAG,+CAA+C,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 Relationships\r\n */\r\n\r\n// NOTE: A NavigationRelationship is not an Entity, so is not registered in the ClassRegistry.\r\n// NOTE: It does, however, have a classFullName property for consistency with Entity subclasses.\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { RelatedElement, TypeDefinition } from \"@itwin/core-common\";\r\n\r\n/** Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.\r\n * @public\r\n */\r\nexport class ElementOwnsChildElements extends RelatedElement {\r\n  public static classFullName = \"BisCore:ElementOwnsChildElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = ElementOwnsChildElements.classFullName) {\r\n    super({ id: parentId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a parent [[Subject]] to [[Subject]] child elements.\r\n * @public\r\n */\r\nexport class SubjectOwnsSubjects extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:SubjectOwnsSubjects\";\r\n  public constructor(parentId: Id64String, relClassName: string = SubjectOwnsSubjects.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[Subject]] to [[InformationPartitionElement]] child elements.\r\n * @public\r\n */\r\nexport class SubjectOwnsPartitionElements extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:SubjectOwnsPartitionElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = SubjectOwnsPartitionElements.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[Category]] to [[SubCategory]] child elements.\r\n * @public\r\n */\r\nexport class CategoryOwnsSubCategories extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:CategoryOwnsSubCategories\";\r\n  public constructor(parentId: Id64String, relClassName: string = CategoryOwnsSubCategories.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[RenderMaterial]] to [[RenderMaterial]] child elements.\r\n * @public\r\n */\r\nexport class RenderMaterialOwnsRenderMaterials extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:RenderMaterialOwnsRenderMaterials\";\r\n  public constructor(parentId: Id64String, relClassName: string = RenderMaterialOwnsRenderMaterials.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent Element to child Elements which represent **hidden** parts of the Entity.\r\n * @public\r\n */\r\nexport class ElementEncapsulatesElements extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:ElementEncapsulatesElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = ElementEncapsulatesElements.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[PhysicalElement]] to [[PhysicalElement]] children that it assembles.\r\n * @public\r\n */\r\nexport class PhysicalElementAssemblesElements extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:PhysicalElementAssemblesElements\";\r\n  public constructor(parentId: Id64String, relClassName: string = PhysicalElementAssemblesElements.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[ExternalSource]] to its [[ExternalSourceAttachment]] children.\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 ExternalSourceOwnsAttachments extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:ExternalSourceOwnsAttachments\";\r\n  public constructor(parentId: Id64String, relClassName: string = ExternalSourceOwnsAttachments.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a parent [[FolderLink]] to its [[RepositoryLink]] children.\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 FolderContainsRepositories extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:FolderContainsRepositories\";\r\n  public constructor(parentId: Id64String, relClassName: string = FolderContainsRepositories.classFullName) {\r\n    super(parentId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[SheetIndexFolder]] to the [[SheetIndexEntry]]'s that it contains.\r\n * @beta\r\n */\r\nexport class SheetIndexFolderOwnsEntries extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:SheetIndexFolderOwnsEntries\";\r\n  public constructor(parentId: Id64String, relClassName: string = SheetIndexFolderOwnsEntries.classFullName) {\r\n    super(parentId, relClassName );\r\n  }\r\n}\r\n\r\n/** Relates a [[SheetIndex]] to the [SheetIndexEntry]]'s that it contains.\r\n * @beta\r\n */\r\nexport class SheetIndexOwnsEntries extends ElementOwnsChildElements {\r\n  public static override classFullName = \"BisCore:SheetIndexOwnsEntries\";\r\n  public constructor(parentId: Id64String, relClassName: string = SheetIndexOwnsEntries.classFullName) {\r\n    super(parentId, relClassName );\r\n  }\r\n}\r\n\r\n/** Relates a [[GeometricElement2d]] to its [[TypeDefinitionElement]]\r\n * @public\r\n */\r\nexport class GeometricElement2dHasTypeDefinition extends TypeDefinition {\r\n  public static classFullName = \"BisCore:GeometricElement2dHasTypeDefinition\";\r\n  public constructor(id: Id64String, relClassName: string = GeometricElement2dHasTypeDefinition.classFullName) {\r\n    super({ id, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a [[GraphicalElement2d]] to its [[GraphicalType2d]]\r\n * @public\r\n */\r\nexport class GraphicalElement2dIsOfType extends GeometricElement2dHasTypeDefinition {\r\n  public static override classFullName = \"BisCore:GraphicalElement2dIsOfType\";\r\n  public constructor(id: Id64String, relClassName: string = GraphicalElement2dIsOfType.classFullName) {\r\n    super(id, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[GeometricElement3d]] to its [[TypeDefinitionElement]]\r\n * @public\r\n */\r\nexport class GeometricElement3dHasTypeDefinition extends TypeDefinition {\r\n  public static classFullName = \"BisCore:GeometricElement3dHasTypeDefinition\";\r\n  public constructor(id: Id64String, relClassName: string = GeometricElement3dHasTypeDefinition.classFullName) {\r\n    super({ id, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a [[SpatialLocationElement]] to its [[SpatialLocationType]]\r\n * @public\r\n */\r\nexport class SpatialLocationIsOfType extends GeometricElement3dHasTypeDefinition {\r\n  public static override classFullName = \"BisCore:SpatialLocationIsOfType\";\r\n  public constructor(id: Id64String, relClassName: string = SpatialLocationIsOfType.classFullName) {\r\n    super(id, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[PhysicalElement]] to its [[PhysicalType]]\r\n * @public\r\n */\r\nexport class PhysicalElementIsOfType extends GeometricElement3dHasTypeDefinition {\r\n  public static override classFullName = \"BisCore:PhysicalElementIsOfType\";\r\n  public constructor(id: Id64String, relClassName: string = PhysicalElementIsOfType.classFullName) {\r\n    super(id, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates a [[PhysicalElement]] to its [[PhysicalMaterial]]\r\n * @public\r\n */\r\nexport class PhysicalElementIsOfPhysicalMaterial extends RelatedElement {\r\n  public static classFullName = \"BisCore:PhysicalElementIsOfPhysicalMaterial\";\r\n  public constructor(id: Id64String) {\r\n    super({ id });\r\n  }\r\n}\r\n\r\n/** Relates a [[PhysicalType]] to its [[PhysicalMaterial]]\r\n * @public\r\n */\r\nexport class PhysicalTypeIsOfPhysicalMaterial extends RelatedElement {\r\n  public static classFullName = \"BisCore:PhysicalTypeIsOfPhysicalMaterial\";\r\n  public constructor(id: Id64String) {\r\n    super({ id });\r\n  }\r\n}\r\n\r\n/** Relates an [[Element]] and an [[ElementUniqueAspect]] that it owns.\r\n * @public\r\n */\r\nexport class ElementOwnsUniqueAspect extends RelatedElement {\r\n  public static classFullName = \"BisCore:ElementOwnsUniqueAspect\";\r\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsUniqueAspect.classFullName) {\r\n    super({ id: elementId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates an [[Element]] and an [[ElementMultiAspect]] that it owns.\r\n * @public\r\n */\r\nexport class ElementOwnsMultiAspects extends RelatedElement {\r\n  public static classFullName = \"BisCore:ElementOwnsMultiAspects\";\r\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsMultiAspects.classFullName) {\r\n    super({ id: elementId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates an [[Element]] and an [[ExternalSourceAspect]] that it owns.\r\n * @public\r\n */\r\nexport class ElementOwnsExternalSourceAspects extends ElementOwnsMultiAspects {\r\n  public static override classFullName = \"BisCore:ElementOwnsExternalSourceAspects\";\r\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsExternalSourceAspects.classFullName) {\r\n    super(elementId, relClassName);\r\n  }\r\n}\r\n\r\n/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.\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 ExternalSourceIsInRepository extends RelatedElement {\r\n  public static classFullName = \"BisCore:ExternalSourceIsInRepository\";\r\n  public constructor(repositoryId: Id64String, relClassName: string = ExternalSourceIsInRepository.classFullName) {\r\n    super({ id: repositoryId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.\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 ExternalSourceAttachmentAttachesSource extends RelatedElement {\r\n  public static classFullName = \"BisCore:ExternalSourceAttachmentAttachesSource\";\r\n  public constructor(externalSourceId: Id64String, relClassName: string = ExternalSourceAttachmentAttachesSource.classFullName) {\r\n    super({ id: externalSourceId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a [[SheetReference]] and [[Sheet]] that it refers.\r\n * @beta\r\n */\r\nexport class SheetReferenceRefersToSheet extends RelatedElement {\r\n  public static classFullName = \"BisCore:SheetReferenceRefersToSheet\";\r\n  public constructor(sheetId: Id64String, relClassName: string = SheetReferenceRefersToSheet.classFullName) {\r\n    super({ id: sheetId, relClassName });\r\n  }\r\n}\r\n\r\n/** Relates a [[SheetIndexReference]] to a [[SheetIndex]] it refers.\r\n * @beta\r\n */\r\nexport class SheetIndexReferenceRefersToSheetIndex extends RelatedElement {\r\n  public static classFullName = \"BisCore:SheetIndexReferenceRefersToSheetIndex\";\r\n  public constructor(sheetIndexId: Id64String, relClassName: string = SheetIndexReferenceRefersToSheetIndex.classFullName) {\r\n    super({ id: sheetIndexId, relClassName });\r\n  }\r\n}\r\n"]}

package/lib/cjs/SchemaSync.d.ts

@@ -24,6 +24,7 @@ export declare namespace SchemaSync {
     const withReadonlyAccess: (iModel: IModelDb | {
         readonly fileName: LocalFileName;
     }, operation: (access: CloudAccess) => Promise<void>) => Promise<void>;
+    const isEnabled: (iModel: IModelDb) => boolean;
     /** Synchronize local briefcase schemas with cloud container */
     const pull: (iModel: IModelDb) => Promise<void>;
     const initializeForIModel: (arg: {

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaSync.d.ts","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAe,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAY,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAe,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKhE,gBAAgB;AAChB,yBAAiB,UAAU,CAAC;IAG1B,kFAAkF;IAClF,MAAa,YAAa,SAAQ,iBAAiB;QACjD,SAAyB,SAAS,WAAW;kBAC1B,SAAS;KAC7B;IAMM,MAAM,YAAY,WAAY,QAAQ,cAAc,MAAM,SAKhE,CAAC;IA+BK,MAAM,gBAAgB,WAAkB,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,QAAQ;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,sBAAsB,WAAW,KAAK,QAAQ,IAAI,CAAC,KAAG,QAAQ,IAAI,CAOpO,CAAC;IAEK,MAAM,kBAAkB,WAAkB,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,sBAAsB,WAAW,KAAK,QAAQ,IAAI,CAAC,KAAG,QAAQ,IAAI,CASjK,CAAC;IAEF,+DAA+D;IACxD,MAAM,IAAI,WAAkB,QAAQ,kBAS1C,CAAC;IAEK,MAAM,mBAAmB,QAAe;QAAE,MAAM,EAAE,QAAQ,CAAC;QAAC,cAAc,EAAE,YAAY,cAAc,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE,kBA6B3I,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;oBAC9C,KAAK,EAAE,WAAW,CAAC,oBAAoB;QAInD,MAAM;QAGb;;;;SAIC;eACmB,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc;KAGnE;CACF"}
+{"version":3,"file":"SchemaSync.d.ts","sourceRoot":"","sources":["../../src/SchemaSync.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAe,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAY,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAe,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKhE,gBAAgB;AAChB,yBAAiB,UAAU,CAAC;IAG1B,kFAAkF;IAClF,MAAa,YAAa,SAAQ,iBAAiB;QACjD,SAAyB,SAAS,WAAW;kBAC1B,SAAS;KAC7B;IAMM,MAAM,YAAY,WAAY,QAAQ,cAAc,MAAM,SAKhE,CAAC;IA+BK,MAAM,gBAAgB,WAAkB,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,QAAQ;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,sBAAsB,WAAW,KAAK,QAAQ,IAAI,CAAC,KAAG,QAAQ,IAAI,CAOpO,CAAC;IAEK,MAAM,kBAAkB,WAAkB,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,sBAAsB,WAAW,KAAK,QAAQ,IAAI,CAAC,KAAG,QAAQ,IAAI,CASjK,CAAC;IAEK,MAAM,SAAS,WAAY,QAAQ,YAEzC,CAAC;IAEF,+DAA+D;IACxD,MAAM,IAAI,WAAkB,QAAQ,kBAS1C,CAAC;IAEK,MAAM,mBAAmB,QAAe;QAAE,MAAM,EAAE,QAAQ,CAAC;QAAC,cAAc,EAAE,YAAY,cAAc,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE,kBA6B3I,CAAC;IAEF,0EAA0E;IAC1E,MAAa,WAAY,SAAQ,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;oBAC9C,KAAK,EAAE,WAAW,CAAC,oBAAoB;QAInD,MAAM;QAGb;;;;SAIC;eACmB,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,cAAc;KAGnE;CACF"}

package/lib/cjs/SchemaSync.js

@@ -87,6 +87,9 @@ var SchemaSync;
             access.close();
         }
     };
+    SchemaSync.isEnabled = (iModel) => {
+        return iModel[Symbols_1._nativeDb].schemaSyncEnabled();
+    };
     /** Synchronize local briefcase schemas with cloud container */
     SchemaSync.pull = async (iModel) => {
         if (iModel[Symbols_1._nativeDb].schemaSyncEnabled() && !iModel.isReadonly) {

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,CAkI1B;AAlID,WAAiB,UAAU;IACzB,MAAM,UAAU,GAAiC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEtF,kFAAkF;IAClF,MAAa,YAAa,SAAQ,4BAAiB;QAAnD;;YAC2B,cAAS,GAAG,OAAO,CAAC;QAE/C,CAAC;QADoB,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,cAAuB,CAAC;IAC9C,MAAM,oBAAoB,GAAG,6BAAsC,CAAC;IACpE,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;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,EAlIgB,UAAU,0BAAV,UAAU,QAkI1B","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\" as const;\r\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\" as const;\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  /** 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;QAAnD;;YAC2B,cAAS,GAAG,OAAO,CAAC;QAE/C,CAAC;QADoB,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,cAAuB,CAAC;IAC9C,MAAM,oBAAoB,GAAG,6BAAsC,CAAC;IACpE,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\" as const;\r\n  const testSyncCachePropKey = \"test.schema_sync.cache_name\" as const;\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"]}

package/lib/cjs/SheetIndex.d.ts

@@ -0,0 +1,148 @@
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Code, CodeScopeProps, EntityReferenceSet, RelatedElementProps, SheetIndexEntryProps, SheetIndexReferenceProps, SheetReferenceProps } from "@itwin/core-common";
+import { InformationReferenceElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+import { Id64String } from "@itwin/core-bentley";
+import { SheetIndexReferenceRefersToSheetIndex, SheetReferenceRefersToSheet } from "./NavigationRelationship";
+/** Arguments used to create a [[SheetIndexEntry]].
+ * @beta
+ */
+export interface SheetIndexEntryCreateArgs {
+    /** The iModel that will contain the sheet index entry. */
+    iModelDb: IModelDb;
+    /** The Id of the [[SheetIndexModel]] that will contain the sheet index entry. */
+    sheetIndexModelId: Id64String;
+    /** The [[SheetIndex]] or [[SheetIndexFolder]] that is parent to this SheetIndexEntry */
+    parentId: Id64String;
+    /** The name of the SheetIndexEntry */
+    name: string;
+    /** The priority of the SheetIndexEntry */
+    priority: number;
+}
+/** Arguments supplied when creating a [[SheetIndexReference]].
+ * @beta
+ */
+export interface SheetIndexReferenceCreateArgs extends SheetIndexEntryCreateArgs {
+    /** The [[SheetIndex]] to which the reference refers. */
+    sheetIndexId?: Id64String;
+}
+/** Arguments supplied when creating a [[SheetReference]].
+ * @beta
+ */
+export interface SheetReferenceCreateArgs extends SheetIndexEntryCreateArgs {
+    /** The [[Sheet]] to which the reference refers. */
+    sheetId?: Id64String;
+}
+/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.
+ * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating
+ * sub-trees via [[SheetIndexReference]]s.
+ * @beta
+ */
+export declare class SheetIndex extends InformationReferenceElement {
+    static get className(): string;
+    /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.
+     * @param iModel  The IModelDb
+     * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.
+     * @param codeValue The SheetIndex name
+     */
+    static createCode(iModel: IModelDb, scopeSheetIndexModelId: CodeScopeProps, codeValue: string): Code;
+    /** Create a SheetIndex
+     * @param iModelDb The IModelDb
+     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
+     * @param name The name (codeValue) of the SheetIndex
+     * @returns The newly constructed SheetIndex
+     * @throws [[IModelError]] if there is a problem creating the SheetIndex
+     */
+    static create(iModelDb: IModelDb, modelId: Id64String, name: string): SheetIndex;
+    /** Insert a SheetIndex
+     * @param iModelDb The IModelDb
+     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
+     * @param name The name (codeValue) of the SheetIndex
+     * @returns The Id of the newly inserted SheetIndex
+     * @throws [[IModelError]] if there is a problem inserting the SheetIndex
+     */
+    static insert(iModelDb: IModelDb, modelId: Id64String, name: string): Id64String;
+}
+/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.
+ * @beta
+*/
+export declare abstract class SheetIndexEntry extends InformationReferenceElement {
+    static get className(): string;
+    /** Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder. */
+    entryPriority: number;
+    protected constructor(props: SheetIndexEntryProps, iModel: IModelDb);
+    toJSON(): SheetIndexEntryProps;
+    /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.
+     * @param codeValue The name of the entry
+     */
+    static createCode(iModelDb: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code;
+    protected static createParentRelationshipProps(iModelDb: IModelDb, id: Id64String): RelatedElementProps;
+    protected static createProps(arg: SheetIndexEntryCreateArgs): SheetIndexEntryProps;
+}
+/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].
+ * @beta
+ */
+export declare class SheetIndexFolder extends SheetIndexEntry {
+    static get className(): string;
+    /** Create a new SheetIndexFolder
+     * @returns The newly constructed SheetIndexFolder element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg: SheetIndexEntryCreateArgs): SheetIndexFolder;
+    /** Create a new SheetIndexFolder
+     * @returns The Id of the newly inserted SheetIndexFolder element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg: SheetIndexEntryCreateArgs): Id64String;
+}
+/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.
+ * @beta
+*/
+export declare class SheetIndexReference extends SheetIndexEntry {
+    static get className(): string;
+    /** The bis:SheetIndex that this bis:SheetIndexReference is pointing to. */
+    sheetIndex?: SheetIndexReferenceRefersToSheetIndex;
+    protected constructor(props: SheetIndexReferenceProps, iModel: IModelDb);
+    protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps;
+    toJSON(): SheetIndexReferenceProps;
+    /** Create a new SheetIndexReference
+     * @returns The newly constructed SheetIndexReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg: SheetIndexReferenceCreateArgs): SheetIndexReference;
+    /** Create a new SheetIndexReference
+     * @returns The Id of the newly inserted SheetIndexReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg: SheetIndexReferenceCreateArgs): Id64String;
+    /** @alpha */
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+}
+/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].
+ * @beta
+*/
+export declare class SheetReference extends SheetIndexEntry {
+    static get className(): string;
+    /** The bis:Sheet that this bis:SheetReference is pointing to. */
+    sheet: SheetReferenceRefersToSheet | undefined;
+    protected constructor(props: SheetReferenceProps, iModel: IModelDb);
+    protected static createReferenceRelationshipProps(id: Id64String): RelatedElementProps;
+    toJSON(): SheetReferenceProps;
+    /** Create a new SheetReference
+     * @returns The newly constructed SheetReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg: SheetReferenceCreateArgs): SheetReference;
+    /** Insert a new SheetReference
+     * @returns The Id of the newly inserted SheetReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg: SheetReferenceCreateArgs): Id64String;
+    /** @alpha */
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+}
+//# sourceMappingURL=SheetIndex.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SheetIndex.d.ts","sourceRoot":"","sources":["../../src/SheetIndex.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAe,IAAI,EAAE,cAAc,EAA0B,kBAAkB,EAAe,mBAAmB,EAAE,oBAAoB,EAAyB,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACjP,OAAO,EAAE,2BAA2B,EAAS,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAsD,qCAAqC,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAElK;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0DAA0D;IAC1D,QAAQ,EAAE,QAAQ,CAAC;IACnB,iFAAiF;IACjF,iBAAiB,EAAE,UAAU,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,EAAE,UAAU,CAAC;IACrB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,yBAAyB;IAC9E,wDAAwD;IACxD,YAAY,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,yBAAyB;IACzE,mDAAmD;IACnD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,2BAA2B;IACzD,WAA2B,SAAS,IAAI,MAAM,CAAyB;IAEvE;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,sBAAsB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAK3G;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IASvF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAMxF;AAED;;EAEE;AACF,8BAAsB,eAAgB,SAAQ,2BAA2B;IACvE,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAC5E,0FAA0F;IACnF,aAAa,EAAE,MAAM,CAAC;IAE7B,SAAS,aAAa,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,QAAQ;IAKnD,MAAM,IAAI,oBAAoB;IAI9C;;;;OAIG;WACW,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKnG,SAAS,CAAC,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAOvG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,yBAAyB;CAW5D;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB;IAKnD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,yBAAyB,GAAG,UAAU;CAMjE;AAED;;EAEE;AACF,qBAAa,mBAAoB,SAAQ,eAAe;IACtD,WAA2B,SAAS,IAAI,MAAM,CAAkC;IAEhF,2EAA2E;IACpE,UAAU,CAAC,EAAE,qCAAqC,CAAC;IAE1D,SAAS,aAAa,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,QAAQ;IAWvE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,wBAAwB;IAOlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B;IAQvD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,6BAA6B,GAAG,UAAU;IAOpE,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E;AAED;;EAEE;AACF,qBAAa,cAAe,SAAQ,eAAe;IACjD,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,iEAAiE;IAC1D,KAAK,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAEtD,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAWlE,SAAS,CAAC,MAAM,CAAC,gCAAgC,CAAC,EAAE,EAAE,UAAU,GAAG,mBAAmB;IAItE,MAAM,IAAI,mBAAmB;IAO7C;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB;IAQlD;;;OAGG;WACW,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,UAAU;IAO/D,aAAa;cACM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAK/E"}

package/lib/cjs/SheetIndex.js

@@ -0,0 +1,230 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Elements
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SheetReference = exports.SheetIndexReference = exports.SheetIndexFolder = exports.SheetIndexEntry = exports.SheetIndex = void 0;
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("./Element");
+const core_bentley_1 = require("@itwin/core-bentley");
+const NavigationRelationship_1 = require("./NavigationRelationship");
+/** A [structured collection]($docs/bis/domains/drawings-sheets#sheet-index) of [[SheetIndexEntry]]s.
+ * The sheet index is a tree whose leaf nodes refer to [[Sheet]]s, optionally grouped by [[SheetIndexFolder]]s and/or incorporating
+ * sub-trees via [[SheetIndexReference]]s.
+ * @beta
+ */
+class SheetIndex extends Element_1.InformationReferenceElement {
+    static get className() { return "SheetIndex"; }
+    /** Create a Code for a SheetIndex given a name that is meant to be unique within the scope of the specified SheetIndexModel.
+     * @param iModel  The IModelDb
+     * @param scopeSheetIndexModelId The Id of the Model that contains the LinkElement and provides the scope for its name.
+     * @param codeValue The SheetIndex name
+     */
+    static createCode(iModel, scopeSheetIndexModelId, codeValue) {
+        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.sheetIndex);
+        return new core_common_1.Code({ spec: codeSpec.id, scope: scopeSheetIndexModelId, value: codeValue });
+    }
+    /** Create a SheetIndex
+     * @param iModelDb The IModelDb
+     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
+     * @param name The name (codeValue) of the SheetIndex
+     * @returns The newly constructed SheetIndex
+     * @throws [[IModelError]] if there is a problem creating the SheetIndex
+     */
+    static create(iModelDb, modelId, name) {
+        const props = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, modelId, name).toJSON(),
+            model: modelId,
+        };
+        return new this(props, iModelDb);
+    }
+    /** Insert a SheetIndex
+     * @param iModelDb The IModelDb
+     * @param modelId The Id of the Model that contains the SheetIndex and provides the scope for its name.
+     * @param name The name (codeValue) of the SheetIndex
+     * @returns The Id of the newly inserted SheetIndex
+     * @throws [[IModelError]] if there is a problem inserting the SheetIndex
+     */
+    static insert(iModelDb, modelId, name) {
+        const instance = this.create(iModelDb, modelId, name);
+        const elements = iModelDb.elements;
+        instance.id = elements.insertElement(instance.toJSON());
+        return instance.id;
+    }
+}
+exports.SheetIndex = SheetIndex;
+/** The base class for all elements that can participate in a [[SheetIndex]] hierarchy.
+ * @beta
+*/
+class SheetIndexEntry extends Element_1.InformationReferenceElement {
+    static get className() { return "SheetIndexEntry"; }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.entryPriority = props.entryPriority;
+    }
+    toJSON() {
+        return { ...super.toJSON(), entryPriority: this.entryPriority };
+    }
+    /** Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.
+     * @param iModel  The IModel
+     * @param scopeModelId The Id of the [[SheetIndexModel]] that contains the [[SheetIndexEntry]] and provides the scope for its name.
+     * @param codeValue The name of the entry
+     */
+    static createCode(iModelDb, scopeModelId, codeValue) {
+        const codeSpec = iModelDb.codeSpecs.getByName(core_common_1.BisCodeSpec.sheetIndexEntry);
+        return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+    static createParentRelationshipProps(iModelDb, id) {
+        const parentElementProps = iModelDb.elements.getElementProps(id);
+        const isFolder = parentElementProps.classFullName === SheetIndexFolder.classFullName;
+        const relClass = isFolder ? NavigationRelationship_1.SheetIndexFolderOwnsEntries : NavigationRelationship_1.SheetIndexOwnsEntries;
+        return { id, relClassName: relClass.classFullName };
+    }
+    static createProps(arg) {
+        const parent = this.createParentRelationshipProps(arg.iModelDb, arg.parentId);
+        const props = {
+            classFullName: this.classFullName,
+            model: arg.sheetIndexModelId,
+            code: this.createCode(arg.iModelDb, arg.sheetIndexModelId, arg.name),
+            entryPriority: arg.priority,
+            parent,
+        };
+        return props;
+    }
+}
+exports.SheetIndexEntry = SheetIndexEntry;
+/** A container used to group [[SheetIndexEntry]]s within a [[SheetIndex]].
+ * @beta
+ */
+class SheetIndexFolder extends SheetIndexEntry {
+    static get className() { return "SheetIndexFolder"; }
+    /** Create a new SheetIndexFolder
+     * @returns The newly constructed SheetIndexFolder element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg) {
+        const props = this.createProps(arg);
+        return new this(props, arg.iModelDb);
+    }
+    /** Create a new SheetIndexFolder
+     * @returns The Id of the newly inserted SheetIndexFolder element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg) {
+        const instance = this.create(arg);
+        const elements = arg.iModelDb.elements;
+        instance.id = elements.insertElement(instance.toJSON());
+        return instance.id;
+    }
+}
+exports.SheetIndexFolder = SheetIndexFolder;
+/** A node within one [[SheetIndex]] that incorporates another [[SheetIndex]] as a sub-tree.
+ * @beta
+*/
+class SheetIndexReference extends SheetIndexEntry {
+    static get className() { return "SheetIndexReference"; }
+    constructor(props, iModel) {
+        super(props, iModel);
+        if (props.sheetIndex) {
+            const sheetIndex = iModel.elements.tryGetElement(props.sheetIndex.id);
+            if (!sheetIndex)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "SheetIndex not found");
+            this.sheetIndex = new NavigationRelationship_1.SheetIndexReferenceRefersToSheetIndex(props.sheetIndex.id);
+        }
+    }
+    static createReferenceRelationshipProps(id) {
+        return { id, relClassName: NavigationRelationship_1.SheetIndexReferenceRefersToSheetIndex.classFullName };
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            sheetIndex: this.sheetIndex ? this.sheetIndex.toJSON() : undefined,
+        };
+    }
+    /** Create a new SheetIndexReference
+     * @returns The newly constructed SheetIndexReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg) {
+        const props = {
+            ...this.createProps(arg),
+            sheetIndex: arg.sheetIndexId ? this.createReferenceRelationshipProps(arg.sheetIndexId) : undefined,
+        };
+        return new this(props, arg.iModelDb);
+    }
+    /** Create a new SheetIndexReference
+     * @returns The Id of the newly inserted SheetIndexReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg) {
+        const instance = this.create(arg);
+        const elements = arg.iModelDb.elements;
+        instance.id = elements.insertElement(instance.toJSON());
+        return instance.id;
+    }
+    /** @alpha */
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        if (this.sheetIndex)
+            referenceIds.addElement(this.sheetIndex.id);
+    }
+}
+exports.SheetIndexReference = SheetIndexReference;
+/** A leaf node in a [[SheetIndex]] that refers to a specific [[Sheet]].
+ * @beta
+*/
+class SheetReference extends SheetIndexEntry {
+    static get className() { return "SheetReference"; }
+    constructor(props, iModel) {
+        super(props, iModel);
+        if (props.sheet) {
+            const sheet = iModel.elements.tryGetElement(props.sheet.id);
+            if (!sheet)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "Sheet not found");
+            this.sheet = new NavigationRelationship_1.SheetReferenceRefersToSheet(sheet.id);
+        }
+    }
+    static createReferenceRelationshipProps(id) {
+        return { id, relClassName: NavigationRelationship_1.SheetIndexReferenceRefersToSheetIndex.classFullName };
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            sheet: this.sheet ? this.sheet.toJSON() : undefined,
+        };
+    }
+    /** Create a new SheetReference
+     * @returns The newly constructed SheetReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(arg) {
+        const props = {
+            ...this.createProps(arg),
+            sheet: arg.sheetId ? this.createReferenceRelationshipProps(arg.sheetId) : undefined,
+        };
+        return new this(props, arg.iModelDb);
+    }
+    /** Insert a new SheetReference
+     * @returns The Id of the newly inserted SheetReference element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static insert(arg) {
+        const instance = this.create(arg);
+        const elements = arg.iModelDb.elements;
+        instance.id = elements.insertElement(instance.toJSON());
+        return instance.id;
+    }
+    /** @alpha */
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        if (this.sheet)
+            referenceIds.addModel(this.sheet.id);
+    }
+}
+exports.SheetReference = SheetReference;
+//# sourceMappingURL=SheetIndex.js.map