@itwin/presentation-common 4.0.0-dev.48 → 4.0.0-dev.51

package/lib/esm/presentation-common/hierarchy/Node.js

@@ -1,104 +1,104 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { NodeKey } from "./Key";
-/** @public */
-export var Node;
-(function (Node) {
-    /**
-     * Serialize given [[Node]] to JSON
-     * @deprecated in 3.x. Use [[Node]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(node) {
-        const { label, ...baseNode } = node;
-        return {
-            ...baseNode,
-            labelDefinition: label,
-        };
-    }
-    Node.toJSON = toJSON;
-    /** @internal */
-    // eslint-disable-next-line deprecation/deprecation
-    function toPartialJSON(node) {
-        if (node.key === undefined) {
-            return node;
-        }
-        const { label, ...baseNode } = node;
-        return {
-            ...baseNode,
-            labelDefinition: label,
-        };
-    }
-    Node.toPartialJSON = toPartialJSON;
-    /**
-     * Deserialize [[Node]] from JSON
-     * @deprecated in 3.x. Use [[Node]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        if (typeof json === "string")
-            return JSON.parse(json, reviver);
-        const { labelDefinition, ...baseJson } = json;
-        return {
-            ...baseJson,
-            // eslint-disable-next-line deprecation/deprecation
-            key: NodeKey.fromJSON(json.key),
-            label: labelDefinition,
-        };
-    }
-    Node.fromJSON = fromJSON;
-    /** @internal */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromPartialJSON(json) {
-        if (json.key === undefined) {
-            return json;
-        }
-        const { key, labelDefinition, ...baseJson } = json;
-        return {
-            ...baseJson,
-            // eslint-disable-next-line deprecation/deprecation
-            key: NodeKey.fromJSON(key),
-            label: labelDefinition,
-        };
-    }
-    Node.fromPartialJSON = fromPartialJSON;
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[Node]] objects.
-     * @internal
-     */
-    function reviver(key, value) {
-        // eslint-disable-next-line deprecation/deprecation
-        return key === "" ? fromJSON(value) : value;
-    }
-    Node.reviver = reviver;
-    /**
-     * Deserialize nodes list from JSON
-     * @param json JSON or JSON serialized to string to deserialize from
-     * @returns Deserialized nodes list
-     * @internal
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function listFromJSON(json) {
-        if (typeof json === "string")
-            return JSON.parse(json, listReviver);
-        // eslint-disable-next-line deprecation/deprecation
-        return json.map((m) => fromJSON(m));
-    }
-    Node.listFromJSON = listFromJSON;
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[Node]][] objects.
-     * @internal
-     */
-    function listReviver(key, value) {
-        return key === "" ? listFromJSON(value) : value;
-    }
-    Node.listReviver = listReviver;
-})(Node || (Node = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { NodeKey } from "./Key";
+/** @public */
+export var Node;
+(function (Node) {
+    /**
+     * Serialize given [[Node]] to JSON
+     * @deprecated in 3.x. Use [[Node]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(node) {
+        const { label, ...baseNode } = node;
+        return {
+            ...baseNode,
+            labelDefinition: label,
+        };
+    }
+    Node.toJSON = toJSON;
+    /** @internal */
+    // eslint-disable-next-line deprecation/deprecation
+    function toPartialJSON(node) {
+        if (node.key === undefined) {
+            return node;
+        }
+        const { label, ...baseNode } = node;
+        return {
+            ...baseNode,
+            labelDefinition: label,
+        };
+    }
+    Node.toPartialJSON = toPartialJSON;
+    /**
+     * Deserialize [[Node]] from JSON
+     * @deprecated in 3.x. Use [[Node]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        if (typeof json === "string")
+            return JSON.parse(json, reviver);
+        const { labelDefinition, ...baseJson } = json;
+        return {
+            ...baseJson,
+            // eslint-disable-next-line deprecation/deprecation
+            key: NodeKey.fromJSON(json.key),
+            label: labelDefinition,
+        };
+    }
+    Node.fromJSON = fromJSON;
+    /** @internal */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromPartialJSON(json) {
+        if (json.key === undefined) {
+            return json;
+        }
+        const { key, labelDefinition, ...baseJson } = json;
+        return {
+            ...baseJson,
+            // eslint-disable-next-line deprecation/deprecation
+            key: NodeKey.fromJSON(key),
+            label: labelDefinition,
+        };
+    }
+    Node.fromPartialJSON = fromPartialJSON;
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[Node]] objects.
+     * @internal
+     */
+    function reviver(key, value) {
+        // eslint-disable-next-line deprecation/deprecation
+        return key === "" ? fromJSON(value) : value;
+    }
+    Node.reviver = reviver;
+    /**
+     * Deserialize nodes list from JSON
+     * @param json JSON or JSON serialized to string to deserialize from
+     * @returns Deserialized nodes list
+     * @internal
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function listFromJSON(json) {
+        if (typeof json === "string")
+            return JSON.parse(json, listReviver);
+        // eslint-disable-next-line deprecation/deprecation
+        return json.map((m) => fromJSON(m));
+    }
+    Node.listFromJSON = listFromJSON;
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[Node]][] objects.
+     * @internal
+     */
+    function listReviver(key, value) {
+        return key === "" ? listFromJSON(value) : value;
+    }
+    Node.listReviver = listReviver;
+})(Node || (Node = {}));
 //# sourceMappingURL=Node.js.map

package/lib/esm/presentation-common/hierarchy/Node.js.map

@@ -1 +1 @@
-{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAe,MAAM,OAAO,CAAC;AAyH7C,cAAc;AACd,MAAM,KAAW,IAAI,CA6FpB;AA7FD,WAAiB,IAAI;IACnB;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,IAAU;QAC/B,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;IANe,WAAM,SAMrB,CAAA;IAED,gBAAgB;IAChB,mDAAmD;IACnD,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;IAVe,kBAAa,gBAU5B,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAVe,aAAQ,WAUvB,CAAA;IAED,gBAAgB;IAChB,mDAAmD;IACnD,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAZe,oBAAe,kBAY9B,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,mDAAmD;QACnD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAHe,YAAO,UAGtB,CAAA;IAED;;;;;OAKG;IACH,mDAAmD;IACnD,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,mDAAmD;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IALe,iBAAY,eAK3B,CAAA;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,gBAAW,cAE1B,CAAA;AACH,CAAC,EA7FgB,IAAI,KAAJ,IAAI,QA6FpB","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 Hierarchies\n */\n\nimport { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\nimport { NodeKey, NodeKeyJSON } from \"./Key\";\n\n/**\n * Data structure that describes a tree node.\n * @public\n */\nexport interface Node {\n  /** A key that uniquely identifies a node. */\n  key: NodeKey;\n  /** Definition of node display label */\n  label: LabelDefinition;\n  /** Extensive description */\n  description?: string;\n  /**\n   * Image ID\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  imageId?: string;\n  /**\n   * Foreground color\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  foreColor?: string;\n  /**\n   * Background color\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  backColor?: string;\n  /**\n   * Font style\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  fontStyle?: string;\n  /** Does this node have child nodes */\n  hasChildren?: boolean;\n  /** Is this node selectable */\n  isSelectionDisabled?: boolean;\n  /** Is this node editable */\n  isEditable?: boolean;\n  /** Is this node expanded */\n  isExpanded?: boolean;\n  /**\n   * Is checkbox visible for this node\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  isCheckboxVisible?: boolean;\n  /**\n   * Is this node's checkbox checked\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  isChecked?: boolean;\n  /**\n   * Is this node's checkbox enabled\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  isCheckboxEnabled?: boolean;\n  /**\n   * Identifies whether the hierarchy level below this node supports filtering. If not, requesting either a hierarchy level descriptor or\n   * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.\n   * @beta\n   */\n  supportsFiltering?: boolean;\n  /** Extended data injected into this node */\n  extendedData?: {\n    [key: string]: any;\n  };\n}\n\n/**\n * Serialized [[Node]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[Node]].\n */\nexport interface NodeJSON {\n  // eslint-disable-next-line deprecation/deprecation\n  key: NodeKeyJSON;\n  // TODO: rename to `label`\n  // eslint-disable-next-line deprecation/deprecation\n  labelDefinition: LabelDefinitionJSON;\n  description?: string;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  imageId?: string;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  foreColor?: string;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  backColor?: string;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  fontStyle?: string;\n  hasChildren?: boolean;\n  isSelectionDisabled?: boolean;\n  isEditable?: boolean;\n  isExpanded?: boolean;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  isCheckboxVisible?: boolean;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  isChecked?: boolean;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  isCheckboxEnabled?: boolean;\n  /** @beta */\n  supportsFiltering?: boolean;\n  extendedData?: {\n    [key: string]: any;\n  };\n}\n\n/**\n * Partial node definition.\n * @public\n */\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\n\n/**\n * Serialized [[PartialNode]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[PartialNode]].\n */\n// eslint-disable-next-line deprecation/deprecation\nexport type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, \"key\" | \"labelDefinition\">;\n\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\n\n/** @public */\nexport namespace Node {\n  /**\n   * Serialize given [[Node]] to JSON\n   * @deprecated in 3.x. Use [[Node]].\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  export function toJSON(node: Node): NodeJSON {\n    const { label, ...baseNode } = node;\n    return {\n      ...baseNode,\n      labelDefinition: label,\n    };\n  }\n\n  /** @internal */\n  // eslint-disable-next-line deprecation/deprecation\n  export function toPartialJSON(node: PartialNode): PartialNodeJSON {\n    if (node.key === undefined) {\n      return node;\n    }\n\n    const { label, ...baseNode } = node;\n    return {\n      ...baseNode,\n      labelDefinition: label,\n    };\n  }\n\n  /**\n   * Deserialize [[Node]] from JSON\n   * @deprecated in 3.x. Use [[Node]].\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  export function fromJSON(json: NodeJSON | string): Node {\n    if (typeof json === \"string\")\n      return JSON.parse(json, reviver);\n    const { labelDefinition, ...baseJson } = json;\n    return {\n      ...baseJson,\n      // eslint-disable-next-line deprecation/deprecation\n      key: NodeKey.fromJSON(json.key),\n      label: labelDefinition,\n    };\n  }\n\n  /** @internal */\n  // eslint-disable-next-line deprecation/deprecation\n  export function fromPartialJSON(json: PartialNodeJSON): PartialNode {\n    if (json.key === undefined) {\n      return json;\n    }\n\n    const { key, labelDefinition, ...baseJson } = json;\n    return {\n      ...baseJson,\n      // eslint-disable-next-line deprecation/deprecation\n      key: NodeKey.fromJSON(key),\n      label: labelDefinition,\n    };\n  }\n\n  /**\n   * Reviver function that can be used as a second argument for\n   * `JSON.parse` method when parsing [[Node]] objects.\n   * @internal\n   */\n  export function reviver(key: string, value: any): any {\n    // eslint-disable-next-line deprecation/deprecation\n    return key === \"\" ? fromJSON(value) : value;\n  }\n\n  /**\n   * Deserialize nodes list from JSON\n   * @param json JSON or JSON serialized to string to deserialize from\n   * @returns Deserialized nodes list\n   * @internal\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\n    if (typeof json === \"string\")\n      return JSON.parse(json, listReviver);\n    // eslint-disable-next-line deprecation/deprecation\n    return json.map((m) => fromJSON(m));\n  }\n\n  /**\n   * Reviver function that can be used as a second argument for\n   * `JSON.parse` method when parsing [[Node]][] objects.\n   * @internal\n   */\n  export function listReviver(key: string, value: any): any {\n    return key === \"\" ? listFromJSON(value) : value;\n  }\n}\n"]}
+{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAe,MAAM,OAAO,CAAC;AAyH7C,cAAc;AACd,MAAM,KAAW,IAAI,CA6FpB;AA7FD,WAAiB,IAAI;IACnB;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,IAAU;QAC/B,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;IANe,WAAM,SAMrB,CAAA;IAED,gBAAgB;IAChB,mDAAmD;IACnD,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;IAVe,kBAAa,gBAU5B,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAVe,aAAQ,WAUvB,CAAA;IAED,gBAAgB;IAChB,mDAAmD;IACnD,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAZe,oBAAe,kBAY9B,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,mDAAmD;QACnD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAHe,YAAO,UAGtB,CAAA;IAED;;;;;OAKG;IACH,mDAAmD;IACnD,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,mDAAmD;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IALe,iBAAY,eAK3B,CAAA;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,gBAAW,cAE1B,CAAA;AACH,CAAC,EA7FgB,IAAI,KAAJ,IAAI,QA6FpB","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 Hierarchies\r\n */\r\n\r\nimport { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\r\nimport { NodeKey, NodeKeyJSON } from \"./Key\";\r\n\r\n/**\r\n * Data structure that describes a tree node.\r\n * @public\r\n */\r\nexport interface Node {\r\n  /** A key that uniquely identifies a node. */\r\n  key: NodeKey;\r\n  /** Definition of node display label */\r\n  label: LabelDefinition;\r\n  /** Extensive description */\r\n  description?: string;\r\n  /**\r\n   * Image ID\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n  /**\r\n   * Foreground color\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  foreColor?: string;\r\n  /**\r\n   * Background color\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  backColor?: string;\r\n  /**\r\n   * Font style\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  fontStyle?: string;\r\n  /** Does this node have child nodes */\r\n  hasChildren?: boolean;\r\n  /** Is this node selectable */\r\n  isSelectionDisabled?: boolean;\r\n  /** Is this node editable */\r\n  isEditable?: boolean;\r\n  /** Is this node expanded */\r\n  isExpanded?: boolean;\r\n  /**\r\n   * Is checkbox visible for this node\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxVisible?: boolean;\r\n  /**\r\n   * Is this node's checkbox checked\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isChecked?: boolean;\r\n  /**\r\n   * Is this node's checkbox enabled\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxEnabled?: boolean;\r\n  /**\r\n   * Identifies whether the hierarchy level below this node supports filtering. If not, requesting either a hierarchy level descriptor or\r\n   * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.\r\n   * @beta\r\n   */\r\n  supportsFiltering?: boolean;\r\n  /** Extended data injected into this node */\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Serialized [[Node]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[Node]].\r\n */\r\nexport interface NodeJSON {\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  key: NodeKeyJSON;\r\n  // TODO: rename to `label`\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  labelDefinition: LabelDefinitionJSON;\r\n  description?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  imageId?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  foreColor?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  backColor?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  fontStyle?: string;\r\n  hasChildren?: boolean;\r\n  isSelectionDisabled?: boolean;\r\n  isEditable?: boolean;\r\n  isExpanded?: boolean;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  isCheckboxVisible?: boolean;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  isChecked?: boolean;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  isCheckboxEnabled?: boolean;\r\n  /** @beta */\r\n  supportsFiltering?: boolean;\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Partial node definition.\r\n * @public\r\n */\r\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\r\n\r\n/**\r\n * Serialized [[PartialNode]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[PartialNode]].\r\n */\r\n// eslint-disable-next-line deprecation/deprecation\r\nexport type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, \"key\" | \"labelDefinition\">;\r\n\r\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\r\n\r\n/** @public */\r\nexport namespace Node {\r\n  /**\r\n   * Serialize given [[Node]] to JSON\r\n   * @deprecated in 3.x. Use [[Node]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(node: Node): NodeJSON {\r\n    const { label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      labelDefinition: label,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toPartialJSON(node: PartialNode): PartialNodeJSON {\r\n    if (node.key === undefined) {\r\n      return node;\r\n    }\r\n\r\n    const { label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      labelDefinition: label,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[Node]] from JSON\r\n   * @deprecated in 3.x. Use [[Node]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: NodeJSON | string): Node {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const { labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      key: NodeKey.fromJSON(json.key),\r\n      label: labelDefinition,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromPartialJSON(json: PartialNodeJSON): PartialNode {\r\n    if (json.key === undefined) {\r\n      return json;\r\n    }\r\n\r\n    const { key, labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      key: NodeKey.fromJSON(key),\r\n      label: labelDefinition,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[Node]] objects.\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize nodes list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized nodes list\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return json.map((m) => fromJSON(m));\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[Node]][] objects.\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n"]}

package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts

@@ -1,97 +1,97 @@
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { Node, NodeJSON } from "./Node";
-/**
- * Serialized [[NodePathElement]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[NodePathElement]].
- */
-export interface NodePathElementJSON {
-    node: NodeJSON;
-    index: number;
-    isMarked?: boolean;
-    children: NodePathElementJSON[];
-    filteringData?: NodePathFilteringDataJSON;
-}
-/**
- * Describes a single step in the nodes path.
- * @public
- */
-export interface NodePathElement {
-    /** Node instance */
-    node: Node;
-    /** Node index  */
-    index: number;
-    /** Is this element part of the marked path */
-    isMarked?: boolean;
-    /** Child path elements */
-    children: NodePathElement[];
-    /** Additional filtering-related information */
-    filteringData?: NodePathFilteringData;
-}
-/** @public */
-export declare namespace NodePathElement {
-    /**
-     * Serialize given [[NodePathElement]] to JSON
-     * @deprecated in 3.x. Use [[NodePathElement]].
-     */
-    function toJSON(npe: NodePathElement): NodePathElementJSON;
-    /**
-     * Deserialize [[NodePathElement]] from JSON
-     * @deprecated in 3.x. Use [[NodePathElement]].
-     */
-    function fromJSON(json: NodePathElementJSON | string): NodePathElement;
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[NodePathElement]] objects.
-     * @internal
-     */
-    function reviver(key: string, value: any): any;
-    /**
-     * Deserialize [[NodePathElement]] list from JSON
-     * @param json JSON or JSON serialized to string to deserialize from
-     * @returns Deserialized [[NodePathElement]] list
-     * @internal
-     */
-    function listFromJSON(json: NodePathElementJSON[] | string): NodePathElement[];
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[NodePathElement]][] objects.
-     * @internal
-     */
-    function listReviver(key: string, value: any): any;
-}
-/**
- * Serialized [[NodePathFilteringData]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[NodePathFilteringData]].
- */
-export interface NodePathFilteringDataJSON {
-    occurances: number;
-    childrenOccurances: number;
-}
-/**
- * Data related to node hierarchy filtering
- * @public
- */
-export interface NodePathFilteringData {
-    /** Number of filter matches in the current element */
-    matchesCount: number;
-    /** Number of filter matches in the current element's children (recursively) */
-    childMatchesCount: number;
-}
-/** @public */
-export declare namespace NodePathFilteringData {
-    /**
-     * Serialize given [[NodePathFilteringData]] to JSON
-     * @deprecated in 3.x. Use [[NodePathFilteringData]].
-     */
-    function toJSON(npfd: NodePathFilteringData): NodePathFilteringDataJSON;
-    /**
-     * Deserialize [[NodePathFilteringData]] from JSON
-     * @deprecated in 3.x. Use [[NodePathFilteringData]].
-     */
-    function fromJSON(json: NodePathFilteringDataJSON): NodePathFilteringData;
-}
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { Node, NodeJSON } from "./Node";
+/**
+ * Serialized [[NodePathElement]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[NodePathElement]].
+ */
+export interface NodePathElementJSON {
+    node: NodeJSON;
+    index: number;
+    isMarked?: boolean;
+    children: NodePathElementJSON[];
+    filteringData?: NodePathFilteringDataJSON;
+}
+/**
+ * Describes a single step in the nodes path.
+ * @public
+ */
+export interface NodePathElement {
+    /** Node instance */
+    node: Node;
+    /** Node index  */
+    index: number;
+    /** Is this element part of the marked path */
+    isMarked?: boolean;
+    /** Child path elements */
+    children: NodePathElement[];
+    /** Additional filtering-related information */
+    filteringData?: NodePathFilteringData;
+}
+/** @public */
+export declare namespace NodePathElement {
+    /**
+     * Serialize given [[NodePathElement]] to JSON
+     * @deprecated in 3.x. Use [[NodePathElement]].
+     */
+    function toJSON(npe: NodePathElement): NodePathElementJSON;
+    /**
+     * Deserialize [[NodePathElement]] from JSON
+     * @deprecated in 3.x. Use [[NodePathElement]].
+     */
+    function fromJSON(json: NodePathElementJSON | string): NodePathElement;
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[NodePathElement]] objects.
+     * @internal
+     */
+    function reviver(key: string, value: any): any;
+    /**
+     * Deserialize [[NodePathElement]] list from JSON
+     * @param json JSON or JSON serialized to string to deserialize from
+     * @returns Deserialized [[NodePathElement]] list
+     * @internal
+     */
+    function listFromJSON(json: NodePathElementJSON[] | string): NodePathElement[];
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[NodePathElement]][] objects.
+     * @internal
+     */
+    function listReviver(key: string, value: any): any;
+}
+/**
+ * Serialized [[NodePathFilteringData]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[NodePathFilteringData]].
+ */
+export interface NodePathFilteringDataJSON {
+    occurances: number;
+    childrenOccurances: number;
+}
+/**
+ * Data related to node hierarchy filtering
+ * @public
+ */
+export interface NodePathFilteringData {
+    /** Number of filter matches in the current element */
+    matchesCount: number;
+    /** Number of filter matches in the current element's children (recursively) */
+    childMatchesCount: number;
+}
+/** @public */
+export declare namespace NodePathFilteringData {
+    /**
+     * Serialize given [[NodePathFilteringData]] to JSON
+     * @deprecated in 3.x. Use [[NodePathFilteringData]].
+     */
+    function toJSON(npfd: NodePathFilteringData): NodePathFilteringDataJSON;
+    /**
+     * Deserialize [[NodePathFilteringData]] from JSON
+     * @deprecated in 3.x. Use [[NodePathFilteringData]].
+     */
+    function fromJSON(json: NodePathFilteringDataJSON): NodePathFilteringData;
+}
 //# sourceMappingURL=NodePathElement.d.ts.map