next-data-kit 9.4.0 → 9.5.0

package/dist/index-DUVfK8q6.d.ts

@@ -0,0 +1,284 @@
+import { s as TFilterConfiguration, T as TDataKitInput, e as TDataKitResult, q as TUseDataKitReturn, g as TPaginationInfo, r as TDataKitColumn, l as TSortEntry } from './useDataKit-XFp3_mUc.js';
+import * as React$1 from 'react';
+import React__default, { ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * next-data-kit - Selectable Types
+ *
+ * Types for selectable/multi-select functionality in tables.
+ */
+/**
+ * Selection state for a table
+ */
+type TSelectionState<T = string> = {
+    selectedIds: Set<T>;
+    isAllSelected: boolean;
+    isIndeterminate: boolean;
+};
+/**
+ * Selection actions for a table
+ */
+type TSelectionActions<T = string> = {
+    select: (id: T) => void;
+    deselect: (id: T) => void;
+    toggle: (id: T) => void;
+    selectAll: (ids: T[]) => void;
+    deselectAll: () => void;
+    toggleAll: (ids: T[]) => void;
+    isSelected: (id: T) => boolean;
+    getSelectedArray: () => T[];
+};
+/**
+ * Combined selection hook return type
+ */
+type TUseSelectionReturn<T = string> = TSelectionState<T> & TSelectionActions<T>;
+/**
+ * Selection mode for tables
+ */
+type TSelectionMode = 'single' | 'multiple' | 'none';
+/**
+ * Selectable item type
+ */
+type TSelectable = {
+    id: string;
+    selected?: boolean;
+    disabled?: boolean;
+};
+
+/**
+ * next-data-kit - Component Types
+ *
+ * Types for the React Data Kit component and related UI elements.
+ */
+
+/**
+ * Extract the item type from a TDataKitResult
+ */
+type TExtractDataKitItemFromResult<R> = R extends TDataKitResult<infer I> ? I : R extends {
+    items: (infer I)[];
+} ? I : R extends [true, infer Ok] ? (Ok extends {
+    items: (infer I)[];
+} ? I : never) : never;
+/**
+ * Extract the item type from an action function's return type
+ */
+type TExtractDataKitItemType<T> = T extends (input: TDataKitInput<unknown>) => infer R ? TExtractDataKitItemFromResult<Awaited<R>> : never;
+/**
+ * Column definition for React Data Kit component
+ */
+type TDataKitComponentColumn<TItem, TRowState = unknown> = {
+    head: React.ReactNode;
+    body: (props: Readonly<{
+        item: TItem;
+        index: number;
+        state: TRowState;
+        setState: React.Dispatch<React.SetStateAction<TRowState>>;
+        setItem: (item: TItem) => void;
+        deleteItem: () => void;
+    }>) => React.ReactNode;
+    sortable?: {
+        path: string;
+        default: 1 | -1 | 0;
+    };
+};
+/**
+ * Base filter item properties
+ */
+type TDataKitFilterItemBase = {
+    id: string;
+    label: string;
+    placeholder?: string;
+    configuration?: TFilterConfiguration;
+};
+/**
+ * Text filter item
+ */
+type TDataKitFilterItemText = TDataKitFilterItemBase & {
+    type: 'TEXT';
+    defaultValue?: string;
+};
+/**
+ * Select filter item - dataset is required
+ */
+type TDataKitFilterItemSelect = TDataKitFilterItemBase & {
+    type: 'SELECT';
+    dataset: {
+        id: string;
+        name: string;
+        label: string;
+    }[];
+    defaultValue?: string;
+};
+/**
+ * Boolean filter item
+ */
+type TDataKitFilterItemBoolean = TDataKitFilterItemBase & {
+    type: 'BOOLEAN';
+    defaultValue?: boolean;
+};
+/**
+ * Filter item configuration - discriminated union for type safety
+ */
+type TDataKitFilterItem = TDataKitFilterItemText | TDataKitFilterItemSelect | TDataKitFilterItemBoolean;
+/**
+ * Bulk action definition for selectable tables
+ */
+type TDataKitBulkAction<TItem> = {
+    type: 'SEPARATOR';
+} | {
+    type?: 'MENU';
+    name: string;
+    icon?: React.ReactNode;
+    function: (selectedItems: TItem[]) => Promise<[boolean, {
+        deselectAll?: boolean;
+        updatedItems?: TItem[];
+    } | string]>;
+};
+/**
+ * Controller ref for external DataKitTable manipulation
+ */
+type TDataKitController<TItem> = {
+    itemPush: (item: TItem, position?: 0 | 1) => void;
+    itemUpdate: (props: {
+        index: number;
+        data: Partial<TItem>;
+    } | {
+        id: string | number;
+        data: Partial<TItem>;
+    }) => void;
+    itemDelete: (props: {
+        index: number;
+    } | {
+        id: string | number;
+    }) => void;
+    refetchData: () => void;
+    deleteBulk: (items: TItem[]) => void;
+    getSelectedItems: () => TItem[];
+    clearSelection: () => void;
+};
+/**
+ * Item with ID for selection purposes
+ */
+type TDataKitSelectableItem = {
+    id: string | number;
+};
+/**
+ * Memory persistence mode
+ */
+type TDataKitMemoryMode = 'memory' | 'search-params';
+/**
+ * DataKit Component Ref Type
+ * Exposes the internal state and actions of the DataKit component.
+ */
+type TDataKitRef<T = unknown, R = unknown> = TUseDataKitReturn<T, R>;
+
+/**
+ * next-data-kit - useSelection Hook
+ *
+ * React hook for managing table row selection.
+ */
+
+declare const useSelection: <T = string>(initialSelected?: T[]) => TUseSelectionReturn<T>;
+declare const useSelectionWithTotal: <T = string>(totalItems: T[], initialSelected?: T[]) => Omit<TUseSelectionReturn<T>, "toggleAll"> & {
+    isAllSelected: boolean;
+    isIndeterminate: boolean;
+    toggleAll: () => void;
+};
+
+/**
+ * next-data-kit - usePagination Hook
+ *
+ * React hook for calculating pagination state.
+ */
+
+type TUsePaginationReturn = TPaginationInfo & {
+    pages: (number | 'ellipsis')[];
+    firstPage: number;
+    lastPage: number;
+};
+declare const usePagination: (props: Readonly<{
+    page: number;
+    limit: number;
+    total: number;
+    siblingCount?: number;
+}>) => TUsePaginationReturn;
+
+type TDataKitContextValue<T = unknown, R = unknown> = TUseDataKitReturn<T, R>;
+declare const createDataKitContext: <T = unknown, R = unknown>() => {
+    DataKitProvider: (props: Readonly<{
+        value: TDataKitContextValue<T, R>;
+        children: ReactNode;
+    }>) => react_jsx_runtime.JSX.Element;
+    useDataKitContext: () => TDataKitContextValue<T, R>;
+    Context: React$1.Context<TDataKitContextValue<T, R> | null>;
+};
+declare const DefaultDataKitProvider: (props: Readonly<{
+    value: TDataKitContextValue<unknown, unknown>;
+    children: ReactNode;
+}>) => react_jsx_runtime.JSX.Element;
+declare const useDefaultDataKitContext: () => TDataKitContextValue<unknown, unknown>;
+declare const DefaultDataKitContext: React$1.Context<TDataKitContextValue<unknown, unknown> | null>;
+
+declare const DataKit: <TAction extends (input: TDataKitInput<unknown>) => Promise<TDataKitResult<TDataKitSelectableItem>>>(props: Readonly<{
+    action: TAction;
+    query?: Record<string, unknown>;
+    filters?: TDataKitFilterItem[];
+    limit?: {
+        default: number;
+    };
+    defaultSort?: {
+        path: string;
+        value: 1 | -1;
+    }[];
+    className?: string;
+    autoFetch?: boolean;
+    debounce?: number;
+    refetchInterval?: number;
+    memory?: TDataKitMemoryMode;
+    manual?: boolean;
+    pagination?: "SIMPLE" | "NUMBER";
+    children: (dataKit: TUseDataKitReturn<unknown, TExtractDataKitItemType<TAction>>) => React__default.ReactNode;
+    ref?: React__default.Ref<TDataKitRef<unknown, TExtractDataKitItemType<TAction>>>;
+}>) => React__default.ReactElement;
+
+/**
+ * next-data-kit - Utility Functions
+ *
+ * Helper utilities for client-side operations.
+ */
+
+/**
+ * Get the value from an item using a column accessor
+ */
+declare const getColumnValue: <T>(item: T, column: TDataKitColumn<T>) => unknown;
+/**
+ * Get the sort value for a column
+ */
+declare const getSortValue: (sorts: TSortEntry[], path: string) => 1 | -1 | null;
+/**
+ * Get the next sort value in the cycle: null -> 1 -> -1 -> null
+ */
+declare const getNextSortValue: (current: 1 | -1 | null) => 1 | -1 | null;
+/**
+ * Format a number with commas
+ */
+declare const formatNumber: (num: number) => string;
+/**
+ * Debounce a function
+ */
+declare const debounce: <T extends (...args: unknown[]) => unknown>(fn: T, delay: number) => ((...args: Parameters<T>) => void);
+/**
+ * Throttle a function
+ */
+declare const throttle: <T extends (...args: unknown[]) => unknown>(fn: T, limit: number) => ((...args: Parameters<T>) => void);
+/**
+ * Create a stable object key from sort entries
+ */
+declare const sortEntriesToKey: (sorts: TSortEntry[]) => string;
+/**
+ * Parse a sort key back to sort entries
+ */
+declare const keyToSortEntries: (key: string) => TSortEntry[];
+
+export { type TDataKitSelectableItem as A, type TDataKitMemoryMode as B, type TDataKitRef as C, DefaultDataKitProvider as D, type TUsePaginationReturn as T, useSelectionWithTotal as a, usePagination as b, createDataKitContext as c, useDefaultDataKitContext as d, DefaultDataKitContext as e, DataKit as f, getColumnValue as g, getSortValue as h, getNextSortValue as i, formatNumber as j, debounce as k, keyToSortEntries as l, type TDataKitContextValue as m, type TSelectionState as n, type TSelectionActions as o, type TUseSelectionReturn as p, type TSelectionMode as q, type TSelectable as r, sortEntriesToKey as s, throttle as t, useSelection as u, type TExtractDataKitItemType as v, type TDataKitComponentColumn as w, type TDataKitFilterItem as x, type TDataKitBulkAction as y, type TDataKitController as z };

package/dist/index-qXbjvUTB.d.cts

@@ -0,0 +1,284 @@
+import { s as TFilterConfiguration, T as TDataKitInput, e as TDataKitResult, q as TUseDataKitReturn, g as TPaginationInfo, r as TDataKitColumn, l as TSortEntry } from './useDataKit-XFp3_mUc.cjs';
+import * as React$1 from 'react';
+import React__default, { ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * next-data-kit - Selectable Types
+ *
+ * Types for selectable/multi-select functionality in tables.
+ */
+/**
+ * Selection state for a table
+ */
+type TSelectionState<T = string> = {
+    selectedIds: Set<T>;
+    isAllSelected: boolean;
+    isIndeterminate: boolean;
+};
+/**
+ * Selection actions for a table
+ */
+type TSelectionActions<T = string> = {
+    select: (id: T) => void;
+    deselect: (id: T) => void;
+    toggle: (id: T) => void;
+    selectAll: (ids: T[]) => void;
+    deselectAll: () => void;
+    toggleAll: (ids: T[]) => void;
+    isSelected: (id: T) => boolean;
+    getSelectedArray: () => T[];
+};
+/**
+ * Combined selection hook return type
+ */
+type TUseSelectionReturn<T = string> = TSelectionState<T> & TSelectionActions<T>;
+/**
+ * Selection mode for tables
+ */
+type TSelectionMode = 'single' | 'multiple' | 'none';
+/**
+ * Selectable item type
+ */
+type TSelectable = {
+    id: string;
+    selected?: boolean;
+    disabled?: boolean;
+};
+
+/**
+ * next-data-kit - Component Types
+ *
+ * Types for the React Data Kit component and related UI elements.
+ */
+
+/**
+ * Extract the item type from a TDataKitResult
+ */
+type TExtractDataKitItemFromResult<R> = R extends TDataKitResult<infer I> ? I : R extends {
+    items: (infer I)[];
+} ? I : R extends [true, infer Ok] ? (Ok extends {
+    items: (infer I)[];
+} ? I : never) : never;
+/**
+ * Extract the item type from an action function's return type
+ */
+type TExtractDataKitItemType<T> = T extends (input: TDataKitInput<unknown>) => infer R ? TExtractDataKitItemFromResult<Awaited<R>> : never;
+/**
+ * Column definition for React Data Kit component
+ */
+type TDataKitComponentColumn<TItem, TRowState = unknown> = {
+    head: React.ReactNode;
+    body: (props: Readonly<{
+        item: TItem;
+        index: number;
+        state: TRowState;
+        setState: React.Dispatch<React.SetStateAction<TRowState>>;
+        setItem: (item: TItem) => void;
+        deleteItem: () => void;
+    }>) => React.ReactNode;
+    sortable?: {
+        path: string;
+        default: 1 | -1 | 0;
+    };
+};
+/**
+ * Base filter item properties
+ */
+type TDataKitFilterItemBase = {
+    id: string;
+    label: string;
+    placeholder?: string;
+    configuration?: TFilterConfiguration;
+};
+/**
+ * Text filter item
+ */
+type TDataKitFilterItemText = TDataKitFilterItemBase & {
+    type: 'TEXT';
+    defaultValue?: string;
+};
+/**
+ * Select filter item - dataset is required
+ */
+type TDataKitFilterItemSelect = TDataKitFilterItemBase & {
+    type: 'SELECT';
+    dataset: {
+        id: string;
+        name: string;
+        label: string;
+    }[];
+    defaultValue?: string;
+};
+/**
+ * Boolean filter item
+ */
+type TDataKitFilterItemBoolean = TDataKitFilterItemBase & {
+    type: 'BOOLEAN';
+    defaultValue?: boolean;
+};
+/**
+ * Filter item configuration - discriminated union for type safety
+ */
+type TDataKitFilterItem = TDataKitFilterItemText | TDataKitFilterItemSelect | TDataKitFilterItemBoolean;
+/**
+ * Bulk action definition for selectable tables
+ */
+type TDataKitBulkAction<TItem> = {
+    type: 'SEPARATOR';
+} | {
+    type?: 'MENU';
+    name: string;
+    icon?: React.ReactNode;
+    function: (selectedItems: TItem[]) => Promise<[boolean, {
+        deselectAll?: boolean;
+        updatedItems?: TItem[];
+    } | string]>;
+};
+/**
+ * Controller ref for external DataKitTable manipulation
+ */
+type TDataKitController<TItem> = {
+    itemPush: (item: TItem, position?: 0 | 1) => void;
+    itemUpdate: (props: {
+        index: number;
+        data: Partial<TItem>;
+    } | {
+        id: string | number;
+        data: Partial<TItem>;
+    }) => void;
+    itemDelete: (props: {
+        index: number;
+    } | {
+        id: string | number;
+    }) => void;
+    refetchData: () => void;
+    deleteBulk: (items: TItem[]) => void;
+    getSelectedItems: () => TItem[];
+    clearSelection: () => void;
+};
+/**
+ * Item with ID for selection purposes
+ */
+type TDataKitSelectableItem = {
+    id: string | number;
+};
+/**
+ * Memory persistence mode
+ */
+type TDataKitMemoryMode = 'memory' | 'search-params';
+/**
+ * DataKit Component Ref Type
+ * Exposes the internal state and actions of the DataKit component.
+ */
+type TDataKitRef<T = unknown, R = unknown> = TUseDataKitReturn<T, R>;
+
+/**
+ * next-data-kit - useSelection Hook
+ *
+ * React hook for managing table row selection.
+ */
+
+declare const useSelection: <T = string>(initialSelected?: T[]) => TUseSelectionReturn<T>;
+declare const useSelectionWithTotal: <T = string>(totalItems: T[], initialSelected?: T[]) => Omit<TUseSelectionReturn<T>, "toggleAll"> & {
+    isAllSelected: boolean;
+    isIndeterminate: boolean;
+    toggleAll: () => void;
+};
+
+/**
+ * next-data-kit - usePagination Hook
+ *
+ * React hook for calculating pagination state.
+ */
+
+type TUsePaginationReturn = TPaginationInfo & {
+    pages: (number | 'ellipsis')[];
+    firstPage: number;
+    lastPage: number;
+};
+declare const usePagination: (props: Readonly<{
+    page: number;
+    limit: number;
+    total: number;
+    siblingCount?: number;
+}>) => TUsePaginationReturn;
+
+type TDataKitContextValue<T = unknown, R = unknown> = TUseDataKitReturn<T, R>;
+declare const createDataKitContext: <T = unknown, R = unknown>() => {
+    DataKitProvider: (props: Readonly<{
+        value: TDataKitContextValue<T, R>;
+        children: ReactNode;
+    }>) => react_jsx_runtime.JSX.Element;
+    useDataKitContext: () => TDataKitContextValue<T, R>;
+    Context: React$1.Context<TDataKitContextValue<T, R> | null>;
+};
+declare const DefaultDataKitProvider: (props: Readonly<{
+    value: TDataKitContextValue<unknown, unknown>;
+    children: ReactNode;
+}>) => react_jsx_runtime.JSX.Element;
+declare const useDefaultDataKitContext: () => TDataKitContextValue<unknown, unknown>;
+declare const DefaultDataKitContext: React$1.Context<TDataKitContextValue<unknown, unknown> | null>;
+
+declare const DataKit: <TAction extends (input: TDataKitInput<unknown>) => Promise<TDataKitResult<TDataKitSelectableItem>>>(props: Readonly<{
+    action: TAction;
+    query?: Record<string, unknown>;
+    filters?: TDataKitFilterItem[];
+    limit?: {
+        default: number;
+    };
+    defaultSort?: {
+        path: string;
+        value: 1 | -1;
+    }[];
+    className?: string;
+    autoFetch?: boolean;
+    debounce?: number;
+    refetchInterval?: number;
+    memory?: TDataKitMemoryMode;
+    manual?: boolean;
+    pagination?: "SIMPLE" | "NUMBER";
+    children: (dataKit: TUseDataKitReturn<unknown, TExtractDataKitItemType<TAction>>) => React__default.ReactNode;
+    ref?: React__default.Ref<TDataKitRef<unknown, TExtractDataKitItemType<TAction>>>;
+}>) => React__default.ReactElement;
+
+/**
+ * next-data-kit - Utility Functions
+ *
+ * Helper utilities for client-side operations.
+ */
+
+/**
+ * Get the value from an item using a column accessor
+ */
+declare const getColumnValue: <T>(item: T, column: TDataKitColumn<T>) => unknown;
+/**
+ * Get the sort value for a column
+ */
+declare const getSortValue: (sorts: TSortEntry[], path: string) => 1 | -1 | null;
+/**
+ * Get the next sort value in the cycle: null -> 1 -> -1 -> null
+ */
+declare const getNextSortValue: (current: 1 | -1 | null) => 1 | -1 | null;
+/**
+ * Format a number with commas
+ */
+declare const formatNumber: (num: number) => string;
+/**
+ * Debounce a function
+ */
+declare const debounce: <T extends (...args: unknown[]) => unknown>(fn: T, delay: number) => ((...args: Parameters<T>) => void);
+/**
+ * Throttle a function
+ */
+declare const throttle: <T extends (...args: unknown[]) => unknown>(fn: T, limit: number) => ((...args: Parameters<T>) => void);
+/**
+ * Create a stable object key from sort entries
+ */
+declare const sortEntriesToKey: (sorts: TSortEntry[]) => string;
+/**
+ * Parse a sort key back to sort entries
+ */
+declare const keyToSortEntries: (key: string) => TSortEntry[];
+
+export { type TDataKitSelectableItem as A, type TDataKitMemoryMode as B, type TDataKitRef as C, DefaultDataKitProvider as D, type TUsePaginationReturn as T, useSelectionWithTotal as a, usePagination as b, createDataKitContext as c, useDefaultDataKitContext as d, DefaultDataKitContext as e, DataKit as f, getColumnValue as g, getSortValue as h, getNextSortValue as i, formatNumber as j, debounce as k, keyToSortEntries as l, type TDataKitContextValue as m, type TSelectionState as n, type TSelectionActions as o, type TUseSelectionReturn as p, type TSelectionMode as q, type TSelectable as r, sortEntriesToKey as s, throttle as t, useSelection as u, type TExtractDataKitItemType as v, type TDataKitComponentColumn as w, type TDataKitFilterItem as x, type TDataKitBulkAction as y, type TDataKitController as z };