@gouvfr-lasuite/ui-kit 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -1,19 +1,29 @@
 import { CunninghamProvider as CunninghamProvider_2 } from '@openfun/cunningham-react';
 import { CursorProps } from 'react-arborist';
 import { Dispatch } from 'react';
-import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { JSX } from 'react/jsx-runtime';
+import { Key } from 'react-stately';
 import { LabelHTMLAttributes } from 'react';
+import { NodeApi } from 'react-arborist';
 import { NodeRendererProps } from 'react-arborist';
 import { PropsWithChildren } from 'react';
 import { ReactNode } from 'react';
 import { SetStateAction } from 'react';
 
-export declare type BaseTreeViewData<T> = T & {
+export declare type BaseTreeViewData<T> = {
     id: string;
     childrenCount?: number;
-    parentId?: string;
-    children?: BaseTreeViewData<T>[];
-};
+    hasLoadedChildren?: boolean;
+    subItems?: BaseTreeViewData<T>[];
+    canDrop?: boolean;
+} & (({
+    type: TreeViewNodeTypeEnum.TITLE;
+    title: string;
+}) | ({
+    type: TreeViewNodeTypeEnum.SEPARATOR;
+}) | ({
+    type?: Exclude<TreeViewNodeTypeEnum, TreeViewNodeTypeEnum.TITLE | TreeViewNodeTypeEnum.SEPARATOR>;
+} & T));
 
 export declare const cunninghamConfig: {
     themes: {
@@ -312,11 +322,11 @@ export declare const cunninghamConfig: {
     };
 };
 
-export declare const CunninghamProvider: (props: Parameters<typeof CunninghamProvider_2>[0]) => JSX_2.Element;
+export declare const CunninghamProvider: (props: Parameters<typeof CunninghamProvider_2>[0]) => JSX.Element;
 
-export declare const CustomTabs: ({ tabs, defaultSelectedTab, fullWidth, }: TabsProps) => JSX_2.Element | null;
+export declare const CustomTabs: ({ tabs, defaultSelectedTab, fullWidth, }: TabsProps) => JSX.Element | null;
 
-export declare const DropdownMenu: ({ options, isOpen, onOpenChange, children, selectedValues, onSelectValue, }: PropsWithChildren<DropdownMenuProps>) => JSX_2.Element;
+export declare const DropdownMenu: ({ options, isOpen, onOpenChange, children, selectedValues, onSelectValue, }: PropsWithChildren<DropdownMenuProps>) => JSX.Element;
 
 export declare type DropdownMenuOption = {
     label: string;
@@ -343,7 +353,7 @@ export declare function getLocales(): {
     frFR: any;
 };
 
-export declare const Header: ({ leftIcon, rightIcon, languages, onTogglePanel, isPanelOpen, }: HeaderProps) => JSX_2.Element;
+export declare const Header: ({ leftIcon, rightIcon, languages, onTogglePanel, isPanelOpen, }: HeaderProps) => JSX.Element;
 
 export declare const headerHeight = 52;
 
@@ -355,25 +365,31 @@ export declare type HeaderProps = {
     isPanelOpen?: boolean;
 };
 
-export declare const HorizontalSeparator: ({ withPadding }: Props_3) => JSX_2.Element;
+export declare const HorizontalSeparator: ({ withPadding }: Props_3) => JSX.Element;
+
+export declare const isNode: <T>(node?: TreeViewDataType<T>) => boolean;
+
+export declare const isSeparator: <T>(node?: TreeViewDataType<T>) => boolean;
+
+export declare const isTitle: <T>(node?: TreeViewDataType<T>) => boolean;
 
 export declare const Label: ({ children, text, ...props }: LabelHTMLAttributes<HTMLLabelElement> & {
     text?: string;
-}) => JSX_2.Element;
+}) => JSX.Element;
 
-export declare const LanguagePicker: ({ languages }: LanguagePickerProps) => JSX_2.Element;
+export declare const LanguagePicker: ({ languages }: LanguagePickerProps) => JSX.Element;
 
 export declare type LanguagePickerProps = {
     languages: DropdownMenuOption[];
 };
 
-export declare const LeftPanel: ({ children, isOpen, }: PropsWithChildren<LeftPanelProps>) => JSX_2.Element;
+export declare const LeftPanel: ({ children, isOpen, }: PropsWithChildren<LeftPanelProps>) => JSX.Element;
 
 export declare type LeftPanelProps = {
     isOpen?: boolean;
 };
 
