next-data-kit 4.0.0 → 6.0.0

package/dist/index.d.cts

@@ -125,10 +125,6 @@ type TPaginationInfo = {
     hasNextPage: boolean;
     hasPrevPage: boolean;
 };
-/**
- * Calculate pagination info from next-data-kit result
- */
-declare const calculatePagination: (page: number, limit: number, total: number) => TPaginationInfo;
 /**
  * React Data Kit Adapter Interface
  * Defines the contract for a database adapter.
@@ -145,6 +141,47 @@ type TDataKitAdapter<T> = (params: Readonly<{
     total: number;
 }>;
 
+/**
+ * next-data-kit - Server Action Types
+ *
+ * Types for the server action and data kit operations.
+ */
+
+/**
+ * Extract document type from a Mongoose Model.
+ */
+type TExtractDocType<M> = M extends Model<infer TRawDocType, any, any, any, any, any> ? TRawDocType : never;
+/**
+ * Base options shared by both mongoose and adapter versions
+ */
+type TBaseOptions<TDoc, R> = {
+    input: TDataKitInput<TDoc>;
+    item: (item: TDoc) => Promise<R> | R;
+    filterAllowed?: string[];
+    maxLimit?: number;
+    queryAllowed?: (keyof TDoc | string)[];
+};
+/**
+ * Options when using a Mongoose model
+ */
+type TMongooseOptions<M, TDoc, R> = TBaseOptions<TDoc, R> & {
+    model: M;
+    adapter?: never;
+    filter?: (filterInput?: Record<string, unknown>) => TMongoFilterQuery<TDoc>;
+    filterCustom?: TFilterCustomConfigWithFilter<TDoc, TMongoFilterQuery<TDoc>>;
+    defaultSort?: TSortOptions<TDoc>;
+};
+/**
+ * Options when using a custom adapter
+ */
+type TAdapterOptions<TDoc, R> = TBaseOptions<TDoc, R> & {
+    adapter: TDataKitAdapter<TDoc>;
+    model?: never;
+    filter?: never;
+    filterCustom?: TFilterCustomConfigWithFilter<TDoc, unknown>;
+    defaultSort?: never;
+};
+
 /**
  * next-data-kit - Hook Types
  *
@@ -206,9 +243,9 @@ type TUseDataKitReturn<T = unknown, R = unknown> = {
     actions: TDataKitActions<T, R>;
 };
 /**
- * React Data Kit controller options
+ * Options for the useDataKit hook
  */
