@itwin/presentation-shared 0.1.0

package/lib/esm/shared/Metadata.d.ts

@@ -0,0 +1,268 @@
+/**
+ * An interface for an object that knows how to get an ECSchema from an iModel.
+ *
+ * @see `createECSchemaProvider` in `@itwin/presentation-core-interop`.
+ * @beta
+ */
+export interface ECSchemaProvider {
+    getSchema(schemaName: string): Promise<EC.Schema | undefined>;
+}
+/**
+ * An interface for a class hierarchy inspector that can be used to determine if one class derives from another.
+ * @see `createCachingECClassHierarchyInspector`
+ * @beta
+ */
+export interface ECClassHierarchyInspector {
+    classDerivesFrom(derivedClassFullName: string, candidateBaseClassFullName: string): Promise<boolean> | boolean;
+}
+/**
+ * Creates a new `ECClassHierarchyInspector` that caches results of `derivesFrom` calls.
+ * @beta
+ */
+export declare function createCachingECClassHierarchyInspector(props: {
+    /** Schema provider used to load schemas and their classes. */
+    schemaProvider: ECSchemaProvider;
+    /** Optional cache size, describing the number of derived/base class combinations to store in cache. Defaults to `0`, which means no caching. */
+    cacheSize?: number;
+}): ECClassHierarchyInspector;
+/**
+ * A namespace containing various [EC types](https://www.itwinjs.org/bis/ec/).
+ * @beta
+ * @see `ECSchemaProvider`
+ */
+export declare namespace EC {
+    /**
+     * Represents an ECSchema that contains classes, relationships, etc.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/schema/
+     * @beta
+     */
+    interface Schema {
+        name: string;
+        getClass(name: string): Promise<Class | undefined>;
+    }
+    /**
+     * Represents an ECSchema item - a class, relationship, etc.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/schemaitem/
+     * @beta
+     */
+    interface SchemaItem {
+        schema: Schema;
+        fullName: string;
+        name: string;
+        label?: string;
+    }
+    /**
+     * Represents an ECClass.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/ecclass/
+     * @beta
+     */
+    interface Class extends SchemaItem {
+        is(className: string, schemaName: string): Promise<boolean>;
+        is(other: Class): Promise<boolean>;
+        getProperty(name: string): Promise<Property | undefined>;
+        getProperties(): Promise<Array<Property>>;
+        isEntityClass(): this is EntityClass;
+        isRelationshipClass(): this is RelationshipClass;
+        isStructClass(): this is StructClass;
+        isMixin(): this is Mixin;
+    }
+    /**
+     * Represents an entity class.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/entityclass/
+     * @beta
+     */
+    type EntityClass = Class;
+    /**
+     * Represents a struct class.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/structclass/
+     * @beta
+     */
+    type StructClass = Class;
+    /**
+     * Represents a mixin.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/mixin/
+     * @beta
+     */
+    type Mixin = Class;
+    /**
+     * Represents a kind of quantity.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/kindofquantity/
+     * @beta
+     */
+    type KindOfQuantity = SchemaItem;
+    /**
+     * Represents a relationship constraint multiplicity.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/relationshipmultiplicity/
+     * @beta
+     */
+    interface RelationshipConstraintMultiplicity {
+        lowerLimit: number;
+        upperLimit: number;
+    }
+    /**
+     * Represents a relationship constraint.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/relationshipconstraint/
+     * @beta
+     */
+    interface RelationshipConstraint {
+        multiplicity?: RelationshipConstraintMultiplicity;
+        polymorphic: boolean;
+        abstractConstraint: Promise<EntityClass | Mixin | RelationshipClass | undefined>;
+    }
+    /**
+     * Represents a relationship class.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/relationshipclass/
+     * @beta
+     */
+    interface RelationshipClass extends Class {
+        direction: "Forward" | "Backward";
+        source: RelationshipConstraint;
+        target: RelationshipConstraint;
+    }
+    /**
+     * Represents an enumerator.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumerator/
+     * @beta
+     */
+    interface Enumerator<T> {
+        name: string;
+        value: T;
+        label?: string;
+        description?: string;
+    }
+    /**
+     * Represents an enumeration.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumeration/
+     * @beta
+     */
+    interface Enumeration extends SchemaItem {
+        enumerators: Array<Enumerator<string | number>>;
+        type: "String" | "Number";
+        isStrict: boolean;
+    }
+    /**
+     * Represents a property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/property/
+     * @beta
+     */
+    interface Property {
+        name: string;
+        class: Class;
+        label?: string;
+        kindOfQuantity: Promise<KindOfQuantity | undefined>;
+        isArray(): this is ArrayProperty;
+        isStruct(): this is StructProperty;
+        isPrimitive(): this is PrimitiveProperty;
+        isEnumeration(): this is EnumerationProperty;
+        isNavigation(): this is NavigationProperty;
+    }
+    /**
+     * Defines array property attributes.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/arrayproperty/
+     * @beta
+     */
+    interface ArrayPropertyAttributes {
+        minOccurs: number;
+        maxOccurs?: number;
+    }
+    /**
+     * Defines a structs array property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/structarrayproperty/
+     * @beta
+     */
+    type StructArrayProperty = StructProperty & ArrayPropertyAttributes;
+    /**
+     * Defines an enumerations array property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumerationarrayproperty/
+     * @beta
+     */
+    type EnumerationArrayProperty = EnumerationProperty & ArrayPropertyAttributes;
+    /**
+     * Defines a primitives array property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/primitivearrayproperty/
+     * @beta
+     */
+    type PrimitiveArrayProperty = PrimitiveProperty & ArrayPropertyAttributes;
+    /**
+     * Defines an array property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/anyarrayproperty/
+     * @beta
+     */
+    type ArrayProperty = StructArrayProperty | EnumerationArrayProperty | PrimitiveArrayProperty;
+    /**
+     * Defines a struct property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/structproperty/
+     * @beta
+     */
+    interface StructProperty extends Property {
+        structClass: StructClass;
+    }
+    /**
+     * Defines an enumeration property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumerationproperty/
+     * @beta
+     */
+    interface EnumerationProperty extends Property {
+        enumeration: Promise<Enumeration | undefined>;
+        extendedTypeName?: string;
+    }
+    /**
+     * Defines a navigation property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/navigationproperty/
+     * @beta
+     */
+    interface NavigationProperty extends Property {
+        relationshipClass: Promise<RelationshipClass>;
+        direction: "Forward" | "Backward";
+    }
+    /**
+     * Defines a primitive property type.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/primitivetype/
+     * @beta
+     */
+    type PrimitiveType = "Binary" | "Boolean" | "DateTime" | "Double" | "Integer" | "Long" | "Point2d" | "Point3d" | "String" | "IGeometry";
+    /**
+     * Defines a primitive property.
+     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/primitiveproperty/
+     * @beta
+     */
+    interface PrimitiveProperty extends Property {
+        primitiveType: PrimitiveType;
+        extendedTypeName?: string;
+    }
+}
+/**
+ * An identifiers' union of all supported primitive value types.
+ * @internal This is an internal type used in public API.
+ */
+export type PrimitiveValueType = "Id" | Exclude<EC.PrimitiveType, "Binary" | "IGeometry">;
+/**
+ * Describes a single step through an ECRelationship from source ECClass to target ECClass.
+ * @internal This is an internal type used in public API.
+ */
+export interface RelationshipPathStep {
+    /** Full name of the source ECClass */
+    sourceClassName: string;
+    /** Full name of the target ECClass */
+    targetClassName: string;
+    /** Full name of the ECRelationshipClass */
+    relationshipName: string;
+    /**
+     * Indicates that the relationship direction be reversed. This should be set to `true` when step direction
+     * doesn't match relationship direction, e.g. relationship is from source `A` to target `B` and the step
+     * describes a step from `B` to `A`.
+     */
+    relationshipReverse?: boolean;
+}
+/**
+ * Describes a path from source ECClass to target ECClass through multiple ECRelationships.
+ * @internal This is an internal type used in public API.
+ */
+export type RelationshipPath<TStep extends RelationshipPathStep = RelationshipPathStep> = TStep[];
+/**
+ * Finds a class with the specified full class name using the given `ECSchemaProvider`.
+ * @throws Error if the schema or class is not found.
+ * @beta
+ */
+export declare function getClass(schemaProvider: ECSchemaProvider, fullClassName: string): Promise<EC.Class>;
+//# sourceMappingURL=Metadata.d.ts.map

