adminforth 1.2.95 → 1.2.97

package/modules/restApi.ts

@@ -21,6 +21,32 @@ import { ADMINFORTH_VERSION, listify } from './utils.js';
 
 import AdminForthAuth from "../auth.js";
 
+
+export async function interpretResource(adminUser: AdminUser, resource: AdminForthResource, meta: any, source: ActionCheckSource): Promise<{allowedActions: AllowedActionsResolved}> {
+  // if (process.env.HEAVY_DEBUG) {
+  //   console.log('🪲Interpreting resource', resource.resourceId, source, 'adminUser', adminUser);
+  // }
+  const allowedActions = {};
+
+  await Promise.all(
+    Object.entries(resource.options?.allowedActions || {}).map(
+      async ([key, value]: [string, AllowedActionValue]) => {
+        if (process.env.HEAVY_DEBUG) {
+          console.log('🪲checking for allowed call', key, 'value:', value, 'typeof', typeof value);
+        }
+      
+        // if callable then call
+        if (typeof value === 'function') {
+          allowedActions[key] = await value({ adminUser, resource, meta, source });
+        } else {
+          allowedActions[key] = value;
+        }
+      })
+  );
+
+  return { allowedActions };
+}
+
 export default class AdminForthRestAPI {
 
   adminforth: IAdminForth;
@@ -188,13 +214,10 @@ export default class AdminForthRestAPI {
         }
 
         async function processMenuItem(menuItem) {
-            console.log('super hueta')
-
             if (menuItem.badge) {
-                console.log('hueta')
-                // if (typeof menuItem.badge !== 'string') {
+                if (typeof menuItem.badge === 'function') {
                     menuItem.badge = await menuItem.badge(adminUser);
-                // }
+                }
             }
         }
         let newMenu = []
@@ -214,12 +237,12 @@ export default class AdminForthRestAPI {
                   continue
                 }
               }
-              processMenuItem(newChild)
+              await processMenuItem(newChild)
               newChildren.push(newChild)
             }
             newMenuItem = {...newMenuItem, children: newChildren}
           }
-          processMenuItem(newMenuItem)
+          await processMenuItem(newMenuItem)
           newMenu.push(newMenuItem)
         }
 
@@ -249,30 +272,7 @@ export default class AdminForthRestAPI {
       },
     });
 
-    async function interpretResource(adminUser: AdminUser, resource: AdminForthResource, meta: any, source: ActionCheckSource): Promise<{allowedActions: AllowedActionsResolved}> {
-      // if (process.env.HEAVY_DEBUG) {
-      //   console.log('🪲Interpreting resource', resource.resourceId, source, 'adminUser', adminUser);
-      // }
-      const allowedActions = {};
-
-      await Promise.all(
-        Object.entries(resource.options?.allowedActions || {}).map(
-          async ([key, value]: [string, AllowedActionValue]) => {
-            if (process.env.HEAVY_DEBUG) {
-              console.log('🪲checking for allowed call', key, 'value:', value, 'typeof', typeof value);
-            }
-          
-            // if callable then call
-            if (typeof value === 'function') {
-              allowedActions[key] = await value({ adminUser, resource, meta, source });
-            } else {
-              allowedActions[key] = value;
-            }
-          })
-      );
-
-      return { allowedActions };
-    }
+    
 
     function checkAccess(action: AllowedActionsEnum, allowedActions: AllowedActions): { allowed: boolean, error?: string } {
       const allowed = (allowedActions[action] as boolean | string | undefined);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adminforth",
-  "version": "1.2.95",
+  "version": "1.2.97",
   "description": "OpenSource Vue3 powered forth-generation admin panel",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/types/AdminForthConfig.ts

@@ -1,4 +1,6 @@
 import type { Express } from 'express';
+import AdminForth from '../index.js';
+import exp from 'constants';
 
 export interface ICodeInjector {
   srcFoldersToSync: Object;
@@ -90,6 +92,17 @@ export interface IExpressHttpServer extends IHttpServer {
   authorize(callable: Function): void;
 }
 
+export interface IAdminForthFilter {
+  field: string;
+  operator: AdminForthFilterOperators;
+  value: any;
+}
+
+export interface IAdminForthSort {
+  field: string, 
+  direction: AdminForthSortDirections 
+}
+
 export interface IAdminForthDataSourceConnector {
   
   /**
@@ -145,15 +158,21 @@ export interface IAdminForthDataSourceConnector {
    * 
    * Fields are returned from db "as is" then {@link AdminForthBaseConnector.getData} will transform each field using {@link IAdminForthDataSourceConnector.getFieldValue}
    */
-  getDataWithOriginalTypes({ resource, limit, offset, sort, filters, getTotals }: {
+  getDataWithOriginalTypes({ resource, limit, offset, sort, filters }: {
     resource: AdminForthResource,
     limit: number,
     offset: number,
-    sort: { field: string, direction: AdminForthSortDirections }[], 
-    filters: { field: string, operator: AdminForthFilterOperators, value: any }[],
-    getTotals?: boolean
-  }): Promise<{data: Array<any>, total: number}>;
+    sort: IAdminForthSort[], 
+    filters: IAdminForthFilter[],
+  }): Promise<Array<any>>;
 
+  /**
+   * Used to get count of records in database.
+   */
+  getCount({ resource, filters }: {
+    resource: AdminForthResource,
+    filters: IAdminForthFilter[],
+  }): Promise<number>;
 
   /**
    * Optional method which used to get min and max values for columns in resource.
@@ -181,7 +200,7 @@ export interface IAdminForthDataSourceConnector {
   /**
    * Used to delete record in database.
    */
-  deleteRecord({ resource, recordId }: { resource: AdminForthResource, recordId: any }): Promise<void>;
+  deleteRecord({ resource, recordId }: { resource: AdminForthResource, recordId: any }): Promise<boolean>;
 }
 
 
@@ -196,12 +215,15 @@ export interface IAdminForthDataSourceConnectorBase extends IAdminForthDataSourc
     resource: AdminForthResource,
     limit: number,
     offset: number,
-    sort: { field: string, direction: AdminForthSortDirections }[],
-    filters: { field: string, operator: AdminForthFilterOperators, value: any }[]
+    sort: IAdminForthSort[],
+    filters: IAdminForthFilter[],
+    getTotals?: boolean,
   }): Promise<{ data: Array<any>, total: number }>;
 
   getRecordByPrimaryKey(resource: AdminForthResource, recordId: string): Promise<any>;
 
