@elliemae/ds-legacy-shuttle-v2 1.0.0-rc.1

package/dist/types/react-desc-prop-types.d.ts

@@ -0,0 +1,199 @@
+import type { WeakValidationMap } from 'react';
+import type React from 'react';
+import type { GlobalAttributesT, XstyledProps, useHeadlessTooltip } from '@elliemae/ds-legacy-utilities';
+import { type DSControlledCheckboxT } from '@elliemae/ds-legacy-form-checkbox';
+import { type DSButtonT } from '@elliemae/ds-legacy-button-v2';
+import { type useSortable, type DnDKitTree } from '@elliemae/ds-legacy-drag-and-drop';
+import type { ZustandT } from '@elliemae/ds-legacy-zustand-helpers';
+import type { REGIONS_FOCUSES, ACTIONS_FOCUSES, ITEMS_FOCUSES } from './constants/index.js';
+import type { useAutoCalculated } from './config/useAutoCalculated/index.js';
+export declare namespace DSShuttleV2T {
+    type Datum = Record<string, unknown>;
+    type PanelMetaInfo = {
+        isDestinationPanel: boolean;
+        hasMultipleSelection: boolean;
+        height?: number;
+    };
+    type HydratedId = string;
+    type DatumInternalMeta = {
+        isFirst: boolean;
+        isLast: boolean;
+        isSelected: boolean;
+        softDeleted: boolean;
+        localIndex: number;
+        hydratedId: HydratedId;
+        hydratedPreventMove: boolean;
+    };
+    type DatumRenderFlags = {
+        selectionPrevented: boolean;
+        withActions: boolean;
+        withMoveBtn: boolean;
+        withDrilldownBtn: boolean;
+        internallyDisabledMove: boolean;
+        internallyDisabledDrilldown: boolean;
+    };
+    type RequiredPanelHydratables = Record<string, never>;
+    type OptionalPanelHydratables = {
+        batchActionableButtonProps: DSButtonT.Props;
+    };
+    type PanelHydratables = RequiredPanelHydratables & OptionalPanelHydratables;
+    type PrimaryKeyHydratables = {
+        id: HydratedId;
+    };
+    type FunctionalHydratables = {
+        preventMove?: boolean;
+    };
+    type RequiredDatumHydratablesWithoutComponents = {
+        label: string;
+    };
+    type OptionalDatumHydratablesWithoutComponents = {
+        subtitle?: string;
+        preventDrilldown?: boolean;
+    };
+    type DatumHydratablesWithoutComponents = PrimaryKeyHydratables & FunctionalHydratables & RequiredDatumHydratablesWithoutComponents & OptionalDatumHydratablesWithoutComponents;
+    type ComponentProps = {
+        datum: Datum;
+        thisItemIsFocused: boolean;
+        panelMetaInfo: PanelMetaInfo;
+        datumInternalMeta: DatumInternalMeta;
+        datumHydratables: DatumHydratablesWithoutComponents;
+        tooltipHelpers?: ReturnType<typeof useHeadlessTooltip>;
+    };
+    type RequiredDatumHydratablesComponents = {};
+    type OptionalDatumHydratablesComponents = {
+        Icon?: React.ComponentType<ComponentProps>;
+        CustomRenderer?: React.ComponentType<ComponentProps>;
+    };
+    type RequiredDatumHydratables = RequiredDatumHydratablesWithoutComponents & RequiredDatumHydratablesComponents;
+    type OptionalDatumHydratables = OptionalDatumHydratablesWithoutComponents & OptionalDatumHydratablesComponents;
+    type DatumHydratables = PrimaryKeyHydratables & RequiredDatumHydratables & OptionalDatumHydratables;
+    type PrimaryKeyHydraters = Hydraters<PrimaryKeyHydratables, [Datum]>;
+    type FunctionalHydraters = Hydraters<FunctionalHydratables, [Datum]>;
+    type HydratersMeta = {
+        datumMeta: DatumInternalMeta;
+        panelMetaInfo: PanelMetaInfo;
+    };
+    type RequiredDatumHydraters = Hydraters<RequiredDatumHydratables, [Datum, HydratersMeta]>;
+    type OptionalDatumHydraters = Hydraters<OptionalDatumHydratables, [Datum, HydratersMeta]>;
+    type DatumHydraters = PrimaryKeyHydraters & FunctionalHydraters & RequiredDatumHydraters & OptionalDatumHydraters;
+    type RequiredPanelHydraters = Hydraters<RequiredPanelHydratables, [PanelMetaInfo]>;
+    type OptionalPanelHydraters = Partial<Hydraters<OptionalPanelHydratables, [PanelMetaInfo]>>;
+    type PanelHydraters = RequiredPanelHydraters & OptionalPanelHydraters;
+    type ConfiguredDatum = DatumInternalMeta & {
+        original: Datum;
+    };
+    interface ItemMeta extends PanelMetaInfo {
+        datum: Datum;
+        datumHydratables: DatumHydratables;
+        datumInternalMeta: DatumInternalMeta;
+        datumRenderFlags: DatumRenderFlags;
+        withDragNDrop: boolean;
+        useSortableHelpers?: ReturnType<typeof useSortable>;
+    }
+    type OnDataChange = (newData: Datum[], metainfo: {
+        event: React.MouseEvent<HTMLButtonElement> | React.KeyboardEvent<HTMLButtonElement>;
+        item?: Datum;
+        selectedItems?: Datum[];
+    }) => void;
+    type OnChangeEvent = (items: Datum[], metainfo: {
+        event: React.MouseEvent<HTMLButtonElement> | React.KeyboardEvent<HTMLButtonElement>;
+    }) => void;
+    type OnReorderEventMetadata = Omit<DnDKitTree.OnReorder<DSShuttleV2T.Datum>, 'considerExpanding'>;
+    type OnReorderEvent = (movedItem: Datum, metadata: OnReorderEventMetadata) => void;
+    type SelectionMap = Record<string, boolean>;
+    type OnSelectionChange = (newSelection: SelectionMap, metainfo: {
+        event: Parameters<Required<DSButtonT.Props>['onClick']>[0] | Parameters<DSControlledCheckboxT.InternalProps['onChange']>[1] | React.MouseEvent<HTMLButtonElement | HTMLDivElement> | React.KeyboardEvent<HTMLDivElement> | React.ChangeEvent<HTMLInputElement>;
+        item?: Datum;
+    }) => void;
+    type OnSelectionDrilldown = (item: Datum, metainfo: {
+        event: React.MouseEvent<HTMLButtonElement> | React.KeyboardEvent<HTMLButtonElement>;
+    }) => void;
+    type OnLoadMore = (e: Parameters<Required<DSButtonT.Props>['onClick']>[0]) => void;
+    type OnFilterChange = (newfilter: string | null, metainfo: {
+        event: React.ChangeEvent<HTMLInputElement> | React.MouseEvent<HTMLButtonElement>;
+    }) => void;
+    type OnSearchbarOpen = (newfilter: boolean, metainfo: {
+        event: Parameters<Required<DSButtonT.Props>['onClick']>[0];
+    }) => void;
+    type SoftDeletedMap = Record<string, boolean>;
+    type OnSoftDeletedChange = (newSoftDeleted: SoftDeletedMap, metainfo: {
+        event: Parameters<Required<DSButtonT.Props>['onClick']>[0] | Parameters<DSControlledCheckboxT.InternalProps['onChange']>[1] | React.MouseEvent<HTMLButtonElement | HTMLDivElement> | React.KeyboardEvent<HTMLDivElement> | React.ChangeEvent<HTMLInputElement>;
+        item?: Datum;
+    }) => void;
+    type FocusRegion = (typeof REGIONS_FOCUSES)[keyof typeof REGIONS_FOCUSES];
+    type FocusItem = Omit<(typeof ITEMS_FOCUSES)[keyof typeof ITEMS_FOCUSES], 'GET_SPECIFIC_ITEM'> & string;
+    type FocusItemAction = (typeof ACTIONS_FOCUSES)[keyof typeof ACTIONS_FOCUSES];
+    type InternalAtoms = {
+        focusRegion: FocusRegion;
+        focusItem: FocusItem;
+        focusItemAction: FocusItemAction;
+        deferFocusUntilFirstRender: boolean;
+        dropIndicatorPosition: number;
+        overId: string;
+        dndDraggingItem: ConfiguredDatum | null;
+        dndDraggingItemMeta: ItemMeta | null;
+        lastActiveId: string;
+        isDropValid: boolean;
+        sourcePanelLastSelectedItem: string | null | undefined;
+        destinationPanelLastSelectedItem: string | null | undefined;
+    };
+    type UseAutoCalculatedT = ReturnType<typeof useAutoCalculated>;
+    type Selectors = {
+        getIsDragAndDropHappening: () => boolean;
+        getPanelLastSelectedItem: (isDestinationPanel: boolean) => string | null | undefined;
+    };
+    type Reducers = Record<string, never>;
+    type ShuttleInternalStore = ZustandT.InternalStore<InternalAtoms, Selectors, Reducers>;
+    interface RequiredProps extends RequiredDatumHydraters, PrimaryKeyHydraters {
+        sourceData: Datum[];
+        sourceSelectedItems: SelectionMap;
+        onSourceSelectionChange: OnSelectionChange;
+        SourceHeader: React.ComponentType<unknown>;
+        onSourceDrilldown: OnSelectionDrilldown;
+        destinationData: Datum[];
+        destinationSelectedItems: SelectionMap;
+        onDestinationSelectionChange: OnSelectionChange;
+        DestinationHeader: React.ComponentType<unknown>;
+        onDestinationDrilldown: OnSelectionDrilldown;
+    }
+    interface DefaultProps extends Required<FunctionalHydraters> {
+        sourceIsLoading: boolean;
+        sourceWithLoadMore: boolean;
+        sourceIsLoadingMore: boolean;
+        onSourceLoadMore: OnLoadMore;
+        destinationIsLoading: boolean;
+        destinationWithLoadMore: boolean;
+        destinationIsLoadingMore: boolean;
+        onDestinationLoadMore: OnLoadMore;
+        onSourceAdd: OnChangeEvent;
+        onSourceRemove: OnChangeEvent;
+        onDestinationAdd: OnChangeEvent;
+        onDestinationRemove: OnChangeEvent;
+        addDragAndDropFromSource: boolean;
+        removeDragAndDropFromDestination: boolean;
+        onSourceReorder: OnReorderEvent;
+        onDestinationReorder: OnReorderEvent;
+        sourceSoftDeletedItems: SoftDeletedMap;
+        onSourceSoftDelete: OnSoftDeletedChange;
+        destinationSoftDeletedItems: SoftDeletedMap;
+        onDestinationSoftDelete: OnSoftDeletedChange;
+    }
+    interface OptionalProps extends OptionalDatumHydraters, OptionalPanelHydraters {
+        sourceItemProps?: Record<string, unknown>;
+        destinationItemProps?: Record<string, unknown>;
+        sourceShowSearchbar?: boolean;
+        destinationShowSearchbar?: boolean;
+        onSourceOpenSearchbar?: OnSearchbarOpen;
+        onDesinationOpenSearchbar?: OnSearchbarOpen;
+        sourceFilterValue?: string;
+        destinationFilterValue?: string;
+        onSourceFilterChange?: OnFilterChange;
+        onDestinationFilterChange?: OnFilterChange;
+    }
+    interface Props extends Partial<DefaultProps>, OptionalProps, Omit<GlobalAttributesT<HTMLButtonElement>, keyof DefaultProps | keyof OptionalProps | keyof RequiredProps>, XstyledProps, RequiredProps {
+    }
+    interface InternalProps extends DefaultProps, OptionalProps, Omit<GlobalAttributesT<HTMLButtonElement>, keyof DefaultProps | keyof OptionalProps | keyof RequiredProps>, XstyledProps, RequiredProps {
+    }
+}
+export declare const defaultProps: DSShuttleV2T.DefaultProps;
+export declare const DSShuttleV2PropTypesSchema: WeakValidationMap<DSShuttleV2T.Props>;