package/lib/esm/shared/Metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metadata.d.ts","sourceRoot":"","sources":["../../../src/shared/Metadata.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,CAAC,oBAAoB,EAAE,MAAM,EAAE,0BAA0B,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;CAChH;AAED;;;GAGG;AACH,wBAAgB,sCAAsC,CAAC,KAAK,EAAE;IAC5D,8DAA8D;IAC9D,cAAc,EAAE,gBAAgB,CAAC;IACjC,gJAAgJ;IAChJ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GAAG,yBAAyB,CAsB5B;AAED;;;;GAIG;AACH,yBAAiB,EAAE,CAAC;IAClB;;;;OAIG;IACH,UAAiB,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;KACpD;IAED;;;;OAIG;IACH,UAAiB,UAAU;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;OAIG;IACH,UAAiB,KAAM,SAAQ,UAAU;QACvC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5D,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QACnC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;QACzD,aAAa,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC1C,aAAa,IAAI,IAAI,IAAI,WAAW,CAAC;QACrC,mBAAmB,IAAI,IAAI,IAAI,iBAAiB,CAAC;QACjD,aAAa,IAAI,IAAI,IAAI,WAAW,CAAC;QACrC,OAAO,IAAI,IAAI,IAAI,KAAK,CAAC;KAC1B;IAED;;;;OAIG;IACH,KAAY,WAAW,GAAG,KAAK,CAAC;IAEhC;;;;OAIG;IACH,KAAY,WAAW,GAAG,KAAK,CAAC;IAEhC;;;;OAIG;IACH,KAAY,KAAK,GAAG,KAAK,CAAC;IAE1B;;;;OAIG;IACH,KAAY,cAAc,GAAG,UAAU,CAAC;IAExC;;;;OAIG;IACH,UAAiB,kCAAkC;QACjD,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;;;OAIG;IACH,UAAiB,sBAAsB;QACrC,YAAY,CAAC,EAAE,kCAAkC,CAAC;QAClD,WAAW,EAAE,OAAO,CAAC;QACrB,kBAAkB,EAAE,OAAO,CAAC,WAAW,GAAG,KAAK,GAAG,iBAAiB,GAAG,SAAS,CAAC,CAAC;KAClF;IAED;;;;OAIG;IACH,UAAiB,iBAAkB,SAAQ,KAAK;QAC9C,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;QAClC,MAAM,EAAE,sBAAsB,CAAC;QAC/B,MAAM,EAAE,sBAAsB,CAAC;KAChC;IAED;;;;OAIG;IACH,UAAiB,UAAU,CAAC,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,CAAC,CAAC;QACT,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;;;OAIG;IACH,UAAiB,WAAY,SAAQ,UAAU;QAC7C,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;QAChD,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAC1B,QAAQ,EAAE,OAAO,CAAC;KACnB;IAED;;;;OAIG;IACH,UAAiB,QAAQ;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;QAEpD,OAAO,IAAI,IAAI,IAAI,aAAa,CAAC;QACjC,QAAQ,IAAI,IAAI,IAAI,cAAc,CAAC;QACnC,WAAW,IAAI,IAAI,IAAI,iBAAiB,CAAC;QACzC,aAAa,IAAI,IAAI,IAAI,mBAAmB,CAAC;QAC7C,YAAY,IAAI,IAAI,IAAI,kBAAkB,CAAC;KAC5C;IAED;;;;OAIG;IACH,UAAiB,uBAAuB;QACtC,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED;;;;OAIG;IACH,KAAY,mBAAmB,GAAG,cAAc,GAAG,uBAAuB,CAAC;IAC3E;;;;OAIG;IACH,KAAY,wBAAwB,GAAG,mBAAmB,GAAG,uBAAuB,CAAC;IACrF;;;;OAIG;IACH,KAAY,sBAAsB,GAAG,iBAAiB,GAAG,uBAAuB,CAAC;IACjF;;;;OAIG;IACH,KAAY,aAAa,GAAG,mBAAmB,GAAG,wBAAwB,GAAG,sBAAsB,CAAC;IAEpG;;;;OAIG;IACH,UAAiB,cAAe,SAAQ,QAAQ;QAC9C,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED;;;;OAIG;IACH,UAAiB,mBAAoB,SAAQ,QAAQ;QACnD,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;QAC9C,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B;IAED;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,QAAQ;QAClD,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC9C,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;KACnC;IAED;;;;OAIG;IACH,KAAY,aAAa,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE/I;;;;OAIG;IACH,UAAiB,iBAAkB,SAAQ,QAAQ;QACjD,aAAa,EAAE,aAAa,CAAC;QAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,aAAa,EAAE,QAAQ,GAAG,WAAW,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,sCAAsC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,sCAAsC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,oBAAoB,GAAG,oBAAoB,IAAI,KAAK,EAAE,CAAC;AAElG;;;;GAIG;AACH,wBAAsB,QAAQ,CAAC,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAWzG"}

