@alaarab/ogrid-core 1.9.0 → 2.0.0

package/dist/types/hooks/useKeyboardNavigation.d.ts

@@ -1,47 +0,0 @@
-import type { RowId, IActiveCell, ISelectionRange, IColumnDef, ICellValueChangedEvent, RowSelectionMode } from '../types';
-import type { EditingCell } from './useCellEditing';
-import type { ContextMenuPosition } from './useContextMenu';
-export interface UseKeyboardNavigationParams<T> {
-    data: {
-        items: T[];
-        visibleCols: IColumnDef<T>[];
-        colOffset: number;
-        hasCheckboxCol: boolean;
-        visibleColumnCount: number;
-        getRowId: (item: T) => RowId;
-    };
-    state: {
-        activeCell: IActiveCell | null;
-        selectionRange: ISelectionRange | null;
-        editingCell: EditingCell | null;
-        selectedRowIds: Set<RowId>;
-    };
-    handlers: {
-        setActiveCell: (cell: IActiveCell | null) => void;
-        setSelectionRange: (range: ISelectionRange | null) => void;
-        setEditingCell: (cell: EditingCell | null) => void;
-        handleRowCheckboxChange: (rowId: RowId, checked: boolean, rowIndex: number, shiftKey: boolean) => void;
-        handleCopy: () => void;
-        handleCut: () => void;
-        handlePaste: () => Promise<void>;
-        setContextMenu: (pos: ContextMenuPosition | null) => void;
-        onUndo?: () => void;
-        onRedo?: () => void;
-        clearClipboardRanges?: () => void;
-    };
-    features: {
-        editable?: boolean;
-        onCellValueChanged: ((event: ICellValueChangedEvent<T>) => void) | undefined;
-        rowSelection: RowSelectionMode;
-        wrapperRef: React.RefObject<HTMLElement | null>;
-    };
-}
-export interface UseKeyboardNavigationResult {
-    handleGridKeyDown: (e: React.KeyboardEvent) => void;
-}
-/**
- * Handles all keyboard navigation, shortcuts, and cell editing triggers for the grid.
- * @param params - Grouped data, state, handlers, and feature flags for keyboard interactions.
- * @returns Keyboard event handler for the grid wrapper.
- */
-export declare function useKeyboardNavigation<T>(params: UseKeyboardNavigationParams<T>): UseKeyboardNavigationResult;

package/dist/types/hooks/useLatestRef.d.ts

@@ -1,6 +0,0 @@
-/**
- * Returns a ref that always holds the latest value.
- * Useful for capturing volatile state in stable callbacks
- * without adding the value to dependency arrays.
- */
-export declare function useLatestRef<T>(value: T): React.MutableRefObject<T>;

package/dist/types/hooks/useMultiSelectFilterState.d.ts

@@ -1,24 +0,0 @@
-/**
- * Multi-select filter state sub-hook for column header filters.
- * Manages temporary selection set, search text, debounced search, filtered options, and select/clear handlers.
- */
-import { type Dispatch, type SetStateAction } from 'react';
-export interface UseMultiSelectFilterStateParams {
-    selectedValues?: string[];
-    onFilterChange?: (values: string[]) => void;
-    options?: string[];
-    isFilterOpen: boolean;
-}
-export interface UseMultiSelectFilterStateResult {
-    tempSelected: Set<string>;
-    setTempSelected: Dispatch<SetStateAction<Set<string>>>;
-    searchText: string;
-    setSearchText: (v: string) => void;
-    debouncedSearchText: string;
-    filteredOptions: string[];
-    handleCheckboxChange: (option: string, checked: boolean) => void;
-    handleSelectAll: () => void;
-    handleClearSelection: () => void;
-    handleApplyMultiSelect: () => void;
-}
-export declare function useMultiSelectFilterState(params: UseMultiSelectFilterStateParams): UseMultiSelectFilterStateResult;

package/dist/types/hooks/useOGrid.d.ts