-export declare const MainLayout: ({ icon, children, leftPanelContent, rightHeaderContent, languages, enableResize, }: PropsWithChildren<MainLayoutProps>) => JSX_2.Element;
+export declare const MainLayout: ({ icon, children, leftPanelContent, rightHeaderContent, languages, enableResize, }: PropsWithChildren<MainLayoutProps>) => JSX.Element;
 
 export declare type MainLayoutProps = {
     icon?: React.ReactNode;
@@ -384,7 +400,7 @@ export declare type MainLayoutProps = {
     enableResize?: boolean;
 };
 
-export declare const ProConnectButton: ({ disabled, onClick, }: ProConnectButtonProps) => JSX_2.Element;
+export declare const ProConnectButton: ({ disabled, onClick, }: ProConnectButtonProps) => JSX.Element;
 
 export declare type ProConnectButtonProps = {
     disabled?: boolean;
@@ -409,7 +425,7 @@ declare type Props_3 = {
     withPadding?: boolean;
 };
 
-export declare const QuickSearch: ({ onFilter, inputContent, inputValue, loading, showInput, label, placeholder, children, }: QuickSearchProps) => JSX_2.Element;
+export declare const QuickSearch: ({ onFilter, inputContent, inputValue, loading, showInput, label, placeholder, children, }: QuickSearchProps) => JSX.Element;
 
 export declare type QuickSearchAction = {
     onSelect?: () => void;
@@ -425,7 +441,7 @@ export declare type QuickSearchData<T> = {
     showWhenEmpty?: boolean;
 };
 
-export declare const QuickSearchGroup: <T>({ group, onSelect, renderElement, }: QuickSearchGroupProps<T>) => JSX_2.Element | null;
+export declare const QuickSearchGroup: <T>({ group, onSelect, renderElement, }: QuickSearchGroupProps<T>) => JSX.Element | null;
 
 export declare type QuickSearchGroupProps<T> = {
     group: QuickSearchData<T>;
@@ -433,11 +449,11 @@ export declare type QuickSearchGroupProps<T> = {
     onSelect?: (element: T) => void;
 };
 
-export declare const QuickSearchInput: ({ loading, inputValue, onFilter, placeholder, children, withSeparator: separator, }: Props_2) => JSX_2.Element;
+export declare const QuickSearchInput: ({ loading, inputValue, onFilter, placeholder, children, withSeparator: separator, }: Props_2) => JSX.Element;
 
-export declare const QuickSearchItem: ({ children, onSelect, id, }: PropsWithChildren<Props>) => JSX_2.Element;
+export declare const QuickSearchItem: ({ children, onSelect, id, }: PropsWithChildren<Props>) => JSX.Element;
 
-export declare const QuickSearchItemTemplate: ({ alwaysShowRight, left, right, }: QuickSearchItemTemplateProps) => JSX_2.Element;
+export declare const QuickSearchItemTemplate: ({ alwaysShowRight, left, right, }: QuickSearchItemTemplateProps) => JSX.Element;
 
 export declare type QuickSearchItemTemplateProps = {
     alwaysShowRight?: boolean;
@@ -456,7 +472,7 @@ export declare type QuickSearchProps = {
     children?: ReactNode;
 };
 
-export declare const Spinner: ({ size }: SpinnerProps) => JSX_2.Element;
+export declare const Spinner: ({ size }: SpinnerProps) => JSX.Element;
 
 declare interface SpinnerProps {
     size?: "sm" | "md" | "lg" | "xl";
@@ -475,31 +491,22 @@ export declare type TabsProps = {
     fullWidth?: boolean;
 };
 
-export declare const treeDemoData: ({
-    id: string;
-    name: string;
-    childrenCount?: undefined;
-    children?: undefined;
-} | {
-    id: string;
-    name: string;
-    childrenCount: number;
-    children: never[];
-} | {
-    id: string;
-    name: string;
-    children: {
-        id: string;
-        name: string;
-    }[];
-    childrenCount?: undefined;
-})[];
+export declare type TreeDataItem<T> = {
+    /** A unique key for the tree node. */
+    key: string;
+    /** The key of the parent node. */
+    parentKey?: string | null;
+    /** The value object for the tree node. */
+    value: TreeViewDataType<T>;
+    /** Children of the tree node. */
+    children: TreeDataItem<T>[] | null;
+};
 
-export declare const TreeView: <T>({ treeData, selectedNodeId, rootNodeId, renderNode, afterMove, }: TreeViewProps<T>) => JSX_2.Element;
+export declare const TreeView: <T>({ treeData, selectedNodeId, rootNodeId, renderNode, handleMove, canDrop, canDrag, }: TreeViewProps<T>) => JSX.Element;
 
 export declare type TreeViewDataType<T> = BaseTreeViewData<T>;
 
-export declare const TreeViewItem: <T>({ children, onClick, node, dragHandle, style, loadChildren, forceLoading, }: PropsWithChildren<TreeViewNodeProps<T>>) => JSX_2.Element;
+export declare const TreeViewItem: <T>({ children, onClick, node, dragHandle, style, loadChildren, forceLoading, }: PropsWithChildren<TreeViewNodeProps<T>>) => JSX.Element;
 
 export declare enum TreeViewMoveModeEnum {
     FIRST_CHILD = "first-child",
@@ -509,28 +516,41 @@ export declare enum TreeViewMoveModeEnum {
 }
 
 export declare type TreeViewMoveResult = {
-    targetNodeId: string;
+    targetModeId: string;
     mode: TreeViewMoveModeEnum;
-    sourceNodeId: string;
     oldParentId?: string;
+    index: number;
+    newParentId: string | null;
+    sourceId: string;
 };
 
-export declare type TreeViewNodeProps<T> = NodeRendererProps<TreeViewDataType<T>> & {
+export declare type TreeViewNodeProps<T> = NodeRendererProps<TreeDataItem<T>> & {
     onClick?: () => void;
     forceLoading?: boolean;
     loadChildren?: (node: TreeViewDataType<T>) => Promise<TreeViewDataType<T>[]>;
 };
 
+export declare enum TreeViewNodeTypeEnum {
+    NODE = "node",
+    SEPARATOR = "separator",
+    TITLE = "title"
+}
+
 export declare type TreeViewProps<T> = {
-    treeData: TreeViewDataType<T>[];
-    width?: number | string;
+    treeData: TreeDataItem<T>[];
     selectedNodeId?: string;
     rootNodeId: string;
-    renderNode: (props: NodeRendererProps<TreeViewDataType<T>>) => React.ReactNode;
-    afterMove?: (result: TreeViewMoveResult, newTreeData: TreeViewDataType<T>[]) => void;
+    canDrop?: (args: {
+        parentNode: NodeApi<TreeDataItem<T>> | null;
+        dragNodes: NodeApi<TreeDataItem<T>>[];
+        index: number;
+    }) => boolean;
+    canDrag?: (node: TreeDataItem<T>) => boolean;
+    handleMove?: (result: TreeViewMoveResult) => void;
+    renderNode: (props: NodeRendererProps<TreeDataItem<T>>) => React.ReactNode;
 };
 
-export declare const TreeViewSeparator: ({ top, left }: CursorProps) => JSX_2.Element;
+export declare const TreeViewSeparator: ({ top, left }: CursorProps) => JSX.Element;
 
 export declare const useDropdownMenu: () => {
     isOpen: boolean;
@@ -543,20 +563,26 @@ export declare const useResponsive: () => {
     isDesktop: boolean;
 };
 
-export declare const useTree: <T>(tree: TreeViewDataType<T>[], refreshCallback?: (id: string) => Promise<Partial<TreeViewDataType<T>>>) => {
-    treeData: TreeViewDataType<T>[];
-    setTreeData: Dispatch<SetStateAction<TreeViewDataType<T>[]>>;
-    addChild: (parentId: string, newNode: TreeViewDataType<T>) => void;
+export declare const useTree: <T extends object>(initialItems: TreeViewDataType<T>[], refreshCallback?: (id: string) => Promise<Partial<TreeViewDataType<T>>>, loadChildrenCallback?: (id: string) => Promise<TreeViewDataType<T>[]>) => {
+    nodes: TreeDataItem<TreeViewDataType<T>>[];
+    addChild: (parentId: string | null, newNode: TreeViewDataType<T>) => void;
     updateNode: (nodeId: string, updatedData: Partial<TreeViewDataType<T>>) => void;
     deleteNode: (nodeId: string) => void;
     addRootNode: (newNode: TreeViewDataType<T>) => void;
     selectedNode: TreeViewDataType<T> | undefined;
     setSelectedNode: Dispatch<SetStateAction<TreeViewDataType<T> | undefined>>;
     refreshNode: (nodeId: string) => Promise<void>;
-    setChildren: (parentId: string, newChildren: TreeViewDataType<T>[], mergeStrategy?: "replace" | "merge") => void;
+    setChildren: (parentId: string, newChildren: TreeViewDataType<T>[]) => void;
+    insertBeforeNode: (nodeId: string, newNode: TreeViewDataType<T>) => void;
+    insertAfterNode: (nodeId: string, newNode: TreeViewDataType<T>) => void;
+    handleMove: (result: TreeViewMoveResult) => void;
+    prependToNode: (nodeId: string, newNode: TreeViewDataType<T>) => void;
+    moveNode: (nodeId: string, newParentId: string | null, newIndex: number, oldParentId?: string | null) => void;
+    move: (key: Key, toParentKey: Key | null, index: number) => void;
+    handleLoadChildren: (nodeId: string) => Promise<TreeViewDataType<T>[]>;
 };
 
-export declare const WithLabel: ({ label, text, labelSide, children, }: PropsWithChildren<WithLabelProps>) => JSX_2.Element;
+export declare const WithLabel: ({ label, text, labelSide, children, }: PropsWithChildren<WithLabelProps>) => JSX.Element;
 
 export declare type WithLabelProps = {
     label: string;