package/lib/esm/shared/Metadata.js

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { LRUMap } from "@itwin/core-bentley";
+import { parseFullClassName } from "./Utils";
+/**
+ * Creates a new `ECClassHierarchyInspector` that caches results of `derivesFrom` calls.
+ * @beta
+ */
+export function createCachingECClassHierarchyInspector(props) {
+    const map = new LRUMap(props.cacheSize ?? 0);
+    function createCacheKey(derivedClassName, baseClassName) {
+        return `${derivedClassName}/${baseClassName}`;
+    }
+    return {
+        classDerivesFrom(derivedClassFullName, candidateBaseClassFullName) {
+            const cacheKey = createCacheKey(derivedClassFullName, candidateBaseClassFullName);
+            let result = map.get(cacheKey);
+            if (result === undefined) {
+                result = Promise.all([getClass(props.schemaProvider, derivedClassFullName), getClass(props.schemaProvider, candidateBaseClassFullName)]).then(async ([derivedClass, baseClass]) => {
+                    const resolvedResult = await derivedClass.is(baseClass);
+                    map.set(cacheKey, resolvedResult);
+                    return resolvedResult;
+                });
+                map.set(cacheKey, result);
+            }
+            return result;
+        },
+    };
+}
+/**
+ * Finds a class with the specified full class name using the given `ECSchemaProvider`.
+ * @throws Error if the schema or class is not found.
+ * @beta
+ */
+export async function getClass(schemaProvider, fullClassName) {
+    const { schemaName, className } = parseFullClassName(fullClassName);
+    const schema = await schemaProvider.getSchema(schemaName);
+    if (!schema) {
+        throw new Error(`Schema "${schemaName}" not found.`);
+    }
+    const lookupClass = await schema.getClass(className);
+    if (!lookupClass) {
+        throw new Error(`Class "${className}" not found in schema "${schemaName}".`);
+    }
+    return lookupClass;
+}
+//# sourceMappingURL=Metadata.js.map

