antd-crud-table 0.4.0 → 0.7.0

package/dist/useLocalStorageCrud.cjs

@@ -1 +1 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}}),require(`./CrudTable.cjs`);let e=require(`antd`),t=require(`react`);var n=(e,t=[])=>{try{let n=localStorage.getItem(e);return n?JSON.parse(n):t}catch{return t}},r=(e,t)=>{try{localStorage.setItem(e,JSON.stringify(t))}catch(e){console.error(`Failed to save to localStorage:`,e)}},i=(e,t,i=[])=>({getList:async t=>{let{current:r=1,pageSize:a=10,sortBy:o,sortOrder:s,...c}=t,l=n(e,i);Object.entries(c).forEach(([e,t])=>{t!=null&&t!==``&&e!==`current`&&e!==`pageSize`&&(l=l.filter(n=>{let r=n[e];return r==null?!1:String(r).toLowerCase().includes(String(t).toLowerCase())}))}),o&&s&&l.sort((e,t)=>{let n=e[o],r=t[o];if(n==null)return 1;if(r==null)return-1;let i=n>r?1:n<r?-1:0;return s===`ascend`?i:-i});let u=(r-1)*a;return{data:l.slice(u,u+a),total:l.length,success:!0}},create:async a=>{let o=n(e,i),s=o.length>0?Math.max(...o.map(e=>Number(e[t])||0),0):0,c={[t]:s+1,...a,createdAt:new Date().toISOString(),updatedAt:new Date().toISOString()};return o.push(c),r(e,o),c},update:async(a,o)=>{let s=n(e,i),c=s.findIndex(e=>e[t]===a);if(c===-1)throw Error(`Item not found`);return s[c]={...s[c],...o,updatedAt:new Date().toISOString()},r(e,s),s[c]},delete:async a=>{r(e,n(e,i).filter(e=>e[t]!==a))}}),a=(n,r,a=[],o)=>{let s=(0,t.useRef)(null),[c,l]=(0,t.useState)({loading:!1,error:null,data:[],total:0,current:1,pageSize:o?.defaultPageSize||10}),u=i(r,n,a),d=(0,t.useCallback)(async()=>{l(e=>({...e,loading:!0,error:null}));try{let e={current:c.current,pageSize:c.pageSize},t=await u.getList(e);l(e=>({...e,data:t.data,total:t.total,loading:!1}))}catch(t){let n=t instanceof Error?t.message:`Failed to fetch data`;l(e=>({...e,loading:!1,error:n})),o?.onError?.(`fetch`,t),e.message.error(n)}},[c.current,c.pageSize,u,o]);return(0,t.useEffect)(()=>{d()},[]),{refresh:d,create:(0,t.useCallback)(async t=>{try{l(e=>({...e,loading:!0}));let n=await u.create(t);return o?.optimisticUpdates?l(e=>({...e,data:[...e.data,n],total:e.total+1,loading:!1})):await d(),o?.onSuccess?.(`create`,n),e.message.success(`Created successfully`),s.current?.reload(),n}catch(t){l(e=>({...e,loading:!1}));let n=t instanceof Error?t.message:`Create failed`;return o?.onError?.(`create`,t),e.message.error(n),null}},[u,o,d]),update:(0,t.useCallback)(async(t,r)=>{try{l(e=>({...e,loading:!0}));let i=await u.update(t,r);return o?.optimisticUpdates?l(e=>({...e,data:e.data.map(e=>e[n]===t?{...e,...i}:e),loading:!1})):await d(),o?.onSuccess?.(`update`,i),e.message.success(`Updated successfully`),s.current?.reload(),i}catch(t){l(e=>({...e,loading:!1}));let n=t instanceof Error?t.message:`Update failed`;return o?.onError?.(`update`,t),e.message.error(n),null}},[u,o,n,d]),delete:(0,t.useCallback)(async t=>{try{return l(e=>({...e,loading:!0})),await u.delete(t),o?.optimisticUpdates?l(e=>({...e,data:e.data.filter(e=>e[n]!==t),total:e.total-1,loading:!1})):await d(),o?.onSuccess?.(`delete`,t),e.message.success(`Deleted successfully`),s.current?.reload(),!0}catch(t){l(e=>({...e,loading:!1}));let n=t instanceof Error?t.message:`Delete failed`;return o?.onError?.(`delete`,t),e.message.error(n),!1}},[u,o,n,d]),setPageSize:(0,t.useCallback)(e=>{l(t=>({...t,pageSize:e,current:1}))},[]),setCurrentPage:(0,t.useCallback)(e=>{l(t=>({...t,current:e}))},[]),state:c,actionRef:s}};exports.default=a,exports.useLocalStorageCrud=a;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./useCrudTable-40jpmCkr.cjs");let t=require("react");var n=(n,r,i=[],a)=>{let o=e.n(n,{...a,storageKey:r,initialData:i}),{refresh:s}=o;return(0,t.useEffect)(()=>{s()},[]),o};exports.useLocalStorageCrud=n;

