@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/NavigationRelationship.d.ts

@@ -0,0 +1,185 @@
+/** @packageDocumentation
+ * @module Relationships
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { RelatedElement, TypeDefinition } from "@itwin/core-common";
+/** Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.
+ * @public
+ */
+export declare class ElementOwnsChildElements extends RelatedElement {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[Subject]] to [[Subject]] child elements.
+ * @public
+ */
+export declare class SubjectOwnsSubjects extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[Subject]] to [[InformationPartitionElement]] child elements.
+ * @public
+ */
+export declare class SubjectOwnsPartitionElements extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[Category]] to [[SubCategory]] child elements.
+ * @public
+ */
+export declare class CategoryOwnsSubCategories extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[RenderMaterial]] to [[RenderMaterial]] child elements.
+ * @public
+ */
+export declare class RenderMaterialOwnsRenderMaterials extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent Element to child Elements which represent **hidden** parts of the Entity.
+ * @public
+ */
+export declare class ElementEncapsulatesElements extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[PhysicalElement]] to [[PhysicalElement]] children that it assembles.
+ * @public
+ */
+export declare class PhysicalElementAssemblesElements extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[ExternalSource]] to its [[ExternalSourceAttachment]] children.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export declare class ExternalSourceOwnsAttachments extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a parent [[FolderLink]] to its [[RepositoryLink]] children.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export declare class FolderContainsRepositories extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a [[SheetIndexFolder]] to the [[SheetIndexEntry]]'s that it contains.
+ * @beta
+ */
+export declare class SheetIndexFolderOwnsEntries extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a [[SheetIndex]] to the [SheetIndexEntry]]'s that it contains.
+ * @beta
+ */
+export declare class SheetIndexOwnsEntries extends ElementOwnsChildElements {
+    static classFullName: string;
+    constructor(parentId: Id64String, relClassName?: string);
+}
+/** Relates a [[GeometricElement2d]] to its [[TypeDefinitionElement]]
+ * @public
+ */
+export declare class GeometricElement2dHasTypeDefinition extends TypeDefinition {
+    static classFullName: string;
+    constructor(id: Id64String, relClassName?: string);
+}
+/** Relates a [[GraphicalElement2d]] to its [[GraphicalType2d]]
+ * @public
+ */
+export declare class GraphicalElement2dIsOfType extends GeometricElement2dHasTypeDefinition {
+    static classFullName: string;
+    constructor(id: Id64String, relClassName?: string);
+}
+/** Relates a [[GeometricElement3d]] to its [[TypeDefinitionElement]]
+ * @public
+ */
+export declare class GeometricElement3dHasTypeDefinition extends TypeDefinition {
+    static classFullName: string;
+    constructor(id: Id64String, relClassName?: string);
+}
+/** Relates a [[SpatialLocationElement]] to its [[SpatialLocationType]]
+ * @public
+ */
+export declare class SpatialLocationIsOfType extends GeometricElement3dHasTypeDefinition {
+    static classFullName: string;
+    constructor(id: Id64String, relClassName?: string);
+}
+/** Relates a [[PhysicalElement]] to its [[PhysicalType]]
+ * @public
+ */
+export declare class PhysicalElementIsOfType extends GeometricElement3dHasTypeDefinition {
+    static classFullName: string;
+    constructor(id: Id64String, relClassName?: string);
+}
+/** Relates a [[PhysicalElement]] to its [[PhysicalMaterial]]
+ * @public
+ */
+export declare class PhysicalElementIsOfPhysicalMaterial extends RelatedElement {
+    static classFullName: string;
+    constructor(id: Id64String);
+}
+/** Relates a [[PhysicalType]] to its [[PhysicalMaterial]]
+ * @public
+ */
+export declare class PhysicalTypeIsOfPhysicalMaterial extends RelatedElement {
+    static classFullName: string;
+    constructor(id: Id64String);
+}
+/** Relates an [[Element]] and an [[ElementUniqueAspect]] that it owns.
+ * @public
+ */
+export declare class ElementOwnsUniqueAspect extends RelatedElement {
+    static classFullName: string;
+    constructor(elementId: Id64String, relClassName?: string);
+}
+/** Relates an [[Element]] and an [[ElementMultiAspect]] that it owns.
+ * @public
+ */
+export declare class ElementOwnsMultiAspects extends RelatedElement {
+    static classFullName: string;
+    constructor(elementId: Id64String, relClassName?: string);
+}
+/** Relates an [[Element]] and an [[ExternalSourceAspect]] that it owns.
+ * @public
+ */
+export declare class ElementOwnsExternalSourceAspects extends ElementOwnsMultiAspects {
+    static classFullName: string;
+    constructor(elementId: Id64String, relClassName?: string);
+}
+/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export declare class ExternalSourceIsInRepository extends RelatedElement {
+    static classFullName: string;
+    constructor(repositoryId: Id64String, relClassName?: string);
+}
+/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export declare class ExternalSourceAttachmentAttachesSource extends RelatedElement {
+    static classFullName: string;
+    constructor(externalSourceId: Id64String, relClassName?: string);
+}
+/** Relates a [[SheetReference]] and [[Sheet]] that it refers.
+ * @beta
+ */
+export declare class SheetReferenceRefersToSheet extends RelatedElement {
+    static classFullName: string;
+    constructor(sheetId: Id64String, relClassName?: string);
+}
+/** Relates a [[SheetIndexReference]] to a [[SheetIndex]] it refers.
+ * @beta
+ */
+export declare class SheetIndexReferenceRefersToSheetIndex extends RelatedElement {
+    static classFullName: string;
+    constructor(sheetIndexId: Id64String, relClassName?: string);
+}
+//# sourceMappingURL=NavigationRelationship.d.ts.map

