@itwin/presentation-shared/lib/esm/shared/Metadata.d.ts

The package contains types and utilities used across different iTwin.js Presentation packages.

/**
 * An interface for an object that knows how to get an ECSchema from an iModel.
 *
 * @see `createECSchemaProvider` in `@itwin/presentation-core-interop`.
 * @public
 */
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`
 * @public
 */
export interface ECClassHierarchyInspector {
    classDerivesFrom(derivedClassFullName: string, candidateBaseClassFullName: string): Promise<boolean> | boolean;
}
/**
 * Creates a new `ECClassHierarchyInspector` that caches results of `derivesFrom` calls.
 * @public
 */
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/).
 * @public
 * @see `ECSchemaProvider`
 */
export declare namespace EC {
    /**
     * Represents an ECSchema that contains classes, relationships, etc.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/schema/
     * @public
     */
    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/
     * @public
     */
    interface SchemaItem {
        schema: Schema;
        fullName: string;
        name: string;
        label?: string;
    }
    /**
     * Represents an ECClass.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/ecclass/
     * @public
     */
    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/
     * @public
     */
    type EntityClass = Class;
    /**
     * Represents a struct class.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/structclass/
     * @public
     */
    type StructClass = Class;
    /**
     * Represents a mixin.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/mixin/
     * @public
     */
    type Mixin = Class;
    /**
     * Represents a kind of quantity.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/kindofquantity/
     * @public
     */
    type KindOfQuantity = SchemaItem;
    /**
     * Represents a relationship constraint multiplicity.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/relationshipmultiplicity/
     * @public
     */
    interface RelationshipConstraintMultiplicity {
        lowerLimit: number;
        upperLimit: number;
    }
    /**
     * Represents a relationship constraint.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/relationshipconstraint/
     * @public
     */
    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/
     * @public
     */
    interface RelationshipClass extends Class {
        direction: "Forward" | "Backward";
        source: RelationshipConstraint;
        target: RelationshipConstraint;
    }
    /**
     * Represents an enumerator.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumerator/
     * @public
     */
    interface Enumerator<T> {
        name: string;
        value: T;
        label?: string;
        description?: string;
    }
    /**
     * Represents an enumeration.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumeration/
     * @public
     */
    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/
     * @public
     */
    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/
     * @public
     */
    interface ArrayPropertyAttributes {
        minOccurs: number;
        maxOccurs?: number;
    }
    /**
     * Defines a structs array property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/structarrayproperty/
     * @public
     */
    type StructArrayProperty = StructProperty & ArrayPropertyAttributes;
    /**
     * Defines an enumerations array property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumerationarrayproperty/
     * @public
     */
    type EnumerationArrayProperty = EnumerationProperty & ArrayPropertyAttributes;
    /**
     * Defines a primitives array property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/primitivearrayproperty/
     * @public
     */
    type PrimitiveArrayProperty = PrimitiveProperty & ArrayPropertyAttributes;
    /**
     * Defines an array property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/anyarrayproperty/
     * @public
     */
    type ArrayProperty = StructArrayProperty | EnumerationArrayProperty | PrimitiveArrayProperty;
    /**
     * Defines a struct property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/structproperty/
     * @public
     */
    interface StructProperty extends Property {
        structClass: StructClass;
    }
    /**
     * Defines an enumeration property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/enumerationproperty/
     * @public
     */
    interface EnumerationProperty extends Property {
        enumeration: Promise<Enumeration | undefined>;
        extendedTypeName?: string;
    }
    /**
     * Defines a navigation property.
     * @see https://www.itwinjs.org/reference/ecschema-metadata/metadata/navigationproperty/
     * @public
     */
    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/
     * @public
     */
    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/
     * @public
     */
    interface PrimitiveProperty extends Property {
        primitiveType: PrimitiveType;
        extendedTypeName?: string;
    }
}
/**
 * An identifiers' union of all supported primitive value types.
 * @public
 */
export type PrimitiveValueType = "Id" | Exclude<EC.PrimitiveType, "Binary" | "IGeometry">;
/**
 * Describes a single step through an ECRelationship from source ECClass to target ECClass.
 * @public
 */
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.
 * @public
 */
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.
 * @public
 */
export declare function getClass(schemaProvider: ECSchemaProvider, fullClassName: string): Promise<EC.Class>;
//# sourceMappingURL=Metadata.d.ts.map