@@ -1,52 +0,0 @@
-import * as React from 'react';
-import type { SideBarProps } from '../components/SideBar';
-import type { IOGridProps, IOGridDataGridProps, IOGridApi, IFilters, IColumnDefinition } from '../types';
-/** Resolved column chooser placement. */
-export type ColumnChooserPlacement = 'toolbar' | 'sidebar' | 'none';
-/** Pagination state and handlers. */
-export interface UseOGridPagination {
-    page: number;
-    pageSize: number;
-    displayTotalCount: number;
-    setPage: (p: number) => void;
-    setPageSize: (size: number) => void;
-    pageSizeOptions?: number[];
-    entityLabelPlural: string;
-}
-/** Column chooser state and handlers. */
-export interface UseOGridColumnChooser {
-    columns: IColumnDefinition[];
-    visibleColumns: Set<string>;
-    onVisibilityChange: (columnKey: string, isVisible: boolean) => void;
-    placement: ColumnChooserPlacement;
-}
-/** Layout / chrome configuration. */
-export interface UseOGridLayout {
-    toolbar: React.ReactNode;
-    toolbarBelow: React.ReactNode;
-    className?: string;
-    emptyState?: {
-        message?: React.ReactNode;
-        render?: () => React.ReactNode;
-    };
-    sideBarProps: SideBarProps | null;
-}
-/** Filter state. */
-export interface UseOGridFilters {
-    hasActiveFilters: boolean;
-    setFilters: (f: IFilters) => void;
-}
-export interface UseOGridResult<T> {
-    dataGridProps: IOGridDataGridProps<T>;
-    pagination: UseOGridPagination;
-    columnChooser: UseOGridColumnChooser;
-    layout: UseOGridLayout;
-    filters: UseOGridFilters;
-}
-/**
- * Top-level orchestration hook for OGrid: manages pagination, sorting, filtering, column visibility, and sidebar.
- * @param props - All OGrid props (columns, data, callbacks, feature flags).
- * @param ref - Forwarded ref for imperative API (refresh, export, applyColumnState).
- * @returns Grouped props for DataGridTable, pagination controls, column chooser, layout, and filters.
- */
-export declare function useOGrid<T>(props: IOGridProps<T>, ref: React.Ref<IOGridApi<T>>): UseOGridResult<T>;

package/dist/types/hooks/usePeopleFilterState.d.ts

@@ -1,25 +0,0 @@
-/**
- * People filter state sub-hook for column header filters.
- * Manages people search text, suggestions, loading state, input ref, and user select/clear handlers.
- * Includes debounced people search effect.
- */
-import { type RefObject } from 'react';
-import type { UserLike } from '../types/dataGridTypes';
-import type { ColumnFilterType } from '../types/columnTypes';
-export interface UsePeopleFilterStateParams {
-    selectedUser?: UserLike;
-    onUserChange?: (user: UserLike | undefined) => void;
-    peopleSearch?: (query: string) => Promise<UserLike[]>;
-    isFilterOpen: boolean;
-    filterType: ColumnFilterType;
-}
-export interface UsePeopleFilterStateResult {
-    peopleSuggestions: UserLike[];
-    isPeopleLoading: boolean;
-    peopleSearchText: string;
-    setPeopleSearchText: (v: string) => void;
-    peopleInputRef: RefObject<HTMLInputElement | null>;
-    handleUserSelect: (user: UserLike) => void;
-    handleClearUser: () => void;
-}
-export declare function usePeopleFilterState(params: UsePeopleFilterStateParams): UsePeopleFilterStateResult;

package/dist/types/hooks/useRichSelectState.d.ts

@@ -1,22 +0,0 @@
-export interface UseRichSelectStateParams {
-    values: unknown[];
-    formatValue?: (value: unknown) => string;
-    initialValue: unknown;
-    onCommit: (value: unknown) => void;
-    onCancel: () => void;
-}
-export interface UseRichSelectStateResult {
-    searchText: string;
-    setSearchText: (text: string) => void;
-    filteredValues: unknown[];
-    highlightedIndex: number;
-    handleKeyDown: (e: React.KeyboardEvent) => void;
-    selectValue: (value: unknown) => void;
-    getDisplayText: (value: unknown) => string;
-}
-/**
- * Manages searchable rich select editor state with keyboard navigation (arrow keys, enter, escape).
- * @param params - Values, format function, initial value, and commit/cancel callbacks.
- * @returns Search text, filtered values, highlighted index, keyboard handler, and select function.
- */
-export declare function useRichSelectState(params: UseRichSelectStateParams): UseRichSelectStateResult;

package/dist/types/hooks/useRowSelection.d.ts

@@ -1,22 +0,0 @@
-import type { RowId, RowSelectionMode, IRowSelectionChangeEvent } from '../types';
-export interface UseRowSelectionParams<T> {
-    items: T[];
-    getRowId: (item: T) => RowId;
-    rowSelection: RowSelectionMode;
-    controlledSelectedRows: Set<RowId> | undefined;
-    onSelectionChange: ((event: IRowSelectionChangeEvent<T>) => void) | undefined;
-}
-export interface UseRowSelectionResult {
-    selectedRowIds: Set<RowId>;
-    updateSelection: (newSelectedIds: Set<RowId>) => void;
-    handleRowCheckboxChange: (rowId: RowId, checked: boolean, rowIndex: number, shiftKey: boolean) => void;
-    handleSelectAll: (checked: boolean) => void;
-    allSelected: boolean;
-    someSelected: boolean;
-}
-/**
- * Manages row selection state for single or multiple selection modes with shift-click range support.
- * @param params - Items, getRowId, selection mode, controlled state, and selection change callback.
- * @returns Selected row IDs, update function, checkbox handlers, and selection state booleans.
- */
-export declare function useRowSelection<T>(params: UseRowSelectionParams<T>): UseRowSelectionResult;

