react-admin-crud-manager 1.1.0 → 1.1.2

package/dist/types/types/crudtypes.d.ts

@@ -0,0 +1,217 @@
+import { type ReactNode } from "react";
+export interface CrudPageProps {
+    config: Config;
+}
+export interface Option {
+    value: string | number | boolean;
+    label: string;
+    color?: string;
+}
+export interface ActionButton {
+    type: string;
+    label: string;
+    color?: string;
+    variant?: string;
+    className?: string;
+    disabled?: boolean;
+    onClick?: (event: React.MouseEvent, item: any) => void | Promise<any>;
+}
+export interface MenuAction {
+    title: string;
+    type: string;
+    variant?: string;
+    icon?: ReactNode;
+}
+export interface TableHead {
+    key: string;
+    title?: string;
+    type?: string;
+    imageKey?: string;
+    titleKey?: string;
+    subtitleKey?: string;
+    onClickDetails?: boolean;
+    variant?: string;
+    chipOptions?: Option[];
+    defaultColor?: string;
+    className?: string;
+    format?: string;
+    menuList?: MenuAction[];
+}
+export interface FormField {
+    key: string;
+    label?: string;
+    type?: string;
+    options?: any[];
+    placeholder?: string;
+    rows?: number;
+    inputClass?: string;
+    search?: boolean;
+    accept?: string;
+    text?: string;
+    required?: boolean;
+    minLength?: number;
+    dragDrop?: boolean;
+    parentClass?: string;
+    countriesList?: boolean;
+    defaultCountry?: string;
+    multiple?: boolean;
+    dropdownMaxHeight?: number;
+    editorKey?: string;
+    fontFamily?: string;
+    disabled?: boolean;
+    negativeNumberAllow?: boolean;
+    defaultValue?: any;
+    renderCondition?: (formData: Record<string, any>) => boolean;
+    pattern?: string;
+    renderType?: string;
+    cropImage?: boolean;
+    aspectRatio?: number;
+    dependencyKey?: string;
+    mask?: string;
+    maskApplyOnValue?: boolean;
+    maxSize?: number;
+    [key: string]: any;
+}
+export interface ViewField {
+    key?: string;
+    label?: string;
+    type?: string;
+    imageKey?: string;
+    titleKey?: string;
+    subtitleKey?: string;
+    blockClass?: string;
+    icon?: ReactNode;
+    variant?: string;
+    chipOptions?: Option[];
+    defaultColor?: string;
+    className?: string;
+    format?: string;
+}
+export interface SearchConfig {
+    enabled?: boolean;
+    useServerSideSearch?: boolean;
+    searchKeys?: string[];
+}
+export interface PaginationConfig {
+    enabled?: boolean;
+    useServerSidePagination?: boolean;
+}
+export interface FilterConfig {
+    enabled?: boolean;
+    useServerSideFilters?: boolean;
+}
+export interface SortChangePayload {
+    value: string;
+    option: {
+        value: string;
+        label: string;
+        key: string;
+        order: string;
+        type?: string;
+    } | null;
+    key: string;
+    order: string;
+    type: string;
+}
+export interface SortConfig {
+    enabled?: boolean;
+    useServerSideSorting?: boolean;
+    options?: Array<{
+        value: string;
+        label: string;
+        key: string;
+        order: string;
+        type?: string;
+    }>;
+    fields?: string[];
+    defaultValue?: string;
+    autoGenerate?: boolean;
+    clearLabel?: string;
+    onChange?: (payload: SortChangePayload) => void;
+}
+export interface TableConfig {
+    table_head: TableHead[];
+    search?: SearchConfig;
+    pagination?: PaginationConfig;
+    filter?: FilterConfig;
+    sort?: SortConfig;
+}
+export interface ModalConfig {
+    addModal?: {
+        title: string;
+        size?: string;
+        formClass?: string;
+        formFields?: FormField[];
+        handleSubmit: (formData: Record<string, any>) => Promise<{
+            newObject: any;
+            message?: string;
+        }>;
+        actionButtons?: ActionButton[];
+        icon?: ReactNode;
+    };
+    editModal?: {
+        title: string;
+        size?: string;
+        formClass?: string;
+        formFields?: FormField[];
+        handleSubmit: (formData: Record<string, any>, item: any) => Promise<{
+            newObject: any;
+            targetObject: any;
+            message?: string;
+        }>;
+        actionButtons?: ActionButton[];
+        icon?: ReactNode;
+    };
+    deleteModal?: {
+        title: string;
+        size?: string;
+        confirmText?: string;
+        referenceKey?: string;
+        actionButtons?: ActionButton[];
+        icon?: ReactNode;
+    };
+    viewModal?: {
+        title: string;
+        size?: string;
+        component?: React.ComponentType<{
+            data: any;
+        }>;
+        fields?: ViewField[];
+        footer?: {
+            cancelButton?: boolean;
+            cancelText?: string;
+        };
+        icon?: ReactNode;
+    };
+}
+export interface FilterConfigProps {
+    fields?: FormField[];
+}
+export interface Config {
+    title: string;
+    description?: string;
+    buttonText?: string;
+    fetchData: (params: {
+        search: string;
+        rows_per_page: number;
+        current_page: number;
+        sort_by: string;
+        sort_order: string;
+        [key: string]: any;
+    }) => Promise<{
+        data: any[];
+        pagination: any;
+    }>;
+    fetchRowDetails?: (item: any) => Promise<any>;
+    isStaticData?: boolean;
+    tableConfig: TableConfig;
+    modalConfig?: ModalConfig;
+    filterConfig?: FilterConfigProps;
+}
+export interface ServerSidePaginationData {
+    search: string;
+    rows_per_page: number;
+    current_page: number;
+    sort_by: string;
+    sort_order: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-admin-crud-manager",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "A reusable React CRUD admin template with modular components.",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -8,7 +8,8 @@
   "exports": {
     ".": {
       "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs.js"
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/types/index.d.ts"
     },
     "./dist/tailwind.css": "./dist/tailwind.css"
   },
@@ -36,6 +37,8 @@
   "scripts": {
     "dev": "vite",
     "build": "vite build && node build-css.js",
+    "build:types": "tsc --emitDeclarationOnly",
+    "build:all": "npm run build && npm run build:types",
     "preview": "vite preview"
   },
   "dependencies": {
@@ -53,6 +56,7 @@
   },
   "devDependencies": {
     "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^4.2.1",
     "autoprefixer": "10.4.15",
     "tailwindcss": "3.3.3",