@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/presentation-common/content/Value.js

@@ -1,274 +1,274 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Content
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DisplayValueGroup = exports.NestedContentValue = exports.DisplayValue = exports.Value = void 0;
-/** @public */
-var Value;
-(function (Value) {
-    /** Is the value a primitive */
-    function isPrimitive(value) {
-        return isPrimitiveValue(value);
-    }
-    Value.isPrimitive = isPrimitive;
-    /** Is the value an array */
-    function isArray(value) {
-        return isArrayValue(value);
-    }
-    Value.isArray = isArray;
-    /** Is the value a map / struct */
-    function isMap(value) {
-        return isMapValue(value);
-    }
-    Value.isMap = isMap;
-    /** Is the value a nested content value */
-    function isNestedContent(value) {
-        return isNestedContentValue(value);
-    }
-    Value.isNestedContent = isNestedContent;
-    /**
-     * Serialize [[Value]] to JSON
-     * @deprecated in 3.x. Use [[Value]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        if (json === null)
-            return undefined;
-        if (isNestedContentValue(json))
-            // eslint-disable-next-line deprecation/deprecation
-            return json.map(NestedContentValue.fromJSON);
-        if (isArrayValue(json))
-            return valuesArrayFromJSON(json);
-        if (isMapValue(json))
-            return valuesMapFromJSON(json);
-        return json;
-    }
-    Value.fromJSON = fromJSON;
-    /**
-     * Deserialize [[Value]] from JSON
-     * @deprecated in 3.x. Use [[Value]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(value) {
-        if (undefined === value)
-            return null;
-        if (isNestedContentValue(value))
-            // eslint-disable-next-line deprecation/deprecation
-            return value.map(NestedContentValue.toJSON);
-        if (isArrayValue(value))
-            return valuesArrayToJSON(value);
-        if (isMapValue(value))
-            return valuesMapToJSON(value);
-        return value;
-    }
-    Value.toJSON = toJSON;
-})(Value = exports.Value || (exports.Value = {}));
-/** @public */
-var DisplayValue;
-(function (DisplayValue) {
-    /** Is the value a primitive */
-    function isPrimitive(value) {
-        return isPrimitiveValue(value);
-    }
-    DisplayValue.isPrimitive = isPrimitive;
-    /** Is the value an array */
-    function isArray(value) {
-        return isArrayValue(value);
-    }
-    DisplayValue.isArray = isArray;
-    /** Is the value a map / struct */
-    function isMap(value) {
-        return isMapValue(value);
-    }
-    DisplayValue.isMap = isMap;
-    /**
-     * Serialize [[DisplayValue]] to JSON
-     * @deprecated in 3.x. Use [[DisplayValue]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        if (json === null)
-            return undefined;
-        if (isArrayValue(json))
-            return displayValuesArrayFromJSON(json);
-        if (isMapValue(json))
-            return displayValuesMapFromJSON(json);
-        return json;
-    }
-    DisplayValue.fromJSON = fromJSON;
-    /**
-     * Deserialize [[DisplayValue]] from JSON
-     * @deprecated in 3.x. Use [[DisplayValue]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(value) {
-        if (undefined === value)
-            return null;
-        if (isArrayValue(value))
-            return displayValuesArrayToJSON(value);
-        if (isMapValue(value))
-            return displayValuesMapToJSON(value);
-        return value;
-    }
-    DisplayValue.toJSON = toJSON;
-})(DisplayValue = exports.DisplayValue || (exports.DisplayValue = {}));
-/** @public */
-var NestedContentValue;
-(function (NestedContentValue) {
-    /**
-     * Serialize [[NestedContentValue]] to JSON
-     * @deprecated in 3.x. Use [[NestedContentValue]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(value) {
-        return {
-            ...value,
-            values: valuesMapToJSON(value.values),
-            displayValues: displayValuesMapToJSON(value.displayValues),
-        };
-    }
-    NestedContentValue.toJSON = toJSON;
-    /**
-     * Deserialize [[NestedContentValue]] from JSON
-     * @deprecated in 3.x. Use [[NestedContentValue]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        return {
-            ...json,
-            values: valuesMapFromJSON(json.values),
-            displayValues: displayValuesMapFromJSON(json.displayValues),
-        };
-    }
-    NestedContentValue.fromJSON = fromJSON;
-})(NestedContentValue = exports.NestedContentValue || (exports.NestedContentValue = {}));
-/** @public */
-var DisplayValueGroup;
-(function (DisplayValueGroup) {
-    /**
-     * Serialize [[DisplayValueGroup]] to JSON
-     * @deprecated in 3.x. Use [[DisplayValueGroup]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(group) {
-        return {
-            // eslint-disable-next-line deprecation/deprecation
-            displayValue: DisplayValue.toJSON(group.displayValue),
-            // eslint-disable-next-line deprecation/deprecation
-            groupedRawValues: group.groupedRawValues.map(Value.toJSON),
-        };
-    }
-    DisplayValueGroup.toJSON = toJSON;
-    /**
-     * Deserialize [[DisplayValueGroup]] from JSON
-     * @deprecated in 3.x. Use [[DisplayValueGroup]]
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        return {
-            // eslint-disable-next-line deprecation/deprecation
-            displayValue: DisplayValue.fromJSON(json.displayValue),
-            // eslint-disable-next-line deprecation/deprecation
-            groupedRawValues: json.groupedRawValues.map(Value.fromJSON),
-        };
-    }
-    DisplayValueGroup.fromJSON = fromJSON;
-})(DisplayValueGroup = exports.DisplayValueGroup || (exports.DisplayValueGroup = {}));
-// eslint-disable-next-line deprecation/deprecation
-function isNestedContentValue(v) {
-    return (v !== undefined) && Array.isArray(v)
-        && ((v.length === 0)
-            || v[0].primaryKeys !== undefined
-                && v[0].values !== undefined
-                && v[0].displayValues !== undefined
-                && v[0].mergedFieldNames !== undefined);
-}
-// eslint-disable-next-line deprecation/deprecation
-function isArrayValue(v) {
-    // note: we don't guarantee by 100% that v is ValuesArray | DisplayValuesArray, but merely make compiler happy.
-    // we have other means to determine the type of value.
-    return (v !== undefined) && Array.isArray(v);
-}
-// eslint-disable-next-line deprecation/deprecation
-function isMapValue(v) {
-    return (v !== undefined) && (typeof v === "object") && !Array.isArray(v);
-}
-function isPrimitiveValue(v) {
-    return !isArrayValue(v) && !isMapValue(v);
-}
-// eslint-disable-next-line deprecation/deprecation
-function valuesArrayFromJSON(json) {
-    // eslint-disable-next-line deprecation/deprecation
-    return json.map(Value.fromJSON);
-}
-// eslint-disable-next-line deprecation/deprecation
-function valuesArrayToJSON(values) {
-    // eslint-disable-next-line deprecation/deprecation
-    return values.map(Value.toJSON);
-}
-// eslint-disable-next-line deprecation/deprecation
-function valuesMapFromJSON(json) {
-    const map = {};
-    for (const key in json) {
-        /* istanbul ignore else */
-        if (json.hasOwnProperty(key)) {
-            // eslint-disable-next-line deprecation/deprecation
-            map[key] = Value.fromJSON(json[key]);
-        }
-    }
-    return map;
-}
-// eslint-disable-next-line deprecation/deprecation
-function valuesMapToJSON(values) {
-    // eslint-disable-next-line deprecation/deprecation
-    const map = {};
-    for (const key in values) {
-        /* istanbul ignore else */
-        if (values.hasOwnProperty(key)) {
-            // eslint-disable-next-line deprecation/deprecation
-            map[key] = Value.toJSON(values[key]);
-        }
-    }
-    return map;
-}
-// eslint-disable-next-line deprecation/deprecation
-function displayValuesArrayFromJSON(json) {
-    // eslint-disable-next-line deprecation/deprecation
-    return json.map(DisplayValue.fromJSON);
-}
-// eslint-disable-next-line deprecation/deprecation
-function displayValuesArrayToJSON(values) {
-    // eslint-disable-next-line deprecation/deprecation
-    return values.map(DisplayValue.toJSON);
-}
-// eslint-disable-next-line deprecation/deprecation
-function displayValuesMapFromJSON(json) {
-    const map = {};
-    for (const key in json) {
-        /* istanbul ignore else */
-        if (json.hasOwnProperty(key)) {
-            // eslint-disable-next-line deprecation/deprecation
-            map[key] = DisplayValue.fromJSON(json[key]);
-        }
-    }
-    return map;
-}
-// eslint-disable-next-line deprecation/deprecation
-function displayValuesMapToJSON(values) {
-    // eslint-disable-next-line deprecation/deprecation
-    const map = {};
-    for (const key in values) {
-        /* istanbul ignore else */
-        if (values.hasOwnProperty(key)) {
-            // eslint-disable-next-line deprecation/deprecation
-            map[key] = DisplayValue.toJSON(values[key]);
-        }
-    }
-    return map;
-}
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Content
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DisplayValueGroup = exports.NestedContentValue = exports.DisplayValue = exports.Value = void 0;
+/** @public */
+var Value;
+(function (Value) {
+    /** Is the value a primitive */
+    function isPrimitive(value) {
+        return isPrimitiveValue(value);
+    }
+    Value.isPrimitive = isPrimitive;
+    /** Is the value an array */
+    function isArray(value) {
+        return isArrayValue(value);
+    }
+    Value.isArray = isArray;
+    /** Is the value a map / struct */
+    function isMap(value) {
+        return isMapValue(value);
+    }
+    Value.isMap = isMap;
+    /** Is the value a nested content value */
+    function isNestedContent(value) {
+        return isNestedContentValue(value);
+    }
+    Value.isNestedContent = isNestedContent;
+    /**
+     * Serialize [[Value]] to JSON
+     * @deprecated in 3.x. Use [[Value]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        if (json === null)
+            return undefined;
+        if (isNestedContentValue(json))
+            // eslint-disable-next-line deprecation/deprecation
+            return json.map(NestedContentValue.fromJSON);
+        if (isArrayValue(json))
+            return valuesArrayFromJSON(json);
+        if (isMapValue(json))
+            return valuesMapFromJSON(json);
+        return json;
+    }
+    Value.fromJSON = fromJSON;
+    /**
+     * Deserialize [[Value]] from JSON
+     * @deprecated in 3.x. Use [[Value]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(value) {
+        if (undefined === value)
+            return null;
+        if (isNestedContentValue(value))
+            // eslint-disable-next-line deprecation/deprecation
+            return value.map(NestedContentValue.toJSON);
+        if (isArrayValue(value))
+            return valuesArrayToJSON(value);
+        if (isMapValue(value))
+            return valuesMapToJSON(value);
+        return value;
+    }
+    Value.toJSON = toJSON;
+})(Value = exports.Value || (exports.Value = {}));
+/** @public */
+var DisplayValue;
+(function (DisplayValue) {
+    /** Is the value a primitive */
+    function isPrimitive(value) {
+        return isPrimitiveValue(value);
+    }
+    DisplayValue.isPrimitive = isPrimitive;
+    /** Is the value an array */
+    function isArray(value) {
+        return isArrayValue(value);
+    }
+    DisplayValue.isArray = isArray;
+    /** Is the value a map / struct */
+    function isMap(value) {
+        return isMapValue(value);
+    }
+    DisplayValue.isMap = isMap;
+    /**
+     * Serialize [[DisplayValue]] to JSON
+     * @deprecated in 3.x. Use [[DisplayValue]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        if (json === null)
+            return undefined;
+        if (isArrayValue(json))
+            return displayValuesArrayFromJSON(json);
+        if (isMapValue(json))
+            return displayValuesMapFromJSON(json);
+        return json;
+    }
+    DisplayValue.fromJSON = fromJSON;
+    /**
+     * Deserialize [[DisplayValue]] from JSON
+     * @deprecated in 3.x. Use [[DisplayValue]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(value) {
+        if (undefined === value)
+            return null;
+        if (isArrayValue(value))
+            return displayValuesArrayToJSON(value);
+        if (isMapValue(value))
+            return displayValuesMapToJSON(value);
+        return value;
+    }
+    DisplayValue.toJSON = toJSON;
+})(DisplayValue = exports.DisplayValue || (exports.DisplayValue = {}));
+/** @public */
+var NestedContentValue;
+(function (NestedContentValue) {
+    /**
+     * Serialize [[NestedContentValue]] to JSON
+     * @deprecated in 3.x. Use [[NestedContentValue]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(value) {
+        return {
+            ...value,
+            values: valuesMapToJSON(value.values),
+            displayValues: displayValuesMapToJSON(value.displayValues),
+        };
+    }
+    NestedContentValue.toJSON = toJSON;
+    /**
+     * Deserialize [[NestedContentValue]] from JSON
+     * @deprecated in 3.x. Use [[NestedContentValue]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        return {
+            ...json,
+            values: valuesMapFromJSON(json.values),
+            displayValues: displayValuesMapFromJSON(json.displayValues),
+        };
+    }
+    NestedContentValue.fromJSON = fromJSON;
+})(NestedContentValue = exports.NestedContentValue || (exports.NestedContentValue = {}));
+/** @public */
+var DisplayValueGroup;
+(function (DisplayValueGroup) {
+    /**
+     * Serialize [[DisplayValueGroup]] to JSON
+     * @deprecated in 3.x. Use [[DisplayValueGroup]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(group) {
+        return {
+            // eslint-disable-next-line deprecation/deprecation
+            displayValue: DisplayValue.toJSON(group.displayValue),
+            // eslint-disable-next-line deprecation/deprecation
+            groupedRawValues: group.groupedRawValues.map(Value.toJSON),
+        };
+    }
+    DisplayValueGroup.toJSON = toJSON;
+    /**
+     * Deserialize [[DisplayValueGroup]] from JSON
+     * @deprecated in 3.x. Use [[DisplayValueGroup]]
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        return {
+            // eslint-disable-next-line deprecation/deprecation
+            displayValue: DisplayValue.fromJSON(json.displayValue),
+            // eslint-disable-next-line deprecation/deprecation
+            groupedRawValues: json.groupedRawValues.map(Value.fromJSON),
+        };
+    }
+    DisplayValueGroup.fromJSON = fromJSON;
+})(DisplayValueGroup = exports.DisplayValueGroup || (exports.DisplayValueGroup = {}));
+// eslint-disable-next-line deprecation/deprecation
+function isNestedContentValue(v) {
+    return (v !== undefined) && Array.isArray(v)
+        && ((v.length === 0)
+            || v[0].primaryKeys !== undefined
+                && v[0].values !== undefined
+                && v[0].displayValues !== undefined
+                && v[0].mergedFieldNames !== undefined);
+}
+// eslint-disable-next-line deprecation/deprecation
+function isArrayValue(v) {
+    // note: we don't guarantee by 100% that v is ValuesArray | DisplayValuesArray, but merely make compiler happy.
+    // we have other means to determine the type of value.
+    return (v !== undefined) && Array.isArray(v);
+}
+// eslint-disable-next-line deprecation/deprecation
+function isMapValue(v) {
+    return (v !== undefined) && (typeof v === "object") && !Array.isArray(v);
+}
+function isPrimitiveValue(v) {
+    return !isArrayValue(v) && !isMapValue(v);
+}
+// eslint-disable-next-line deprecation/deprecation
+function valuesArrayFromJSON(json) {
+    // eslint-disable-next-line deprecation/deprecation
+    return json.map(Value.fromJSON);
+}
+// eslint-disable-next-line deprecation/deprecation
+function valuesArrayToJSON(values) {
+    // eslint-disable-next-line deprecation/deprecation
+    return values.map(Value.toJSON);
+}
+// eslint-disable-next-line deprecation/deprecation
+function valuesMapFromJSON(json) {
+    const map = {};
+    for (const key in json) {
+        /* istanbul ignore else */
+        if (json.hasOwnProperty(key)) {
+            // eslint-disable-next-line deprecation/deprecation
+            map[key] = Value.fromJSON(json[key]);
+        }
+    }
+    return map;
+}
+// eslint-disable-next-line deprecation/deprecation
+function valuesMapToJSON(values) {
+    // eslint-disable-next-line deprecation/deprecation
+    const map = {};
+    for (const key in values) {
+        /* istanbul ignore else */
+        if (values.hasOwnProperty(key)) {
+            // eslint-disable-next-line deprecation/deprecation
+            map[key] = Value.toJSON(values[key]);
+        }
+    }
+    return map;
+}
+// eslint-disable-next-line deprecation/deprecation
+function displayValuesArrayFromJSON(json) {
+    // eslint-disable-next-line deprecation/deprecation
+    return json.map(DisplayValue.fromJSON);
+}
+// eslint-disable-next-line deprecation/deprecation
+function displayValuesArrayToJSON(values) {
+    // eslint-disable-next-line deprecation/deprecation
+    return values.map(DisplayValue.toJSON);
+}
+// eslint-disable-next-line deprecation/deprecation
+function displayValuesMapFromJSON(json) {
+    const map = {};
+    for (const key in json) {
+        /* istanbul ignore else */
+        if (json.hasOwnProperty(key)) {
+            // eslint-disable-next-line deprecation/deprecation
+            map[key] = DisplayValue.fromJSON(json[key]);
+        }
+    }
+    return map;
+}
+// eslint-disable-next-line deprecation/deprecation
+function displayValuesMapToJSON(values) {
+    // eslint-disable-next-line deprecation/deprecation
+    const map = {};
+    for (const key in values) {
+        /* istanbul ignore else */
+        if (values.hasOwnProperty(key)) {
+            // eslint-disable-next-line deprecation/deprecation
+            map[key] = DisplayValue.toJSON(values[key]);
+        }
+    }
+    return map;
+}
 //# sourceMappingURL=Value.js.map

package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts

@@ -1,38 +1,38 @@
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { Node, NodeJSON } from "./Node";
-/**
- * Defines a hierarchy level that consists of an array of nodes and possibly other information.
- * @beta
- */
-export interface HierarchyLevel {
-    /** A list of nodes in a hierarchy level. */
-    nodes: Node[];
-    /**
-     * Identifies whether the hierarchy level supports filtering. If not, requesting either a hierarchy level descriptor or
-     * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.
-     */
-    supportsFiltering?: boolean;
-}
-/**
- * JSON representation of [[HierarchyLevel]].
- * @beta
- * @deprecated in 3.x. Use [[HierarchyLevel]]
- */
-export interface HierarchyLevelJSON {
-    nodes: NodeJSON[];
-    supportsFiltering?: boolean;
-}
-/**
- * Contains helper functions for working with objects of [[HierarchyLevel]] type.
- * @beta
- */
-export declare namespace HierarchyLevel {
-    /**
-     * Deserialize [[HierarchyLevel]] from JSON
-     * @deprecated in 3.x. Use [[HierarchyLevel]].
-     */
-    function fromJSON(json: HierarchyLevelJSON): HierarchyLevel;
-}
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { Node, NodeJSON } from "./Node";
+/**
+ * Defines a hierarchy level that consists of an array of nodes and possibly other information.
+ * @beta
+ */
+export interface HierarchyLevel {
+    /** A list of nodes in a hierarchy level. */
+    nodes: Node[];
+    /**
+     * Identifies whether the hierarchy level supports filtering. If not, requesting either a hierarchy level descriptor or
+     * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.
+     */
+    supportsFiltering?: boolean;
+}
+/**
+ * JSON representation of [[HierarchyLevel]].
+ * @beta
+ * @deprecated in 3.x. Use [[HierarchyLevel]]
+ */
+export interface HierarchyLevelJSON {
+    nodes: NodeJSON[];
+    supportsFiltering?: boolean;
+}
+/**
+ * Contains helper functions for working with objects of [[HierarchyLevel]] type.
+ * @beta
+ */
+export declare namespace HierarchyLevel {
+    /**
+     * Deserialize [[HierarchyLevel]] from JSON
+     * @deprecated in 3.x. Use [[HierarchyLevel]].
+     */
+    function fromJSON(json: HierarchyLevelJSON): HierarchyLevel;
+}
 //# sourceMappingURL=HierarchyLevel.d.ts.map