package/dist/types/hooks/useSideBarState.d.ts

@@ -1,20 +0,0 @@
-import type { SideBarPanelId, ISideBarDef } from '../types';
-export interface UseSideBarStateParams {
-    config: boolean | ISideBarDef | undefined;
-}
-export interface UseSideBarStateResult {
-    isEnabled: boolean;
-    activePanel: SideBarPanelId | null;
-    setActivePanel: (panel: SideBarPanelId | null) => void;
-    panels: SideBarPanelId[];
-    position: 'left' | 'right';
-    isOpen: boolean;
-    toggle: (panel: SideBarPanelId) => void;
-    close: () => void;
-}
-/**
- * Manages side bar panel state: enabled panels, active panel, position, and toggle/close handlers.
- * @param params - Side bar config (boolean, ISideBarDef, or undefined).
- * @returns Enabled flag, active panel, setters, panel list, position, open state, toggle, and close.
- */
-export declare function useSideBarState(params: UseSideBarStateParams): UseSideBarStateResult;

package/dist/types/hooks/useTableLayout.d.ts

@@ -1,27 +0,0 @@
-import type { RefObject } from 'react';
-import type { IColumnDef } from '../types';
-export interface UseTableLayoutParams<T> {
-    wrapperRef: RefObject<HTMLDivElement | null>;
-    visibleCols: IColumnDef<T>[];
-    flatColumns: IColumnDef<T>[];
-    hasCheckboxCol: boolean;
-    initialColumnWidths?: Record<string, number>;
-    onColumnResized?: (columnId: string, width: number) => void;
-}
-export interface UseTableLayoutResult {
-    containerWidth: number;
-    minTableWidth: number;
-    desiredTableWidth: number;
-    columnSizingOverrides: Record<string, {
-        widthPx: number;
-    }>;
-    setColumnSizingOverrides: React.Dispatch<React.SetStateAction<Record<string, {
-        widthPx: number;
-    }>>>;
-    onColumnResized?: (columnId: string, width: number) => void;
-}
-/**
- * Manages table layout: container width measurement, column sizing overrides,
- * min/desired table width calculations.
- */
-export declare function useTableLayout<T>(params: UseTableLayoutParams<T>): UseTableLayoutResult;

package/dist/types/hooks/useTextFilterState.d.ts

@@ -1,16 +0,0 @@
-/**
- * Text filter state sub-hook for column header filters.
- * Manages temporary text value and apply/clear handlers.
- */
-export interface UseTextFilterStateParams {
-    textValue?: string;
-    onTextChange?: (value: string) => void;
-    isFilterOpen: boolean;
-}
-export interface UseTextFilterStateResult {
-    tempTextValue: string;
-    setTempTextValue: (v: string) => void;
-    handleTextApply: () => void;
-    handleTextClear: () => void;
-}
-export declare function useTextFilterState(params: UseTextFilterStateParams): UseTextFilterStateResult;

package/dist/types/hooks/useUndoRedo.d.ts

@@ -1,23 +0,0 @@
-import type { ICellValueChangedEvent } from '../types';
-export interface UseUndoRedoParams<T> {
-    onCellValueChanged: ((event: ICellValueChangedEvent<T>) => void) | undefined;
-    maxUndoDepth?: number;
-}
-export interface UseUndoRedoResult<T> {
-    onCellValueChanged: ((event: ICellValueChangedEvent<T>) => void) | undefined;
-    undo: () => void;
-    redo: () => void;
-    canUndo: boolean;
-    canRedo: boolean;
-    /** Start a batch — all changes until endBatch() are grouped as one undo step. */
-    beginBatch: () => void;
-    /** End a batch — commits the accumulated changes as a single undo entry. */
-    endBatch: () => void;
-    /** The configured maximum undo stack depth. */
-    maxUndoDepth: number;
-}
-/**
- * Wraps onCellValueChanged with an undo/redo history stack.
- * Supports batch operations: changes between beginBatch/endBatch are one undo step.
- */
-export declare function useUndoRedo<T>(params: UseUndoRedoParams<T>): UseUndoRedoResult<T>;

