@itwin/presentation-common 3.4.0-dev.9 → 3.4.1

package/lib/cjs/presentation-common/Diagnostics.js.map

@@ -1 +1 @@
-{"version":3,"file":"Diagnostics.js","sourceRoot":"","sources":["../../../src/presentation-common/Diagnostics.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA6DH,aAAa;AACb,IAAiB,mBAAmB,CAOnC;AAPD,WAAiB,mBAAmB;IAClC,SAAgB,SAAS,CAAC,KAA0B;QAClD,OAAO,CAAC,CAAE,KAAa,CAAC,OAAO,CAAC;IAClC,CAAC;IAFe,6BAAS,YAExB,CAAA;IACD,SAAgB,OAAO,CAAC,KAA0B;QAChD,OAAO,CAAC,CAAE,KAAa,CAAC,KAAK,CAAC;IAChC,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EAPgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAOnC","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 Core\r\n */\r\n\r\n/** @alpha */\r\nexport type DiagnosticsLoggerSeverity = \"error\" | \"warning\" | \"info\" | \"debug\" | \"trace\";\r\n\r\n/** @alpha */\r\nexport interface Diagnostics {\r\n  logs?: DiagnosticsScopeLogs[];\r\n}\r\n\r\n/** @alpha */\r\nexport interface ClientDiagnostics extends Diagnostics {\r\n  backendVersion?: string;\r\n}\r\n\r\n/** @alpha */\r\nexport interface DiagnosticsOptions {\r\n  /** Measure performance */\r\n  perf?: boolean;\r\n  /** Severity for developer log messages */\r\n  dev?: boolean | DiagnosticsLoggerSeverity;\r\n  /** Severity for presentation rules' editor log messages */\r\n  editor?: boolean | DiagnosticsLoggerSeverity;\r\n}\r\n\r\n/** @alpha */\r\nexport type ClientDiagnosticsHandler = (logs: ClientDiagnostics) => void;\r\n\r\n/** @alpha */\r\nexport interface ClientDiagnosticsOptions extends DiagnosticsOptions {\r\n  backendVersion?: boolean;\r\n  handler: ClientDiagnosticsHandler;\r\n}\r\n\r\n/** @public */\r\nexport interface ClientDiagnosticsAttribute {\r\n  /** @alpha */\r\n  diagnostics?: ClientDiagnosticsOptions;\r\n}\r\n\r\n/** @alpha */\r\nexport interface DiagnosticsLogMessage {\r\n  severity: {\r\n    dev?: DiagnosticsLoggerSeverity;\r\n    editor?: DiagnosticsLoggerSeverity;\r\n  };\r\n  category: string;\r\n  message: string;\r\n  timestamp: number;\r\n}\r\n\r\n/** @alpha */\r\nexport interface DiagnosticsScopeLogs {\r\n  scope: string;\r\n  duration?: number;\r\n  logs?: DiagnosticsLogEntry[];\r\n}\r\n\r\n/** @alpha */\r\nexport type DiagnosticsLogEntry = DiagnosticsLogMessage | DiagnosticsScopeLogs;\r\n\r\n/** @alpha */\r\nexport namespace DiagnosticsLogEntry { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  export function isMessage(entry: DiagnosticsLogEntry): entry is DiagnosticsLogMessage {\r\n    return !!(entry as any).message;\r\n  }\r\n  export function isScope(entry: DiagnosticsLogEntry): entry is DiagnosticsScopeLogs {\r\n    return !!(entry as any).scope;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Diagnostics.js","sourceRoot":"","sources":["../../../src/presentation-common/Diagnostics.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAQH;;;;;;;;GAQG;AACH,SAAgB,4BAA4B,CAAC,GAAoD,EAAE,GAAoD;IACrJ,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG;QACd,OAAO,SAAS,CAAC;IACnB,MAAM,gBAAgB,GACpB,CAAC,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC9E,CAAC,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBAC3C,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;IACvE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AATD,oEASC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,4BAA4B,CAAC,GAAoD,EAAE,GAAoD;IACrJ,MAAM,aAAa,GAA8B,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAC/H,MAAM,aAAa,GAA8B,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IAC/H,IAAI,aAAa,KAAK,aAAa;QACjC,OAAO,CAAC,CAAC;IACX,IAAI,aAAa,KAAK,OAAO;QAC3B,OAAO,CAAC,CAAC;IACX,IAAI,aAAa,KAAK,SAAS;QAC7B,OAAO,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,aAAa,KAAK,MAAM;QAC1B,OAAO,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3E,IAAI,aAAa,KAAK,OAAO;QAC3B,OAAO,aAAa,KAAK,MAAM,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvG,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAdD,oEAcC;AA6FD;;;GAGG;AACH,IAAiB,mBAAmB,CAOnC;AAPD,WAAiB,mBAAmB;IAClC,SAAgB,SAAS,CAAC,KAA0B;QAClD,OAAO,CAAC,CAAE,KAAa,CAAC,OAAO,CAAC;IAClC,CAAC;IAFe,6BAAS,YAExB,CAAA;IACD,SAAgB,OAAO,CAAC,KAA0B;QAChD,OAAO,CAAC,CAAE,KAAa,CAAC,KAAK,CAAC;IAChC,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EAPgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAOnC","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 Core\n */\n\n/**\n * Type of diagnostics logger severity.\n * @beta\n */\nexport type DiagnosticsLoggerSeverity = \"error\" | \"warning\" | \"info\" | \"debug\" | \"trace\";\n\n/**\n * Returns lower severity of the given two. Examples:\n * ```\n * combineDiagnosticsSeverities(\"error\", \"error\") === \"error\"\n * combineDiagnosticsSeverities(\"error\", \"debug\") === \"debug\"\n * combineDiagnosticsSeverities(\"debug\", \"error\") === \"debug\"\n * ```\n * @internal\n */\nexport function combineDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity) {\n  if (!lhs && !rhs)\n    return undefined;\n  const combinedSeverity: DiagnosticsLoggerSeverity =\n    (lhs === \"trace\" || rhs === \"trace\") ? \"trace\" :\n      (lhs === \"debug\" || lhs === true || rhs === \"debug\" || rhs === true) ? \"debug\" :\n        (lhs === \"info\" || rhs === \"info\") ? \"info\" :\n          (lhs === \"warning\" || rhs === \"warning\") ? \"warning\" : \"error\";\n  return combinedSeverity;\n}\n\n/**\n * Returns 0 if the given severities are equal after normalization, negative if `lhs` is lower, positive if higher. Examples:\n * ```\n * compareDiagnosticsSeverities(\"error\", \"error\") === 0\n * compareDiagnosticsSeverities(\"error\", false) === 0\n * compareDiagnosticsSeverities(\"error\", undefined) === 0\n * compareDiagnosticsSeverities(\"debug\", true) === 0\n * compareDiagnosticsSeverities(\"debug\", \"error\") < 0\n * compareDiagnosticsSeverities(\"error\", \"debug\") > 0\n * ```\n * @internal\n */\nexport function compareDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity) {\n  const normalizedLhs: DiagnosticsLoggerSeverity = (lhs === undefined || lhs === false) ? \"error\" : lhs === true ? \"debug\" : lhs;\n  const normalizedRhs: DiagnosticsLoggerSeverity = (rhs === undefined || rhs === false) ? \"error\" : rhs === true ? \"debug\" : rhs;\n  if (normalizedLhs === normalizedRhs)\n    return 0;\n  if (normalizedLhs === \"error\")\n    return 1;\n  if (normalizedLhs === \"warning\")\n    return normalizedRhs === \"error\" ? -1 : 1;\n  if (normalizedLhs === \"info\")\n    return normalizedRhs === \"warning\" || normalizedRhs === \"error\" ? -1 : 1;\n  if (normalizedLhs === \"debug\")\n    return normalizedRhs === \"info\" || normalizedRhs === \"warning\" || normalizedRhs === \"error\" ? -1 : 1;\n  return -1;\n}\n\n/**\n * Data structure for diagnostics information.\n * @beta\n */\nexport interface Diagnostics {\n  logs?: DiagnosticsScopeLogs[];\n}\n\n/**\n * Data structure with client diagnostics information.\n * @beta\n */\nexport interface ClientDiagnostics extends Diagnostics {\n  backendVersion?: string;\n}\n\n/**\n * Data structure for diagnostics options.\n * @beta\n */\nexport interface DiagnosticsOptions {\n  /**\n   * Flag specifying that performance should be measured, or\n   * minimum duration in milliseconds for which performance metric should be included.\n   */\n  perf?: boolean | { minimumDuration: number };\n  /** Severity for developer log messages */\n  dev?: boolean | DiagnosticsLoggerSeverity;\n  /** Severity for presentation rules' editor log messages */\n  editor?: boolean | DiagnosticsLoggerSeverity;\n}\n\n/**\n * A function that can be called after receiving diagnostics.\n * @beta\n */\nexport type ClientDiagnosticsHandler = (logs: ClientDiagnostics) => void;\n\n/**\n * Data structure for client diagnostics options.\n * @beta\n */\nexport interface ClientDiagnosticsOptions extends DiagnosticsOptions {\n  backendVersion?: boolean;\n  handler: ClientDiagnosticsHandler;\n}\n\n/**\n * Data structure which contains client diagnostics options.\n * @public\n */\nexport interface ClientDiagnosticsAttribute {\n  /**\n   * Diagnostics options.\n   * @beta\n   */\n  diagnostics?: ClientDiagnosticsOptions;\n}\n\n/**\n * Data structure for diagnostics log message information.\n * @beta\n */\nexport interface DiagnosticsLogMessage {\n  severity: {\n    dev?: DiagnosticsLoggerSeverity;\n    editor?: DiagnosticsLoggerSeverity;\n  };\n  category: string;\n  message: string;\n  timestamp: number;\n}\n\n/**\n * Data structure for diagnostics scope information.\n * @beta\n */\nexport interface DiagnosticsScopeLogs {\n  scope: string;\n  scopeCreateTimestamp?: number;\n  duration?: number;\n  logs?: DiagnosticsLogEntry[];\n  attributes?: { [attributeKey: string]: string | string[] };\n}\n\n/**\n * Data structure for diagnostics log entry.\n * @beta\n */\nexport type DiagnosticsLogEntry = DiagnosticsLogMessage | DiagnosticsScopeLogs;\n\n/**\n * Functions related to diagnostics log entry.\n * @beta\n */\nexport namespace DiagnosticsLogEntry { // eslint-disable-line @typescript-eslint/no-redeclare\n  export function isMessage(entry: DiagnosticsLogEntry): entry is DiagnosticsLogMessage {\n    return !!(entry as any).message;\n  }\n  export function isScope(entry: DiagnosticsLogEntry): entry is DiagnosticsScopeLogs {\n    return !!(entry as any).scope;\n  }\n}\n"]}

package/lib/cjs/presentation-common/EC.d.ts

@@ -1,316 +1,316 @@
-/** @packageDocumentation
- * @module Core
- */
-import { Id64String } from "@itwin/core-bentley";
-import { FormatProps } from "@itwin/core-quantity";
-import { PartialBy } from "./Utils";
-/**
- * Type of an ECClass ID.
- * @public
- */
-export declare type ClassId = Id64String;
-/**
- * Type of an ECInstance ID.
- * @public
- */
-export declare type InstanceId = Id64String;
-/**
- * A key that uniquely identifies an instance in an iModel
- * @public
- */
-export interface InstanceKey {
-    /** Full class name in format `SchemaName:ClassName` */
-    className: string;
-    /** ECInstance ID */
-    id: InstanceId;
-}
-/** @public */
-export declare namespace InstanceKey {
-    /** Compare 2 instance keys */
-    function compare(lhs: InstanceKey, rhs: InstanceKey): number;
-    /** Serialize [[InstanceKey]] to JSON */
-    function toJSON(json: InstanceKey): InstanceKeyJSON;
-    /** Deserialize [[InstanceKey]] from JSON */
-    function fromJSON(json: InstanceKeyJSON): {
-        id: string;
-        className: string;
-    };
-}
-/**
- * A serialized version of [[InstanceKey]]
- * @public
- */
-export interface InstanceKeyJSON {
-    className: string;
-    id: string;
-}
-/**
- * Information about an ECClass
- * @public
- */
-export interface ClassInfo {
-    /** ECClass ID */
-    id: ClassId;
-    /** Full class name in format `SchemaName:ClassName` */
-    name: string;
-    /** ECClass label */
-    label: string;
-}
-/** @public */
-export declare namespace ClassInfo {
-    /** Serialize [[ClassInfo]] to JSON */
-    function toJSON(info: ClassInfo): ClassInfoJSON;
-    /** Deserialize [[ClassInfo]] from JSON */
-    function fromJSON(json: ClassInfoJSON): ClassInfo;
-}
-/**
- * A serialized version of [[ClassInfo]]
- * @public
- */
-export interface ClassInfoJSON {
-    id: string;
-    name: string;
-    label: string;
-}
-/**
- * A serialized and compressed version of [[ClassInfo]]
- * @public
- */
-export interface CompressedClassInfoJSON {
-    name: string;
-    label: string;
-}
-/**
- * A single choice in enumeration
- * @public
- */
-export interface EnumerationChoice {
-    /** Label of the choice */
-    label: string;
-    /** Value of the choice */
-    value: string | number;
-}
-/**
- * Enumeration information
- * @public
- */
-export interface EnumerationInfo {
-    /** Available enumeration choices */
-    choices: EnumerationChoice[];
-    /** Is the enumeration strict (values only allowed from `choices` list) */
-    isStrict: boolean;
-}
-/**
- * Kind of quantity information
- * @public
- */
-export interface KindOfQuantityInfo {
-    /** Full name of KindOfQuantity in format `SchemaName:KindOfQuantityName` */
-    name: string;
-    /** Label of KindOfQuantity */
-    label: string;
-    /**
-     * Persistence unit identifier.
-     * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
-     */
-    persistenceUnit: string;
-    /**
-     * Active format that was used to format property value.
-     * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
-     */
-    activeFormat?: FormatProps;
-}
-/**
- * Navigation property information
- * @beta
- */
-export interface NavigationPropertyInfo {
-    /** Information about ECProperty's relationship class */
-    classInfo: ClassInfo;
-    /** Is the direction of the relationship forward */
-    isForwardRelationship: boolean;
-    /** Information about ECProperty's target class */
-    targetClassInfo: ClassInfo;
-    /** Is ECProperty's target class polymorphic */
-    isTargetPolymorphic: boolean;
-}
-/** @beta */
-export declare namespace NavigationPropertyInfo {
-    /** Serialize [[NavigationPropertyInfo]] to JSON */
-    function toJSON(info: NavigationPropertyInfo): NavigationPropertyInfoJSON;
-    /** Serialize [[NavigationPropertyInfo]] to compressed JSON */
-    function toCompressedJSON(navigationPropertyInfo: NavigationPropertyInfo, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): NavigationPropertyInfoJSON<string>;
-    /** Deserialize [[NavigationPropertyInfo]] from JSON */
-    function fromJSON(json: NavigationPropertyInfo): NavigationPropertyInfo;
-    /** Deserialize [[NavigationPropertyInfo]] from compressed JSON */
-    function fromCompressedJSON(compressedNavigationPropertyInfoJSON: NavigationPropertyInfoJSON<string>, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): NavigationPropertyInfo;
-}
-/**
- * A serialized version of [[NavigationPropertyInfo]]
- * @beta
- */
-export interface NavigationPropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
-    classInfo: TClassInfoJSON;
-    isForwardRelationship: boolean;
-    targetClassInfo: TClassInfoJSON;
-    isTargetPolymorphic: boolean;
-}
-/**
- * A structure that describes an ECProperty
- * @public
- */
-export interface PropertyInfo {
-    /** Information about ECProperty class */
-    classInfo: ClassInfo;
-    /** Name of the ECProperty */
-    name: string;
-    /** Type name of the ECProperty */
-    type: string;
-    /** Enumeration info if the property is enumerable */
-    enumerationInfo?: EnumerationInfo;
-    /**
-     * Kind of quantity information, if any.
-     * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
-     */
-    kindOfQuantity?: KindOfQuantityInfo;
-    /** Extended type name of the ECProperty if it has one */
-    extendedType?: string;
-    /**
-     * Navigation property info if the field is navigation type
-     * @beta
-    */
-    navigationPropertyInfo?: NavigationPropertyInfo;
-}
-/** @public */
-export declare namespace PropertyInfo {
-    /** Serialize [[PropertyInfo]] to JSON */
-    function toJSON(info: PropertyInfo): PropertyInfoJSON;
-    /** Serialize [[PropertyInfo]] to compressed JSON */
-    function toCompressedJSON(propertyInfo: PropertyInfo, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): PropertyInfoJSON<string>;
-    /** Deserialize [[PropertyInfo]] from JSON */
-    function fromJSON(json: PropertyInfoJSON): PropertyInfo;
-}
-/**
- * A serialized version of [[PropertyInfo]]
- * @public
- */
-export interface PropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
-    classInfo: TClassInfoJSON;
-    name: string;
-    type: string;
-    enumerationInfo?: EnumerationInfo;
-    kindOfQuantity?: KindOfQuantityInfo;
-    /** @beta */
-    navigationPropertyInfo?: NavigationPropertyInfoJSON<TClassInfoJSON>;
-}
-/**
- * A structure that describes a related class and the properties of that relationship.
- * @public
- */
-export interface RelatedClassInfo {
-    /** Information about the source ECClass */
-    sourceClassInfo: ClassInfo;
-    /** Information about the target ECClass */
-    targetClassInfo: ClassInfo;
-    /** Is target class handled polymorphically */
-    isPolymorphicTargetClass: boolean;
-    /** Information about the ECRelationship */
-    relationshipInfo: ClassInfo;
-    /** Should relationship be followed in a forward direction to access the related class. */
-    isForwardRelationship: boolean;
-    /** Is relationship handled polymorphically */
-    isPolymorphicRelationship: boolean;
-}
-/** @public */
-export declare namespace RelatedClassInfo {
-    /** Serialize [[RelatedClassInfo]] to JSON */
-    function toJSON(info: RelatedClassInfo): RelatedClassInfoJSON;
-    /** Serialize [[RelatedClassInfo]] to compressed JSON */
-    function toCompressedJSON(classInfo: RelatedClassInfo, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): RelatedClassInfoJSON<string>;
-    /** Deserialize [[RelatedClassInfo]] from JSON */
-    function fromJSON(json: RelatedClassInfoJSON): RelatedClassInfo;
-    /** Deserialize [[RelatedClassInfo]] from compressed JSON */
-    function fromCompressedJSON(json: RelatedClassInfoJSON<string>, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): RelatedClassInfo;
-    /** Check two [[RelatedClassInfo]] or [[StrippedRelatedClassInfo]] for equality */
-    function equals(lhs: RelatedClassInfo | StrippedRelatedClassInfo, rhs: RelatedClassInfo | StrippedRelatedClassInfo): boolean;
-    /** Strip given [[RelatedClassInfo]] to [[StrippedRelatedClassInfo]] */
-    function strip(full: RelatedClassInfo): StrippedRelatedClassInfo;
-}
-/**
- * A serialized version of [[RelatedClassInfo]]
- * @public
- */
-export interface RelatedClassInfoJSON<TClassInfoJSON = ClassInfoJSON> {
-    sourceClassInfo: TClassInfoJSON;
-    targetClassInfo: TClassInfoJSON;
-    isPolymorphicTargetClass?: boolean;
-    relationshipInfo: TClassInfoJSON;
-    isForwardRelationship: boolean;
-    isPolymorphicRelationship?: boolean;
-}
-/**
- * A structure that describes a relationship between source and target classes where
- * an actual ECRelationship between them is optional.
- * @public
- */
-export declare type RelatedClassInfoWithOptionalRelationship = PartialBy<RelatedClassInfo, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
-/** @public */
-export declare type RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON = ClassInfoJSON> = PartialBy<RelatedClassInfoJSON<TClassInfoJSON>, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
-/** @public */
-export declare namespace RelatedClassInfoWithOptionalRelationship {
-    /** Serialize [[RelatedClassInfoWithOptionalRelationship]] to compressed JSON */
-    function toCompressedJSON(classInfo: RelatedClassInfoWithOptionalRelationship, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): RelatedClassInfoWithOptionalRelationshipJSON<string>;
-    /** Deserialize [[RelatedClassInfoWithOptionalRelationship]] from compressed JSON */
-    function fromCompressedJSON(json: RelatedClassInfoWithOptionalRelationshipJSON<string>, classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    }): RelatedClassInfoWithOptionalRelationship;
-}
-/**
- * A structure that describes a related class path.
- * @public
- */
-export declare type RelationshipPath = RelatedClassInfo[];
-/**
- * Serialized [[RelationshipPath]]
- * @public
- */
-export declare type RelationshipPathJSON<TClassInfoJSON = ClassInfoJSON> = RelatedClassInfoJSON<TClassInfoJSON>[];
-/** @public */
-export declare namespace RelationshipPath {
-    /** Reverse direction of the given [[RelationshipPath]] */
-    function reverse(path: RelationshipPath): RelationshipPath;
-    /** Check two [[RelationshipPath]] or [[StrippedRelationshipPath]] for equality */
-    function equals(lhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>, rhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>): boolean;
-    /** Strip given [[RelationshipPath]] to [[StrippedRelationshipPath]] */
-    function strip(full: RelationshipPath): StrippedRelationshipPath;
-}
-/**
- * Data structure that contains a subset of [[RelatedClassInfo]] required to
- * identify the relationship.
- * @public
- */
-export interface StrippedRelatedClassInfo {
-    sourceClassName: string;
-    targetClassName: string;
-    relationshipName: string;
-    isForwardRelationship: boolean;
-}
-/**
- * Data structure that contains a subset of [[RelationshipPath]] required to
- * identify the relationship path.
- * @public
- */
-export declare type StrippedRelationshipPath = StrippedRelatedClassInfo[];
+/** @packageDocumentation
+ * @module Core
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { FormatProps } from "@itwin/core-quantity";
+import { PartialBy } from "./Utils";
+/**
+ * Type of an ECClass ID.
+ * @public
+ */
+export declare type ClassId = Id64String;
+/**
+ * Type of an ECInstance ID.
+ * @public
+ */
+export declare type InstanceId = Id64String;
+/**
+ * A key that uniquely identifies an instance in an iModel
+ * @public
+ */
+export interface InstanceKey {
+    /** Full class name in format `SchemaName:ClassName` */
+    className: string;
+    /** ECInstance ID */
+    id: InstanceId;
+}
+/** @public */
+export declare namespace InstanceKey {
+    /** Compare 2 instance keys */
+    function compare(lhs: InstanceKey, rhs: InstanceKey): number;
+    /** Serialize [[InstanceKey]] to JSON */
+    function toJSON(json: InstanceKey): InstanceKeyJSON;
+    /** Deserialize [[InstanceKey]] from JSON */
+    function fromJSON(json: InstanceKeyJSON): {
+        id: string;
+        className: string;
+    };
+}
+/**
+ * A serialized version of [[InstanceKey]]
+ * @public
+ */
+export interface InstanceKeyJSON {
+    className: string;
+    id: string;
+}
+/**
+ * Information about an ECClass
+ * @public
+ */
+export interface ClassInfo {
+    /** ECClass ID */
+    id: ClassId;
+    /** Full class name in format `SchemaName:ClassName` */
+    name: string;
+    /** ECClass label */
+    label: string;
+}
+/** @public */
+export declare namespace ClassInfo {
+    /** Serialize [[ClassInfo]] to JSON */
+    function toJSON(info: ClassInfo): ClassInfoJSON;
+    /** Deserialize [[ClassInfo]] from JSON */
+    function fromJSON(json: ClassInfoJSON): ClassInfo;
+}
+/**
+ * A serialized version of [[ClassInfo]]
+ * @public
+ */
+export interface ClassInfoJSON {
+    id: string;
+    name: string;
+    label: string;
+}
+/**
+ * A serialized and compressed version of [[ClassInfo]]
+ * @public
+ */
+export interface CompressedClassInfoJSON {
+    name: string;
+    label: string;
+}
+/**
+ * A single choice in enumeration
+ * @public
+ */
+export interface EnumerationChoice {
+    /** Label of the choice */
+    label: string;
+    /** Value of the choice */
+    value: string | number;
+}
+/**
+ * Enumeration information
+ * @public
+ */
+export interface EnumerationInfo {
+    /** Available enumeration choices */
+    choices: EnumerationChoice[];
+    /** Is the enumeration strict (values only allowed from `choices` list) */
+    isStrict: boolean;
+}
+/**
+ * Kind of quantity information
+ * @public
+ */
+export interface KindOfQuantityInfo {
+    /** Full name of KindOfQuantity in format `SchemaName:KindOfQuantityName` */
+    name: string;
+    /** Label of KindOfQuantity */
+    label: string;
+    /**
+     * Persistence unit identifier.
+     * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
+     */
+    persistenceUnit: string;
+    /**
+     * Active format that was used to format property value.
+     * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
+     */
+    activeFormat?: FormatProps;
+}
+/**
+ * Navigation property information
+ * @beta
+ */
+export interface NavigationPropertyInfo {
+    /** Information about ECProperty's relationship class */
+    classInfo: ClassInfo;
+    /** Is the direction of the relationship forward */
+    isForwardRelationship: boolean;
+    /** Information about ECProperty's target class */
+    targetClassInfo: ClassInfo;
+    /** Is ECProperty's target class polymorphic */
+    isTargetPolymorphic: boolean;
+}
+/** @beta */
+export declare namespace NavigationPropertyInfo {
+    /** Serialize [[NavigationPropertyInfo]] to JSON */
+    function toJSON(info: NavigationPropertyInfo): NavigationPropertyInfoJSON;
+    /** Serialize [[NavigationPropertyInfo]] to compressed JSON */
+    function toCompressedJSON(navigationPropertyInfo: NavigationPropertyInfo, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): NavigationPropertyInfoJSON<string>;
+    /** Deserialize [[NavigationPropertyInfo]] from JSON */
+    function fromJSON(json: NavigationPropertyInfo): NavigationPropertyInfo;
+    /** Deserialize [[NavigationPropertyInfo]] from compressed JSON */
+    function fromCompressedJSON(compressedNavigationPropertyInfoJSON: NavigationPropertyInfoJSON<string>, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): NavigationPropertyInfo;
+}
+/**
+ * A serialized version of [[NavigationPropertyInfo]]
+ * @beta
+ */
+export interface NavigationPropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
+    classInfo: TClassInfoJSON;
+    isForwardRelationship: boolean;
+    targetClassInfo: TClassInfoJSON;
+    isTargetPolymorphic: boolean;
+}
+/**
+ * A structure that describes an ECProperty
+ * @public
+ */
+export interface PropertyInfo {
+    /** Information about ECProperty class */
+    classInfo: ClassInfo;
+    /** Name of the ECProperty */
+    name: string;
+    /** Type name of the ECProperty */
+    type: string;
+    /** Enumeration info if the property is enumerable */
+    enumerationInfo?: EnumerationInfo;
+    /**
+     * Kind of quantity information, if any.
+     * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
+     */
+    kindOfQuantity?: KindOfQuantityInfo;
+    /** Extended type name of the ECProperty if it has one */
+    extendedType?: string;
+    /**
+     * Navigation property info if the field is navigation type
+     * @beta
+    */
+    navigationPropertyInfo?: NavigationPropertyInfo;
+}
+/** @public */
+export declare namespace PropertyInfo {
+    /** Serialize [[PropertyInfo]] to JSON */
+    function toJSON(info: PropertyInfo): PropertyInfoJSON;
+    /** Serialize [[PropertyInfo]] to compressed JSON */
+    function toCompressedJSON(propertyInfo: PropertyInfo, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): PropertyInfoJSON<string>;
+    /** Deserialize [[PropertyInfo]] from JSON */
+    function fromJSON(json: PropertyInfoJSON): PropertyInfo;
+}
+/**
+ * A serialized version of [[PropertyInfo]]
+ * @public
+ */
+export interface PropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
+    classInfo: TClassInfoJSON;
+    name: string;
+    type: string;
+    enumerationInfo?: EnumerationInfo;
+    kindOfQuantity?: KindOfQuantityInfo;
+    /** @beta */
+    navigationPropertyInfo?: NavigationPropertyInfoJSON<TClassInfoJSON>;
+}
+/**
+ * A structure that describes a related class and the properties of that relationship.
+ * @public
+ */
+export interface RelatedClassInfo {
+    /** Information about the source ECClass */
+    sourceClassInfo: ClassInfo;
+    /** Information about the target ECClass */
+    targetClassInfo: ClassInfo;
+    /** Is target class handled polymorphically */
+    isPolymorphicTargetClass: boolean;
+    /** Information about the ECRelationship */
+    relationshipInfo: ClassInfo;
+    /** Should relationship be followed in a forward direction to access the related class. */
+    isForwardRelationship: boolean;
+    /** Is relationship handled polymorphically */
+    isPolymorphicRelationship: boolean;
+}
+/** @public */
+export declare namespace RelatedClassInfo {
+    /** Serialize [[RelatedClassInfo]] to JSON */
+    function toJSON(info: RelatedClassInfo): RelatedClassInfoJSON;
+    /** Serialize [[RelatedClassInfo]] to compressed JSON */
+    function toCompressedJSON(classInfo: RelatedClassInfo, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): RelatedClassInfoJSON<string>;
+    /** Deserialize [[RelatedClassInfo]] from JSON */
+    function fromJSON(json: RelatedClassInfoJSON): RelatedClassInfo;
+    /** Deserialize [[RelatedClassInfo]] from compressed JSON */
+    function fromCompressedJSON(json: RelatedClassInfoJSON<string>, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): RelatedClassInfo;
+    /** Check two [[RelatedClassInfo]] or [[StrippedRelatedClassInfo]] for equality */
+    function equals(lhs: RelatedClassInfo | StrippedRelatedClassInfo, rhs: RelatedClassInfo | StrippedRelatedClassInfo): boolean;
+    /** Strip given [[RelatedClassInfo]] to [[StrippedRelatedClassInfo]] */
+    function strip(full: RelatedClassInfo): StrippedRelatedClassInfo;
+}
+/**
+ * A serialized version of [[RelatedClassInfo]]
+ * @public
+ */
+export interface RelatedClassInfoJSON<TClassInfoJSON = ClassInfoJSON> {
+    sourceClassInfo: TClassInfoJSON;
+    targetClassInfo: TClassInfoJSON;
+    isPolymorphicTargetClass?: boolean;
+    relationshipInfo: TClassInfoJSON;
+    isForwardRelationship: boolean;
+    isPolymorphicRelationship?: boolean;
+}
+/**
+ * A structure that describes a relationship between source and target classes where
+ * an actual ECRelationship between them is optional.
+ * @public
+ */
+export declare type RelatedClassInfoWithOptionalRelationship = PartialBy<RelatedClassInfo, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
+/** @public */
+export declare type RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON = ClassInfoJSON> = PartialBy<RelatedClassInfoJSON<TClassInfoJSON>, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
+/** @public */
+export declare namespace RelatedClassInfoWithOptionalRelationship {
+    /** Serialize [[RelatedClassInfoWithOptionalRelationship]] to compressed JSON */
+    function toCompressedJSON(classInfo: RelatedClassInfoWithOptionalRelationship, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): RelatedClassInfoWithOptionalRelationshipJSON<string>;
+    /** Deserialize [[RelatedClassInfoWithOptionalRelationship]] from compressed JSON */
+    function fromCompressedJSON(json: RelatedClassInfoWithOptionalRelationshipJSON<string>, classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    }): RelatedClassInfoWithOptionalRelationship;
+}
+/**
+ * A structure that describes a related class path.
+ * @public
+ */
+export declare type RelationshipPath = RelatedClassInfo[];
+/**
+ * Serialized [[RelationshipPath]]
+ * @public
+ */
+export declare type RelationshipPathJSON<TClassInfoJSON = ClassInfoJSON> = RelatedClassInfoJSON<TClassInfoJSON>[];
+/** @public */
+export declare namespace RelationshipPath {
+    /** Reverse direction of the given [[RelationshipPath]] */
+    function reverse(path: RelationshipPath): RelationshipPath;
+    /** Check two [[RelationshipPath]] or [[StrippedRelationshipPath]] for equality */
+    function equals(lhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>, rhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>): boolean;
+    /** Strip given [[RelationshipPath]] to [[StrippedRelationshipPath]] */
+    function strip(full: RelationshipPath): StrippedRelationshipPath;
+}
+/**
+ * Data structure that contains a subset of [[RelatedClassInfo]] required to
+ * identify the relationship.
+ * @public
+ */
+export interface StrippedRelatedClassInfo {
+    sourceClassName: string;
+    targetClassName: string;
+    relationshipName: string;
+    isForwardRelationship: boolean;
+}
+/**
+ * Data structure that contains a subset of [[RelationshipPath]] required to
+ * identify the relationship path.
+ * @public
+ */
+export declare type StrippedRelationshipPath = StrippedRelatedClassInfo[];
 //# sourceMappingURL=EC.d.ts.map