package/lib/esm/NavigationRelationship.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationRelationship.d.ts","sourceRoot":"","sources":["../../src/NavigationRelationship.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpE;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,cAAc;IAC1D,OAAc,aAAa,SAAsC;gBAC9C,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAA+C;CAGvG;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,wBAAwB;IAC/D,OAAuB,aAAa,SAAiC;gBAClD,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAA0C;CAGlG;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,wBAAwB;IACxE,OAAuB,aAAa,SAA0C;gBAC3D,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAmD;CAG3G;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,wBAAwB;IACrE,OAAuB,aAAa,SAAuC;gBACxD,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAgD;CAGxG;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,wBAAwB;IAC7E,OAAuB,aAAa,SAA+C;gBAChE,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAwD;CAGhH;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,wBAAwB;IACvE,OAAuB,aAAa,SAAyC;gBAC1D,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAkD;CAG1G;AAED;;GAEG;AACH,qBAAa,gCAAiC,SAAQ,wBAAwB;IAC5E,OAAuB,aAAa,SAA8C;gBAC/D,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAuD;CAG/G;AAED;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,wBAAwB;IACzE,OAAuB,aAAa,SAA2C;gBAC5D,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAoD;CAG5G;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,wBAAwB;IACtE,OAAuB,aAAa,SAAwC;gBACzD,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAiD;CAGzG;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,wBAAwB;IACvE,OAAuB,aAAa,SAAyC;gBAC1D,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAAkD;CAG1G;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,wBAAwB;IACjE,OAAuB,aAAa,SAAmC;gBACpD,QAAQ,EAAE,UAAU,EAAE,YAAY,GAAE,MAA4C;CAGpG;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,cAAc;IACrE,OAAc,aAAa,SAAiD;gBACzD,EAAE,EAAE,UAAU,EAAE,YAAY,GAAE,MAA0D;CAG5G;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,mCAAmC;IACjF,OAAuB,aAAa,SAAwC;gBACzD,EAAE,EAAE,UAAU,EAAE,YAAY,GAAE,MAAiD;CAGnG;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,cAAc;IACrE,OAAc,aAAa,SAAiD;gBACzD,EAAE,EAAE,UAAU,EAAE,YAAY,GAAE,MAA0D;CAG5G;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,mCAAmC;IAC9E,OAAuB,aAAa,SAAqC;gBACtD,EAAE,EAAE,UAAU,EAAE,YAAY,GAAE,MAA8C;CAGhG;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,mCAAmC;IAC9E,OAAuB,aAAa,SAAqC;gBACtD,EAAE,EAAE,UAAU,EAAE,YAAY,GAAE,MAA8C;CAGhG;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,cAAc;IACrE,OAAc,aAAa,SAAiD;gBACzD,EAAE,EAAE,UAAU;CAGlC;AAED;;GAEG;AACH,qBAAa,gCAAiC,SAAQ,cAAc;IAClE,OAAc,aAAa,SAA8C;gBACtD,EAAE,EAAE,UAAU;CAGlC;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;IACzD,OAAc,aAAa,SAAqC;gBAC7C,SAAS,EAAE,UAAU,EAAE,YAAY,GAAE,MAA8C;CAGvG;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;IACzD,OAAc,aAAa,SAAqC;gBAC7C,SAAS,EAAE,UAAU,EAAE,YAAY,GAAE,MAA8C;CAGvG;AAED;;GAEG;AACH,qBAAa,gCAAiC,SAAQ,uBAAuB;IAC3E,OAAuB,aAAa,SAA8C;gBAC/D,SAAS,EAAE,UAAU,EAAE,YAAY,GAAE,MAAuD;CAGhH;AAED;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,cAAc;IAC9D,OAAc,aAAa,SAA0C;gBAClD,YAAY,EAAE,UAAU,EAAE,YAAY,GAAE,MAAmD;CAG/G;AAED;;;GAGG;AACH,qBAAa,sCAAuC,SAAQ,cAAc;IACxE,OAAc,aAAa,SAAoD;gBAC5D,gBAAgB,EAAE,UAAU,EAAE,YAAY,GAAE,MAA6D;CAG7H;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,cAAc;IAC7D,OAAc,aAAa,SAAyC;gBACjD,OAAO,EAAE,UAAU,EAAE,YAAY,GAAE,MAAkD;CAGzG;AAED;;GAEG;AACH,qBAAa,qCAAsC,SAAQ,cAAc;IACvE,OAAc,aAAa,SAAmD;gBAC3D,YAAY,EAAE,UAAU,EAAE,YAAY,GAAE,MAA4D;CAGxH"}

package/lib/esm/NavigationRelationship.js