package/dist/types/storybook/index.d.ts

@@ -1,2 +0,0 @@
-export { storyRows, storyGetRowId, noop, editableInitialRows, editableColumns, NotesPopupEditor, spreadsheetRows, spreadsheetColumns, departmentFilterOptions, statusFilterOptions, } from './mockData';
-export type { StoryRow, EditableRow, RowWithNotes, SpreadsheetRow, } from './mockData';

package/dist/types/storybook/mockData.d.ts

@@ -1,37 +0,0 @@
-import * as React from 'react';
-import type { IColumnDef, ICellEditorProps } from '../types';
-export interface StoryRow {
-    id: string;
-    name: string;
-    status: string;
-    owner: string;
-    approved?: boolean;
-}
-export declare const storyRows: StoryRow[];
-export declare const storyGetRowId: (r: StoryRow) => string;
-export declare const noop: () => void;
-export interface EditableRow {
-    id: string;
-    name: string;
-    status: string;
-    approved: boolean;
-}
-export declare const editableInitialRows: EditableRow[];
-export declare const editableColumns: IColumnDef<EditableRow>[];
-export interface RowWithNotes extends EditableRow {
-    notes?: string;
-}
-export declare function NotesPopupEditor<T>({ value, onValueChange, onCommit, onCancel }: ICellEditorProps<T>): React.ReactElement;
-export interface SpreadsheetRow {
-    id: string;
-    name: string;
-    department: string;
-    salary: number;
-    startDate: string;
-    status: string;
-    email: string;
-}
-export declare const spreadsheetRows: SpreadsheetRow[];
-export declare const spreadsheetColumns: IColumnDef<SpreadsheetRow>[];
-export declare const departmentFilterOptions: string[];
-export declare const statusFilterOptions: string[];

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