package/dist/types/tests/configs/basic.d.ts

@@ -0,0 +1,25 @@
+export function BreadCrumbHoc({ path, setCurrentNode }: {
+    path: any;
+    setCurrentNode: any;
+}): (props: any) => import("react/jsx-runtime").JSX.Element;
+export function useShuttle(): {
+    setCurrentSourceNode: React.Dispatch<React.SetStateAction<import("@elliemae/ds-legacy-tree-model").Node<any>>>;
+    setCurrentDestinationNode: React.Dispatch<React.SetStateAction<import("@elliemae/ds-legacy-tree-model").Node<any>>>;
+    sourceDisplayedData: any[];
+    destinationDisplayedData: any[];
+    sourceSelection: {};
+    destinationSelection: {};
+    setSourceSelection: React.Dispatch<React.SetStateAction<{}>>;
+    setDestinationSelection: React.Dispatch<React.SetStateAction<{}>>;
+    onSourceDrilldown: (item: any) => void;
+    onDestinationDrilldown: (item: any) => void;
+    onSourceAdd: (items: any) => any;
+    onSourceRemove: (items: any) => any;
+    onDestinationAdd: (items: any) => any;
+    onDestinationRemove: (items: any) => any;
+    sourceBreadCrumbPath: import("@elliemae/ds-legacy-tree-model").Node<any>[];
+    destinationBreadCrumbPath: import("@elliemae/ds-legacy-tree-model").Node<any>[];
+    currentSourceNode: import("@elliemae/ds-legacy-tree-model").Node<any>;
+    currentDestinationNode: import("@elliemae/ds-legacy-tree-model").Node<any>;
+};
+import React from 'react';

