admin_lsac 1.4.8 → 1.5.0

package/.eslintrc.cjs

@@ -6,7 +6,7 @@ module.exports = {
     'plugin:@typescript-eslint/recommended',
     'plugin:react-hooks/recommended',
   ],
-  ignorePatterns: ['dist', '.eslintrc.cjs', 'src/testSchemas'],
+  ignorePatterns: ['dist', '.eslintrc.cjs', 'src/testSchemas', 'admin_lsac.d.ts'],
   parser: '@typescript-eslint/parser',
   plugins: ['react-refresh'],
   rules: {

package/README.md

@@ -2,14 +2,12 @@
 
 For configuring your own admin panel, follow the next instructions.
 
+## How to install it?
+
 ### `npm install admin_lsac`
 
 This command will download and install the specified package and its dependencies into your project's node_modules directory, making it available for use in your project.
 
-### `npm install export-to-csv@1.2.1`
-
-Export-to-csv package latest version is not working properly, so make sure you have the last functional version of this package install.
-
 ## What do you need to import?
 
 ### `import { ChakraProvider } from '@chakra-ui/react'`
@@ -18,13 +16,15 @@ Export-to-csv package latest version is not working properly, so make sure you h
 
 ### `import { AdminPage } from 'admin_lsac'`
 
-You can import these in App.js / App.ts. If your project is TypeScript-based, you need to write the following line as well:
+You can import these in App.js / App.ts or wherever your routes to the pages are located.
 
 ### `import { PageSchema } from 'admin_lsac'`
 
-* Import the component from above where you want to write your schemas. (See below for details about schemas)
+If your project is TypeScript-based, you need to use the line above as well.
 
-You need to create an array of schemas for your own admin panel. You can write the following inside your Routes component from App.js / App.ts:
+- Import the component from above where you want to write your schemas. (See below for details about schemas)
+
+## How to add routes to the admin panel's pages?
 
 ```
 {your_array.map((page) => (
@@ -39,7 +39,7 @@ You need to create an array of schemas for your own admin panel. You can write t
     }
   />
 ))}
-{your_array[0] ? (
+{your_array[0] ? ( // recommended default route when accessing admin panel
   <Route
     path={`${your_url_to_admin_panel}/*`}
     element={
@@ -53,7 +53,9 @@ You need to create an array of schemas for your own admin panel. You can write t
 ) : null}
 ```
 
-#### ⚠️ Don't forget to wrap the Router component into a ChakraProvider component.
+You will need to create an array of schemas for your own admin panel.
+
+#### ⚠️ Don't forget to wrap the Router component into a ChakraProvider component. Otherwise, you will not like the way it looks. :)
 
 ## What is a schema?
 
@@ -121,9 +123,9 @@ export interface RowAction {
 }
 ```
 
-A page schema is based on these interfaces, which can be imported into your files. A page schema describes how one table of your admin panel would need to be structured to accomplish what the user needs regarding an entity. (i.e. users, teams, companies, quizzes)
+A page schema is based on these interfaces, and it describes how one table of your admin panel would need to be structured to accomplish what the user needs to do regarding an entity. (i.e. users, teams, companies, quizzes)
 
-#### An array of schemas would be defined as follows:
+#### An array of schemas must be defined as below:
 
 ```
 const your_array = [
@@ -137,7 +139,7 @@ const your_array = [
 ];
 ```
 
-* In TypeScript, it would slightly change:
+- In TypeScript, it would slightly change:
 
 ```
 const your_array: PageSchema[] = [
@@ -153,9 +155,9 @@ const your_array: PageSchema[] = [
 
 ## Other Specifications
 
-Due to some corrupt dependencies, you need a Node version >= 20.5.0 to use this package in a Vite app.
+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).
 
-For every entity you describe through a page schema, getRequest and onSubmit functions will use routes created for the entity. `getRequest` function will make a GET request, while `onSumbit` will probably make a POST, PATCH or DELETE request.
+For every entity you describe through a page schema, getRequest and onSubmit functions use routes created for the entity. `getRequest` function makes a GET request, while `onSumbit` function generally makes a POST, PATCH or DELETE request.
 
 ## Learn More
 

package/admin_lsac.d.ts

@@ -0,0 +1,68 @@
+declare module 'admin_lsac' {
+  import * as React from 'react';
+  export interface TableField {
+    name: string;
+    access: (obj: any) => string | number | React.ReactElement;
+  }
+  export interface SimpleField {
+    name: string;
+    label: string;
+    type: 'string' | 'number' | 'file';
+    validationSchema: any;
+  }
+  export interface Option {
+    value: string | number | boolean;
+    display: string;
+  }
+  export interface DropdownField {
+    name: string;
+    label: string;
+    type: 'dropdown';
+    options?: Option[] | undefined;
+    getOptions: () => Promise<Option[]>;
+  }
+  export interface ObjectField {
+    name: string;
+    label: string;
+    type: 'object';
+    fields: FormField[];
+  }
+  export interface ArrayField {
+    name: string;
+    label: string;
+    type: 'array';
+    element: Exclude<FormField, ArrayField>;
+  }
+  export type FormField = SimpleField | DropdownField | ObjectField | ArrayField;
+  export interface Action {
+    name: string;
+    fields?: FormField[];
+    onSubmit: (obj1: any, obj2?: any) => Promise<any>;
+  }
+  export interface RowAction {
+    name: string;
+    fields?: FormField[];
+    initialise?: (obj: any) => any;
+    onSubmit: (obj1: any, obj2?: any) => Promise<any>;
+  }
+  export interface PageSchema {
+    name: string;
+    actions: Action[];
+    rowActions: RowAction[];
+    getRequest: () => Promise<any[]>;
+    tableFields: TableField[];
+  }
+
+  export function pageToUrl(page: PageSchema): string;
+  export function AdminPage({
+    pages,
+    selectedPage,
+    basePath,
+    apiURL,
+  }: {
+    pages: PageSchema[];
+    selectedPage: PageSchema;
+    basePath: string;
+    apiURL?: string;
+  }): import('react/jsx-runtime').JSX.Element;
+}

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

@@ -0,0 +1,68 @@
+declare module 'admin_lsac' {
+  import * as React from 'react';
+  export interface TableField {
+    name: string;
+    access: (obj: any) => string | number | React.ReactElement;
+  }
+  export interface SimpleField {
+    name: string;
+    label: string;
+    type: 'string' | 'number' | 'file';
+    validationSchema: any;
+  }
+  export interface Option {
+    value: string | number | boolean;
+    display: string;
+  }
+  export interface DropdownField {
+    name: string;
+    label: string;
+    type: 'dropdown';
+    options?: Option[] | undefined;
+    getOptions: () => Promise<Option[]>;
+  }
+  export interface ObjectField {
+    name: string;
+    label: string;
+    type: 'object';
+    fields: FormField[];
+  }
+  export interface ArrayField {
+    name: string;
+    label: string;
+    type: 'array';
+    element: Exclude<FormField, ArrayField>;
+  }
+  export type FormField = SimpleField | DropdownField | ObjectField | ArrayField;
+  export interface Action {
+    name: string;
+    fields?: FormField[];
+    onSubmit: (obj1: any, obj2?: any) => Promise<any>;
+  }
+  export interface RowAction {
+    name: string;
+    fields?: FormField[];
+    initialise?: (obj: any) => any;
+    onSubmit: (obj1: any, obj2?: any) => Promise<any>;
+  }
+  export interface PageSchema {
+    name: string;
+    actions: Action[];
+    rowActions: RowAction[];
+    getRequest: () => Promise<any[]>;
+    tableFields: TableField[];
+  }
+
+  export function pageToUrl(page: PageSchema): string;
+  export function AdminPage({
+    pages,
+    selectedPage,
+    basePath,
+    apiURL,
+  }: {
+    pages: PageSchema[];
+    selectedPage: PageSchema;
+    basePath: string;
+    apiURL?: string;
+  }): import('react/jsx-runtime').JSX.Element;
+}

package/package.json

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