@elliemae/ds-menu-button 3.46.0-rc.2 → 3.46.0-rc.4

package/dist/types/utils/nodesTypeguardsAndGetters.d.ts

@@ -1,22 +1,134 @@
 import { type DSMenuButtonT } from '../react-desc-prop-types.js';
+/**
+ * Heuristic to determine if the selected item is an item or a node.
+ * Not perfect because JavaScript is not typed.
+ * If app devs provide an object that matches all of those conditions, it's an edge case the app devs should handle.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is (heuristically) a menu node, false otherwise.
+ */
+export declare const isObjectAMenuNode: (item: unknown) => item is DSMenuButtonT.MenuNode;
+/**
+ * Checks if the item is an activable node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is an activable node, false otherwise.
+ */
 export declare const isActivableNode: (item: unknown) => item is DSMenuButtonT.MenuNodeActivableItem;
-export declare const isActivableWithSubmenuNode: (item: unknown) => item is DSMenuButtonT.MenuNodeActivableWithSubmenuItem;
+/**
+ * Checks if the item is a skeleton node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a skeleton node, false otherwise.
+ */
 export declare const isSkeletonNode: (item: unknown) => item is DSMenuButtonT.MenuNodeSkeletonItem;
+/**
+ * Checks if the item is a multiple select only node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a multiple select only node, false otherwise.
+ */
 export declare const isMultipleSelectOnlyNode: (item: unknown) => item is DSMenuButtonT.MenuNodeMultipleSelectItem;
+/**
+ * Checks if the item is a multiple select node with a submenu.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a multiple select node with a submenu, false otherwise.
+ */
 export declare const isMultipleSelectWithSubmenuNode: (item: unknown) => item is DSMenuButtonT.MenuNodeMultipleSelectWithSubmenuItem;
+/**
+ * Checks if the item is a multiple select node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a multiple select node, false otherwise.
+ */
 export declare const isMultipleSelectNode: (item: unknown) => item is DSMenuButtonT.MultipleSelectionableMenuNodes;
+/**
+ * Checks if the item is a single select only node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a single select only node, false otherwise.
+ */
 export declare const isSingleSelectOnlyNode: (item: unknown) => item is DSMenuButtonT.MenuNodeSingleSelectItem;
+/**
+ * Checks if the item is a single select node with a submenu.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a single select node with a submenu, false otherwise.
+ */
 export declare const isSingleSelectNodeWithSubmenu: (item: unknown) => item is DSMenuButtonT.MenuNodeSingleSelectWithSubmenuItem;
+/**
+ * Checks if the item is a single select node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a single select node, false otherwise.
+ */
 export declare const isSingleSelectNode: (item: unknown) => item is DSMenuButtonT.SingleSelectionableMenuNodes;
+/**
+ * Checks if the item is a selectionable node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a selectionable node, false otherwise.
+ */
 export declare const isSelectionableNode: (item: unknown) => item is DSMenuButtonT.SelectionableMenuNodes;
+/**
+ * Gets all selectionable nodes from the tree.
+ * @param {DSMenuButtonT.MenuNode} tree - The tree to search.
+ * @returns {DSMenuButtonT.SelectionableMenuNodes[]} - An array of selectionable nodes.
+ */
 export declare const getSelectionableNodes: (tree: DSMenuButtonT.MenuNode) => DSMenuButtonT.SelectionableMenuNodes[];
+/**
+ * Checks if the item is a node with a submenu (and nothing else).
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a node with a submenu, false otherwise.
+ */
 export declare const isWithSubmenuOnlyNode: (item: unknown) => item is DSMenuButtonT.MenuNodeWithSubmenuItem;
+/**
+ * Checks if the item is a selectionable node with a submenu.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a selectionable node with a submenu, false otherwise.
+ */
 export declare const isSelectionableWithSubmenuNode: (item: unknown) => item is DSMenuButtonT.SelectionablesWithSubmenuMenuNodes;
+/**
+ * Checks if the item is an activable node with a submenu.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is an activable node with a submenu, false otherwise.
+ */
+export declare const isActivableWithSubmenuNode: (item: unknown) => item is DSMenuButtonT.MenuNodeActivableWithSubmenuItem;
+/**
+ * Checks if the item is a node with a submenu.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a node with a submenu, false otherwise.
+ */
 export declare const isWithSubmenuNode: (item: unknown) => item is DSMenuButtonT.WithSubmenuMenuNodes;
+/**
+ * Gets all nodes with a submenu from the tree.
+ * @param {DSMenuButtonT.MenuNode} tree - The tree to search.
+ * @returns {DSMenuButtonT.PseudoFocusableMenuNodes[]} - An array of nodes with a submenu.
+ */
 export declare const getWithSubmenuNodes: (tree: DSMenuButtonT.MenuNode) => DSMenuButtonT.PseudoFocusableMenuNodes[];