package/dist/types/tests/configs/filter.d.ts

@@ -0,0 +1,29 @@
+export function BreadCrumbHoc({ path, setCurrentNode }: {
+    path: any;
+    setCurrentNode: any;
+}): (props: any) => import("react/jsx-runtime").JSX.Element;
+export function useShuttle(): {
+    setCurrentSourceNode: React.Dispatch<React.SetStateAction<import("@elliemae/ds-legacy-tree-model").Node<any>>>;
+    setCurrentDestinationNode: React.Dispatch<React.SetStateAction<import("@elliemae/ds-legacy-tree-model").Node<any>>>;
+    sourceDisplayedData: any[];
+    destinationDisplayedData: any[];
+    sourceSelection: {};
+    destinationSelection: {};
+    setSourceSelection: React.Dispatch<React.SetStateAction<{}>>;
+    setDestinationSelection: React.Dispatch<React.SetStateAction<{}>>;
+    sourceFilterValue: string;
+    destinationFilterValue: string;
+    setSourceFilterValue: React.Dispatch<React.SetStateAction<string>>;
+    setDestinationFilterValue: React.Dispatch<React.SetStateAction<string>>;
+    onSourceDrilldown: (item: any) => void;
+    onDestinationDrilldown: (item: any) => void;
+    onSourceAdd: (items: any) => any;
+    onSourceRemove: (items: any) => any;
+    onDestinationAdd: (items: any) => any;
+    onDestinationRemove: (items: any) => any;
+    sourceBreadCrumbPath: import("@elliemae/ds-legacy-tree-model").Node<any>[];
+    destinationBreadCrumbPath: import("@elliemae/ds-legacy-tree-model").Node<any>[];
+    currentSourceNode: import("@elliemae/ds-legacy-tree-model").Node<any>;
+    currentDestinationNode: import("@elliemae/ds-legacy-tree-model").Node<any>;
+};
+import React from 'react';