@@ -0,0 +1,238 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Relationships
+ */
+import { RelatedElement, TypeDefinition } from "@itwin/core-common";
+/** Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.
+ * @public
+ */
+export class ElementOwnsChildElements extends RelatedElement {
+    static classFullName = "BisCore:ElementOwnsChildElements";
+    constructor(parentId, relClassName = ElementOwnsChildElements.classFullName) {
+        super({ id: parentId, relClassName });
+    }
+}
+/** Relates a parent [[Subject]] to [[Subject]] child elements.
+ * @public
+ */
+export class SubjectOwnsSubjects extends ElementOwnsChildElements {
+    static classFullName = "BisCore:SubjectOwnsSubjects";
+    constructor(parentId, relClassName = SubjectOwnsSubjects.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent [[Subject]] to [[InformationPartitionElement]] child elements.
+ * @public
+ */
+export class SubjectOwnsPartitionElements extends ElementOwnsChildElements {
+    static classFullName = "BisCore:SubjectOwnsPartitionElements";
+    constructor(parentId, relClassName = SubjectOwnsPartitionElements.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent [[Category]] to [[SubCategory]] child elements.
+ * @public
+ */
+export class CategoryOwnsSubCategories extends ElementOwnsChildElements {
+    static classFullName = "BisCore:CategoryOwnsSubCategories";
+    constructor(parentId, relClassName = CategoryOwnsSubCategories.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent [[RenderMaterial]] to [[RenderMaterial]] child elements.
+ * @public
+ */
+export class RenderMaterialOwnsRenderMaterials extends ElementOwnsChildElements {
+    static classFullName = "BisCore:RenderMaterialOwnsRenderMaterials";
+    constructor(parentId, relClassName = RenderMaterialOwnsRenderMaterials.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent Element to child Elements which represent **hidden** parts of the Entity.
+ * @public
+ */
+export class ElementEncapsulatesElements extends ElementOwnsChildElements {
+    static classFullName = "BisCore:ElementEncapsulatesElements";
+    constructor(parentId, relClassName = ElementEncapsulatesElements.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent [[PhysicalElement]] to [[PhysicalElement]] children that it assembles.
+ * @public
+ */
+export class PhysicalElementAssemblesElements extends ElementOwnsChildElements {
+    static classFullName = "BisCore:PhysicalElementAssemblesElements";
+    constructor(parentId, relClassName = PhysicalElementAssemblesElements.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent [[ExternalSource]] to its [[ExternalSourceAttachment]] children.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export class ExternalSourceOwnsAttachments extends ElementOwnsChildElements {
+    static classFullName = "BisCore:ExternalSourceOwnsAttachments";
+    constructor(parentId, relClassName = ExternalSourceOwnsAttachments.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a parent [[FolderLink]] to its [[RepositoryLink]] children.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export class FolderContainsRepositories extends ElementOwnsChildElements {
+    static classFullName = "BisCore:FolderContainsRepositories";
+    constructor(parentId, relClassName = FolderContainsRepositories.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a [[SheetIndexFolder]] to the [[SheetIndexEntry]]'s that it contains.
+ * @beta
+ */
+export class SheetIndexFolderOwnsEntries extends ElementOwnsChildElements {
+    static classFullName = "BisCore:SheetIndexFolderOwnsEntries";
+    constructor(parentId, relClassName = SheetIndexFolderOwnsEntries.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a [[SheetIndex]] to the [SheetIndexEntry]]'s that it contains.
+ * @beta
+ */
+export class SheetIndexOwnsEntries extends ElementOwnsChildElements {
+    static classFullName = "BisCore:SheetIndexOwnsEntries";
+    constructor(parentId, relClassName = SheetIndexOwnsEntries.classFullName) {
+        super(parentId, relClassName);
+    }
+}
+/** Relates a [[GeometricElement2d]] to its [[TypeDefinitionElement]]
+ * @public
+ */
+export class GeometricElement2dHasTypeDefinition extends TypeDefinition {
+    static classFullName = "BisCore:GeometricElement2dHasTypeDefinition";
+    constructor(id, relClassName = GeometricElement2dHasTypeDefinition.classFullName) {
+        super({ id, relClassName });
+    }
+}
+/** Relates a [[GraphicalElement2d]] to its [[GraphicalType2d]]
+ * @public
+ */
+export class GraphicalElement2dIsOfType extends GeometricElement2dHasTypeDefinition {
+    static classFullName = "BisCore:GraphicalElement2dIsOfType";
+    constructor(id, relClassName = GraphicalElement2dIsOfType.classFullName) {
+        super(id, relClassName);
+    }
+}
+/** Relates a [[GeometricElement3d]] to its [[TypeDefinitionElement]]
+ * @public
+ */
+export class GeometricElement3dHasTypeDefinition extends TypeDefinition {
+    static classFullName = "BisCore:GeometricElement3dHasTypeDefinition";
+    constructor(id, relClassName = GeometricElement3dHasTypeDefinition.classFullName) {
+        super({ id, relClassName });
+    }
+}
+/** Relates a [[SpatialLocationElement]] to its [[SpatialLocationType]]
+ * @public
+ */
+export class SpatialLocationIsOfType extends GeometricElement3dHasTypeDefinition {
+    static classFullName = "BisCore:SpatialLocationIsOfType";
+    constructor(id, relClassName = SpatialLocationIsOfType.classFullName) {
+        super(id, relClassName);
+    }
+}
+/** Relates a [[PhysicalElement]] to its [[PhysicalType]]
+ * @public
+ */
+export class PhysicalElementIsOfType extends GeometricElement3dHasTypeDefinition {
+    static classFullName = "BisCore:PhysicalElementIsOfType";
+    constructor(id, relClassName = PhysicalElementIsOfType.classFullName) {
+        super(id, relClassName);
+    }
+}
+/** Relates a [[PhysicalElement]] to its [[PhysicalMaterial]]
+ * @public
+ */
+export class PhysicalElementIsOfPhysicalMaterial extends RelatedElement {
+    static classFullName = "BisCore:PhysicalElementIsOfPhysicalMaterial";
+    constructor(id) {
+        super({ id });
+    }
+}
+/** Relates a [[PhysicalType]] to its [[PhysicalMaterial]]
+ * @public
+ */
+export class PhysicalTypeIsOfPhysicalMaterial extends RelatedElement {
+    static classFullName = "BisCore:PhysicalTypeIsOfPhysicalMaterial";
+    constructor(id) {
+        super({ id });
+    }
+}
+/** Relates an [[Element]] and an [[ElementUniqueAspect]] that it owns.
+ * @public
+ */
+export class ElementOwnsUniqueAspect extends RelatedElement {
+    static classFullName = "BisCore:ElementOwnsUniqueAspect";
+    constructor(elementId, relClassName = ElementOwnsUniqueAspect.classFullName) {
+        super({ id: elementId, relClassName });
+    }
+}
+/** Relates an [[Element]] and an [[ElementMultiAspect]] that it owns.
+ * @public
+ */
+export class ElementOwnsMultiAspects extends RelatedElement {
+    static classFullName = "BisCore:ElementOwnsMultiAspects";
+    constructor(elementId, relClassName = ElementOwnsMultiAspects.classFullName) {
+        super({ id: elementId, relClassName });
+    }
+}
+/** Relates an [[Element]] and an [[ExternalSourceAspect]] that it owns.
+ * @public
+ */
+export class ElementOwnsExternalSourceAspects extends ElementOwnsMultiAspects {
+    static classFullName = "BisCore:ElementOwnsExternalSourceAspects";
+    constructor(elementId, relClassName = ElementOwnsExternalSourceAspects.classFullName) {
+        super(elementId, relClassName);
+    }
+}
+/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export class ExternalSourceIsInRepository extends RelatedElement {
+    static classFullName = "BisCore:ExternalSourceIsInRepository";
+    constructor(repositoryId, relClassName = ExternalSourceIsInRepository.classFullName) {
+        super({ id: repositoryId, relClassName });
+    }
+}
+/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.13
+ * @beta
+ */
+export class ExternalSourceAttachmentAttachesSource extends RelatedElement {
+    static classFullName = "BisCore:ExternalSourceAttachmentAttachesSource";
+    constructor(externalSourceId, relClassName = ExternalSourceAttachmentAttachesSource.classFullName) {
+        super({ id: externalSourceId, relClassName });
+    }
+}
+/** Relates a [[SheetReference]] and [[Sheet]] that it refers.
+ * @beta
+ */
+export class SheetReferenceRefersToSheet extends RelatedElement {
+    static classFullName = "BisCore:SheetReferenceRefersToSheet";
+    constructor(sheetId, relClassName = SheetReferenceRefersToSheet.classFullName) {
+        super({ id: sheetId, relClassName });
+    }
+}
+/** Relates a [[SheetIndexReference]] to a [[SheetIndex]] it refers.
+ * @beta
+ */
+export class SheetIndexReferenceRefersToSheetIndex extends RelatedElement {
+    static classFullName = "BisCore:SheetIndexReferenceRefersToSheetIndex";
+    constructor(sheetIndexId, relClassName = SheetIndexReferenceRefersToSheetIndex.classFullName) {
+        super({ id: sheetIndexId, relClassName });
+    }
+}
+//# sourceMappingURL=NavigationRelationship.js.map

package/lib/esm/NavigationRelationship.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationRelationship.js","sourceRoot":"","sources":["../../src/NavigationRelationship.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAMH,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpE;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,cAAc;IACnD,MAAM,CAAC,aAAa,GAAG,kCAAkC,CAAC;IACjE,YAAmB,QAAoB,EAAE,eAAuB,wBAAwB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IACxC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,wBAAwB;IACxD,MAAM,CAAU,aAAa,GAAG,6BAA6B,CAAC;IACrE,YAAmB,QAAoB,EAAE,eAAuB,mBAAmB,CAAC,aAAa;QAC/F,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,wBAAwB;IACjE,MAAM,CAAU,aAAa,GAAG,sCAAsC,CAAC;IAC9E,YAAmB,QAAoB,EAAE,eAAuB,4BAA4B,CAAC,aAAa;QACxG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,wBAAwB;IAC9D,MAAM,CAAU,aAAa,GAAG,mCAAmC,CAAC;IAC3E,YAAmB,QAAoB,EAAE,eAAuB,yBAAyB,CAAC,aAAa;QACrG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,iCAAkC,SAAQ,wBAAwB;IACtE,MAAM,CAAU,aAAa,GAAG,2CAA2C,CAAC;IACnF,YAAmB,QAAoB,EAAE,eAAuB,iCAAiC,CAAC,aAAa;QAC7G,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,wBAAwB;IAChE,MAAM,CAAU,aAAa,GAAG,qCAAqC,CAAC;IAC7E,YAAmB,QAAoB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACvG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,gCAAiC,SAAQ,wBAAwB;IACrE,MAAM,CAAU,aAAa,GAAG,0CAA0C,CAAC;IAClF,YAAmB,QAAoB,EAAE,eAAuB,gCAAgC,CAAC,aAAa;QAC5G,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,wBAAwB;IAClE,MAAM,CAAU,aAAa,GAAG,uCAAuC,CAAC;IAC/E,YAAmB,QAAoB,EAAE,eAAuB,6BAA6B,CAAC,aAAa;QACzG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;;GAGG;AACH,MAAM,OAAO,0BAA2B,SAAQ,wBAAwB;IAC/D,MAAM,CAAU,aAAa,GAAG,oCAAoC,CAAC;IAC5E,YAAmB,QAAoB,EAAE,eAAuB,0BAA0B,CAAC,aAAa;QACtG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAChC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,wBAAwB;IAChE,MAAM,CAAU,aAAa,GAAG,qCAAqC,CAAC;IAC7E,YAAmB,QAAoB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACvG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAE,CAAC;IACjC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,wBAAwB;IAC1D,MAAM,CAAU,aAAa,GAAG,+BAA+B,CAAC;IACvE,YAAmB,QAAoB,EAAE,eAAuB,qBAAqB,CAAC,aAAa;QACjG,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAE,CAAC;IACjC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,cAAc;IAC9D,MAAM,CAAC,aAAa,GAAG,6CAA6C,CAAC;IAC5E,YAAmB,EAAc,EAAE,eAAuB,mCAAmC,CAAC,aAAa;QACzG,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9B,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,mCAAmC;IAC1E,MAAM,CAAU,aAAa,GAAG,oCAAoC,CAAC;IAC5E,YAAmB,EAAc,EAAE,eAAuB,0BAA0B,CAAC,aAAa;QAChG,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,cAAc;IAC9D,MAAM,CAAC,aAAa,GAAG,6CAA6C,CAAC;IAC5E,YAAmB,EAAc,EAAE,eAAuB,mCAAmC,CAAC,aAAa;QACzG,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9B,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,mCAAmC;IACvE,MAAM,CAAU,aAAa,GAAG,iCAAiC,CAAC;IACzE,YAAmB,EAAc,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QAC7F,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,mCAAmC;IACvE,MAAM,CAAU,aAAa,GAAG,iCAAiC,CAAC;IACzE,YAAmB,EAAc,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QAC7F,KAAK,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IAC1B,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,mCAAoC,SAAQ,cAAc;IAC9D,MAAM,CAAC,aAAa,GAAG,6CAA6C,CAAC;IAC5E,YAAmB,EAAc;QAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChB,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,gCAAiC,SAAQ,cAAc;IAC3D,MAAM,CAAC,aAAa,GAAG,0CAA0C,CAAC;IACzE,YAAmB,EAAc;QAC/B,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChB,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IAClD,MAAM,CAAC,aAAa,GAAG,iCAAiC,CAAC;IAChE,YAAmB,SAAqB,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IACzC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IAClD,MAAM,CAAC,aAAa,GAAG,iCAAiC,CAAC;IAChE,YAAmB,SAAqB,EAAE,eAAuB,uBAAuB,CAAC,aAAa;QACpG,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IACzC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,gCAAiC,SAAQ,uBAAuB;IACpE,MAAM,CAAU,aAAa,GAAG,0CAA0C,CAAC;IAClF,YAAmB,SAAqB,EAAE,eAAuB,gCAAgC,CAAC,aAAa;QAC7G,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACjC,CAAC;;AAGH;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,cAAc;IACvD,MAAM,CAAC,aAAa,GAAG,sCAAsC,CAAC;IACrE,YAAmB,YAAwB,EAAE,eAAuB,4BAA4B,CAAC,aAAa;QAC5G,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;;AAGH;;;GAGG;AACH,MAAM,OAAO,sCAAuC,SAAQ,cAAc;IACjE,MAAM,CAAC,aAAa,GAAG,gDAAgD,CAAC;IAC/E,YAAmB,gBAA4B,EAAE,eAAuB,sCAAsC,CAAC,aAAa;QAC1H,KAAK,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,YAAY,EAAE,CAAC,CAAC;IAChD,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,cAAc;IACtD,MAAM,CAAC,aAAa,GAAG,qCAAqC,CAAC;IACpE,YAAmB,OAAmB,EAAE,eAAuB,2BAA2B,CAAC,aAAa;QACtG,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IACvC,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,qCAAsC,SAAQ,cAAc;IAChE,MAAM,CAAC,aAAa,GAAG,+CAA+C,CAAC;IAC9E,YAAmB,YAAwB,EAAE,eAAuB,qCAAqC,CAAC,aAAa;QACrH,KAAK,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,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 Relationships\n */\n\n// NOTE: A NavigationRelationship is not an Entity, so is not registered in the ClassRegistry.\n// NOTE: It does, however, have a classFullName property for consistency with Entity subclasses.\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { RelatedElement, TypeDefinition } from \"@itwin/core-common\";\n\n/** Relates a parent Element to child Elements which represent parts of the Entity modeled by the parent Element.\n * @public\n */\nexport class ElementOwnsChildElements extends RelatedElement {\n  public static classFullName = \"BisCore:ElementOwnsChildElements\";\n  public constructor(parentId: Id64String, relClassName: string = ElementOwnsChildElements.classFullName) {\n    super({ id: parentId, relClassName });\n  }\n}\n\n/** Relates a parent [[Subject]] to [[Subject]] child elements.\n * @public\n */\nexport class SubjectOwnsSubjects extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:SubjectOwnsSubjects\";\n  public constructor(parentId: Id64String, relClassName: string = SubjectOwnsSubjects.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent [[Subject]] to [[InformationPartitionElement]] child elements.\n * @public\n */\nexport class SubjectOwnsPartitionElements extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:SubjectOwnsPartitionElements\";\n  public constructor(parentId: Id64String, relClassName: string = SubjectOwnsPartitionElements.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent [[Category]] to [[SubCategory]] child elements.\n * @public\n */\nexport class CategoryOwnsSubCategories extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:CategoryOwnsSubCategories\";\n  public constructor(parentId: Id64String, relClassName: string = CategoryOwnsSubCategories.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent [[RenderMaterial]] to [[RenderMaterial]] child elements.\n * @public\n */\nexport class RenderMaterialOwnsRenderMaterials extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:RenderMaterialOwnsRenderMaterials\";\n  public constructor(parentId: Id64String, relClassName: string = RenderMaterialOwnsRenderMaterials.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent Element to child Elements which represent **hidden** parts of the Entity.\n * @public\n */\nexport class ElementEncapsulatesElements extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:ElementEncapsulatesElements\";\n  public constructor(parentId: Id64String, relClassName: string = ElementEncapsulatesElements.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent [[PhysicalElement]] to [[PhysicalElement]] children that it assembles.\n * @public\n */\nexport class PhysicalElementAssemblesElements extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:PhysicalElementAssemblesElements\";\n  public constructor(parentId: Id64String, relClassName: string = PhysicalElementAssemblesElements.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent [[ExternalSource]] to its [[ExternalSourceAttachment]] children.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceOwnsAttachments extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:ExternalSourceOwnsAttachments\";\n  public constructor(parentId: Id64String, relClassName: string = ExternalSourceOwnsAttachments.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a parent [[FolderLink]] to its [[RepositoryLink]] children.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class FolderContainsRepositories extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:FolderContainsRepositories\";\n  public constructor(parentId: Id64String, relClassName: string = FolderContainsRepositories.classFullName) {\n    super(parentId, relClassName);\n  }\n}\n\n/** Relates a [[SheetIndexFolder]] to the [[SheetIndexEntry]]'s that it contains.\n * @beta\n */\nexport class SheetIndexFolderOwnsEntries extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:SheetIndexFolderOwnsEntries\";\n  public constructor(parentId: Id64String, relClassName: string = SheetIndexFolderOwnsEntries.classFullName) {\n    super(parentId, relClassName );\n  }\n}\n\n/** Relates a [[SheetIndex]] to the [SheetIndexEntry]]'s that it contains.\n * @beta\n */\nexport class SheetIndexOwnsEntries extends ElementOwnsChildElements {\n  public static override classFullName = \"BisCore:SheetIndexOwnsEntries\";\n  public constructor(parentId: Id64String, relClassName: string = SheetIndexOwnsEntries.classFullName) {\n    super(parentId, relClassName );\n  }\n}\n\n/** Relates a [[GeometricElement2d]] to its [[TypeDefinitionElement]]\n * @public\n */\nexport class GeometricElement2dHasTypeDefinition extends TypeDefinition {\n  public static classFullName = \"BisCore:GeometricElement2dHasTypeDefinition\";\n  public constructor(id: Id64String, relClassName: string = GeometricElement2dHasTypeDefinition.classFullName) {\n    super({ id, relClassName });\n  }\n}\n\n/** Relates a [[GraphicalElement2d]] to its [[GraphicalType2d]]\n * @public\n */\nexport class GraphicalElement2dIsOfType extends GeometricElement2dHasTypeDefinition {\n  public static override classFullName = \"BisCore:GraphicalElement2dIsOfType\";\n  public constructor(id: Id64String, relClassName: string = GraphicalElement2dIsOfType.classFullName) {\n    super(id, relClassName);\n  }\n}\n\n/** Relates a [[GeometricElement3d]] to its [[TypeDefinitionElement]]\n * @public\n */\nexport class GeometricElement3dHasTypeDefinition extends TypeDefinition {\n  public static classFullName = \"BisCore:GeometricElement3dHasTypeDefinition\";\n  public constructor(id: Id64String, relClassName: string = GeometricElement3dHasTypeDefinition.classFullName) {\n    super({ id, relClassName });\n  }\n}\n\n/** Relates a [[SpatialLocationElement]] to its [[SpatialLocationType]]\n * @public\n */\nexport class SpatialLocationIsOfType extends GeometricElement3dHasTypeDefinition {\n  public static override classFullName = \"BisCore:SpatialLocationIsOfType\";\n  public constructor(id: Id64String, relClassName: string = SpatialLocationIsOfType.classFullName) {\n    super(id, relClassName);\n  }\n}\n\n/** Relates a [[PhysicalElement]] to its [[PhysicalType]]\n * @public\n */\nexport class PhysicalElementIsOfType extends GeometricElement3dHasTypeDefinition {\n  public static override classFullName = \"BisCore:PhysicalElementIsOfType\";\n  public constructor(id: Id64String, relClassName: string = PhysicalElementIsOfType.classFullName) {\n    super(id, relClassName);\n  }\n}\n\n/** Relates a [[PhysicalElement]] to its [[PhysicalMaterial]]\n * @public\n */\nexport class PhysicalElementIsOfPhysicalMaterial extends RelatedElement {\n  public static classFullName = \"BisCore:PhysicalElementIsOfPhysicalMaterial\";\n  public constructor(id: Id64String) {\n    super({ id });\n  }\n}\n\n/** Relates a [[PhysicalType]] to its [[PhysicalMaterial]]\n * @public\n */\nexport class PhysicalTypeIsOfPhysicalMaterial extends RelatedElement {\n  public static classFullName = \"BisCore:PhysicalTypeIsOfPhysicalMaterial\";\n  public constructor(id: Id64String) {\n    super({ id });\n  }\n}\n\n/** Relates an [[Element]] and an [[ElementUniqueAspect]] that it owns.\n * @public\n */\nexport class ElementOwnsUniqueAspect extends RelatedElement {\n  public static classFullName = \"BisCore:ElementOwnsUniqueAspect\";\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsUniqueAspect.classFullName) {\n    super({ id: elementId, relClassName });\n  }\n}\n\n/** Relates an [[Element]] and an [[ElementMultiAspect]] that it owns.\n * @public\n */\nexport class ElementOwnsMultiAspects extends RelatedElement {\n  public static classFullName = \"BisCore:ElementOwnsMultiAspects\";\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsMultiAspects.classFullName) {\n    super({ id: elementId, relClassName });\n  }\n}\n\n/** Relates an [[Element]] and an [[ExternalSourceAspect]] that it owns.\n * @public\n */\nexport class ElementOwnsExternalSourceAspects extends ElementOwnsMultiAspects {\n  public static override classFullName = \"BisCore:ElementOwnsExternalSourceAspects\";\n  public constructor(elementId: Id64String, relClassName: string = ElementOwnsExternalSourceAspects.classFullName) {\n    super(elementId, relClassName);\n  }\n}\n\n/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceIsInRepository extends RelatedElement {\n  public static classFullName = \"BisCore:ExternalSourceIsInRepository\";\n  public constructor(repositoryId: Id64String, relClassName: string = ExternalSourceIsInRepository.classFullName) {\n    super({ id: repositoryId, relClassName });\n  }\n}\n\n/** Relates an [[ExternalSource]] to the [[RepositoryLink]] that it is persisted in.\n * @note The associated ECClass was added to the BisCore schema in version 1.0.13\n * @beta\n */\nexport class ExternalSourceAttachmentAttachesSource extends RelatedElement {\n  public static classFullName = \"BisCore:ExternalSourceAttachmentAttachesSource\";\n  public constructor(externalSourceId: Id64String, relClassName: string = ExternalSourceAttachmentAttachesSource.classFullName) {\n    super({ id: externalSourceId, relClassName });\n  }\n}\n\n/** Relates a [[SheetReference]] and [[Sheet]] that it refers.\n * @beta\n */\nexport class SheetReferenceRefersToSheet extends RelatedElement {\n  public static classFullName = \"BisCore:SheetReferenceRefersToSheet\";\n  public constructor(sheetId: Id64String, relClassName: string = SheetReferenceRefersToSheet.classFullName) {\n    super({ id: sheetId, relClassName });\n  }\n}\n\n/** Relates a [[SheetIndexReference]] to a [[SheetIndex]] it refers.\n * @beta\n */\nexport class SheetIndexReferenceRefersToSheetIndex extends RelatedElement {\n  public static classFullName = \"BisCore:SheetIndexReferenceRefersToSheetIndex\";\n  public constructor(sheetIndexId: Id64String, relClassName: string = SheetIndexReferenceRefersToSheetIndex.classFullName) {\n    super({ id: sheetIndexId, relClassName });\n  }\n}\n"]}

package/lib/esm/PromiseMemoizer.d.ts

@@ -0,0 +1,48 @@
+/** Wrapper around a promise that allows synchronous queries of it's state
+ * @internal
+ */
+export declare class QueryablePromise<T> {
+    readonly promise: Promise<T>;
+    result?: T;
+    error?: any;
+    private _fulfilled;
+    private _rejected;
+    get isPending(): boolean;
+    get isFulfilled(): boolean;
+    get isRejected(): boolean;
+    constructor(promise: Promise<T>);
+}
+/** @internal */
+export type MemoizeFnType<T> = (...args: any[]) => Promise<T>;
+/** @internal */
+export type GenerateKeyFnType = (...args: any[]) => string;
+/** Utility to cache and retrieve results of long running asynchronous functions.
+ * The cache is keyed on the input arguments passed to these functions
+ * @internal
+ */
+export declare class PromiseMemoizer<T> implements Disposable {
+    private readonly _cachedPromises;
+    private readonly _timers;
+    private readonly _memoizeFn;
+    private readonly _generateKeyFn;
+    private readonly _maxCacheSize;
+    private readonly _cacheTimeout;
+    /**
+     * Constructor
+     * @param memoizeFn Function to memoize
+     * @param generateKeyFn Function to generate the key for the memoized function
+     * @param maxCacheSize Maximum size of the memoizer cache.
+     * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these
+     * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize
+     * threshold, the entire cache is then cleared.
+     */
+    constructor(memoizeFn: MemoizeFnType<T>, generateKeyFn: GenerateKeyFnType, maxCacheSize?: number, cacheTimeout?: number);
+    /** Call the memoized function */
+    memoize(...args: any[]): QueryablePromise<T>;
+    /** Delete the memoized function */
+    deleteMemoized(...args: any[]): void;
+    /** Clear all entries in the memoizer cache */
+    clearCache(): void;
+    [Symbol.dispose](): void;
+}
+//# sourceMappingURL=PromiseMemoizer.d.ts.map

package/lib/esm/PromiseMemoizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PromiseMemoizer.d.ts","sourceRoot":"","sources":["../../src/PromiseMemoizer.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,qBAAa,gBAAgB,CAAC,CAAC;aAUM,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAT/C,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,KAAK,CAAC,EAAE,GAAG,CAAC;IAEnB,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,SAAS,CAAkB;IAEnC,IAAW,SAAS,IAAI,OAAO,CAAkD;IACjF,IAAW,WAAW,IAAI,OAAO,CAA4B;IAC7D,IAAW,UAAU,IAAI,OAAO,CAA2B;gBACxB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;CASvD;AAED,gBAAgB;AAChB,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAC9D,gBAAgB;AAChB,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC;AAE3D;;;GAGG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,YAAW,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4E;IAC5G,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkE;IAC1F,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;IAC9C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAoB;IACnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC;;;;;;;;OAQG;gBACgB,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,GAAE,MAAY,EAAE,YAAY,GAAE,MAAc;IAO1I,iCAAiC;IAC1B,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,gBAAgB,CAAC,CAAC,CAAC;IA8BnD,mCAAmC;IAC5B,cAAc,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE;IAQpC,8CAA8C;IACvC,UAAU;IAIV,CAAC,MAAM,CAAC,OAAO,CAAC;CAOxB"}

package/lib/esm/PromiseMemoizer.js

@@ -0,0 +1,101 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { Logger } from "@itwin/core-bentley";
+import { BackendLoggerCategory } from "./BackendLoggerCategory";
+/** Wrapper around a promise that allows synchronous queries of it's state
+ * @internal
+ */
+export class QueryablePromise {
+    promise;
+    result;
+    error;
+    _fulfilled = false;
+    _rejected = false;
+    get isPending() { return !this.isFulfilled && !this.isRejected; }
+    get isFulfilled() { return this._fulfilled; }
+    get isRejected() { return this._rejected; }
+    constructor(promise) {
+        this.promise = promise;
+        this.promise.then((res) => {
+            this.result = res;
+            this._fulfilled = true;
+        }).catch((err) => {
+            this.error = err;
+            this._rejected = true;
+        });
+    }
+}
+/** Utility to cache and retrieve results of long running asynchronous functions.
+ * The cache is keyed on the input arguments passed to these functions
+ * @internal
+ */
+export class PromiseMemoizer {
+    _cachedPromises = new Map();
+    _timers = new Map();
+    _memoizeFn;
+    _generateKeyFn;
+    _maxCacheSize;
+    _cacheTimeout;
+    /**
+     * Constructor
+     * @param memoizeFn Function to memoize
+     * @param generateKeyFn Function to generate the key for the memoized function
+     * @param maxCacheSize Maximum size of the memoizer cache.
+     * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these
+     * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize
+     * threshold, the entire cache is then cleared.
+     */
+    constructor(memoizeFn, generateKeyFn, maxCacheSize = 500, cacheTimeout = 30000) {
+        this._memoizeFn = memoizeFn;
+        this._generateKeyFn = generateKeyFn;
+        this._maxCacheSize = maxCacheSize;
+        this._cacheTimeout = cacheTimeout;
+    }
+    /** Call the memoized function */
+    memoize(...args) {
+        const key = this._generateKeyFn(...args);
+        let qp = this._cachedPromises.get(key);
+        if (qp)
+            return qp;
+        if (this._cachedPromises.size >= this._maxCacheSize) {
+            if (this._maxCacheSize > 1)
+                Logger.logError(BackendLoggerCategory.PromiseMemoizer, "Cleared too many unresolved entries in memoizer cache");
+            this.clearCache();
+        }
+        const removeCachedPromise = (v) => {
+            const cleanUp = () => {
+                this._cachedPromises.delete(key);
+                this._timers.delete(key);
+            };
+            this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));
+            return v;
+        };
+        const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {
+            throw removeCachedPromise(e); // eslint-disable-line @typescript-eslint/only-throw-error
+        });
+        qp = new QueryablePromise(p);
+        this._cachedPromises.set(key, qp);
+        return qp;
+    }
+    /** Delete the memoized function */
+    deleteMemoized(...args) {
+        const key = this._generateKeyFn(...args);
+        this._cachedPromises.delete(key);
+        const timer = this._timers.get(key);
+        if (timer)
+            clearTimeout(timer);
+    }
+    /** Clear all entries in the memoizer cache */
+    clearCache() {
+        this._cachedPromises.clear();
+    }
+    [Symbol.dispose]() {
+        for (const timer of this._timers.values())
+            clearTimeout(timer);
+        this._timers.clear();
+        this.clearCache();
+    }
+}
+//# sourceMappingURL=PromiseMemoizer.js.map

package/lib/esm/PromiseMemoizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PromiseMemoizer.js","sourceRoot":"","sources":["../../src/PromiseMemoizer.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAUQ;IAT5B,MAAM,CAAK;IACX,KAAK,CAAO;IAEX,UAAU,GAAY,KAAK,CAAC;IAC5B,SAAS,GAAY,KAAK,CAAC;IAEnC,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACjF,IAAW,WAAW,KAAc,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7D,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3D,YAAmC,OAAmB;QAAnB,YAAO,GAAP,OAAO,CAAY;QACpD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAM,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;YACjB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAOD;;;GAGG;AACH,MAAM,OAAO,eAAe;IACT,eAAe,GAAqC,IAAI,GAAG,EAA+B,CAAC;IAC3F,OAAO,GAAgC,IAAI,GAAG,EAA0B,CAAC;IACzE,UAAU,CAAmB;IAC7B,cAAc,CAAoB;IAClC,aAAa,CAAS;IACtB,aAAa,CAAS;IAEvC;;;;;;;;OAQG;IACH,YAAmB,SAA2B,EAAE,aAAgC,EAAE,eAAuB,GAAG,EAAE,eAAuB,KAAK;QACxI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED,iCAAiC;IAC1B,OAAO,CAAC,GAAG,IAAW;QAC3B,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,EAAE,GAAoC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxE,IAAI,EAAE;YACJ,OAAO,EAAE,CAAC;QAEZ,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACpD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC;gBACxB,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,eAAe,EAAE,uDAAuD,CAAC,CAAC;YAClH,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;QAED,MAAM,mBAAmB,GAAG,CAAC,CAAI,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,GAAG,EAAE;gBACnB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YAC/D,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QAEF,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE,EAAE;YACjE,MAAM,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,0DAA0D;QAC1F,CAAC,CAAC,CAAC;QAEH,EAAE,GAAG,IAAI,gBAAgB,CAAI,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAClC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,mCAAmC;IAC5B,cAAc,CAAC,GAAG,IAAW;QAClC,MAAM,GAAG,GAAW,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK;YACP,YAAY,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,8CAA8C;IACvC,UAAU;QACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACvC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEtB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;CACF","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*--------------------------------------------------------------------------------------------*/\nimport { Logger } from \"@itwin/core-bentley\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\n\n/** Wrapper around a promise that allows synchronous queries of it's state\n * @internal\n */\nexport class QueryablePromise<T> {\n  public result?: T;\n  public error?: any;\n\n  private _fulfilled: boolean = false;\n  private _rejected: boolean = false;\n\n  public get isPending(): boolean { return !this.isFulfilled && !this.isRejected; }\n  public get isFulfilled(): boolean { return this._fulfilled; }\n  public get isRejected(): boolean { return this._rejected; }\n  public constructor(public readonly promise: Promise<T>) {\n    this.promise.then((res: T) => {\n      this.result = res;\n      this._fulfilled = true;\n    }).catch((err: any) => {\n      this.error = err;\n      this._rejected = true;\n    });\n  }\n}\n\n/** @internal */\nexport type MemoizeFnType<T> = (...args: any[]) => Promise<T>;\n/** @internal */\nexport type GenerateKeyFnType = (...args: any[]) => string;\n\n/** Utility to cache and retrieve results of long running asynchronous functions.\n * The cache is keyed on the input arguments passed to these functions\n * @internal\n */\nexport class PromiseMemoizer<T> implements Disposable {\n  private readonly _cachedPromises: Map<string, QueryablePromise<T>> = new Map<string, QueryablePromise<T>>();\n  private readonly _timers: Map<string, NodeJS.Timeout> = new Map<string, NodeJS.Timeout>();\n  private readonly _memoizeFn: MemoizeFnType<T>;\n  private readonly _generateKeyFn: GenerateKeyFnType;\n  private readonly _maxCacheSize: number;\n  private readonly _cacheTimeout: number;\n\n  /**\n   * Constructor\n   * @param memoizeFn Function to memoize\n   * @param generateKeyFn Function to generate the key for the memoized function\n   * @param maxCacheSize Maximum size of the memoizer cache.\n   * If the maximum cache size is exceeded, fulfilled/rejected entries are first discarded - these\n   * may have been unclaimed/orphaned promises. If the cache size is still above the maxCacheSize\n   * threshold, the entire cache is then cleared.\n   */\n  public constructor(memoizeFn: MemoizeFnType<T>, generateKeyFn: GenerateKeyFnType, maxCacheSize: number = 500, cacheTimeout: number = 30000) {\n    this._memoizeFn = memoizeFn;\n    this._generateKeyFn = generateKeyFn;\n    this._maxCacheSize = maxCacheSize;\n    this._cacheTimeout = cacheTimeout;\n  }\n\n  /** Call the memoized function */\n  public memoize(...args: any[]): QueryablePromise<T> {\n    const key: string = this._generateKeyFn(...args);\n    let qp: QueryablePromise<T> | undefined = this._cachedPromises.get(key);\n    if (qp)\n      return qp;\n\n    if (this._cachedPromises.size >= this._maxCacheSize) {\n      if (this._maxCacheSize > 1)\n        Logger.logError(BackendLoggerCategory.PromiseMemoizer, \"Cleared too many unresolved entries in memoizer cache\");\n      this.clearCache();\n    }\n\n    const removeCachedPromise = (v: T) => {\n      const cleanUp = () => {\n        this._cachedPromises.delete(key);\n        this._timers.delete(key);\n      };\n      this._timers.set(key, setTimeout(cleanUp, this._cacheTimeout));\n      return v;\n    };\n\n    const p = this._memoizeFn(...args).then(removeCachedPromise, (e) => {\n      throw removeCachedPromise(e); // eslint-disable-line @typescript-eslint/only-throw-error\n    });\n\n    qp = new QueryablePromise<T>(p);\n    this._cachedPromises.set(key, qp);\n    return qp;\n  }\n\n  /** Delete the memoized function */\n  public deleteMemoized(...args: any[]) {\n    const key: string = this._generateKeyFn(...args);\n    this._cachedPromises.delete(key);\n    const timer = this._timers.get(key);\n    if (timer)\n      clearTimeout(timer);\n  }\n\n  /** Clear all entries in the memoizer cache */\n  public clearCache() {\n    this._cachedPromises.clear();\n  }\n\n  public [Symbol.dispose]() {\n    for (const timer of this._timers.values())\n      clearTimeout(timer);\n\n    this._timers.clear();\n    this.clearCache();\n  }\n}\n"]}