+/**
+ * Checks if the item is a node that can be focused.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a node that can be focused, false otherwise.
+ */
 export declare const isFocusableNode: (item: unknown) => item is DSMenuButtonT.PseudoFocusableMenuNodes;
+/**
+ * Gets all nodes that can be focused from the tree.
+ * @param {DSMenuButtonT.MenuNode} tree - The tree to search.
+ * @returns {DSMenuButtonT.PseudoFocusableMenuNodes[]} - An array of nodes that can be focused.
+ */
 export declare const getFocusableNodes: (tree: DSMenuButtonT.MenuNode) => DSMenuButtonT.PseudoFocusableMenuNodes[];
+/**
+ * Checks if the item is a separator node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a separator node, false otherwise.
+ */
 export declare const isSeparatorNode: (item: unknown) => item is DSMenuButtonT.MenuNodeSeparatorItem;
+/**
+ * Checks if the item is a group node.
+ * @param {unknown} item - The item to check.
+ * @returns {boolean} - True if the item is a group node, false otherwise.
+ */
 export declare const isGroup: (item: unknown) => item is DSMenuButtonT.MenuNodeGroupItem;
+/**
+ * Checks if the given item is a root node of the menu.
+ * @param {DSMenuButtonT.MenuNode} tree - The tree to search.
+ * @returns {DSMenuButtonT.PseudoFocusableMenuNodes[]} - An array of nodes that can be focused.
+ * @remarks
+ * The root item is not a renderable item and must always be treated with special care.
+ *
+ * This function uses a hardcoded string to identify the root item.
+ */
 export declare const isRootNode: (item: unknown) => item is DSMenuButtonT.MenuNodeRootItem;
 export declare const isMenuNodeAllowedToHaveChildren: (item: unknown) => item is DSMenuButtonT.MenuNodesAllowedToHaveChildren;

package/dist/types/utils/useOptionsArrayToDsTree.d.ts

@@ -3,6 +3,7 @@ import { type DSMenuButtonT } from '../react-desc-prop-types.js';
 type UseOptionsArrayToDsTreeRootNodeConfig = {
     options: DSMenuButtonT.MenuItemInterface[];
     instanceUid: string;
+    propsWithDefault?: DSMenuButtonT.MenuSpecifiDefaultProps;
 };
-export declare const useOptionsArrayToDsTree: ({ options, instanceUid }: UseOptionsArrayToDsTreeRootNodeConfig) => UseDSTreeT.OutputT<DSMenuButtonT.MenuItemInterface>;
+export declare const useOptionsArrayToDsTree: ({ options, instanceUid, propsWithDefault, }: UseOptionsArrayToDsTreeRootNodeConfig) => UseDSTreeT.OutputT<DSMenuButtonT.MenuItemInterface>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-menu-button",
-  "version": "3.46.0-rc.2",
+  "version": "3.46.0-rc.4",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Menu Button",
   "files": [
@@ -37,22 +37,21 @@
   },
   "dependencies": {
     "@xstyled/styled-components": "~3.6.0",
-    "@elliemae/ds-button-v2": "3.46.0-rc.2",
-    "@elliemae/ds-grid": "3.46.0-rc.2",
-    "@elliemae/ds-icons": "3.46.0-rc.2",
-    "@elliemae/ds-menu-items-commons": "3.46.0-rc.2",
-    "@elliemae/ds-props-helpers": "3.46.0-rc.2",
-    "@elliemae/ds-system": "3.46.0-rc.2",
-    "@elliemae/ds-tree-model": "3.46.0-rc.2",
-    "@elliemae/ds-hooks-on-blur-out": "3.46.0-rc.2",
-    "@elliemae/ds-floating-context": "3.46.0-rc.2"
+    "@elliemae/ds-button-v2": "3.46.0-rc.4",
+    "@elliemae/ds-floating-context": "3.46.0-rc.4",
+    "@elliemae/ds-grid": "3.46.0-rc.4",
+    "@elliemae/ds-hooks-on-blur-out": "3.46.0-rc.4",
+    "@elliemae/ds-menu-items-commons": "3.46.0-rc.4",
+    "@elliemae/ds-props-helpers": "3.46.0-rc.4",
+    "@elliemae/ds-tree-model": "3.46.0-rc.4",
+    "@elliemae/ds-system": "3.46.0-rc.4",
+    "@elliemae/ds-icons": "3.46.0-rc.4"
   },
   "devDependencies": {
     "@elliemae/pui-cli": "9.0.0-next.50",
     "styled-components": "~5.3.9",
-    "@elliemae/ds-monorepo-devops": "3.46.0-rc.2",
-    "@elliemae/ds-typescript-helpers": "3.46.0-rc.2",
-    "@elliemae/ds-dropdownmenu-v2": "3.46.0-rc.2"
+    "@elliemae/ds-monorepo-devops": "3.46.0-rc.4",
+    "@elliemae/ds-typescript-helpers": "3.46.0-rc.4"
   },
   "peerDependencies": {
     "@testing-library/jest-dom": "~5.16.4",