@itwin/presentation-common 3.7.9 → 3.7.11

package/lib/esm/presentation-common/content/Value.d.ts

@@ -1,190 +1,190 @@
-/** @packageDocumentation
- * @module Content
- */
-import { InstanceKey } from "../EC";
-import { ValuesDictionary } from "../Utils";
-/**
- * Raw value type
- * @public
- */
-export declare type Value = string | number | boolean | undefined | ValuesMap | ValuesArray | NestedContentValue[];
-/** @public */
-export declare namespace Value {
-    /** Is the value a primitive */
-    function isPrimitive(value: Value): value is string | number | boolean | undefined;
-    /** Is the value an array */
-    function isArray(value: Value): value is ValuesArray;
-    /** Is the value a map / struct */
-    function isMap(value: Value): value is ValuesMap;
-    /** Is the value a nested content value */
-    function isNestedContent(value: Value): value is NestedContentValue[];
-    /**
-     * Serialize [[Value]] to JSON
-     * @deprecated in 3.x. Use [[Value]]
-     */
-    function fromJSON(json: ValueJSON): Value;
-    /**
-     * Deserialize [[Value]] from JSON
-     * @deprecated in 3.x. Use [[Value]]
-     */
-    function toJSON(value: Value): ValueJSON;
-}
-/**
- * A map of raw values
- * @public
- */
-export interface ValuesMap extends ValuesDictionary<Value> {
-}
-/**
- * An array of raw values
- * @public
- */
-export interface ValuesArray extends Array<Value> {
-}
-/**
- * Display value type.
- * @public
- */
-export declare type DisplayValue = string | undefined | DisplayValuesMap | DisplayValuesArray;
-/** @public */
-export declare namespace DisplayValue {
-    /** Is the value a primitive */
-    function isPrimitive(value: DisplayValue): value is string | undefined;
-    /** Is the value an array */
-    function isArray(value: DisplayValue): value is DisplayValuesArray;
-    /** Is the value a map / struct */
-    function isMap(value: DisplayValue): value is DisplayValuesMap;
-    /**
-     * Serialize [[DisplayValue]] to JSON
-     * @deprecated in 3.x. Use [[DisplayValue]]
-     */
-    function fromJSON(json: DisplayValueJSON): DisplayValue;
-    /**
-     * Deserialize [[DisplayValue]] from JSON
-     * @deprecated in 3.x. Use [[DisplayValue]]
-     */
-    function toJSON(value: DisplayValue): DisplayValueJSON;
-}
-/**
- * A map of display values
- * @public
- */
-export interface DisplayValuesMap extends ValuesDictionary<DisplayValue> {
-}
-/**
- * An array of display values
- * @public
- */
-export interface DisplayValuesArray extends Array<DisplayValue> {
-}
-/**
- * Data structure that describes nested content value.
- * @public
- */
-export interface NestedContentValue {
-    /** Keys of instances whose content is contained in this value */
-    primaryKeys: InstanceKey[];
-    /** Content values map */
-    values: ValuesDictionary<Value>;
-    /** Content display values map */
-    displayValues: ValuesDictionary<DisplayValue>;
-    /** Names of fields whose values are merged */
-    mergedFieldNames: string[];
-}
-/** @public */
-export declare namespace NestedContentValue {
-    /**
-     * Serialize [[NestedContentValue]] to JSON
-     * @deprecated in 3.x. Use [[NestedContentValue]]
-     */
-    function toJSON(value: NestedContentValue): NestedContentValueJSON;
-    /**
-     * Deserialize [[NestedContentValue]] from JSON
-     * @deprecated in 3.x. Use [[NestedContentValue]]
-     */
-    function fromJSON(json: NestedContentValueJSON): NestedContentValue;
-}
-/**
- * JSON representation of [[Value]]
- * @public
- * @deprecated in 3.x. Use [[Value]]
- */
-export declare type ValueJSON = string | number | boolean | null | ValuesMapJSON | ValuesArrayJSON | NestedContentValueJSON[];
-/**
- * JSON representation of [[ValuesMap]]
- * @public
- * @deprecated in 3.x. Use [[ValuesMap]]
- */
-export interface ValuesMapJSON extends ValuesDictionary<ValueJSON> {
-}
-/**
- * JSON representation of [[ValuesArray]]
- * @public
- * @deprecated in 3.x. Use [[ValuesArray]]
- */
-export interface ValuesArrayJSON extends Array<ValueJSON> {
-}
-/**
- * JSON representation of [[DisplayValue]]
- * @public
- * @deprecated in 3.x. Use [[DisplayValue]]
- */
-export declare type DisplayValueJSON = string | null | DisplayValuesMapJSON | DisplayValuesArrayJSON;
-/**
- * JSON representation of [[DisplayValuesMap]]
- * @public
- * @deprecated in 3.x. Use [[DisplayValuesMap]]
- */
-export interface DisplayValuesMapJSON extends ValuesDictionary<DisplayValueJSON> {
-}
-/**
- * JSON representation of [[DisplayValuesArray]]
- * @public
- * @deprecated in 3.x. Use [[DisplayValuesArray]]
- */
-export interface DisplayValuesArrayJSON extends Array<DisplayValueJSON> {
-}
-/**
- * JSON representation of [[NestedContentValue]]
- * @public
- * @deprecated in 3.x. Use [[NestedContentValue]]
- */
-export interface NestedContentValueJSON {
-    primaryKeys: InstanceKey[];
-    values: ValuesDictionary<ValueJSON>;
-    displayValues: ValuesDictionary<DisplayValueJSON>;
-    mergedFieldNames: string[];
-}
-/**
- * A group of raw values and their common display value.
- * @public
- */
-export interface DisplayValueGroup {
-    /** Common display value for all grouped raw values */
-    displayValue: DisplayValue;
-    /** A list of grouped raw values */
-    groupedRawValues: Value[];
-}
-/**
- * JSON representation of [[DisplayValueGroup]].
- * @public
- * @deprecated in 3.x. Use [[DisplayValueGroup]]
- */
-export interface DisplayValueGroupJSON {
-    displayValue: DisplayValueJSON;
-    groupedRawValues: ValueJSON[];
-}
-/** @public */
-export declare namespace DisplayValueGroup {
-    /**
-     * Serialize [[DisplayValueGroup]] to JSON
-     * @deprecated in 3.x. Use [[DisplayValueGroup]]
-     */
-    function toJSON(group: DisplayValueGroup): DisplayValueGroupJSON;
-    /**
-     * Deserialize [[DisplayValueGroup]] from JSON
-     * @deprecated in 3.x. Use [[DisplayValueGroup]]
-     */
-    function fromJSON(json: DisplayValueGroupJSON): DisplayValueGroup;
-}
+/** @packageDocumentation
+ * @module Content
+ */
+import { InstanceKey } from "../EC";
+import { ValuesDictionary } from "../Utils";
+/**
+ * Raw value type
+ * @public
+ */
+export declare type Value = string | number | boolean | undefined | ValuesMap | ValuesArray | NestedContentValue[];
+/** @public */
+export declare namespace Value {
+    /** Is the value a primitive */
+    function isPrimitive(value: Value): value is string | number | boolean | undefined;
+    /** Is the value an array */
+    function isArray(value: Value): value is ValuesArray;
+    /** Is the value a map / struct */
+    function isMap(value: Value): value is ValuesMap;
+    /** Is the value a nested content value */
+    function isNestedContent(value: Value): value is NestedContentValue[];
+    /**
+     * Serialize [[Value]] to JSON
+     * @deprecated in 3.x. Use [[Value]]
+     */
+    function fromJSON(json: ValueJSON): Value;
+    /**
+     * Deserialize [[Value]] from JSON
+     * @deprecated in 3.x. Use [[Value]]
+     */
+    function toJSON(value: Value): ValueJSON;
+}
+/**
+ * A map of raw values
+ * @public
+ */
+export interface ValuesMap extends ValuesDictionary<Value> {
+}
+/**
+ * An array of raw values
+ * @public
+ */
+export interface ValuesArray extends Array<Value> {
+}
+/**
+ * Display value type.
+ * @public
+ */
+export declare type DisplayValue = string | undefined | DisplayValuesMap | DisplayValuesArray;
+/** @public */
+export declare namespace DisplayValue {
+    /** Is the value a primitive */
+    function isPrimitive(value: DisplayValue): value is string | undefined;
+    /** Is the value an array */
+    function isArray(value: DisplayValue): value is DisplayValuesArray;
+    /** Is the value a map / struct */
+    function isMap(value: DisplayValue): value is DisplayValuesMap;
+    /**
+     * Serialize [[DisplayValue]] to JSON
+     * @deprecated in 3.x. Use [[DisplayValue]]
+     */
+    function fromJSON(json: DisplayValueJSON): DisplayValue;
+    /**
+     * Deserialize [[DisplayValue]] from JSON
+     * @deprecated in 3.x. Use [[DisplayValue]]
+     */
+    function toJSON(value: DisplayValue): DisplayValueJSON;
+}
+/**
+ * A map of display values
+ * @public
+ */
+export interface DisplayValuesMap extends ValuesDictionary<DisplayValue> {
+}
+/**
+ * An array of display values
+ * @public
+ */
+export interface DisplayValuesArray extends Array<DisplayValue> {
+}
+/**
+ * Data structure that describes nested content value.
+ * @public
+ */
+export interface NestedContentValue {
+    /** Keys of instances whose content is contained in this value */
+    primaryKeys: InstanceKey[];
+    /** Content values map */
+    values: ValuesDictionary<Value>;
+    /** Content display values map */
+    displayValues: ValuesDictionary<DisplayValue>;
+    /** Names of fields whose values are merged */
+    mergedFieldNames: string[];
+}
+/** @public */
+export declare namespace NestedContentValue {
+    /**
+     * Serialize [[NestedContentValue]] to JSON
+     * @deprecated in 3.x. Use [[NestedContentValue]]
+     */
+    function toJSON(value: NestedContentValue): NestedContentValueJSON;
+    /**
+     * Deserialize [[NestedContentValue]] from JSON
+     * @deprecated in 3.x. Use [[NestedContentValue]]
+     */
+    function fromJSON(json: NestedContentValueJSON): NestedContentValue;
+}
+/**
+ * JSON representation of [[Value]]
+ * @public
+ * @deprecated in 3.x. Use [[Value]]
+ */
+export declare type ValueJSON = string | number | boolean | null | ValuesMapJSON | ValuesArrayJSON | NestedContentValueJSON[];
+/**
+ * JSON representation of [[ValuesMap]]
+ * @public
+ * @deprecated in 3.x. Use [[ValuesMap]]
+ */
+export interface ValuesMapJSON extends ValuesDictionary<ValueJSON> {
+}
+/**
+ * JSON representation of [[ValuesArray]]
+ * @public
+ * @deprecated in 3.x. Use [[ValuesArray]]
+ */
+export interface ValuesArrayJSON extends Array<ValueJSON> {
+}
+/**
+ * JSON representation of [[DisplayValue]]
+ * @public
+ * @deprecated in 3.x. Use [[DisplayValue]]
+ */
+export declare type DisplayValueJSON = string | null | DisplayValuesMapJSON | DisplayValuesArrayJSON;
+/**
+ * JSON representation of [[DisplayValuesMap]]
+ * @public
+ * @deprecated in 3.x. Use [[DisplayValuesMap]]
+ */
+export interface DisplayValuesMapJSON extends ValuesDictionary<DisplayValueJSON> {
+}
+/**
+ * JSON representation of [[DisplayValuesArray]]
+ * @public
+ * @deprecated in 3.x. Use [[DisplayValuesArray]]
+ */
+export interface DisplayValuesArrayJSON extends Array<DisplayValueJSON> {
+}
+/**
+ * JSON representation of [[NestedContentValue]]
+ * @public
+ * @deprecated in 3.x. Use [[NestedContentValue]]
+ */
+export interface NestedContentValueJSON {
+    primaryKeys: InstanceKey[];
+    values: ValuesDictionary<ValueJSON>;
+    displayValues: ValuesDictionary<DisplayValueJSON>;
+    mergedFieldNames: string[];
+}
+/**
+ * A group of raw values and their common display value.
+ * @public
+ */
+export interface DisplayValueGroup {
+    /** Common display value for all grouped raw values */
+    displayValue: DisplayValue;
+    /** A list of grouped raw values */
+    groupedRawValues: Value[];
+}
+/**
+ * JSON representation of [[DisplayValueGroup]].
+ * @public
+ * @deprecated in 3.x. Use [[DisplayValueGroup]]
+ */
+export interface DisplayValueGroupJSON {
+    displayValue: DisplayValueJSON;
+    groupedRawValues: ValueJSON[];
+}
+/** @public */
+export declare namespace DisplayValueGroup {
+    /**
+     * Serialize [[DisplayValueGroup]] to JSON
+     * @deprecated in 3.x. Use [[DisplayValueGroup]]
+     */
+    function toJSON(group: DisplayValueGroup): DisplayValueGroupJSON;
+    /**
+     * Deserialize [[DisplayValueGroup]] from JSON
+     * @deprecated in 3.x. Use [[DisplayValueGroup]]
+     */
+    function fromJSON(json: DisplayValueGroupJSON): DisplayValueGroup;
+}
 //# sourceMappingURL=Value.d.ts.map