package/dist/types/tests/configs/loadMore.d.ts

@@ -0,0 +1,29 @@
+export function BreadCrumbHoc({ path, setCurrentNode }: {
+    path: any;
+    setCurrentNode: any;
+}): (props: any) => import("react/jsx-runtime").JSX.Element;
+export function useShuttle(): {
+    setCurrentSourceNode: React.Dispatch<React.SetStateAction<import("@elliemae/ds-legacy-tree-model").Node<any>>>;
+    setCurrentDestinationNode: React.Dispatch<React.SetStateAction<import("@elliemae/ds-legacy-tree-model").Node<any>>>;
+    sourceDisplayedData: any[];
+    destinationDisplayedData: any[];
+    sourceSelection: {};
+    destinationSelection: {};
+    setSourceSelection: React.Dispatch<React.SetStateAction<{}>>;
+    setDestinationSelection: React.Dispatch<React.SetStateAction<{}>>;
+    onSourceDrilldown: (item: any) => void;
+    onDestinationDrilldown: (item: any) => void;
+    onSourceAdd: (items: any) => any;
+    onSourceRemove: (items: any) => any;
+    onDestinationAdd: (items: any) => any;
+    onDestinationRemove: (items: any) => any;
+    sourceBreadCrumbPath: import("@elliemae/ds-legacy-tree-model").Node<any>[];
+    destinationBreadCrumbPath: import("@elliemae/ds-legacy-tree-model").Node<any>[];
+    isSourceLoadingMore: boolean;
+    onLoadMoreSource: () => void;
+    isDestinationLoadingMore: boolean;
+    onLoadMoreDestination: () => void;
+    currentSourceNode: import("@elliemae/ds-legacy-tree-model").Node<any>;
+    currentDestinationNode: import("@elliemae/ds-legacy-tree-model").Node<any>;
+};
+import React from 'react';

