@elliemae/ds-treeview 2.3.1 → 3.0.0-alpha.3

package/dist/esm/utils/tree-helpers.js

@@ -0,0 +1,155 @@
+import * as React from "react";
+import { createRef } from "react";
+import { standardizeSearchQueryString } from "./string-helpers";
+const walkVisibles = (node, callback, skipRoot = true, highlightOnlyQuery = false) => {
+  const { children, model } = node;
+  const { name, isExpanded, childrenMatchesSearchQuery, matchesSearchQuery } = model;
+  const shouldSkipBecauseIsRoot = skipRoot && name === "__root";
+  const queryRestrictionsPassed = !!(highlightOnlyQuery || childrenMatchesSearchQuery || matchesSearchQuery);
+  if (!shouldSkipBecauseIsRoot && queryRestrictionsPassed)
+    callback(node);
+  const shouldWalkChildren = !!(children.length > 0 && isExpanded && queryRestrictionsPassed);
+  if (shouldWalkChildren) {
+    children.forEach((childNode) => {
+      walkVisibles(childNode, callback, skipRoot, highlightOnlyQuery);
+    });
+  }
+};
+const walkParents = (nodePath, callback, skipRoot = true) => {
+  const parents = [...nodePath].reverse();
+  parents.shift();
+  if (skipRoot)
+    parents.pop();
+  parents.forEach(callback);
+};
+const walkAllNodeChildren = (node, callback, isFirst = true) => {
+  const { children = [] } = node;
+  const shouldWalkChildren = children.length;
+  if (!isFirst)
+    callback(node);
+  if (shouldWalkChildren) {
+    children.forEach((childNode) => {
+      walkAllNodeChildren(childNode, callback, false);
+    });
+  }
+};
+const getNodeById = (treeRoot, id) => {
+  const nodes = treeRoot.all((node) => node.model.id === id);
+  return nodes[0];
+};
+const cloneNode = (tree, node) => tree.parse(node.model);
+const itemsShareSameParent = (items = []) => {
+  if (items.length === 0)
+    throw new Error("Received empty items for comparison");
+  if (items.length === 1)
+    return true;
+  const firstExistingItem = items.find((item) => !!item);
+  if (!firstExistingItem)
+    throw new Error("Received no items, can't retrieve parent");
+  const firstExistingItemPath = firstExistingItem.node.getPath();
+  const directParentNode = firstExistingItemPath[firstExistingItemPath.length - 2];
+  return items.every((item) => {
+    if (!item)
+      return true;
+    const itemPath = item.node.getPath();
+    const itemDirectParent = itemPath[itemPath.length - 2];
+    return directParentNode === itemDirectParent;
+  });
+};
+const getItemsParentNode = (items = [], skipSameParentCheck = false) => {
+  if (items.length === 0)
+    throw new Error("Received empty items, can't retrieve parent");
+  if (!skipSameParentCheck) {
+    if (!itemsShareSameParent(items))
+      throw new Error("Received items don't share the same parent, can't retrieve parent");
+  }
+  const firstExistingItem = items.find((item) => !!item);
+  if (!firstExistingItem)
+    throw new Error("Received no items, can't retrieve parent");
+  const firstExistingItemPath = firstExistingItem.node.getPath();
+  const directParentNode = firstExistingItemPath[firstExistingItemPath.length - 2];
+  return directParentNode;
+};
+const getNodeMatchesSearchQuery = (node, searchQuery = "") => {
+  const standardizedName = standardizeSearchQueryString(node.model.name);
+  const standardizedSearchQuery = standardizeSearchQueryString(searchQuery);
+  return standardizedName.includes(standardizedSearchQuery);
+};
+const getChildrenMatchesSearchQuery = (parentNode, searchQuery = "") => {
+  let anyChildMatch = false;
+  walkAllNodeChildren(parentNode, (node) => {
+    if (getNodeMatchesSearchQuery(node, searchQuery))
+      anyChildMatch = true;
+  });
+  return anyChildMatch;
+};
+const enrichNodeModelInPlace = (node, searchQuery = "", selection = null, expanded = null) => {
+  const path = node.getPath();
+  const depth = path.length - 1;
+  node.model.nodePath = path;
+  node.model.treeDepth = depth;
+  if (!node.model.nodeItemRef) {
+    node.model.nodeItemRef = createRef();
+  }
+  if (typeof node.model.isGroup !== "boolean" && (node.model?.children?.length ?? 0) > 0) {
+    node.model.isGroup = true;
+  }
+  if (node.model.isGroup && node.model.id !== "__ds_tree_root") {
+    if (expanded)
+      node.model.isExpanded = !!expanded[node.model.id];
+    else if (typeof node.model.isExpanded !== "boolean") {
+      node.model.isExpanded = false;
+    }
+  }
+  node.model.matchesSearchQuery = true;
+  node.model.childrenMatchesSearchQuery = false;
+  const partiallyEnrichedNode = node;
+  if (searchQuery) {
+    partiallyEnrichedNode.model.matchesSearchQuery = getNodeMatchesSearchQuery(partiallyEnrichedNode, searchQuery);
+    if (partiallyEnrichedNode.model.isGroup === true) {
+      partiallyEnrichedNode.model.childrenMatchesSearchQuery = getChildrenMatchesSearchQuery(partiallyEnrichedNode, searchQuery);
+      if (partiallyEnrichedNode.model.childrenMatchesSearchQuery)
+        partiallyEnrichedNode.model.isExpanded = true;
+    }
+  }
+  if (selection && selection[partiallyEnrichedNode.model.id]) {
+    partiallyEnrichedNode.model.isChecked = selection[partiallyEnrichedNode.model.id];
+  }
+};
+const focusItem = (item) => {
+  item?.nodeItemRef?.current?.focus();
+};
+const flattenTreeForDnD = (data, shouldDescend = () => true) => {
+  const flattenedTree = [];
+  let index = 0;
+  const doit = (node, depth = 0, parentId = null) => {
+    flattenedTree.push({
+      uid: node.id.toString(),
+      depth,
+      realIndex: index,
+      childrenCount: node.children?.length ?? 0,
+      parentId: parentId !== null ? parentId.toString() : null,
+      original: node
+    });
+    index += 1;
+    if (shouldDescend(node))
+      node.children?.forEach((child) => doit(child, depth + 1, node.id.toString()));
+  };
+  data.forEach((datum) => doit(datum));
+  return flattenedTree;
+};
+export {
+  cloneNode,
+  enrichNodeModelInPlace,
+  flattenTreeForDnD,
+  focusItem,
+  getChildrenMatchesSearchQuery,
+  getItemsParentNode,
+  getNodeById,
+  getNodeMatchesSearchQuery,
+  itemsShareSameParent,
+  walkAllNodeChildren,
+  walkParents,
+  walkVisibles
+};
+//# sourceMappingURL=tree-helpers.js.map

