@snowpact/react-tanstack-query-table 1.5.1 → 1.5.3

package/dist/index.d.ts

@@ -18,12 +18,12 @@ export declare type ActionButtonVariant = 'default' | 'warning' | 'danger' | 'in
 
 export declare const ActionCell: typeof ActionCellInner;
 
-declare function ActionCellInner<T>({ item, actions, onAction }: ActionCellProps<T>): JSX.Element;
+declare function ActionCellInner<T, K>({ item, actions, onAction }: ActionCellProps<T, K>): JSX.Element;
 
-declare interface ActionCellProps<T> {
+declare interface ActionCellProps<T, K> {
     item: T;
-    actions: TableAction<T>[];
-    onAction: (action: TableAction<T>, item: T) => void;
+    actions: TableAction<T, K>[];
+    onAction: (action: TableAction<T, K>, item: T) => void;
 }
 
 export declare type BaseAction = {
@@ -39,10 +39,10 @@ export declare type BaseAction = {
 /**
  * Base props shared between SnowClientDataTable and SnowServerDataTable
  */
-export declare interface BaseSnowTableProps<T extends Record<string, unknown>> extends DataTableUIOptions<T> {
+export declare interface BaseSnowTableProps<T extends Record<string, unknown>, K = unknown> extends DataTableUIOptions<T> {
     queryKey: string[];
     columnConfig: SnowColumnConfig<T>[];
-    actions?: TableAction<T>[];
+    actions?: TableAction<T, K>[];
     filters?: FilterConfig<T>[];
     prefilters?: PreFilter[];
     defaultSortBy?: string;
@@ -167,6 +167,15 @@ declare interface DropdownStyles {
     separator: string;
 }
 
+export declare type EndpointAction<T, K> = BaseAction & {
+    type: 'endpoint';
+    endpoint: (item: T) => Promise<K>;
+    /** Optional confirmation - if returns false, endpoint is not called */
+    withConfirm?: (item: T) => Promise<boolean> | boolean;
+    onSuccess?: (data: K, item: T) => void;
+    onError?: (error: ErrorResponse, item: T) => void;
+};
+
 export declare type ErrorResponse = {
     message: string;
     status: number;
@@ -324,12 +333,12 @@ export declare interface SingleFilterDropdownProps<T extends object> {
     onFilterChange: (key: keyof T, selectedValues: string[]) => void;
 }
 
-export declare const SnowClientDataTable: <T extends Record<string, unknown>>({ queryKey, columnConfig, actions, filters, prefilters, prefilterFn, defaultSortBy, defaultSortOrder, defaultPageSize, persistState, fetchAllItemsEndpoint, ...restProps }: SnowClientDataTableProps<T>) => JSX.Element;
+export declare const SnowClientDataTable: <T extends Record<string, unknown>, K = unknown>({ queryKey, columnConfig, actions, filters, prefilters, prefilterFn, defaultSortBy, defaultSortOrder, defaultPageSize, persistState, fetchAllItemsEndpoint, ...restProps }: SnowClientDataTableProps<T, K>) => JSX.Element;
 
 /**
  * Props for SnowClientDataTable component (client-side filtering/sorting)
  */
-export declare interface SnowClientDataTableProps<T extends Record<string, unknown>> extends BaseSnowTableProps<T> {
+export declare interface SnowClientDataTableProps<T extends Record<string, unknown>, K = unknown> extends BaseSnowTableProps<T, K> {
     fetchAllItemsEndpoint: () => Promise<T[]>;
     /** Optional function to filter items based on active prefilter */
     prefilterFn?: (item: T, prefilterId: string) => boolean;
@@ -345,12 +354,12 @@ export declare type SnowColumnConfig<T extends object> = {
     meta?: ColumnMeta<T, unknown>;
 };
 
-export declare const SnowServerDataTable: <T extends Record<string, unknown>>({ queryKey, columnConfig, actions, filters, prefilters, defaultSortBy, defaultSortOrder, defaultPageSize, persistState, fetchServerEndpoint, ...restProps }: SnowServerDataTableProps<T>) => JSX.Element;
+export declare const SnowServerDataTable: <T extends Record<string, unknown>, K = unknown>({ queryKey, columnConfig, actions, filters, prefilters, defaultSortBy, defaultSortOrder, defaultPageSize, persistState, fetchServerEndpoint, ...restProps }: SnowServerDataTableProps<T, K>) => JSX.Element;
 
 /**
  * Props for SnowServerDataTable component (server-side pagination/filtering/sorting)
  */
-export declare interface SnowServerDataTableProps<T extends Record<string, unknown>> extends BaseSnowTableProps<T> {
+export declare interface SnowServerDataTableProps<T extends Record<string, unknown>, K = unknown> extends BaseSnowTableProps<T, K> {
     fetchServerEndpoint: (params: ServerFetchParams) => Promise<ServerPaginatedResponse<T>>;
     filters?: FilterConfig<Record<string, unknown>>[];
 }
@@ -378,7 +387,7 @@ declare interface StateStyles {
     focus: string;
 }
 
-export declare type TableAction<T> = ClickAction<T> | LinkAction<T> | ((item: T) => ClickAction<T>) | ((item: T) => LinkAction<T>);
+export declare type TableAction<T, K = unknown> = ClickAction<T> | LinkAction<T> | EndpointAction<T, K> | ((item: T) => ClickAction<T>) | ((item: T) => LinkAction<T>) | ((item: T) => EndpointAction<T, K>);
 
 declare interface TabsStyles {
     list: string;
@@ -392,13 +401,13 @@ declare interface TabsStyles {
  * Extracts the common logic for:
  * - Transforming SnowColumnConfig into TanStack Table ColumnDef
  * - Adding action column with ActionCell
- * - Handling action execution (click actions)
+ * - Handling action execution (click, link, endpoint)
  */
-export declare const useSnowColumns: <T extends Record<string, unknown>>({ columnConfig, actions, filters, mode, }: UseSnowColumnsOptions<T>) => UseSnowColumnsReturn<T>;
+export declare const useSnowColumns: <T extends Record<string, unknown>, K>({ columnConfig, actions, filters, mode, }: UseSnowColumnsOptions<T, K>) => UseSnowColumnsReturn<T, K>;
 
-export declare interface UseSnowColumnsOptions<T extends Record<string, unknown>> {
+export declare interface UseSnowColumnsOptions<T extends Record<string, unknown>, K> {
     columnConfig: SnowColumnConfig<T>[];
-    actions?: TableAction<T>[];
+    actions?: TableAction<T, K>[];
     filters?: FilterConfig<T>[];
     /**
      * Mode determines how global filter behaves:
@@ -408,9 +417,9 @@ export declare interface UseSnowColumnsOptions<T extends Record<string, unknown>
     mode: 'client' | 'server';
 }
 
-export declare interface UseSnowColumnsReturn<T extends Record<string, unknown>> {
+export declare interface UseSnowColumnsReturn<T extends Record<string, unknown>, K> {
     columns: ColumnDef<T, unknown>[];
-    handleAction: (action: TableAction<T>, item: T) => void;
+    handleAction: (action: TableAction<T, K>, item: T) => Promise<void>;
 }
 
 export declare const useTableStatePersist: ({ enabled, defaultPrefilter, defaultPageSize, defaultSortBy, defaultSortOrder, }: UseTableStatePersistOptions) => {