package/dist/useLocalStorageCrud.js

@@ -1,201 +1,15 @@
-import { message as e } from "antd";
-import { useCallback as t, useEffect as n, useRef as r, useState as i } from "react";
+import { n as e } from "./useCrudTable-DxjnXVlQ.js";
+import { useEffect as t } from "react";
 //#region lib/hooks/useLocalStorageCrud.ts
-var a = (e, t = []) => {
-	try {
-		let n = localStorage.getItem(e);
-		return n ? JSON.parse(n) : t;
-	} catch {
-		return t;
-	}
-}, o = (e, t) => {
-	try {
-		localStorage.setItem(e, JSON.stringify(t));
-	} catch (e) {
-		console.error("Failed to save to localStorage:", e);
-	}
-}, s = (e, t, n = []) => ({
-	getList: async (t) => {
-		let { current: r = 1, pageSize: i = 10, sortBy: o, sortOrder: s, ...c } = t, l = a(e, n);
-		Object.entries(c).forEach(([e, t]) => {
-			t != null && t !== "" && e !== "current" && e !== "pageSize" && (l = l.filter((n) => {
-				let r = n[e];
-				return r == null ? !1 : String(r).toLowerCase().includes(String(t).toLowerCase());
-			}));
-		}), o && s && l.sort((e, t) => {
-			let n = e[o], r = t[o];
-			if (n == null) return 1;
-			if (r == null) return -1;
-			let i = n > r ? 1 : n < r ? -1 : 0;
-			return s === "ascend" ? i : -i;
-		});
-		let u = (r - 1) * i;
-		return {
-			data: l.slice(u, u + i),
-			total: l.length,
-			success: !0
-		};
-	},
-	create: async (r) => {
-		let i = a(e, n), s = i.length > 0 ? Math.max(...i.map((e) => Number(e[t]) || 0), 0) : 0, c = {
-			[t]: s + 1,
-			...r,
-			createdAt: (/* @__PURE__ */ new Date()).toISOString(),
-			updatedAt: (/* @__PURE__ */ new Date()).toISOString()
-		};
-		return i.push(c), o(e, i), c;
-	},
-	update: async (r, i) => {
-		let s = a(e, n), c = s.findIndex((e) => e[t] === r);
-		if (c === -1) throw Error("Item not found");
-		return s[c] = {
-			...s[c],
-			...i,
-			updatedAt: (/* @__PURE__ */ new Date()).toISOString()
-		}, o(e, s), s[c];
-	},
-	delete: async (r) => {
-		o(e, a(e, n).filter((e) => e[t] !== r));
-	}
-}), c = (a, o, c = [], l) => {
-	let u = r(null), [d, f] = i({
-		loading: !1,
-		error: null,
-		data: [],
-		total: 0,
-		current: 1,
-		pageSize: l?.defaultPageSize || 10
-	}), p = s(o, a, c), m = t(async () => {
-		f((e) => ({
-			...e,
-			loading: !0,
-			error: null
-		}));
-		try {
-			let e = {
-				current: d.current,
-				pageSize: d.pageSize
-			}, t = await p.getList(e);
-			f((e) => ({
-				...e,
-				data: t.data,
-				total: t.total,
-				loading: !1
-			}));
-		} catch (t) {
-			let n = t instanceof Error ? t.message : "Failed to fetch data";
-			f((e) => ({
-				...e,
-				loading: !1,
-				error: n
-			})), l?.onError?.("fetch", t), e.error(n);
-		}
-	}, [
-		d.current,
-		d.pageSize,
-		p,
-		l
-	]);
-	return n(() => {
-		m();
-	}, []), {
-		refresh: m,
-		create: t(async (t) => {
-			try {
-				f((e) => ({
-					...e,
-					loading: !0
-				}));
-				let n = await p.create(t);
-				return l?.optimisticUpdates ? f((e) => ({
-					...e,
-					data: [...e.data, n],
-					total: e.total + 1,
-					loading: !1
-				})) : await m(), l?.onSuccess?.("create", n), e.success("Created successfully"), u.current?.reload(), n;
-			} catch (t) {
-				f((e) => ({
-					...e,
-					loading: !1
-				}));
-				let n = t instanceof Error ? t.message : "Create failed";
-				return l?.onError?.("create", t), e.error(n), null;
-			}
-		}, [
-			p,
-			l,
-			m
-		]),
-		update: t(async (t, n) => {
-			try {
-				f((e) => ({
-					...e,
-					loading: !0
-				}));
-				let r = await p.update(t, n);
-				return l?.optimisticUpdates ? f((e) => ({
-					...e,
-					data: e.data.map((e) => e[a] === t ? {
-						...e,
-						...r
-					} : e),
-					loading: !1
-				})) : await m(), l?.onSuccess?.("update", r), e.success("Updated successfully"), u.current?.reload(), r;
-			} catch (t) {
-				f((e) => ({
-					...e,
-					loading: !1
-				}));
-				let n = t instanceof Error ? t.message : "Update failed";
-				return l?.onError?.("update", t), e.error(n), null;
-			}
-		}, [
-			p,
-			l,
-			a,
-			m
-		]),
-		delete: t(async (t) => {
-			try {
-				return f((e) => ({
-					...e,
-					loading: !0
-				})), await p.delete(t), l?.optimisticUpdates ? f((e) => ({
-					...e,
-					data: e.data.filter((e) => e[a] !== t),
-					total: e.total - 1,
-					loading: !1
-				})) : await m(), l?.onSuccess?.("delete", t), e.success("Deleted successfully"), u.current?.reload(), !0;
-			} catch (t) {
-				f((e) => ({
-					...e,
-					loading: !1
-				}));
-				let n = t instanceof Error ? t.message : "Delete failed";
-				return l?.onError?.("delete", t), e.error(n), !1;
-			}
-		}, [
-			p,
-			l,
-			a,
-			m
-		]),
-		setPageSize: t((e) => {
-			f((t) => ({
-				...t,
-				pageSize: e,
-				current: 1
-			}));
-		}, []),
-		setCurrentPage: t((e) => {
-			f((t) => ({
-				...t,
-				current: e
-			}));
-		}, []),
-		state: d,
-		actionRef: u
-	};
+var n = (n, r, i = [], a) => {
+	let o = e(n, {
+		...a,
+		storageKey: r,
+		initialData: i
+	}), { refresh: s } = o;
+	return t(() => {
+		s();
+	}, []), o;
 };
 //#endregion
-export { c as default, c as useLocalStorageCrud };
+export { n as useLocalStorageCrud };

package/dist/utils/exportData.d.ts

@@ -1,17 +1,33 @@
-export type ExportFormat = 'csv' | 'json' | 'xlsx';
-interface ColumnOption {
+import { EnumOption } from '../fields/types';
+/**
+ * Supported export formats.
+ *
+ * `excel` emits Excel 2003 SpreadsheetML, not OOXML. It was previously named
+ * `xlsx`, which promised a format this library does not produce - writing a
+ * real .xlsx means owning a ZIP implementation, which is not worth a
+ * dependency-free library taking on. See exportToExcel for the tradeoff.
+ */
+export type ExportFormat = 'csv' | 'json' | 'excel';
+/** The column information an exporter needs: a header, a key, and how to format. */
+export interface ColumnOption {
+    /** Header text. Falls back to `dataIndex`. */
     title?: string;
+    /** The record property this column reads. */
     dataIndex?: string;
+    /** Drives value formatting for booleans, enums and dates. */
     fieldType?: string;
-    enumOptions?: Record<string, {
-        text: string;
-        color?: string;
-    }>;
+    /** Labels for `enum` columns, so exports carry text rather than raw keys. */
+    enumOptions?: Record<string, EnumOption>;
 }
-interface ExportOptions<T> {
+/** One export request. */
+export interface ExportOptions<T> {
+    /** Records to write. */
     data: T[];
+    /** Columns to include, in order. */
     columns: ColumnOption[];
+    /** Base filename; the extension is chosen by the format. Defaults to `export`. */
     filename?: string;
+    /** Output format. Defaults to `csv`. */
     format?: ExportFormat;
 }
 /**
@@ -23,15 +39,24 @@ export declare const exportToCSV: <T>(options: ExportOptions<T>) => void;
  */
 export declare const exportToJSON: <T>(options: ExportOptions<T>) => void;
 /**
- * Export data to XLSX format (using simple XML format)
+ * Export data as an Excel-compatible spreadsheet.
+ *
+ * Emits Excel 2003 SpreadsheetML - an XML dialect Excel and LibreOffice open
+ * natively - written to a `.xls` file, rather than a real OOXML `.xlsx`, which
+ * would mean adding a dependency such as exceljs or hand-rolling a ZIP writer.
+ *
+ * Known consequence: because the content is SpreadsheetML and the extension is
+ * `.xls`, Excel 2016 and later show "The file format and extension don't
+ * match" on open. The file is intact and opens correctly once confirmed. The
+ * format is named `excel` rather than `xlsx` so the API does not claim
+ * otherwise.
  */
-export declare const exportToXLSX: <T extends Record<string, any>>(options: ExportOptions<T>) => void;
+export declare const exportToExcel: <T extends object>(options: ExportOptions<T>) => void;
 /**
  * Export data with specified format
  */
-export declare const exportData: <T extends Record<string, any>>(options: ExportOptions<T>) => void;
+export declare const exportData: <T extends object>(options: ExportOptions<T>) => void;
 /**
  * Export all data (including paginated data)
  */
-export declare const exportAllData: <T extends Record<string, any>>(getAllData: () => Promise<T[]>, columns: ColumnOption[], filename?: string, format?: ExportFormat) => Promise<void>;
-export default exportData;
+export declare const exportAllData: <T extends object>(getAllData: () => Promise<T[]>, columns: ColumnOption[], filename?: string, format?: ExportFormat) => Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "antd-crud-table",
   "private": false,
-  "version": "0.4.0",
+  "version": "0.7.0",
   "type": "module",
   "homepage": "https://github.com/maifeeulasad/antd-crud-table",
   "repository": {
@@ -16,38 +16,58 @@
     "components"
   ],
   "license": "MIT",
+  "engines": {
+    "node": ">=20.19.0"
+  },
   "author": "Maifee Ul Asad<maifeeulasad@gmail.com>",
   "peerDependencies": {
     "@ant-design/icons": "^6.0.0",
     "@ant-design/pro-components": "^2.8.10",
     "antd": "^6.3.6",
-    "date-fns": "^4.1.0",
     "dayjs": "^1.11.13",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
   },
   "devDependencies": {
+    "@ant-design/icons": "^6.0.0",
+    "@ant-design/pro-components": "^2.8.10",
     "@eslint/js": "^9.22.0",
+    "@storybook/react-vite": "^10.5.10",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/user-event": "^14.6.6",
     "@types/node": "^22.15.2",
-    "@types/react": "^19.0.10",
-    "@types/react-dom": "^19.0.4",
+    "@types/react": "^19.2.18",
+    "@types/react-dom": "^19.2.5",
     "@vitejs/plugin-react-swc": "^3.8.0",
+    "@vitest/coverage-v8": "^4.1.11",
+    "antd": "^6.3.6",
+    "dayjs": "^1.11.13",
     "eslint": "^9.22.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.19",
     "globals": "^16.0.0",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "storybook": "^10.5.10",
+    "typedoc": "^0.28.20",
     "typescript": "~5.7.2",
     "typescript-eslint": "^8.26.1",
     "vite": "^8.0.8",
-    "vite-plugin-dts": "^4.5.3"
+    "vite-plugin-dts": "^4.5.3",
+    "vitest": "^4.1.11"
   },
-  "main": "./dist/CrudTable.cjs",
-  "module": "./dist/CrudTable.js",
-  "types": "./dist/CrudTable.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./CrudTable": {
       "types": "./dist/CrudTable.d.ts",
       "import": "./dist/CrudTable.js",
       "require": "./dist/CrudTable.cjs"
@@ -63,21 +83,37 @@
       "require": "./dist/useCrudTable.cjs"
     },
     "./hooks/useLocalStorageCrud": {
-      "types": "./dist/hooks/useLocalStorageCrud.d.ts"
+      "types": "./dist/hooks/useLocalStorageCrud.d.ts",
+      "import": "./dist/useLocalStorageCrud.js",
+      "require": "./dist/useLocalStorageCrud.cjs"
     },
     "./utils/exportData": {
-      "types": "./dist/utils/exportData.d.ts"
-    }
+      "types": "./dist/utils/exportData.d.ts",
+      "import": "./dist/exportData.js",
+      "require": "./dist/exportData.cjs"
+    },
+    "./styles.css": "./dist/antd-crud-table.css"
   },
   "files": [
     "dist"
   ],
+  "sideEffects": [
+    "*.css"
+  ],
   "scripts": {
     "dev": "vite",
-    "build:static": "tsc -b && vite build",
+    "build:demo": "tsc -b && vite build",
     "build:lib": "tsc --p ./tsconfig.build.json && vite build --config vite.config.lib.ts",
+    "docs:api": "typedoc",
+    "build:storybook": "STORYBOOK_BASE=\"${SITE_BASE:-/antd-crud-table/}storybook/\" storybook build -o dist-site/storybook",
+    "build:site": "pnpm build:demo && pnpm docs:api && pnpm build:storybook && pnpm inject:analytics",
+    "inject:analytics": "node scripts/inject-analytics.ts dist-site",
+    "storybook": "storybook dev -p 6006",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "preview": "vite preview"
   }
 }