@box/combobox-with-api 0.25.0

package/types/lib/components/combobox-with-api-tree-view/combobox-with-api-tree-view.d.ts

@@ -0,0 +1,21 @@
+import { TreeOptionType } from '../combobox-with-api-pagination/types';
+export declare const ComboboxWithApiTreeView: import('react').ForwardRefExoticComponent<{
+    levels: import('./types').Level[];
+    selectableLevels: number[];
+    defaultFetcher(input: import('../combobox-with-api-pagination/types').TreeQueryInput): Promise<import('../combobox-with-api-pagination/types').FetcherResponse<TreeOptionType>>;
+    placeholder?: string;
+    includeTextInputOption?: boolean;
+    noResultMessage?: import('react').ReactElement | string;
+    onInputValueChange?: (inputValue: string) => void;
+    multiselect?: boolean;
+    onValueChange?: (selectedOptions: TreeOptionType[]) => void;
+    value?: TreeOptionType[];
+    defaultValue?: TreeOptionType[];
+    disabled?: boolean;
+    loadingAriaLabel?: string;
+    portalElement?: HTMLElement | (() => HTMLElement);
+    experimentalVirtualization?: boolean;
+    className?: string;
+    hideLabel?: boolean;
+    treeAriaLabel?: string;
+} & import('@box/blueprint-web').Labelable & import('react').RefAttributes<HTMLInputElement>>;

package/types/lib/components/combobox-with-api-tree-view/dynamic-loading-tree.d.ts

@@ -0,0 +1,23 @@
+import { NodeId, TreeProps } from '@box/tree';
+import { TreeOptionType } from '../combobox-with-api-pagination/types';
+import { ComboboxWithApiTreeViewProps, Level } from './types';
+export interface SearchResultsNameProps {
+    levelName: string;
+    parentDisplayValue: string;
+    displayValue: string;
+}
+export declare const SearchResultsName: ({ levelName, parentDisplayValue, displayValue }: SearchResultsNameProps) => import("react/jsx-runtime").JSX.Element;
+export interface DynamicLoadingTreeProps {
+    ariaLabel: string;
+    onSelect: TreeProps['onNodeSelect'];
+    selectedNodes: NodeId[];
+    defaultFetcher: ComboboxWithApiTreeViewProps<TreeOptionType>['defaultFetcher'];
+    levels: Level[];
+    selectableLevels: number[];
+    multiselect: boolean;
+    open: boolean;
+    searchInput: string;
+    noResultMessage: string | React.ReactElement;
+    loadingAriaLabel: string;
+}
+export declare const DynamicLoadingTree: ({ ariaLabel, onSelect, selectedNodes, defaultFetcher, levels, selectableLevels, multiselect, open, searchInput, noResultMessage, loadingAriaLabel, }: DynamicLoadingTreeProps) => import("react/jsx-runtime").JSX.Element;

package/types/lib/components/combobox-with-api-tree-view/index.d.ts

@@ -0,0 +1,3 @@
+export type { TreeOptionType, TreeQueryInput } from '../combobox-with-api-pagination/types';
+export { ComboboxWithApiTreeView } from './combobox-with-api-tree-view';
+export type { ComboboxWithApiTreeViewProps, Level } from './types';

package/types/lib/components/combobox-with-api-tree-view/stories/mock-api-response.d.ts

@@ -0,0 +1,11 @@
+export declare const apiResponse: {
+    id: string;
+    ancestors: {
+        id: string;
+        displayName: string;
+        level: number;
+    }[];
+    displayName: string;
+    level: number;
+    selectable: boolean;
+}[];

package/types/lib/components/combobox-with-api-tree-view/stories/shared.d.ts