package/dist/esm/utils/tree-helpers.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/utils/tree-helpers.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "/* eslint-disable max-statements */\n/* eslint-disable max-params */\n/* eslint-disable complexity */\n/* eslint-disable max-lines */\nimport { createRef } from 'react';\nimport type TreeModel from 'tree-model';\nimport { standardizeSearchQueryString } from './string-helpers';\nimport type { DSTreeviewT } from '../react-desc-prop-types';\n\nexport const walkVisibles = (\n  node: DSTreeviewT.Item['node'],\n  callback: (node: DSTreeviewT.Item['node']) => void,\n  skipRoot = true,\n  highlightOnlyQuery = false,\n) => {\n  const { children, model } = node;\n  const { name, isExpanded, childrenMatchesSearchQuery, matchesSearchQuery } = model;\n\n  const shouldSkipBecauseIsRoot = skipRoot && name === '__root';\n  const queryRestrictionsPassed = !!(highlightOnlyQuery || childrenMatchesSearchQuery || matchesSearchQuery);\n\n  if (!shouldSkipBecauseIsRoot && queryRestrictionsPassed) callback(node);\n\n  const shouldWalkChildren = !!(children.length > 0 && isExpanded && queryRestrictionsPassed);\n  if (shouldWalkChildren) {\n    children.forEach((childNode) => {\n      walkVisibles(childNode, callback, skipRoot, highlightOnlyQuery);\n    });\n  }\n};\n\nexport const walkParents = (\n  nodePath: DSTreeviewT.Item['nodePath'],\n  callback: (currParent: DSTreeviewT.Item['node']) => void,\n  skipRoot = true,\n) => {\n  const parents = [...nodePath].reverse();\n  parents.shift(); // remove current node from the parents array\n  if (skipRoot) parents.pop(); // remove the root from the parents if skipping root\n  parents.forEach(callback);\n};\n\ntype RecursiveCallbackT = (childNode: DSTreeviewT.Item['node'], cb?: RecursiveCallbackT, isFirst?: boolean) => void;\nexport const walkAllNodeChildren = (node: DSTreeviewT.Item['node'], callback: RecursiveCallbackT, isFirst = true) => {\n  const { children = [] } = node;\n  const shouldWalkChildren = children.length;\n\n  if (!isFirst) callback(node);\n\n  if (shouldWalkChildren) {\n    children.forEach((childNode) => {\n      walkAllNodeChildren(childNode, callback, false);\n    });\n  }\n};\n\nexport const getNodeById = (treeRoot: DSTreeviewT.Item['node'], id: DSTreeviewT.StringOrNum) => {\n  const nodes = treeRoot.all((node) => (node as unknown as DSTreeviewT.Item).model.id === id);\n  return nodes[0];\n};\n\nexport const cloneNode = (tree: TreeModel, node: DSTreeviewT.Item) => tree.parse(node.model);\n\nexport const itemsShareSameParent = (items: DSTreeviewT.Item[] = []) => {\n  if (items.length === 0) throw new Error('Received empty items for comparison');\n  if (items.length === 1) return true;\n\n  // when moving in first position we receive [undefined,...{items}]\n  // when moving in last position we receive [...{items}, undefined]\n  const firstExistingItem = items.find((item) => !!item);\n  if (!firstExistingItem) throw new Error(\"Received no items, can't retrieve parent\");\n\n  const firstExistingItemPath = firstExistingItem.node.getPath();\n  // path is like [rootParent, ...[parentsNodes], currentNode]\n  // length -1 is the current-node\n  // length -2 is the parent-node\n  // root node is not printed and is always present so minimum path length is 2 (root + currentNode)\n  const directParentNode = firstExistingItemPath[firstExistingItemPath.length - 2];\n\n  return items.every((item) => {\n    // undefined nodes count as having the same parent\n    if (!item) return true;\n    const itemPath = item.node.getPath();\n    const itemDirectParent = itemPath[itemPath.length - 2];\n    return directParentNode === itemDirectParent;\n  });\n};\n\nexport const getItemsParentNode = (items: DSTreeviewT.Item[] = [], skipSameParentCheck = false) => {\n  if (items.length === 0) throw new Error(\"Received empty items, can't retrieve parent\");\n\n  // in case we already know the items compared shares the same parent\n  if (!skipSameParentCheck)\n    if (!itemsShareSameParent(items))\n      // if we don't know (default, we don't) check if they share the parent\n      throw new Error(\"Received items don't share the same parent, can't retrieve parent\");\n\n  // when moving in first position we receive [undefined,...{items}]\n  // when moving in last position we receive [...{items}, undefined]\n  const firstExistingItem = items.find((item) => !!item);\n  if (!firstExistingItem) throw new Error(\"Received no items, can't retrieve parent\");\n\n  const firstExistingItemPath = firstExistingItem.node.getPath();\n  // path is like [rootParent, ...[parentsNodes], currentNode]\n  // length -1 is the current-node\n  // length -2 is the parent-node\n  // root node is not printed and is always present so minimum path length is 2 (root + currentNode)\n  const directParentNode = firstExistingItemPath[firstExistingItemPath.length - 2];\n  return directParentNode as unknown as DSTreeviewT.Item['node'];\n};\n\nexport const getNodeMatchesSearchQuery = (node: DSTreeviewT.Item['node'], searchQuery = '') => {\n  const standardizedName = standardizeSearchQueryString(node.model.name);\n  const standardizedSearchQuery = standardizeSearchQueryString(searchQuery);\n  return standardizedName.includes(standardizedSearchQuery);\n};\n\nexport const getChildrenMatchesSearchQuery = (parentNode: DSTreeviewT.Item['node'], searchQuery = '') => {\n  let anyChildMatch = false;\n  walkAllNodeChildren(parentNode, (node) => {\n    if (getNodeMatchesSearchQuery(node, searchQuery)) anyChildMatch = true;\n  });\n  return anyChildMatch;\n};\n\n/**\n * Mutate in place a node from tree-model normalizing object properties like \"isGroup\" even if user didn't specify it explicitly,\n * after execution the node will have \"nodePath\" \"treeDepth\" \"nodeItemRef\" \"isGroup\" \"isExpanded\"\n * (optionally, based on the provided arguments) \"matchesSearchQuery\" \"childrenMatchesSearchQuery\" \"isChecked\"\n *\n * @param {Object} node - node (based on 'tree-model' lib) that you wish to mutate with extra props\n * @param {string} [searchQuery=''] - optional string used to parse \"matchesSearchQuery\"/\"childrenMatchesSearchQuery\" properties\n * @param {Object} [selection=null] - optional selection hashmap used to parse \"isChecked\" properties\n * @param {Object} [expanded=null] - optional expanded hashmap used to parse \"isExpanded\" properties\n */\nexport const enrichNodeModelInPlace = (\n  node: TreeModel.Node<DSTreeviewT.SimpleItem>,\n  searchQuery = '',\n  selection: DSTreeviewT.SelectionItems | null = null,\n  expanded: DSTreeviewT.ExpandedItems | null = null,\n) => {\n  const path = node.getPath();\n  const depth = path.length - 1;\n  node.model.nodePath = path;\n  node.model.treeDepth = depth;\n\n  if (!node.model.nodeItemRef) {\n    node.model.nodeItemRef = createRef();\n  }\n\n  // if a node has children but was not marked as isGroup, force-mark as group\n  // this is useful to avoid having to always check both the flag and the children.length...\n  if (typeof node.model.isGroup !== 'boolean' && (node.model?.children?.length ?? 0) > 0) {\n    node.model.isGroup = true;\n  }\n\n  if (node.model.isGroup && node.model.id !== '__ds_tree_root') {\n    if (expanded) node.model.isExpanded = !!expanded[node.model.id];\n    else if (typeof node.model.isExpanded !== 'boolean') {\n      node.model.isExpanded = false;\n    }\n  }\n\n  node.model.matchesSearchQuery = true;\n  node.model.childrenMatchesSearchQuery = false;\n  const partiallyEnrichedNode = node as unknown as TreeModel.Node<DSTreeviewT.Item>;\n  if (searchQuery) {\n    partiallyEnrichedNode.model.matchesSearchQuery = getNodeMatchesSearchQuery(partiallyEnrichedNode, searchQuery);\n\n    if (partiallyEnrichedNode.model.isGroup === true) {\n      partiallyEnrichedNode.model.childrenMatchesSearchQuery = getChildrenMatchesSearchQuery(\n        partiallyEnrichedNode,\n        searchQuery,\n      );\n      if (partiallyEnrichedNode.model.childrenMatchesSearchQuery) partiallyEnrichedNode.model.isExpanded = true;\n    }\n  }\n  if (selection && selection[partiallyEnrichedNode.model.id]) {\n    partiallyEnrichedNode.model.isChecked = selection[partiallyEnrichedNode.model.id];\n  }\n};\n\nexport const focusItem = (item: DSTreeviewT.Item | null) => {\n  item?.nodeItemRef?.current?.focus();\n};\n\nexport const flattenTreeForDnD = (\n  data: DSTreeviewT.SimpleItem[],\n  shouldDescend: (datum: DSTreeviewT.SimpleItem) => boolean = () => true,\n) => {\n  const flattenedTree: DSTreeviewT.DndItem[] = [];\n  let index = 0;\n  const doit = (node: DSTreeviewT.SimpleItem, depth = 0, parentId: DSTreeviewT.StringOrNum | null = null) => {\n    flattenedTree.push({\n      uid: node.id.toString(),\n      depth,\n      realIndex: index,\n      childrenCount: node.children?.length ?? 0,\n      parentId: parentId !== null ? parentId.toString() : null,\n      original: node,\n    });\n    index += 1;\n    if (shouldDescend(node)) node.children?.forEach((child) => doit(child, depth + 1, node.id.toString()));\n  };\n\n  data.forEach((datum) => doit(datum));\n  return flattenedTree;\n};\n"],
+  "mappings": "AAAA;ACIA;AAEA;AAGO,MAAM,eAAe,CAC1B,MACA,UACA,WAAW,MACX,qBAAqB,UAClB;AACH,QAAM,EAAE,UAAU,UAAU;AAC5B,QAAM,EAAE,MAAM,YAAY,4BAA4B,uBAAuB;AAE7E,QAAM,0BAA0B,YAAY,SAAS;AACrD,QAAM,0BAA0B,CAAC,CAAE,uBAAsB,8BAA8B;AAEvF,MAAI,CAAC,2BAA2B;AAAyB,aAAS;AAElE,QAAM,qBAAqB,CAAC,CAAE,UAAS,SAAS,KAAK,cAAc;AACnE,MAAI,oBAAoB;AACtB,aAAS,QAAQ,CAAC,cAAc;AAC9B,mBAAa,WAAW,UAAU,UAAU;AAAA;AAAA;AAAA;AAK3C,MAAM,cAAc,CACzB,UACA,UACA,WAAW,SACR;AACH,QAAM,UAAU,CAAC,GAAG,UAAU;AAC9B,UAAQ;AACR,MAAI;AAAU,YAAQ;AACtB,UAAQ,QAAQ;AAAA;AAIX,MAAM,sBAAsB,CAAC,MAAgC,UAA8B,UAAU,SAAS;AACnH,QAAM,EAAE,WAAW,OAAO;AAC1B,QAAM,qBAAqB,SAAS;AAEpC,MAAI,CAAC;AAAS,aAAS;AAEvB,MAAI,oBAAoB;AACtB,aAAS,QAAQ,CAAC,cAAc;AAC9B,0BAAoB,WAAW,UAAU;AAAA;AAAA;AAAA;AAKxC,MAAM,cAAc,CAAC,UAAoC,OAAgC;AAC9F,QAAM,QAAQ,SAAS,IAAI,CAAC,SAAU,KAAqC,MAAM,OAAO;AACxF,SAAO,MAAM;AAAA;AAGR,MAAM,YAAY,CAAC,MAAiB,SAA2B,KAAK,MAAM,KAAK;AAE/E,MAAM,uBAAuB,CAAC,QAA4B,OAAO;AACtE,MAAI,MAAM,WAAW;AAAG,UAAM,IAAI,MAAM;AACxC,MAAI,MAAM,WAAW;AAAG,WAAO;AAI/B,QAAM,oBAAoB,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;AACjD,MAAI,CAAC;AAAmB,UAAM,IAAI,MAAM;AAExC,QAAM,wBAAwB,kBAAkB,KAAK;AAKrD,QAAM,mBAAmB,sBAAsB,sBAAsB,SAAS;AAE9E,SAAO,MAAM,MAAM,CAAC,SAAS;AAE3B,QAAI,CAAC;AAAM,aAAO;AAClB,UAAM,WAAW,KAAK,KAAK;AAC3B,UAAM,mBAAmB,SAAS,SAAS,SAAS;AACpD,WAAO,qBAAqB;AAAA;AAAA;AAIzB,MAAM,qBAAqB,CAAC,QAA4B,IAAI,sBAAsB,UAAU;AACjG,MAAI,MAAM,WAAW;AAAG,UAAM,IAAI,MAAM;AAGxC,MAAI,CAAC;AACH,QAAI,CAAC,qBAAqB;AAExB,YAAM,IAAI,MAAM;AAAA;AAIpB,QAAM,oBAAoB,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;AACjD,MAAI,CAAC;AAAmB,UAAM,IAAI,MAAM;AAExC,QAAM,wBAAwB,kBAAkB,KAAK;AAKrD,QAAM,mBAAmB,sBAAsB,sBAAsB,SAAS;AAC9E,SAAO;AAAA;AAGF,MAAM,4BAA4B,CAAC,MAAgC,cAAc,OAAO;AAC7F,QAAM,mBAAmB,6BAA6B,KAAK,MAAM;AACjE,QAAM,0BAA0B,6BAA6B;AAC7D,SAAO,iBAAiB,SAAS;AAAA;AAG5B,MAAM,gCAAgC,CAAC,YAAsC,cAAc,OAAO;AACvG,MAAI,gBAAgB;AACpB,sBAAoB,YAAY,CAAC,SAAS;AACxC,QAAI,0BAA0B,MAAM;AAAc,sBAAgB;AAAA;AAEpE,SAAO;AAAA;AAaF,MAAM,yBAAyB,CACpC,MACA,cAAc,IACd,YAA+C,MAC/C,WAA6C,SAC1C;AACH,QAAM,OAAO,KAAK;AAClB,QAAM,QAAQ,KAAK,SAAS;AAC5B,OAAK,MAAM,WAAW;AACtB,OAAK,MAAM,YAAY;AAEvB,MAAI,CAAC,KAAK,MAAM,aAAa;AAC3B,SAAK,MAAM,cAAc;AAAA;AAK3B,MAAI,OAAO,KAAK,MAAM,YAAY,aAAc,MAAK,OAAO,UAAU,UAAU,KAAK,GAAG;AACtF,SAAK,MAAM,UAAU;AAAA;AAGvB,MAAI,KAAK,MAAM,WAAW,KAAK,MAAM,OAAO,kBAAkB;AAC5D,QAAI;AAAU,WAAK,MAAM,aAAa,CAAC,CAAC,SAAS,KAAK,MAAM;AAAA,aACnD,OAAO,KAAK,MAAM,eAAe,WAAW;AACnD,WAAK,MAAM,aAAa;AAAA;AAAA;AAI5B,OAAK,MAAM,qBAAqB;AAChC,OAAK,MAAM,6BAA6B;AACxC,QAAM,wBAAwB;AAC9B,MAAI,aAAa;AACf,0BAAsB,MAAM,qBAAqB,0BAA0B,uBAAuB;AAElG,QAAI,sBAAsB,MAAM,YAAY,MAAM;AAChD,4BAAsB,MAAM,6BAA6B,8BACvD,uBACA;AAEF,UAAI,sBAAsB,MAAM;AAA4B,8BAAsB,MAAM,aAAa;AAAA;AAAA;AAGzG,MAAI,aAAa,UAAU,sBAAsB,MAAM,KAAK;AAC1D,0BAAsB,MAAM,YAAY,UAAU,sBAAsB,MAAM;AAAA;AAAA;AAI3E,MAAM,YAAY,CAAC,SAAkC;AAC1D,QAAM,aAAa,SAAS;AAAA;AAGvB,MAAM,oBAAoB,CAC/B,MACA,gBAA4D,MAAM,SAC/D;AACH,QAAM,gBAAuC;AAC7C,MAAI,QAAQ;AACZ,QAAM,OAAO,CAAC,MAA8B,QAAQ,GAAG,WAA2C,SAAS;AACzG,kBAAc,KAAK;AAAA,MACjB,KAAK,KAAK,GAAG;AAAA,MACb;AAAA,MACA,WAAW;AAAA,MACX,eAAe,KAAK,UAAU,UAAU;AAAA,MACxC,UAAU,aAAa,OAAO,SAAS,aAAa;AAAA,MACpD,UAAU;AAAA;AAEZ,aAAS;AACT,QAAI,cAAc;AAAO,WAAK,UAAU,QAAQ,CAAC,UAAU,KAAK,OAAO,QAAQ,GAAG,KAAK,GAAG;AAAA;AAG5F,OAAK,QAAQ,CAAC,UAAU,KAAK;AAC7B,SAAO;AAAA;",
+  "names": []
+}

