admin_lsac 2.0.0 → 2.0.2

package/README.md

@@ -33,8 +33,9 @@ Import the component from above where you want to write your schemas! (See below
     element={
       <AdminPage
         pages={your_array}
-        selectedPage={page}
+        selectedPage={page} // 'page' param from above
         basePath={your_url_to_admin_panel}
+        apiURL={your_url_to_backend} // optional, for websockets
       />
     }
   />
@@ -47,6 +48,7 @@ Import the component from above where you want to write your schemas! (See below
         pages={your_array}
         selectedPage={your_array[0]}
         basePath={your_url_to_admin_panel}
+        apiURL={your_url_to_backend} // optional, for websockets
       />
     }
   />
@@ -193,7 +195,7 @@ const companies: PageSchema = {
           name: "name",
           label: "Quiz Name",
           type: "string", // for every FormField, type must be specified
-          validationSchema: Yup.string().required(),
+          validationSchema: Yup.string().required(), // you can also require 'boolean' values with Yup
         },
         {
           name: "questions",
@@ -309,6 +311,12 @@ const your_array: PageSchema[] = [
 ];
 ```
 
+## Websockets Support
+
+For real-time changes, this NPM module uses socket.io-client library to implement WebSockets. So, on the server-side, you will have to use socket.io library, and provide an `apiURL` as shown above.
+
+In order for it to work, emit an event 'updateData' from the server for every route associated with an action/rowAction. You can also send a message that the client will receive (the message will be shown in the web console).
+
 ## Other Specifications
 
 Due to some corrupt dependencies, you will need a Node version >= 20.5.0 to use this NPM package (it may work in some cases, but we still recommend updating Node to a newer version).

package/dist/esm/src/components/AdminPage.js

@@ -36,7 +36,23 @@ function exportToCSV(data, filename) {
         }
         return formattedObj;
     };
-    const formattedData = data.map(formatImageData);
+    const removeTimestamps = (obj) => {
+        const { createdAt, updatedAt, ...rest } = obj;
+        return rest;
+    };
+    const allKeys = new Set();
+    data.forEach((item) => {
+        Object.keys(formatImageData(removeTimestamps(item))).forEach((key) => allKeys.add(key));
+    });
+    const formattedData = data.map((item) => {
+        const newItem = formatImageData(removeTimestamps(item));
+        allKeys.forEach((key) => {
+            if (!(key in newItem)) {
+                newItem[key] = '';
+            }
+        });
+        return newItem;
+    });
     const csvConfig = mkConfig({
         useKeysAsHeaders: true,
         filename: filename,

package/dist/esm/src/components/GenericForm.js

@@ -37,7 +37,7 @@ function generateSingleField(formfield, fieldName, key) {
                         if (event.currentTarget.files != null) {
                             form.setFieldValue(fieldName, event.currentTarget.files[0]);
                         }
-                    } })) : (_jsxs(Select, { ...field, defaultValue: "", children: [_jsx("option", { disabled: true, value: "", children: "Select an option!" }), formfield.options?.map((option, key) => (_jsx("option", { value: `${option.value}`, children: option.display }, key)))] })), _jsx(FormErrorMessage, { children: getIn(form.errors, fieldName) })] })) }, key));
+                    } })) : formfield.type === 'date' ? (_jsx(Input, { ...field, type: "date", placeholder: "" })) : (_jsxs(Select, { ...field, defaultValue: "", children: [_jsx("option", { disabled: true, value: "", children: "Select an option!" }), formfield.options?.map((option, key) => (_jsx("option", { value: `${option.value}`, children: option.display }, key)))] })), _jsx(FormErrorMessage, { children: getIn(form.errors, fieldName) })] })) }, key));
 }
 function parseFields(fields, previous) {
     if (!fields) {
@@ -135,7 +135,7 @@ export function GenericForm({ action, onClose, rowId }) {
                         await action.onSubmit(values);
                     if (onClose)
                         onClose();
-                    Swal.fire('Ok');
+                    Swal.fire('Action/RowAction executed successfully');
                 }
                 catch (e) {
                     if (onClose)
@@ -145,5 +145,5 @@ export function GenericForm({ action, onClose, rowId }) {
                         text: 'Error: ' + err,
                     });
                 }
-            }, children: ({ isSubmitting }) => (_jsxs(Form, { children: [formFields, _jsx(Button, { mt: 4, colorScheme: "teal", isLoading: isSubmitting, type: "submit", children: "Submit" }), _jsx(Button, { mt: 4, colorScheme: "teal", type: "reset", children: "Initialise Form" })] })) }) }));
+            }, children: ({ isSubmitting }) => (_jsxs(Form, { children: [formFields, _jsx(Button, { mt: 4, mb: 2, colorScheme: "teal", isLoading: isSubmitting, type: "submit", children: "Submit" }), action.initialise && (_jsx(Button, { mt: 4, mb: 2, ml: 4, colorScheme: "teal", type: "reset", children: "Initialise Form" }))] })) }) }));
 }

package/dist/esm/src/schema.d.ts

@@ -6,7 +6,7 @@ export interface TableField {
 export interface SimpleField {
     name: string;
     label: string;
-    type: 'string' | 'number' | 'file';
+    type: 'string' | 'number' | 'file' | 'date';
     validationSchema: any;
 }
 export interface Option {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "admin_lsac",
   "private": false,
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Generic Admin Panel created for storing events' data",
   "scripts": {
     "dev": "vite",