-type TDataKitControllerOptions<T = unknown, R = unknown> = {
+type TUseDataKitOptions<T = unknown, R = unknown> = {
     initial?: {
         page?: number;
         limit?: number;
@@ -299,9 +336,9 @@ type TSelectable = {
  */
 type TExtractDataKitItemFromResult<R> = R extends TDataKitResult<infer I> ? I : R extends {
     items: (infer I)[];
-} ? I : R extends [true, infer Ok] ? Ok extends {
+} ? I : R extends [true, infer Ok] ? (Ok extends {
     items: (infer I)[];
-} ? I : never : never;
+} ? I : never) : never;
 /**
  * Extract the item type from an action function's return type
  */
@@ -373,9 +410,9 @@ type TDataKitBulkAction<TItem> = {
     } | string]>;
 };
 /**
- * Controller for external table manipulation
+ * Controller ref for external DataKitTable manipulation
  */
-type TDataKitComponentController<TItem> = {
+type TDataKitController<TItem> = {
     itemPush: (item: TItem, position?: 0 | 1) => void;
     refetchData: () => void;
     deleteBulk: (items: TItem[]) => void;
@@ -405,40 +442,6 @@ type TDataKitRef<T = unknown, R = unknown> = TUseDataKitReturn<T, R>;
  * with pagination, filtering, and sorting.
  */
 
-/**
- * Extract document type from a Mongoose Model.
- */
-type TExtractDocType<M> = M extends Model<infer TRawDocType, any, any, any, any, any> ? TRawDocType : never;
-/**
- * Base options shared by both mongoose and adapter versions
- */
-type TBaseOptions<TDoc, R> = {
-    input: TDataKitInput<TDoc>;
-    item: (item: TDoc) => Promise<R> | R;
-    filterAllowed?: string[];
-    maxLimit?: number;
-    queryAllowed?: (keyof TDoc | string)[];
-};
-/**
- * Options when using a Mongoose model
- */
-type TMongooseOptions<M, TDoc, R> = TBaseOptions<TDoc, R> & {
-    model: M;
-    adapter?: never;
-    filter?: (filterInput?: Record<string, unknown>) => TMongoFilterQuery<TDoc>;
-    filterCustom?: TFilterCustomConfigWithFilter<TDoc, TMongoFilterQuery<TDoc>>;
-    defaultSort?: TSortOptions<TDoc>;
-};
-/**
- * Options when using a custom adapter
- */
-type TAdapterOptions<TDoc, R> = TBaseOptions<TDoc, R> & {
-    adapter: TDataKitAdapter<TDoc>;
-    model?: never;
-    filter?: never;
-    filterCustom?: TFilterCustomConfigWithFilter<TDoc, unknown>;
-    defaultSort?: never;
-};
 /**
  * Server action with Mongoose model (auto-infers document type)
  */
@@ -458,7 +461,6 @@ declare const mongooseAdapter: <DocType = unknown>(model: TMongoModel<DocType>,
     filter?: (filterInput?: Record<string, unknown>) => TMongoFilterQuery<DocType>;
     filterCustom?: TFilterCustomConfigWithFilter<DocType, TMongoFilterQuery<DocType>>;
     defaultSort?: TSortOptions<DocType>;
-    [key: string]: any;
 }>) => TDataKitAdapter<DocType>;
 
 /**
@@ -495,6 +497,10 @@ declare const escapeRegex: (str: string) => string;
  * ```
  */
 declare const createSearchFilter: <T>(fields: (keyof T | string)[]) => ((value: unknown) => TMongoFilterQuery<T>);
+/**
+ * Calculate pagination info from page, limit, and total
+ */
+declare const calculatePagination: (page: number, limit: number, total: number) => TPaginationInfo;
 
 /**
  * next-data-kit - useDataKit Hook
@@ -502,7 +508,7 @@ declare const createSearchFilter: <T>(fields: (keyof T | string)[]) => ((value:
  * React hook for managing next-data-kit state and actions.
  */
 
-declare const useDataKit: <T = unknown, R = unknown>(props: Readonly<TDataKitControllerOptions<T, R>>) => TUseDataKitReturn<T, R>;
+declare const useDataKit: <T = unknown, R = unknown>(props: Readonly<TUseDataKitOptions<T, R>>) => TUseDataKitReturn<T, R>;
 
 /**
  * next-data-kit - useSelection Hook
@@ -608,4 +614,4 @@ declare const sortEntriesToKey: (sorts: TSortEntry[]) => string;
  */
 declare const keyToSortEntries: (key: string) => TSortEntry[];
 
-export { DataKit, DefaultDataKitContext as DataKitContext, DefaultDataKitProvider as DataKitProvider, type TDataKitActions, type TDataKitAdapter, type TDataKitBulkAction, type TDataKitColumn, type TDataKitComponentColumn, type TDataKitComponentController, type TDataKitContextValue, type TDataKitControllerOptions, type TDataKitFilterItem, type TDataKitInput, type TDataKitRef, type TDataKitResult, type TDataKitSelectableItem, type TDataKitState, type TDataKitStateMode, type TExtractDataKitItemType, type TFilterConfig, type TFilterCustomConfig, type TFilterCustomConfigWithFilter, type TMongoFilterOperators, type TMongoFilterQuery, type TMongoModel, type TMongoRootFilterOperators, type TPaginationInfo, type TSelectable, type TSelectionActions, type TSelectionMode, type TSelectionState, type TSortEntry, type TSortOptions, type TSortOrder, type TUseDataKitReturn, type TUsePaginationReturn, type TUseSelectionReturn, adapterMemory, calculatePagination, createDataKitContext, createSearchFilter, dataKitServerAction, debounce, escapeRegex, formatNumber, getColumnValue, getNextSortValue, getSortValue, keyToSortEntries, mongooseAdapter, sortEntriesToKey, throttle, useDataKit, useDefaultDataKitContext as useDataKitContext, usePagination, useSelection, useSelectionWithTotal };
+export { DataKit, DefaultDataKitContext as DataKitContext, DefaultDataKitProvider as DataKitProvider, type TAdapterOptions, type TBaseOptions, type TDataKitActions, type TDataKitAdapter, type TDataKitBulkAction, type TDataKitColumn, type TDataKitComponentColumn, type TDataKitContextValue, type TDataKitController, type TDataKitFilterItem, type TDataKitInput, type TDataKitRef, type TDataKitResult, type TDataKitSelectableItem, type TDataKitState, type TDataKitStateMode, type TExtractDataKitItemType, type TExtractDocType, type TFilterConfig, type TFilterCustomConfig, type TFilterCustomConfigWithFilter, type TMongoFilterOperators, type TMongoFilterQuery, type TMongoModel, type TMongoRootFilterOperators, type TMongooseOptions, type TPaginationInfo, type TSelectable, type TSelectionActions, type TSelectionMode, type TSelectionState, type TSortEntry, type TSortOptions, type TSortOrder, type TUseDataKitOptions, type TUseDataKitReturn, type TUsePaginationReturn, type TUseSelectionReturn, adapterMemory, calculatePagination, createDataKitContext, createSearchFilter, dataKitServerAction, debounce, escapeRegex, formatNumber, getColumnValue, getNextSortValue, getSortValue, keyToSortEntries, mongooseAdapter, sortEntriesToKey, throttle, useDataKit, useDefaultDataKitContext as useDataKitContext, usePagination, useSelection, useSelectionWithTotal };

package/dist/index.d.ts

@@ -125,10 +125,6 @@ type TPaginationInfo = {
     hasNextPage: boolean;
     hasPrevPage: boolean;
 };
-/**
- * Calculate pagination info from next-data-kit result
- */
-declare const calculatePagination: (page: number, limit: number, total: number) => TPaginationInfo;
 /**
  * React Data Kit Adapter Interface
  * Defines the contract for a database adapter.
@@ -145,6 +141,47 @@ type TDataKitAdapter<T> = (params: Readonly<{
     total: number;
 }>;
 
+/**
+ * next-data-kit - Server Action Types
+ *
+ * Types for the server action and data kit operations.
+ */
+
+/**
+ * Extract document type from a Mongoose Model.
+ */
+type TExtractDocType<M> = M extends Model<infer TRawDocType, any, any, any, any, any> ? TRawDocType : never;
+/**
+ * Base options shared by both mongoose and adapter versions
+ */
+type TBaseOptions<TDoc, R> = {
+    input: TDataKitInput<TDoc>;
+    item: (item: TDoc) => Promise<R> | R;
+    filterAllowed?: string[];
+    maxLimit?: number;
+    queryAllowed?: (keyof TDoc | string)[];
+};
+/**
+ * Options when using a Mongoose model
+ */
+type TMongooseOptions<M, TDoc, R> = TBaseOptions<TDoc, R> & {
+    model: M;
+    adapter?: never;
+    filter?: (filterInput?: Record<string, unknown>) => TMongoFilterQuery<TDoc>;
+    filterCustom?: TFilterCustomConfigWithFilter<TDoc, TMongoFilterQuery<TDoc>>;
+    defaultSort?: TSortOptions<TDoc>;
+};
+/**
+ * Options when using a custom adapter
+ */
+type TAdapterOptions<TDoc, R> = TBaseOptions<TDoc, R> & {
+    adapter: TDataKitAdapter<TDoc>;
+    model?: never;
+    filter?: never;
+    filterCustom?: TFilterCustomConfigWithFilter<TDoc, unknown>;
+    defaultSort?: never;
+};
+
 /**
  * next-data-kit - Hook Types
  *
@@ -206,9 +243,9 @@ type TUseDataKitReturn<T = unknown, R = unknown> = {
     actions: TDataKitActions<T, R>;
 };
 /**
- * React Data Kit controller options
+ * Options for the useDataKit hook
  */
-type TDataKitControllerOptions<T = unknown, R = unknown> = {
+type TUseDataKitOptions<T = unknown, R = unknown> = {
     initial?: {
         page?: number;
         limit?: number;
@@ -299,9 +336,9 @@ type TSelectable = {
  */
 type TExtractDataKitItemFromResult<R> = R extends TDataKitResult<infer I> ? I : R extends {
     items: (infer I)[];
-} ? I : R extends [true, infer Ok] ? Ok extends {
+} ? I : R extends [true, infer Ok] ? (Ok extends {
     items: (infer I)[];
-} ? I : never : never;
+} ? I : never) : never;
 /**
  * Extract the item type from an action function's return type
  */
@@ -373,9 +410,9 @@ type TDataKitBulkAction<TItem> = {
     } | string]>;
 };
 /**
- * Controller for external table manipulation
+ * Controller ref for external DataKitTable manipulation
  */
-type TDataKitComponentController<TItem> = {
+type TDataKitController<TItem> = {
     itemPush: (item: TItem, position?: 0 | 1) => void;
     refetchData: () => void;
     deleteBulk: (items: TItem[]) => void;
@@ -405,40 +442,6 @@ type TDataKitRef<T = unknown, R = unknown> = TUseDataKitReturn<T, R>;
  * with pagination, filtering, and sorting.
  */
 
-/**
- * Extract document type from a Mongoose Model.
- */
-type TExtractDocType<M> = M extends Model<infer TRawDocType, any, any, any, any, any> ? TRawDocType : never;
-/**
- * Base options shared by both mongoose and adapter versions
- */
-type TBaseOptions<TDoc, R> = {
-    input: TDataKitInput<TDoc>;
-    item: (item: TDoc) => Promise<R> | R;
-    filterAllowed?: string[];
-    maxLimit?: number;
-    queryAllowed?: (keyof TDoc | string)[];
-};
-/**
- * Options when using a Mongoose model
- */
-type TMongooseOptions<M, TDoc, R> = TBaseOptions<TDoc, R> & {
-    model: M;
-    adapter?: never;
-    filter?: (filterInput?: Record<string, unknown>) => TMongoFilterQuery<TDoc>;
-    filterCustom?: TFilterCustomConfigWithFilter<TDoc, TMongoFilterQuery<TDoc>>;
-    defaultSort?: TSortOptions<TDoc>;
-};
-/**
- * Options when using a custom adapter
- */
-type TAdapterOptions<TDoc, R> = TBaseOptions<TDoc, R> & {
-    adapter: TDataKitAdapter<TDoc>;
-    model?: never;
-    filter?: never;
-    filterCustom?: TFilterCustomConfigWithFilter<TDoc, unknown>;
-    defaultSort?: never;
-};
 /**
  * Server action with Mongoose model (auto-infers document type)
  */
@@ -458,7 +461,6 @@ declare const mongooseAdapter: <DocType = unknown>(model: TMongoModel<DocType>,
     filter?: (filterInput?: Record<string, unknown>) => TMongoFilterQuery<DocType>;
     filterCustom?: TFilterCustomConfigWithFilter<DocType, TMongoFilterQuery<DocType>>;
     defaultSort?: TSortOptions<DocType>;
-    [key: string]: any;
 }>) => TDataKitAdapter<DocType>;
 
 /**
@@ -495,6 +497,10 @@ declare const escapeRegex: (str: string) => string;
  * ```
  */
 declare const createSearchFilter: <T>(fields: (keyof T | string)[]) => ((value: unknown) => TMongoFilterQuery<T>);
+/**
+ * Calculate pagination info from page, limit, and total
+ */
+declare const calculatePagination: (page: number, limit: number, total: number) => TPaginationInfo;
 
 /**
  * next-data-kit - useDataKit Hook
@@ -502,7 +508,7 @@ declare const createSearchFilter: <T>(fields: (keyof T | string)[]) => ((value:
  * React hook for managing next-data-kit state and actions.
  */
 
-declare const useDataKit: <T = unknown, R = unknown>(props: Readonly<TDataKitControllerOptions<T, R>>) => TUseDataKitReturn<T, R>;
+declare const useDataKit: <T = unknown, R = unknown>(props: Readonly<TUseDataKitOptions<T, R>>) => TUseDataKitReturn<T, R>;
 
 /**
  * next-data-kit - useSelection Hook
@@ -608,4 +614,4 @@ declare const sortEntriesToKey: (sorts: TSortEntry[]) => string;
  */
 declare const keyToSortEntries: (key: string) => TSortEntry[];
 
-export { DataKit, DefaultDataKitContext as DataKitContext, DefaultDataKitProvider as DataKitProvider, type TDataKitActions, type TDataKitAdapter, type TDataKitBulkAction, type TDataKitColumn, type TDataKitComponentColumn, type TDataKitComponentController, type TDataKitContextValue, type TDataKitControllerOptions, type TDataKitFilterItem, type TDataKitInput, type TDataKitRef, type TDataKitResult, type TDataKitSelectableItem, type TDataKitState, type TDataKitStateMode, type TExtractDataKitItemType, type TFilterConfig, type TFilterCustomConfig, type TFilterCustomConfigWithFilter, type TMongoFilterOperators, type TMongoFilterQuery, type TMongoModel, type TMongoRootFilterOperators, type TPaginationInfo, type TSelectable, type TSelectionActions, type TSelectionMode, type TSelectionState, type TSortEntry, type TSortOptions, type TSortOrder, type TUseDataKitReturn, type TUsePaginationReturn, type TUseSelectionReturn, adapterMemory, calculatePagination, createDataKitContext, createSearchFilter, dataKitServerAction, debounce, escapeRegex, formatNumber, getColumnValue, getNextSortValue, getSortValue, keyToSortEntries, mongooseAdapter, sortEntriesToKey, throttle, useDataKit, useDefaultDataKitContext as useDataKitContext, usePagination, useSelection, useSelectionWithTotal };
+export { DataKit, DefaultDataKitContext as DataKitContext, DefaultDataKitProvider as DataKitProvider, type TAdapterOptions, type TBaseOptions, type TDataKitActions, type TDataKitAdapter, type TDataKitBulkAction, type TDataKitColumn, type TDataKitComponentColumn, type TDataKitContextValue, type TDataKitController, type TDataKitFilterItem, type TDataKitInput, type TDataKitRef, type TDataKitResult, type TDataKitSelectableItem, type TDataKitState, type TDataKitStateMode, type TExtractDataKitItemType, type TExtractDocType, type TFilterConfig, type TFilterCustomConfig, type TFilterCustomConfigWithFilter, type TMongoFilterOperators, type TMongoFilterQuery, type TMongoModel, type TMongoRootFilterOperators, type TMongooseOptions, type TPaginationInfo, type TSelectable, type TSelectionActions, type TSelectionMode, type TSelectionState, type TSortEntry, type TSortOptions, type TSortOrder, type TUseDataKitOptions, type TUseDataKitReturn, type TUsePaginationReturn, type TUseSelectionReturn, adapterMemory, calculatePagination, createDataKitContext, createSearchFilter, dataKitServerAction, debounce, escapeRegex, formatNumber, getColumnValue, getNextSortValue, getSortValue, keyToSortEntries, mongooseAdapter, sortEntriesToKey, throttle, useDataKit, useDefaultDataKitContext as useDataKitContext, usePagination, useSelection, useSelectionWithTotal };

package/dist/index.js

@@ -11,18 +11,44 @@ import { Slot } from '@radix-ui/react-slot';
 import { cva } from 'class-variance-authority';
 import * as SelectPrimitive from '@radix-ui/react-select';
 
-// src/types/next-data-kit.ts
-var calculatePagination = (page, limit, total) => ({
-  currentPage: page,
-  totalPages: Math.ceil(total / limit),
-  totalItems: total,
-  itemsPerPage: limit,
-  hasNextPage: page * limit < total,
-  hasPrevPage: page > 1
-});
-
 // src/server/utils.ts
 var isProvided = (value) => value !== void 0 && value !== null && value !== "";
+var getValueByPath = (obj, path) => {
+  if (!path) return void 0;
+  const parts = path.split(".");
+  let current = obj;
+  for (const part of parts) {
+    if (current && typeof current === "object" && part in current) {
+      current = current[part];
+    } else {
+      return void 0;
+    }
+  }
+  return current;
+};
+var matchesExact = (rowValue, needle) => {
+  if (Array.isArray(needle)) return needle.includes(rowValue);
+  return rowValue === needle;
+};
+var matchesRegexLike = (rowValue, needle) => {
+  if (!isProvided(needle)) return true;
+  if (rowValue === void 0 || rowValue === null) return false;
+  const hay = String(rowValue);
+  if (needle instanceof RegExp) return needle.test(hay);
+  const n = String(needle);
+  return hay.toLowerCase().includes(n.toLowerCase());
+};
+var compareValues = (a, b) => {
+  if (a === b) return 0;
+  if (a === void 0 || a === null) return -1;
+  if (b === void 0 || b === null) return 1;
+  if (typeof a === "number" && typeof b === "number") return a - b;
+  if (typeof a === "bigint" && typeof b === "bigint") return a < b ? -1 : 1;
+  const as = String(a);
+  const bs = String(b);
+  return as.localeCompare(bs);
+};
+var normalizeSorts = (sorts) => Array.isArray(sorts) ? sorts.filter((s) => !!s?.path && (s.value === 1 || s.value === -1)) : [];
 var isSafeKey = (key) => {
   const unsafeKeys = ["__proto__", "constructor", "prototype"];
   return !unsafeKeys.includes(key);
@@ -43,6 +69,14 @@ var createSearchFilter = (fields) => {
     };
   };
 };
+var calculatePagination = (page, limit, total) => ({
+  currentPage: page,
+  totalPages: Math.ceil(total / limit),
+  totalItems: total,
+  itemsPerPage: limit,
+  hasNextPage: page * limit < total,
+  hasPrevPage: page > 1
+});
 
 // src/server/adapters/mongoose.ts
 var mongooseAdapter = (model, options = {}) => {
@@ -197,43 +231,6 @@ async function dataKitServerAction(props) {
 }
 
 // src/server/adapters/memory.ts
-var isProvided2 = (value) => value !== void 0 && value !== null && value !== "";
-var getValueByPath = (obj, path) => {
-  if (!path) return void 0;
-  const parts = path.split(".");
-  let current = obj;
-  for (const part of parts) {
-    if (current && typeof current === "object" && part in current) {
-      current = current[part];
-    } else {
-      return void 0;
-    }
-  }
-  return current;
-};
-var matchesExact = (rowValue, needle) => {
-  if (Array.isArray(needle)) return needle.includes(rowValue);
-  return rowValue === needle;
-};
-var matchesRegexLike = (rowValue, needle) => {
-  if (!isProvided2(needle)) return true;
-  if (rowValue === void 0 || rowValue === null) return false;
-  const hay = String(rowValue);
-  if (needle instanceof RegExp) return needle.test(hay);
-  const n = String(needle);
-  return hay.toLowerCase().includes(n.toLowerCase());
-};
-var compareValues = (a, b) => {
-  if (a === b) return 0;
-  if (a === void 0 || a === null) return -1;
-  if (b === void 0 || b === null) return 1;
-  if (typeof a === "number" && typeof b === "number") return a - b;
-  if (typeof a === "bigint" && typeof b === "bigint") return a < b ? -1 : 1;
-  const as = String(a);
-  const bs = String(b);
-  return as.localeCompare(bs);
-};
-var normalizeSorts = (sorts) => Array.isArray(sorts) ? sorts.filter((s) => !!s?.path && (s.value === 1 || s.value === -1)) : [];
 var adapterMemory = (dataset, options = {}) => {
   const { defaultFilterType = "exact" } = options;
   return async ({ filter, sorts, limit, skip, input }) => {
@@ -241,7 +238,7 @@ var adapterMemory = (dataset, options = {}) => {
     const query = input.query ?? {};
     let rows = dataset.filter((row) => {
       for (const [key, value] of Object.entries(query)) {
-        if (!isProvided2(value)) continue;
+        if (!isProvided(value)) continue;
         const rowValue = getValueByPath(row, key);
         if (!matchesExact(rowValue, value)) return false;
       }
@@ -250,7 +247,7 @@ var adapterMemory = (dataset, options = {}) => {
     const effectiveFilter = filter ?? {};
     rows = rows.filter((row) => {
       for (const [key, value] of Object.entries(effectiveFilter)) {
-        if (!isProvided2(value)) continue;
+        if (!isProvided(value)) continue;
         const config = filterConfig?.[key];
         const field = config?.field ?? key;
         const rowValue = getValueByPath(row, field);
@@ -281,6 +278,7 @@ var adapterMemory = (dataset, options = {}) => {
   };
 };
 z.object({
+  action: z.literal("FETCH").optional(),
   page: z.number().int().positive().optional(),
   limit: z.number().int().positive().optional(),
   query: z.record(z.string(), z.union([z.string(), z.number(), z.boolean()])).optional(),