@@ -1,169 +0,0 @@
-/**
- * View model helpers for DataGridTable. Core owns the logic; UI packages only render.
- */
-import type * as React from 'react';
-import type { ColumnFilterType, ICellEditorProps, IDateFilterValue } from '../types/columnTypes';
-import type { IColumnDef } from '../types/columnTypes';
-import type { RowId, UserLike, IFilters, FilterValue } from '../types/dataGridTypes';
-export interface HeaderFilterConfigInput {
-    sortBy?: string;
-    sortDirection: 'asc' | 'desc';
-    onColumnSort: (columnKey: string) => void;
-    filters: IFilters;
-    onFilterChange: (key: string, value: FilterValue | undefined) => void;
-    filterOptions: Record<string, string[]>;
-    loadingFilterOptions: Record<string, boolean>;
-    peopleSearch?: (query: string) => Promise<UserLike[]>;
-}
-/** Props to pass to ColumnHeaderFilter. Matches IColumnHeaderFilterProps. */
-export interface HeaderFilterConfig {
-    columnKey: string;
-    columnName: string;
-    filterType: ColumnFilterType;
-    isSorted?: boolean;
-    isSortedDescending?: boolean;
-    onSort?: () => void;
-    selectedValues?: string[];
-    onFilterChange?: (values: string[]) => void;
-    options?: string[];
-    isLoadingOptions?: boolean;
-    textValue?: string;
-    onTextChange?: (value: string) => void;
-    selectedUser?: UserLike;
-    onUserChange?: (user: UserLike | undefined) => void;
-    peopleSearch?: (query: string) => Promise<UserLike[]>;
-    dateValue?: IDateFilterValue;
-    onDateChange?: (value: IDateFilterValue | undefined) => void;
-}
-/**
- * Returns ColumnHeaderFilter props from column def and grid filter/sort state.
- * Use in Fluent/Material/Radix DataGridTable instead of createHeaderWithFilter.
- */
-export declare function getHeaderFilterConfig<T>(col: IColumnDef<T>, input: HeaderFilterConfigInput): HeaderFilterConfig;
-/**
- * Checks whether a given row index falls within a selection range.
- * O(1) — used by React.memo comparators to skip unchanged rows.
- */
-export declare function isRowInRange(range: {
-    startRow: number;
-    endRow: number;
-} | null, rowIndex: number): boolean;
-export type CellRenderMode = 'editing-inline' | 'editing-popover' | 'display';
-export interface CellRenderDescriptorInput<T> {
-    editingCell: {
-        rowId: RowId;
-        columnId: string;
-    } | null;
-    activeCell: {
-        rowIndex: number;
-        columnIndex: number;
-    } | null;
-    selectionRange: {
-        startRow: number;
-        startCol: number;
-        endRow: number;
-        endCol: number;
-    } | null;
-    cutRange: {
-        startRow: number;
-        startCol: number;
-        endRow: number;
-        endCol: number;
-    } | null;
-    copyRange: {
-        startRow: number;
-        startCol: number;
-        endRow: number;
-        endCol: number;
-    } | null;
-    colOffset: number;
-    itemsLength: number;
-    getRowId: (item: T) => RowId;
-    editable?: boolean;
-    onCellValueChanged?: (event: import('../types/columnTypes').ICellValueChangedEvent<T>) => void;
-    /** True while user is drag-selecting cells — hides fill handle during drag. */
-    isDragging?: boolean;
-}
-export interface CellRenderDescriptor {
-    mode: CellRenderMode;
-    editorType?: 'text' | 'select' | 'checkbox' | 'richSelect' | 'date';
-    value?: unknown;
-    isActive: boolean;
-    isInRange: boolean;
-    isInCutRange: boolean;
-    isInCopyRange: boolean;
-    isSelectionEndCell: boolean;
-    canEditAny: boolean;
-    isPinned: boolean;
-    pinnedSide?: 'left' | 'right';
-    globalColIndex: number;
-    rowId: RowId;
-    rowIndex: number;
-    /** Raw value for display (when mode === 'display'). UI uses col.renderCell or col.valueFormatter. */
-    displayValue?: unknown;
-}
-/**
- * Returns a descriptor for rendering a cell. UI uses this to decide editing-inline vs editing-popover vs display
- * and to apply isActive, isInRange, etc. without duplicating the boolean logic.
- */
-export declare function getCellRenderDescriptor<T>(item: T, col: IColumnDef<T>, rowIndex: number, colIdx: number, input: CellRenderDescriptorInput<T>): CellRenderDescriptor;
-/**
- * Resolves display content for a cell in display mode.
- * Handles the renderCell → valueFormatter → String() fallback chain.
- */
-export declare function resolveCellDisplayContent<T>(col: IColumnDef<T>, item: T, displayValue: unknown): React.ReactNode;
-/**
- * Resolves the cellStyle from a column def, handling both function and static values.
- */
-export declare function resolveCellStyle<T>(col: IColumnDef<T>, item: T): React.CSSProperties | undefined;
-/**
- * Builds props for InlineCellEditor. Shared across all UI packages.
- */
-export declare function buildInlineEditorProps<T>(item: T, col: IColumnDef<T>, descriptor: CellRenderDescriptor, callbacks: {
-    commitCellEdit: (item: T, columnId: string, oldValue: unknown, newValue: unknown, rowIndex: number, globalColIndex: number) => void;
-    setEditingCell: (cell: null) => void;
-}): {
-    value: unknown;
-    item: T;
-    column: IColumnDef<T>;
-    rowIndex: number;
-    editorType: "text" | "select" | "checkbox" | "richSelect" | "date";
-    onCommit: (newValue: unknown) => void;
-    onCancel: () => void;
-};
-/**
- * Builds ICellEditorProps for custom popover editors. Shared across all UI packages.
- */
-export declare function buildPopoverEditorProps<T>(item: T, col: IColumnDef<T>, descriptor: CellRenderDescriptor, pendingEditorValue: unknown, callbacks: {
-    setPendingEditorValue: (value: unknown) => void;
-    commitCellEdit: (item: T, columnId: string, oldValue: unknown, newValue: unknown, rowIndex: number, globalColIndex: number) => void;
-    cancelPopoverEdit: () => void;
-}): ICellEditorProps<T>;
-/**
- * Common interaction props for cell wrapper elements.
- * Includes data attributes, event handlers, and accessibility props.
- * Spread onto the cell wrapper div/Box in each UI package.
- */
-export interface CellInteractionHandlers {
-    handleCellMouseDown: (e: React.MouseEvent, rowIndex: number, colIndex: number) => void;
-    setActiveCell: (cell: {
-        rowIndex: number;
-        columnIndex: number;
-    }) => void;
-    setEditingCell: (cell: {
-        rowId: RowId;
-        columnId: string;
-    } | null) => void;
-    handleCellContextMenu: (e: React.MouseEvent) => void;
-}
-export declare function getCellInteractionProps(descriptor: CellRenderDescriptor, columnId: string, handlers: CellInteractionHandlers): {
-    role?: "button" | undefined;
-    onDoubleClick?: (() => void) | undefined;
-    tabIndex: number;
-    onMouseDown: (e: React.MouseEvent) => void;
-    onClick: () => void;
-    onContextMenu: (e: React.MouseEvent) => void;
-    'data-in-range'?: "true" | undefined;
-    'data-row-index': number;
-    'data-col-index': number;
-};