package/{esm → dist/esm}/utils/useInstanceRefActions.js

@@ -1,16 +1,10 @@
-import 'core-js/modules/web.dom-collections.iterator.js';
-import { useRef, useMemo, useState, useEffect, useCallback } from 'react';
-import { focusItem } from './tree-helpers.js';
-import { toggleExpandAllHelper } from './group-expands-helpers.js';
-
-const useInstanceRefActions = (_ref, ctx) => {
-  let {
-    actions
-  } = _ref;
+import * as React from "react";
+import { useEffect, useMemo, useState, useRef, useCallback } from "react";
+import { focusItem } from "./tree-helpers";
+import { toggleExpandAllHelper } from "./group-expands-helpers";
+const useInstanceRefActions = ({ actions }, ctx) => {
   const {
-    props: {
-      onItemFocus
-    },
+    props: { onItemFocus },
     virtualListHelpers,
     treeRoot,
     visibleItems,
@@ -20,12 +14,8 @@ const useInstanceRefActions = (_ref, ctx) => {
     setFocusedItem,
     setLatestToggledItem
   } = ctx;
-  const {
-    current: promises
-  } = useRef({});
-  const {
-    scrollToIndex
-  } = useMemo(() => virtualListHelpers, [virtualListHelpers]);
+  const { current: promises } = useRef({});
+  const { scrollToIndex } = useMemo(() => virtualListHelpers, [virtualListHelpers]);
   const [expandPromise, setPromise] = useState();
   useEffect(() => {
     if (expandPromise && promises.expandResolve) {
@@ -34,36 +24,30 @@ const useInstanceRefActions = (_ref, ctx) => {
       setPromise(null);
     }
   }, [visibleItems, expandPromise, promises]);
-  actions.toggleExpandAll = useCallback(isExpand => {
-    const p = new Promise(resolve => {
+  actions.toggleExpandAll = useCallback((isExpand) => {
+    const p = new Promise((resolve) => {
       promises.expandResolve = resolve;
-      if (treeRoot) toggleExpandAllHelper(isExpand, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState);
+      if (treeRoot)
+        toggleExpandAllHelper(isExpand, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState);
     });
     setPromise(p);
     return p;
   }, [promises, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState]);
-  actions.scrollTo = useCallback(function (indx) {
-    let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
-      align: 'start'
-    };
-    if (scrollToIndex) scrollToIndex(indx, opts);
+  actions.scrollTo = useCallback((indx, opts = { align: "start" }) => {
+    if (scrollToIndex)
+      scrollToIndex(indx, opts);
   }, [scrollToIndex]);
-  actions.setSelectedItemByVirtualIndex = useCallback(index => {
+  actions.setSelectedItemByVirtualIndex = useCallback((index) => {
     const itemByIndex = visibleItems[index];
     setSelectedItem(itemByIndex);
   }, [visibleItems, setSelectedItem]);
-  actions.setFocusedItemByVirtualIndex = useCallback(function (index) {
-    let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
-      align: 'start',
-      withScroll: false
-    };
+  actions.setFocusedItemByVirtualIndex = useCallback((index, opts = { align: "start", withScroll: false }) => {
     const itemByIndex = visibleItems[index];
     const onItemFocusParams = {
       itemIndex: itemByIndex.virtualIndex,
       scrollToItem: () => scrollToIndex(index, opts),
       item: itemByIndex
     };
-
     if (opts.withScroll && scrollToIndex) {
       scrollToIndex(index, opts);
       setTimeout(() => {
@@ -79,5 +63,7 @@ const useInstanceRefActions = (_ref, ctx) => {
   }, [visibleItems, scrollToIndex, setFocusedItem, onItemFocus]);
   return actions;
 };
-
-export { useInstanceRefActions };
+export {
+  useInstanceRefActions
+};
+//# sourceMappingURL=useInstanceRefActions.js.map

package/dist/esm/utils/useInstanceRefActions.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/utils/useInstanceRefActions.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import { useEffect, useMemo, useState, useRef, useCallback } from 'react';\nimport { focusItem } from './tree-helpers';\nimport { toggleExpandAllHelper } from './group-expands-helpers';\nimport type { DSTreeviewT } from '../react-desc-prop-types';\nimport type { DSTreeviewInternalsT } from '../sharedTypes';\n\ninterface PromisesRefT {\n  expandResolve?: null | ((value: DSTreeviewT.Item[] | PromiseLike<DSTreeviewT.Item[]>) => void);\n  scrollTo?: null | ((value: DSTreeviewT.Item[] | PromiseLike<DSTreeviewT.Item[]>) => void);\n}\n\nexport const useInstanceRefActions = ({ actions }: DSTreeviewT.InstanceRef, ctx: DSTreeviewInternalsT.CTX) => {\n  const {\n    props: { onItemFocus },\n    virtualListHelpers,\n    treeRoot,\n    visibleItems,\n    triggerTreeRerender,\n    updateUserExpandedState,\n    setSelectedItem,\n    setFocusedItem,\n    setLatestToggledItem,\n  } = ctx;\n  const { current: promises } = useRef<PromisesRefT>({});\n  const { scrollToIndex } = useMemo(() => virtualListHelpers, [virtualListHelpers]);\n  const [expandPromise, setPromise] = useState<Promise<DSTreeviewT.Item[]> | undefined | null>();\n\n  useEffect(() => {\n    if (expandPromise && promises.expandResolve) {\n      promises.expandResolve(visibleItems);\n      promises.expandResolve = null;\n      setPromise(null);\n    }\n  }, [visibleItems, expandPromise, promises]);\n\n  actions.toggleExpandAll = useCallback(\n    (isExpand) => {\n      const p = new Promise<DSTreeviewT.Item[]>((resolve) => {\n        promises.expandResolve = resolve;\n        if (treeRoot)\n          toggleExpandAllHelper(isExpand, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState);\n      });\n      setPromise(p);\n      return p;\n    },\n    [promises, treeRoot, triggerTreeRerender, setLatestToggledItem, updateUserExpandedState],\n  );\n  actions.scrollTo = useCallback(\n    (indx, opts = { align: 'start' }) => {\n      if (scrollToIndex) scrollToIndex(indx, opts);\n    },\n    [scrollToIndex],\n  );\n\n  actions.setSelectedItemByVirtualIndex = useCallback(\n    (index) => {\n      const itemByIndex = visibleItems[index];\n      setSelectedItem(itemByIndex);\n    },\n    [visibleItems, setSelectedItem],\n  );\n\n  actions.setFocusedItemByVirtualIndex = useCallback(\n    (index, opts = { align: 'start', withScroll: false }) => {\n      const itemByIndex = visibleItems[index];\n      const onItemFocusParams = {\n        itemIndex: itemByIndex.virtualIndex as number,\n        scrollToItem: () => scrollToIndex(index, opts),\n        item: itemByIndex,\n      };\n\n      if (opts.withScroll && scrollToIndex) {\n        scrollToIndex(index, opts);\n        setTimeout(() => {\n          setFocusedItem(itemByIndex);\n          focusItem(itemByIndex);\n          onItemFocus(onItemFocusParams);\n        }, 300);\n      } else {\n        setFocusedItem(itemByIndex);\n        focusItem(itemByIndex);\n        onItemFocus(onItemFocusParams);\n      }\n    },\n    [visibleItems, scrollToIndex, setFocusedItem, onItemFocus],\n  );\n\n  return actions;\n};\n"],
+  "mappings": "AAAA;ACAA;AACA;AACA;AASO,MAAM,wBAAwB,CAAC,EAAE,WAAoC,QAAkC;AAC5G,QAAM;AAAA,IACJ,OAAO,EAAE;AAAA,IACT;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,MACE;AACJ,QAAM,EAAE,SAAS,aAAa,OAAqB;AACnD,QAAM,EAAE,kBAAkB,QAAQ,MAAM,oBAAoB,CAAC;AAC7D,QAAM,CAAC,eAAe,cAAc;AAEpC,YAAU,MAAM;AACd,QAAI,iBAAiB,SAAS,eAAe;AAC3C,eAAS,cAAc;AACvB,eAAS,gBAAgB;AACzB,iBAAW;AAAA;AAAA,KAEZ,CAAC,cAAc,eAAe;AAEjC,UAAQ,kBAAkB,YACxB,CAAC,aAAa;AACZ,UAAM,IAAI,IAAI,QAA4B,CAAC,YAAY;AACrD,eAAS,gBAAgB;AACzB,UAAI;AACF,8BAAsB,UAAU,UAAU,qBAAqB,sBAAsB;AAAA;AAEzF,eAAW;AACX,WAAO;AAAA,KAET,CAAC,UAAU,UAAU,qBAAqB,sBAAsB;AAElE,UAAQ,WAAW,YACjB,CAAC,MAAM,OAAO,EAAE,OAAO,cAAc;AACnC,QAAI;AAAe,oBAAc,MAAM;AAAA,KAEzC,CAAC;AAGH,UAAQ,gCAAgC,YACtC,CAAC,UAAU;AACT,UAAM,cAAc,aAAa;AACjC,oBAAgB;AAAA,KAElB,CAAC,cAAc;AAGjB,UAAQ,+BAA+B,YACrC,CAAC,OAAO,OAAO,EAAE,OAAO,SAAS,YAAY,YAAY;AACvD,UAAM,cAAc,aAAa;AACjC,UAAM,oBAAoB;AAAA,MACxB,WAAW,YAAY;AAAA,MACvB,cAAc,MAAM,cAAc,OAAO;AAAA,MACzC,MAAM;AAAA;AAGR,QAAI,KAAK,cAAc,eAAe;AACpC,oBAAc,OAAO;AACrB,iBAAW,MAAM;AACf,uBAAe;AACf,kBAAU;AACV,oBAAY;AAAA,SACX;AAAA,WACE;AACL,qBAAe;AACf,gBAAU;AACV,kBAAY;AAAA;AAAA,KAGhB,CAAC,cAAc,eAAe,gBAAgB;AAGhD,SAAO;AAAA;",
+  "names": []
+}

package/dist/esm/utils/useTree.js

@@ -0,0 +1,96 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+import * as React from "react";
+import { useState, useCallback, useMemo, useEffect } from "react";
+import TreeModel from "tree-model";
+import { cloneDeep } from "lodash";
+import { walkVisibles, enrichNodeModelInPlace, flattenTreeForDnD } from "./tree-helpers";
+import { updateExpandedState } from "./group-expands-helpers";
+const useTree = (data, props, states) => {
+  const { setExpandedGroups } = states;
+  const unfrozenData = useMemo(() => cloneDeep(data), [data]);
+  const tree = useMemo(() => new TreeModel(), []);
+  const [treeData, setTreeData] = useState({
+    id: "__ds_tree_root",
+    name: "__root",
+    isExpanded: true,
+    children: unfrozenData
+  });
+  useEffect(() => {
+    setTreeData({
+      id: "__ds_tree_root",
+      name: "__root",
+      isExpanded: true,
+      children: unfrozenData
+    });
+  }, [unfrozenData]);
+  const [rerenderItems, setRerenderItems] = useState({});
+  const triggerTreeRerender = useCallback(() => {
+    setRerenderItems({});
+  }, []);
+  const [treeRoot, setTreeRoot] = useState(tree.parse(treeData));
+  useEffect(() => {
+    setTreeRoot(tree.parse(treeData));
+  }, [treeData, rerenderItems, tree]);
+  const [visibleItems, setVisibleItems] = useState([]);
+  const { searchQuery, highlightOnlyQuery, onVisibleItemsChange, selection, expanded, onExpandChange } = props;
+  const updateUserExpandedState = useCallback(() => {
+    updateExpandedState(treeRoot, onExpandChange);
+  }, [treeRoot, onExpandChange]);
+  useEffect(() => {
+    const parsedVisibleItems = [];
+    const newExpandedHashMap = {};
+    const shouldContinueWalking = true;
+    treeRoot.walk((node) => {
+      enrichNodeModelInPlace(node, searchQuery, selection, expanded);
+      if (node.model.id && node.model.isGroup && node.model.isExpanded)
+        newExpandedHashMap[node.model.id] = true;
+      return shouldContinueWalking;
+    });
+    walkVisibles(treeRoot, (node) => {
+      parsedVisibleItems.push(__spreadProps(__spreadValues({}, node.model), { node }));
+    }, true, highlightOnlyQuery);
+    setVisibleItems(parsedVisibleItems);
+    onVisibleItemsChange(parsedVisibleItems);
+    setExpandedGroups(newExpandedHashMap);
+  }, [
+    treeRoot,
+    rerenderItems,
+    searchQuery,
+    highlightOnlyQuery,
+    selection,
+    expanded,
+    setExpandedGroups
+  ]);
+  const flattenedItems = useMemo(() => flattenTreeForDnD(data), [data]);
+  return {
+    visibleItems,
+    flattenedItems,
+    tree,
+    treeRoot,
+    rerenderItems,
+    triggerTreeRerender,
+    updateUserExpandedState
+  };
+};
+export {
+  useTree
+};
+//# sourceMappingURL=useTree.js.map

package/dist/esm/utils/useTree.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/utils/useTree.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import { useState, useCallback, useMemo, useEffect } from 'react';\nimport TreeModel from 'tree-model';\nimport { cloneDeep } from 'lodash';\n\nimport { walkVisibles, enrichNodeModelInPlace, flattenTreeForDnD } from './tree-helpers';\nimport type { DSTreeviewT } from '../react-desc-prop-types';\nimport type { DSTreeviewInternalsT } from '../sharedTypes';\nimport { updateExpandedState } from './group-expands-helpers';\n\nexport const useTree = (\n  data: DSTreeviewT.SimpleItem[],\n  props: DSTreeviewT.Props,\n  states: {\n    setExpandedGroups: DSTreeviewInternalsT.StateSetter<DSTreeviewT.ExpandedItems>;\n  },\n) => {\n  const { setExpandedGroups } = states;\n  const unfrozenData = useMemo(() => cloneDeep(data), [data]);\n\n  // convert data into a TreeModel with extra isExpanded prop\n  // root element type is an exception, children model is based on what the dev passed on\n  // since root is an excepcion we must typecast\n  const tree = useMemo(() => new TreeModel(), []);\n  const [treeData, setTreeData] = useState({\n    id: '__ds_tree_root',\n    name: '__root',\n    isExpanded: true,\n    children: unfrozenData,\n  } as unknown as DSTreeviewT.Item);\n\n  useEffect(() => {\n    setTreeData({\n      id: '__ds_tree_root',\n      name: '__root',\n      isExpanded: true,\n      children: unfrozenData,\n    } as unknown as DSTreeviewT.Item);\n  }, [unfrozenData]);\n\n  // expose a way to rerender the tree\n  //   used for expand functionality\n  const [rerenderItems, setRerenderItems] = useState({});\n  const triggerTreeRerender = useCallback(() => {\n    setRerenderItems({});\n  }, []);\n\n  // when re-rendering we re-parse the list\n  const [treeRoot, setTreeRoot] = useState(tree.parse(treeData));\n  useEffect(() => {\n    setTreeRoot(tree.parse(treeData));\n  }, [treeData, rerenderItems, tree]);\n\n  const [visibleItems, setVisibleItems] = useState<DSTreeviewT.Item[]>([]);\n\n  const { searchQuery, highlightOnlyQuery, onVisibleItemsChange, selection, expanded, onExpandChange } = props;\n\n  const updateUserExpandedState = useCallback(() => {\n    updateExpandedState(treeRoot, onExpandChange);\n  }, [treeRoot, onExpandChange]);\n  // we add missing properties to the received Items\n  //   not the best of the patterns, but it works\n  //   this is where we convert \"SimpleItems\" to \"Items\"\n  //   this was done to avoid breaking changes back in v1\n  useEffect(() => {\n    const parsedVisibleItems: DSTreeviewT.Item[] = [];\n    const newExpandedHashMap: DSTreeviewT.ExpandedItems = {};\n    const shouldContinueWalking = true; // tree-model ask we return true if we want to continue walking\n    treeRoot.walk((node) => {\n      enrichNodeModelInPlace(node, searchQuery, selection, expanded);\n      if (node.model.id && node.model.isGroup && node.model.isExpanded) newExpandedHashMap[node.model.id] = true;\n      return shouldContinueWalking;\n    });\n\n    walkVisibles(\n      treeRoot,\n      (node) => {\n        parsedVisibleItems.push({ ...node.model, node });\n      },\n      true,\n      highlightOnlyQuery,\n    );\n    setVisibleItems(parsedVisibleItems);\n    onVisibleItemsChange(parsedVisibleItems);\n\n    setExpandedGroups(newExpandedHashMap);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [\n    treeRoot,\n    rerenderItems,\n    searchQuery,\n    highlightOnlyQuery,\n    selection,\n    expanded,\n    setExpandedGroups,\n    // onVisibleItemsChange // evaluate potential performance hit?\n  ]);\n\n  const flattenedItems = useMemo(() => flattenTreeForDnD(data), [data]);\n\n  return {\n    visibleItems,\n    flattenedItems,\n    tree,\n    treeRoot,\n    rerenderItems,\n    triggerTreeRerender,\n    updateUserExpandedState,\n  };\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;ACAA;AACA;AACA;AAEA;AAGA;AAEO,MAAM,UAAU,CACrB,MACA,OACA,WAGG;AACH,QAAM,EAAE,sBAAsB;AAC9B,QAAM,eAAe,QAAQ,MAAM,UAAU,OAAO,CAAC;AAKrD,QAAM,OAAO,QAAQ,MAAM,IAAI,aAAa;AAC5C,QAAM,CAAC,UAAU,eAAe,SAAS;AAAA,IACvC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,YAAY;AAAA,IACZ,UAAU;AAAA;AAGZ,YAAU,MAAM;AACd,gBAAY;AAAA,MACV,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,YAAY;AAAA,MACZ,UAAU;AAAA;AAAA,KAEX,CAAC;AAIJ,QAAM,CAAC,eAAe,oBAAoB,SAAS;AACnD,QAAM,sBAAsB,YAAY,MAAM;AAC5C,qBAAiB;AAAA,KAChB;AAGH,QAAM,CAAC,UAAU,eAAe,SAAS,KAAK,MAAM;AACpD,YAAU,MAAM;AACd,gBAAY,KAAK,MAAM;AAAA,KACtB,CAAC,UAAU,eAAe;AAE7B,QAAM,CAAC,cAAc,mBAAmB,SAA6B;AAErE,QAAM,EAAE,aAAa,oBAAoB,sBAAsB,WAAW,UAAU,mBAAmB;AAEvG,QAAM,0BAA0B,YAAY,MAAM;AAChD,wBAAoB,UAAU;AAAA,KAC7B,CAAC,UAAU;AAKd,YAAU,MAAM;AACd,UAAM,qBAAyC;AAC/C,UAAM,qBAAgD;AACtD,UAAM,wBAAwB;AAC9B,aAAS,KAAK,CAAC,SAAS;AACtB,6BAAuB,MAAM,aAAa,WAAW;AACrD,UAAI,KAAK,MAAM,MAAM,KAAK,MAAM,WAAW,KAAK,MAAM;AAAY,2BAAmB,KAAK,MAAM,MAAM;AACtG,aAAO;AAAA;AAGT,iBACE,UACA,CAAC,SAAS;AACR,yBAAmB,KAAK,iCAAK,KAAK,QAAV,EAAiB;AAAA,OAE3C,MACA;AAEF,oBAAgB;AAChB,yBAAqB;AAErB,sBAAkB;AAAA,KAEjB;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAIF,QAAM,iBAAiB,QAAQ,MAAM,kBAAkB,OAAO,CAAC;AAE/D,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA;",
+  "names": []
+}