adminforth 1.1.12 → 1.1.14

package/spa/src/stores/core.ts

@@ -8,7 +8,7 @@ export const useCoreStore = defineStore('core', () => {
   const resourceById: Ref<Object> = ref({});
   const menu = ref([]);
   const config = ref({});
-  const record = ref({});
+  const record: Ref<any | null> = ref({});
   const resource: Ref<AdminForthResource | null> = ref(null);
 
   const resourceColumnsWithFilters = computed(() => {
@@ -67,9 +67,17 @@ export const useCoreStore = defineStore('core', () => {
       }
     });
 
-    console.log('📦 record', respData);
-    record.value = respData.data[0];
-    resourceOptions.value = respData.options;
+    if (respData.error) {
+      window.adminforth.alert({
+        message: respData.error,
+        variant: 'danger',
+        timeout: 'unlimited'
+      });
+      record.value = {};
+    } else {
+      record.value = respData.data[0];
+    }
+
   }
 
   async function fetchResourceFull({ resourceId }: { resourceId: string }) {
@@ -103,12 +111,7 @@ export const useCoreStore = defineStore('core', () => {
     config.value = {...config.value, ...res};
   }
 
-  async function logout() {
-    await callAdminForthApi({
-      path: '/logout',
-      method: 'POST',
-    });
-  }
+ 
 
   const username = computed(() => {
     const usernameField = config.value.usernameField;
@@ -134,7 +137,6 @@ export const useCoreStore = defineStore('core', () => {
     fetchResourceFull, 
     resourceColumnsError,
     resourceOptions,
-    logout,
     resource,
     adminUser,
     resourceColumnsWithFilters

package/spa/src/stores/user.ts

@@ -0,0 +1,50 @@
+import {ref} from 'vue';
+import {defineStore} from 'pinia';
+import { callAdminForthApi } from '@/utils';
+
+export const useUserStore = defineStore('user', () => {
+    const isAuthorized = ref(false);
+
+    function authorize() {
+        isAuthorized.value = true;
+    }
+
+    function unauthorize() {
+        isAuthorized.value = false;
+    }
+
+    async function logout() {
+        await callAdminForthApi({
+          path: '/logout',
+          method: 'POST',
+        });
+      }
+
+    async function checkAuth( skipApiCall = false){
+        if(isAuthorized.value) return true;
+        else {
+            if(skipApiCall) return false;
+            const resp = await callAdminForthApi({
+                path: '/check_auth',
+                method: 'POST',
+            });
+            if (resp.status !== 401) {
+                authorize();
+                return true;
+            }
+            else {
+                unauthorize();
+                return false;}
+        }
+        
+    }
+
+    return {
+        isAuthorized,
+        authorize,
+        unauthorize,
+        checkAuth,
+        logout
+    }
+
+});        

package/spa/src/utils.ts

@@ -4,6 +4,7 @@ import type {  CoreConfig } from './spa_types/core';
 import router from "./router";
 import { useRouter } from 'vue-router';
 import { useCoreStore } from './stores/core';
+import { useUserStore } from './stores/user';
 
 export async function callApi({path, method, body=undefined} ) {
   const options = {
@@ -16,14 +17,18 @@ export async function callApi({path, method, body=undefined} ) {
   const fullPath = `${import.meta.env.VITE_ADMINFORTH_PUBLIC_PATH || ''}${path}`;
   const r = await fetch(fullPath, options);
   if (r.status == 401) {
-    console.log('router', router);
-    router.push({name: 'login'});
+    useUserStore().unauthorize();
+    router.push({ name: 'login' });
     return null;
   }
   return await r.json();
 }
 
-export async function callAdminForthApi({ path, method, body=undefined }) {
+export async function callAdminForthApi({ path, method, body=undefined }: {
+  path: string,
+  method: 'GET' | 'POST' | 'PUT' | 'DELETE',
+  body?: any
+}) {
   try {
     return callApi({path: `/adminapi/v1${path}`, method, body} );
   } catch (e) {

package/spa/src/views/CreateView.vue

@@ -137,6 +137,13 @@ async function saveRecord() {
       record: record.value,
     },
   });
+  if (response.error) {
+    window.adminforth.alert({
+      message: resp.error,
+      variant: 'danger',
+      timeout: 'unlimited',
+    })
+  }
   saving.value = false;
   if (route.query.returnTo) {
     router.push(route.query.returnTo);

package/spa/src/views/EditView.vue

@@ -145,7 +145,7 @@ async function saveRecord() {
     }
   }
 
-  await callAdminForthApi({
+  const resp = await callAdminForthApi({
     method: 'POST',
     path: `/update_record`,
     body: {
@@ -154,6 +154,13 @@ async function saveRecord() {
       record: updates,
     },
   });
+  if (resp.error) {
+    window.adminforth.alert({
+      message: resp.error,
+      variant: 'danger',
+      timeout: 'unlimited',
+    })
+  }
   saving.value = false;
   router.push({ name: 'resource-show', params: { resourceId: route.params.resourceId, primaryKey: coreStore.record[coreStore.primaryKey] } });
 }

package/spa/src/views/ListView.vue

@@ -183,7 +183,16 @@ async function getList() {
       sort: sort.value,
     }
   });
-
+  if (data.error) {
+    window.adminforth.alert({
+      message: data.error,
+      variant: 'danger',
+      timeout: 'unlimited',
+    });
+    rows.value = [];
+    totalRows.value = 0;
+    return;
+  }
   rows.value = data.data?.map(row => {
     row._primaryKeyValue = row[coreStore.resource.columns.find(c => c.primaryKey).name];
     return row;

package/types/AdminForthConfig.ts

@@ -26,12 +26,31 @@ export interface GenericHttpServer {
    */
   endpoint(options: {
     method: string,
+    noAuth?: boolean,
     path: string,
-    handler: Function,
+    handler: (body: any, adminUser: any, query: {[key: string]: string}, headers: {[key: string]: string}, cookies: {[key: string]: string}, response: {
+      setHeader: (key: string, value: string) => void,
+      setStatus: (code: number, message: string) => void,
+    }) => void,
   }): void;
 
 }
 
+export type AdminUser = {
+  /**
+   * primaryKey field value of user in table which is defined by {@link AdminForthConfig.auth.resourceId}
+   * or null if it is user logged in as {@link AdminForthConfig.rootUser}
+   */
+  pk: string | null,
+
+  /**
+   * Username which takend from {@link AdminForthConfig.auth.usernameField} field in user resource {@link AdminForthConfig.auth.resourceId}
+   */
+  username: string,
+  isRoot: boolean,
+  dbUser: any,
+}
+
 export interface ExpressHttpServer extends GenericHttpServer {
 
   /**
@@ -67,7 +86,7 @@ export interface AdminForthClass {
 
   auth: {
 
-    verify(jwt : string): any;
+    verify(jwt : string): Promise<any>;
   }
 
   /**
@@ -75,7 +94,6 @@ export interface AdminForthClass {
    */
   runningHotReload: boolean;
 
-
   /**
    * Connects to databases defined in datasources and fetches described resource columns to find out data types and constraints.
    * You must call this method as soon as possible after AdminForth class is instantiated.
@@ -182,6 +200,7 @@ export enum AdminForthResourcePages {
   edit = 'edit',
   create = 'create',
   filter = 'filter',
+  
 }
 
 
@@ -400,6 +419,32 @@ export type AdminForthResourceColumn = {
     masked?: boolean,
 }
   
+
+/**
+ * Modify query to change how data is fetched from database.
+ * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
+ */
+export type BeforeDataSourceRequestFunction = (params: {resource: AdminForthResource, adminUser: AdminUser, query: any}) => Promise<{ok: boolean, error?: string}>;
+
+/**
+ * Modify response to change how data is returned after fetching from database.
+ * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
+ */
+export type AfterDataSourceResponseFunction = (params: {resource: AdminForthResource, adminUser: AdminUser, response: any}) => Promise<{ok: boolean, error?: string}>;
+
+/**
+ * Modify record to change how data is saved to database.
+ * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
+ */
+export type BeforeSaveFunction = (params:{resource: AdminForthResource, adminUser: AdminUser, record: any}) => Promise<{ok: boolean, error?: string}>;
+
+/**
+ * Modify record to change how data is saved to database.
+ * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.
+ */
+export type AfterSaveFunction = (params: {resource: AdminForthResource, adminUser: AdminUser, record: any}) => Promise<{ok: boolean, error?: string}>;
+
+
 /**
  * Resource describes one table or collection in database.
  * AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.
@@ -456,24 +501,24 @@ export type AdminForthResource = {
     plugins?: Array<AdminForthPluginType>,
     hooks?: {
       show?: {
-        beforeDatasourceRequest?: Function | Array<Function>,
-        afterDatasourceResponse?: Function | Array<Function>,
+        beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+        afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
       list?: {
-        beforeDatasourceRequest?: Function | Array<Function>,
-        afterDatasourceResponse?: Function | Array<Function>,
+        beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+        afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
       create?: {
-        beforeSave?: Function | Array<Function>,
-        afterSave?: Function | Array<Function>,
+        beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+        afterSave?: AfterSaveFunction | Array<AfterSaveFunction>,
       },
       edit?: {
-        beforeSave?: Function | Array<Function>,
-        afterSave?: Function | Array<Function>,
+        beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+        afterSave?: AfterSaveFunction | Array<AfterSaveFunction>,
       },
       delete?: {
-        beforeSave?: Function | Array<Function>,
-        afterSave?: Function | Array<Function>,
+        beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+        afterSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
       },
     },
     options?: {
@@ -770,14 +815,21 @@ export type AdminForthConfig = {
     deleteConfirmation?: boolean,
    
     styles?: Object,
-  }
+}
   
+
+export enum AllowedActionsEnum {
+  show = 'show',
+  list = 'list',
+  edit = 'edit',
+  create = 'create',
+  delete = 'delete',
+  filter = 'filter',
+}
+
+
 export type AllowedActions = {
-    create?: boolean,
-    edit?: boolean,
-    show?: boolean,
-    delete?: boolean,
-    filter?: boolean,
+  [key in AllowedActionsEnum]?: boolean
 }
   
 export type ValidationObject = {
@@ -960,8 +1012,8 @@ export type AdminForthForeignResource = {
     resourceId: string,
     hooks?: {
       dropdownList?: {
-        beforeDatasourceRequest?: Function,
-        afterDatasourceResponse?: Function,
+        beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+        afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
     },
   }

package/types/FrontendAPI.ts

@@ -88,7 +88,13 @@ export type AlertParams = {
     /**
      * The variant of the alert
      */
-    variant?: AlertVariant;
+    variant?: AlertVariant | keyof typeof AlertVariant;
+
+    /**
+     * The timeout of the alert
+     */
+    timeout?: number | 'unlimited';
+    
 }
 
 export type FilterParams = {
@@ -107,10 +113,10 @@ export type FilterParams = {
 }
 
 export enum AlertVariant {
-    Danger = 'danger',
-    Success = 'success',
-    Warning = 'warning',
-    Info = 'info'
+    danger = 'danger',
+    success = 'success',
+    warning = 'warning',
+    info = 'info'
   }
 
 export type Operator = 'in' | 'ilike' | 'gte' | 'lte'  ;