package/dist/types/tests/shuttle-v2.basic.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/shuttle-v2.filter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/shuttle-v2.load-more.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@elliemae/ds-legacy-shuttle-v2",
+  "version": "1.0.0-rc.1",
+  "license": "MIT",
+  "description": "ICE MT - Dimsum - Shuttle v2",
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "sideEffects": [
+    "*.css",
+    "*.scss"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://git.elliemae.io/platform-ui/dimsum-legacy.git"
+  },
+  "engines": {
+    "pnpm": ">=6",
+    "node": ">=16"
+  },
+  "author": "ICE MT",
+  "jestSonar": {
+    "sonar56x": true,
+    "reportPath": "reports",
+    "reportFile": "tests.xml",
+    "indent": 4
+  },
+  "dependencies": {
+    "fast-deep-equal": "~3.1.3",
+    "uid": "~2.0.1",
+    "@elliemae/ds-legacy-circular-progress-indicator": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-drag-and-drop": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-form-checkbox": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-fast-list": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-form-input-text": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-grid": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-hooks-fontsize-detector": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-indeterminate-progress-indicator": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-icons": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-popperjs": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-props-helpers": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-system": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-button-v2": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-typography": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-utilities": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-zustand-helpers": "1.0.0-rc.1"
+  },
+  "devDependencies": {
+    "@elliemae/pui-cli": "~9.0.0-next.31",
+    "lodash": "^4.17.21",
+    "styled-components": "~5.3.9",
+    "@elliemae/ds-legacy-breadcrumb": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-monorepo-devops": "1.0.0-rc.1",
+    "@elliemae/ds-legacy-tree-model": "1.0.0-rc.1"
+  },
+  "peerDependencies": {
+    "lodash": "^4.17.21",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "styled-components": "~5.3.9"
+  },
+  "publishConfig": {
+    "access": "public",
+    "typeSafety": false
+  },
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development node ../../../scripts/build/build.mjs --watch",
+    "test": "pui-cli test --passWithNoTests",
+    "lint": "node ../../../scripts/lint.mjs",
+    "eslint:fix": "eslint --ext='.js,.jsx,.test.js,.ts,.tsx' --fix --config='../../../.eslintrc.js' src/",
+    "dts": "node ../../../scripts/dts.mjs",
+    "dts:withdeps": "pnpm --filter {.}... dts",
+    "build": "cross-env NODE_ENV=production node ../../../scripts/build/build.mjs",
+    "dev:build": "pnpm --filter {.}... build",
+    "dev:install": "pnpm --filter {.}... i --no-lockfile && pnpm run dev:build",
+    "checkDeps": "npm exec ../../util/ds-codemods -- check-missing-packages --projectFolderPath=\"./\" --ignorePackagesGlobPattern=\"\" --ignoreFilesGlobPattern=\"**/test-ables/*,**/tests/*\""
+  }
+}