@@ -0,0 +1,26 @@
+import { FetcherResponse, TreeOptionType, TreeQueryInput } from '../../combobox-with-api-pagination/types';
+export declare const defaultArgs: {
+    label: string;
+    defaultFetcher: ({ ...options }: TreeQueryInput) => Promise<FetcherResponse<TreeOptionType>>;
+    portalElement: () => HTMLElement;
+    multiselect: true;
+    selectableLevels: number[];
+    treeAriaLabel: string;
+    levels: {
+        displayName: string;
+        description: string;
+        level: number;
+    }[];
+};
+interface MockFetcherProps extends TreeQueryInput {
+    options?: unknown[];
+    delay?: number;
+    failOnLoadMore?: boolean;
+    failOnLoadMoreTimes?: number;
+    failOnLoadLevel?: number;
+    failOnLoadLevelTimes?: number;
+}
+export declare const mockTreeFetcher: ({ delay, signal, level, searchInput, ancestorId, marker, failOnLoadMore, options, failOnLoadMoreTimes, failOnLoadLevel, failOnLoadLevelTimes, }: MockFetcherProps) => Promise<FetcherResponse<TreeOptionType>>;
+export declare const findNode: (name: string) => TreeOptionType;
+export declare const mockRejectedFetcher: ({ delay }: MockFetcherProps) => Promise<FetcherResponse<TreeOptionType>>;
+export { mockTreeFetcher as mockFetcher };

package/types/lib/components/combobox-with-api-tree-view/tree-utils.d.ts

@@ -0,0 +1,22 @@
+import { LoadingNode, LoadMoreNode, ReloadNode } from '@box/tree';
+import { NodeId } from './types';
+export declare const getServiceNode: (parentId: NodeId, parentName: string, variant: "reload" | "loadMore" | "loading") => LoadMoreNode | ReloadNode | LoadingNode | {
+    name: string;
+    id: string;
+    parent: import('@box/tree').NodeId;
+    children: any[];
+    metadata: {
+        variant: "loading" | "loadMore" | "reload";
+    };
+};
+export declare const RootTreeNode: {
+    name: string;
+    id: string;
+    parent: any;
+    children: any[];
+    metadata: {
+        variant: string;
+        level: number;
+        displayValue: string;
+    };
+};

package/types/lib/components/combobox-with-api-tree-view/types.d.ts

@@ -0,0 +1,60 @@
+import { Labelable } from '@box/blueprint-web';
+import { Node } from '@box/tree';
+import { ReactElement } from 'react';
+import { FetcherResponse, TreeOptionType, TreeQueryInput } from '../combobox-with-api-pagination/types';
+export type NodeId = Node['id'];
+export type ItemType = {
+    id: NodeId;
+    name: string | ReactElement;
+    parent: NodeId | null;
+    children: NodeId[];
+    marker?: string;
+    status?: 'loading' | 'error' | 'success';
+};
+export interface TreeState {
+    [id: string]: TreeNode;
+}
+export declare enum ActionTypes {
+    LOAD_DATA = "LOAD_DATA",
+    LOAD_ERROR = "LOAD_DATA_ERROR",
+    LOAD_SUCCESS = "LOAD_DATA_SUCCESS",
+    LOAD_MORE = "LOAD_DATA_SUCCESS",
+    RESET = "RESET"
+}
+export interface AcitonPayload {
+    id: NodeId;
+    items?: ItemType[];
+    marker?: string;
+}
+export interface TreeStateUpdateAction {
+    type: ActionTypes;
+    payload: AcitonPayload;
+}
+export type TreeNode = ItemType & {
+    metadata: unknown;
+};
+export interface Level {
+    displayName: string;
+    description: string;
+    level: number;
+}
+export type ComboboxWithApiTreeViewProps<T extends TreeOptionType> = {
+    levels: Level[];
+    selectableLevels: number[];
+    defaultFetcher(input: TreeQueryInput): Promise<FetcherResponse<T>>;
+    placeholder?: string;
+    includeTextInputOption?: boolean;
+    noResultMessage?: ReactElement | string;
+    onInputValueChange?: (inputValue: string) => void;
+    multiselect?: boolean;
+    onValueChange?: (selectedOptions: T[]) => void;
+    value?: T[];
+    defaultValue?: T[];
+    disabled?: boolean;
+    loadingAriaLabel?: string;
+    portalElement?: HTMLElement | (() => HTMLElement);
+    experimentalVirtualization?: boolean;
+    className?: string;
+    hideLabel?: boolean;
+    treeAriaLabel?: string;
+} & Labelable;