+  createRecord({ resource, record }: { resource: AdminForthResource, record: any }): Promise<void>;
+
   getMinMaxForColumns({ resource, columns }: { resource: AdminForthResource, columns: AdminForthResourceColumn[] }): Promise<{ [key: string]: { min: any, max: any } }>;
 }
 
@@ -1306,6 +1328,67 @@ export type AdminForthConfig = {
     
    
 }
+
+// define typescript objects which I can instantiate as Filters.EQ(field, value) and they woudl
+// return { field: field, operator: 'eq', value: value }. They should be exported with Filters namespace so I can import Filters from this file
+// and use Filters.EQ(field, value) in my code
+
+export type FDataFilter = (field: string, value: any) => IAdminForthFilter;
+
+export class Filters {
+  static EQ(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.EQ, value };
+  }
+  static NEQ(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.NE, value };
+  }
+  static GT(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.GT, value };
+  }
+  static GTE(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.GTE, value };
+  }
+  static LT(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.LT, value };
+  }
+  static LTE(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.LTE, value };
+  }
+  static IN(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.IN, value };
+  }
+  static NOT_IN(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.NIN, value };
+  }
+  static LIKE(field: string, value: any): IAdminForthFilter {
+    return { field, operator: AdminForthFilterOperators.LIKE, value };
+  }
+}
+
+export type FDataSort = (field: string, direction: AdminForthSortDirections) => IAdminForthSort;
+
+export class Sorts {
+  static ASC(field: string): IAdminForthSort {
+    return { field, direction: AdminForthSortDirections.asc };
+  }
+  static DESC(field: string): IAdminForthSort {
+    return { field, direction: AdminForthSortDirections.desc };
+  }
+}
+
+export interface IOperationalResource {
+  get: (filter: IAdminForthFilter | IAdminForthFilter[]) => Promise<any[]>;
+
+  list: (filter: IAdminForthFilter | IAdminForthFilter[], limit: number, offset: number, sort: IAdminForthSort | IAdminForthSort[]) => Promise<any[]>;
+
+  count: (filter: IAdminForthFilter | IAdminForthFilter[]) => Promise<number>;
+
+  create: (record: any) => Promise<any>;
+
+  update: (primaryKey: any, record: any) => Promise<any>;
+
+  delete: (primaryKey: any) => Promise<boolean>;
+}
   
 
 export enum AllowedActionsEnum {

package/dist/spa/.vscode/extensions.json

@@ -1,6 +0,0 @@
-{
-  "recommendations": [
-    "Vue.volar",
-    "dbaeumer.vscode-eslint"
-  ]
-}

package/dist/spa/spa/.eslintrc.cjs

@@ -1,14 +0,0 @@
-/* eslint-env node */
-require('@rushstack/eslint-patch/modern-module-resolution')
-
-module.exports = {
-  root: true,
-  'extends': [
-    'plugin:vue/vue3-essential',
-    'eslint:recommended',
-    '@vue/eslint-config-typescript'
-  ],
-  parserOptions: {
-    ecmaVersion: 'latest'
-  }
-}

package/dist/spa/spa/.vscode/extensions.json

@@ -1,6 +0,0 @@
-{
-  "recommendations": [
-    "Vue.volar",
-    "dbaeumer.vscode-eslint"
-  ]
-}

package/dist/spa/spa/README.md

@@ -1,39 +0,0 @@
-# spa
-
-This template should help get you started developing with Vue 3 in Vite.
-
-## Recommended IDE Setup
-
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
-
-## Type Support for `.vue` Imports in TS
-
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
-
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
-
-```sh
-npm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
-```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
-```
-
-### Lint with [ESLint](https://eslint.org/)
-
-```sh
-npm run lint
-```

package/dist/spa/spa/env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/dist/spa/spa/index.html

@@ -1,23 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <link rel="icon" href="/* IMPORTANT:ADMINFORTH FAVICON */">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>/* IMPORTANT:ADMINFORTH TITLE */</title>
-<!--     
-    <script>
-      // On page load or when changing themes, best to add inline in `head` to avoid FOUC
-      if (localStorage.getItem('color-theme') === 'dark' || (!('color-theme' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches)) {
-          document.documentElement.classList.add('dark');
-      } else {
-          document.documentElement.classList.remove('dark')
-      }
-  </script> -->
-
-  </head>
-  <body class=" ">
-    <div id="app" class="min-h-screen bg-lightHtml dark:bg-darkHtml"></div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>