package/lib/esm/shared/Metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metadata.js","sourceRoot":"","sources":["../../../src/shared/Metadata.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAqB7C;;;GAGG;AACH,MAAM,UAAU,sCAAsC,CAAC,KAKtD;IACC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAqC,KAAK,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC;IACjF,SAAS,cAAc,CAAC,gBAAwB,EAAE,aAAqB;QACrE,OAAO,GAAG,gBAAgB,IAAI,aAAa,EAAE,CAAC;IAChD,CAAC;IACD,OAAO;QACL,gBAAgB,CAAC,oBAA4B,EAAE,0BAAkC;YAC/E,MAAM,QAAQ,GAAG,cAAc,CAAC,oBAAoB,EAAE,0BAA0B,CAAC,CAAC;YAClF,IAAI,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,oBAAoB,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,IAAI,CAC3I,KAAK,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE;oBAClC,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBACxD,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;oBAClC,OAAO,cAAc,CAAC;gBACxB,CAAC,CACF,CAAC;gBACF,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC5B,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC;AAoQD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,cAAgC,EAAE,aAAqB;IACpF,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IACpE,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,cAAc,CAAC,CAAC;IACvD,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,0BAA0B,UAAU,IAAI,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/lib/esm/shared/Utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * An utility to parse schema and class names from full class name, where
+ * schema and class names are separated by either `:` or `.`.
+ * @beta
+ */
+export declare function parseFullClassName(fullClassName: string): {
+    schemaName: string;
+    className: string;
+};
+/**
+ * An utility to normalize full class name from either `SchemaName:ClassName` or
+ * `SchemaName.ClassName` to always use the dot format.
+ * @beta
+ */
+export declare function normalizeFullClassName(fullClassName: string): string;
+/**
+ * An utility to remove all extra whitespace from a given string.
+ * @beta
+ */
+export declare function trimWhitespace(str: string): string;
+/**
+ * An utility to remove all extra whitespace from a given string.
+ * @beta
+ */
+export declare function trimWhitespace(str: string | undefined): string | undefined;
+//# sourceMappingURL=Utils.d.ts.map

