@hitachivantara/uikit-react-lab 5.26.3 → 5.27.1

package/dist/types/index.d.ts

@@ -30,6 +30,7 @@ import { Node as Node_2 } from 'reactflow';
 import { NodeProps } from 'reactflow';
 import { PanelPosition } from 'reactflow';
 import { default as React_2 } from 'react';
+import { ReactFlowInstance } from 'reactflow';
 import { ReactFlowProps } from 'reactflow';
 import { ReactGridLayoutProps } from 'react-grid-layout';
 import { ResponsiveProps } from 'react-grid-layout';
@@ -461,6 +462,8 @@ export declare const HvFlowEmpty: ({ className, ...others }: HvFlowEmptyProps) =
 export declare interface HvFlowEmptyProps extends HvEmptyStateProps {
 }
 
+export declare type HvFlowInstance<NodeData = any, EdgeData = any> = ReactFlowInstance<NodeData, EdgeData>;
+
 export declare const HvFlowMinimap: ({ nodeColor, maskColor, maskStrokeColor, nodeStrokeColor, classes: classesProp, className, ...others }: HvFlowMinimapProps) => JSX_2.Element;
 
 export declare type HvFlowMinimapClasses = ExtractNames<typeof useClasses_5>;
@@ -1133,26 +1136,36 @@ declare const useClasses_9: (classesProp?: Partial<Record<"root" | "title" | "ti
 
 export declare const useFlowContext: () => HvFlowContextValue<string>;
 
-export declare function useFlowInputNodes<T = any>(id: string): Node_2<T, string | undefined>[];
+/** Retrieves the nodes connected to the inputs of the node */
+export declare function useFlowInputNodes<T = any>(id?: string): Node_2<T, string | undefined>[];
+
+/** Retrieves the React Flow instance */
+export declare function useFlowInstance<NodeData = any, EdgeData = any>(): HvFlowInstance<NodeData, EdgeData>;
 
-export declare function useFlowNode<T extends Node_2 = Node_2>(id: string): T | undefined;
+/** Retrieves the node instance */
+export declare function useFlowNode<T extends Node_2 = Node_2>(id?: string): T | undefined;
 
-export declare function useFlowNodeEdges(id: string): Edge<any>[];
+/** Offers both input and output edges of the node */
+export declare function useFlowNodeEdges(id?: string): Edge<any>[];
 
-export declare function useFlowNodeInputEdges(id: string): Edge<any>[];
+/** Provides the input edges connected to the node */
+export declare function useFlowNodeInputEdges(id?: string): Edge<any>[];
 
-export declare function useFlowNodeMeta(id: string): HvFlowNodeMeta;
+export declare function useFlowNodeMeta(id?: string): HvFlowNodeMeta | undefined;
 
-export declare function useFlowNodeOutputEdges(id: string): Edge<any>[];
+/** Gives the output edges connected from the node */
+export declare function useFlowNodeOutputEdges(id?: string): Edge<any>[];
 
-export declare function useFlowNodeParents(id: string): Node_2<any, string | undefined>[];
+/** Gets the parent nodes of a specified node (nodes that have an output connected to one of the inputs of the node) */
+export declare function useFlowNodeParents(id?: string): Node_2<any, string | undefined>[];
 
 /** Utilities to manipulate a node in the flow */
-export declare function useFlowNodeUtils<NodeData = any>(): {
+export declare function useFlowNodeUtils<NodeData = any>(id?: string): {
     setNodeData: (setNewData: (newData?: NodeData) => NodeData) => void;
 };
 
-export declare function useFlowOutputNodes<T = any>(id: string): Node_2<T, string | undefined>[];
+/** Retrieves the nodes connected to the outputs of the node */
+export declare function useFlowOutputNodes<T = any>(id?: string): Node_2<T, string | undefined>[];
 
 export declare const wizardActionsClasses: {
     actionsContainer: "HvWizardActions-actionsContainer";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hitachivantara/uikit-react-lab",
-  "version": "5.26.3",
+  "version": "5.27.1",
   "private": false,
   "author": "Hitachi Vantara UI Kit Team",
   "description": "Contributed React components for the NEXT UI Kit.",
@@ -32,7 +32,7 @@
     "@dnd-kit/core": "^6.1.0",
     "@dnd-kit/modifiers": "^6.0.1",
     "@emotion/css": "^11.11.0",
-    "@hitachivantara/uikit-react-core": "^5.46.0",
+    "@hitachivantara/uikit-react-core": "^5.46.1",
     "@hitachivantara/uikit-react-icons": "^5.8.2",
     "@hitachivantara/uikit-styles": "^5.18.0",
     "@types/react-grid-layout": "^1.3.5",
@@ -50,7 +50,7 @@
     "access": "public",
     "directory": "package"
   },
-  "gitHead": "a2562049d702de7c20373efd6785fb8f84e9a20a",
+  "gitHead": "9cfeb1c73fd98690c4e8f2c91ce67b27b7bf90f1",
   "main": "dist/cjs/index.cjs",
   "exports": {
     ".": {