package/lib/esm/shared/Utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/shared/Utils.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM;;;EAIvD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CASpE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;AACpD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC"}

package/lib/esm/shared/Utils.js

@@ -0,0 +1,44 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { assert } from "@itwin/core-bentley";
+/**
+ * An utility to parse schema and class names from full class name, where
+ * schema and class names are separated by either `:` or `.`.
+ * @beta
+ */
+export function parseFullClassName(fullClassName) {
+    const [schemaName, className] = fullClassName.split(/[\.:]/);
+    assert(!!schemaName && !!className, "Invalid full class name");
+    return { schemaName, className };
+}
+/**
+ * An utility to normalize full class name from either `SchemaName:ClassName` or
+ * `SchemaName.ClassName` to always use the dot format.
+ * @beta
+ */
+export function normalizeFullClassName(fullClassName) {
+    const colonPos = fullClassName.indexOf(":");
+    if (-1 === colonPos) {
+        assert(fullClassName.indexOf(".") !== -1, "Invalid full class name");
+        return fullClassName;
+    }
+    const schemaName = fullClassName.slice(0, colonPos);
+    const className = fullClassName.slice(colonPos + 1);
+    return `${schemaName}.${className}`;
+}
+/** @beta */
+export function trimWhitespace(str) {
+    // istanbul ignore next
+    if (!str) {
+        return str;
+    }
+    return str
+        .replaceAll(/\s+/gm, " ") // replace all consecutive spaces with a single space
+        .replaceAll(/\(\s+/g, "(") // remove spaces after opening parentheses
+        .replaceAll(/\s+\)/g, ")") // remove spaces before closing parentheses
+        .replaceAll(/\s+,/g, ",") // remove spaces before comma
+        .trim(); // remove spaces from beginning and end of the string
+}
+//# sourceMappingURL=Utils.js.map

package/lib/esm/shared/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/shared/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,aAAqB;IACtD,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,SAAS,EAAE,yBAAyB,CAAC,CAAC;IAC/D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,aAAqB;IAC1D,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpB,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,yBAAyB,CAAC,CAAC;QACrE,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACpD,MAAM,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;IACpD,OAAO,GAAG,UAAU,IAAI,SAAS,EAAE,CAAC;AACtC,CAAC;AAYD,YAAY;AACZ,MAAM,UAAU,cAAc,CAAC,GAAuB;IACpD,uBAAuB;IACvB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,GAAG;SACP,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,qDAAqD;SAC9E,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,0CAA0C;SACpE,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,2CAA2C;SACrE,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,6BAA6B;SACtD,IAAI,EAAE,CAAC,CAAC,qDAAqD;AAClE,CAAC"}

package/lib/esm/shared/Values.d.ts

@@ -0,0 +1,119 @@
+import { Id64String } from "@itwin/core-bentley";
+import { PrimitiveValueType } from "./Metadata";
+/**
+ * A data structure uniquely identifying an ECInstance in an iModel.
+ * @beta
+ */
+export interface InstanceKey {
+    /** Full class name in format `SchemaName.ClassName` */
+    className: string;
+    /** ECInstance ID */
+    id: Id64String;
+}
+/** @beta */
+export declare namespace InstanceKey {
+    /**
+     * Checks whether the two given instance keys are equal.
+     * @beta
+     */
+    function equals(lhs: InstanceKey, rhs: InstanceKey): boolean;
+    /**
+     * Compares two given instance keys.
+     * @returns
+     *- `0` if they are equal
+     *- `negative value` if lhs key is less than rhs key
+     *- `positive value` if lhs key is more than rhs key
+     */
+    function compare(lhs: InstanceKey, rhs: InstanceKey): number;
+}
+/**
+ * A data structure for a 2d point.
+ * @internal This is an internal type used in public API.
+ */
+export interface Point2d {
+    x: number;
+    y: number;
+}
+/**
+ * A data structure for a 3d point.
+ * @internal This is an internal type used in public API.
+ */
+export interface Point3d {
+    x: number;
+    y: number;
+    z: number;
+}
+/**
+ * A union for all supported primitive value types.
+ * @beta
+ */
+export type PrimitiveValue = Id64String | string | number | boolean | Date | Point2d | Point3d;
+/** @beta */
+export declare namespace PrimitiveValue {
+    /**
+     * Checks whether the given value is a `Point2d`.
+     * @note Since `Point3d` is a superset of `Point2d`, this function will return `true` for `Point3d` as well.
+     * @beta
+     */
+    function isPoint2d(value: PrimitiveValue): value is Point2d;
+    /**
+     * Checks whether the given value is a `Point3d`.
+     * @beta
+     */
+    function isPoint3d(value: PrimitiveValue): value is Point3d;
+}
+/**
+ * A type for a primitive value, its type and, optionally, its extended type.
+ * @note Use `TypedPrimitiveValue.create` to create an instance of this type.
+ * @beta
+ */
+export type TypedPrimitiveValue = ({
+    value: number;
+    type: "Integer" | "Long";
+} | {
+    value: number;
+    type: "Double";
+    koqName?: string;
+} | {
+    value: boolean;
+    type: "Boolean";
+} | {
+    value: Id64String;
+    type: "Id";
+} | {
+    value: string;
+    type: "String";
+} | {
+    value: number | string | Date;
+    type: "DateTime";
+} | {
+    value: Point2d;
+    type: "Point2d";
+} | {
+    value: Point3d;
+    type: "Point3d";
+}) & {
+    extendedType?: string;
+};
+/** @beta */
+export declare namespace TypedPrimitiveValue {
+    /**
+     * A function for a creating a `TypedPrimitiveValue` object.
+     * @throws Error if primitive type and value are incompatible.
+     * @beta
+     */
+    function create(value: PrimitiveValue, type: PrimitiveValueType, koqName?: string, extendedType?: string): TypedPrimitiveValue;
+}
+/**
+ * A type for a primitive property value and its metadata - property name and its class full name.
+ * @internal This is an internal type used in public API.
+ */
+export interface PrimitivePropertyValue {
+    /** Full name of the class containing the property with `propertyName` name. */
+    className: string;
+    /** Name of the primitive property whose value this data structure holds. */
+    propertyName: string;
+    /** Raw value of the primitive property. */
+    value: PrimitiveValue;
+}
+//# sourceMappingURL=Values.d.ts.map

package/lib/esm/shared/Values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Values.d.ts","sourceRoot":"","sources":["../../../src/shared/Values.ts"],"names":[],"mappings":"AAKA,OAAO,EAAwB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,EAAE,EAAE,UAAU,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IAC3B;;;OAGG;IACH,SAAgB,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,GAAG,OAAO,CAElE;IACD;;;;;;OAMG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,GAAG,MAAM,CAMlE;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC;AAE/F,YAAY;AAEZ,yBAAiB,cAAc,CAAC;IAC9B;;;;OAIG;IACH,SAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,OAAO,CAMjE;IAED;;;OAGG;IACH,SAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,OAAO,CAMjE;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B;IACE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC;CAC1B,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;CACjB,GACD;IACE,KAAK,EAAE,UAAU,CAAC;IAClB,IAAI,EAAE,IAAI,CAAC;CACZ,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;CAChB,GACD;IACE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC9B,IAAI,EAAE,UAAU,CAAC;CAClB,GACD;IACE,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;CACjB,GACD;IACE,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;CACjB,CACJ,GAAG;IACF,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,YAAY;AAEZ,yBAAiB,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,SAAgB,MAAM,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,mBAAmB,CA8EpI;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,YAAY,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,KAAK,EAAE,cAAc,CAAC;CACvB"}