adminforth 1.6.2-next.3 → 1.6.2-next.5

package/dist/spa/src/types/FrontendAPI.ts

@@ -0,0 +1,189 @@
+import type { AdminForthFilterOperators } from "./Common.js";
+
+ 
+
+export type FilterParams = {
+    /**
+     * Field of resource to filter
+     */
+    field: string;
+    /**
+     * Operator of filter
+     */
+    operator: AdminForthFilterOperators;
+    /**
+     * Value of filter
+     */
+    value: string | number | boolean ;
+} 
+
+export interface FrontendAPIInterface {
+
+    /**
+     * Show a confirmation dialog
+     * 
+     * The dialog will be displayed to the user
+     * 
+     * Example: 
+     * 
+     * ```ts
+     * import adminforth from '@/adminforth'
+     * 
+     * const isConfirmed = await adminforth.confirm({message: 'Are you sure?', yes: 'Yes', no: 'No'})
+     * if (isConfirmed) {
+     *  your code...
+     * }
+     * ```
+     * 
+     * @param params - The parameters of the dialog
+     * @returns A promise that resolves when the user confirms the dialog
+     */   
+    confirm(params:ConfirmParams ): Promise<void>;
+    
+    /**
+     * Show an alert
+     * 
+     * The alert will be displayed to the user
+     * 
+     * Example:
+     * 
+     * ```ts
+     * import adminforth from '@/adminforth'
+     * 
+     * adminforth.alert({message: 'Hello', variant: 'success'})
+     * ```
+     * 
+     * @param params - The parameters of the alert
+     */
+    alert(params:AlertParams): void;
+
+
+    list: {
+
+        /**
+         * Full refresh the list. Loader will be shown during fetching data. Will fully reload table data from the server. If new data available, it will be shown in the list.
+         */
+        refresh(): Promise<{ error? : string }>;
+
+        /**
+         * Silently Refresh existing rows in the list (without loader). 
+         * Should be called when table data already loaded, otherwise method will return an error.
+         * If new data available, it will not appear in the list.
+         */
+        silentRefresh(): Promise<{ error? : string }>;
+
+        /**
+         * Refresh a specific row in the list without loader, row should be already shown in the list, otherwise method will return an error
+         */
+        silentRefreshRow (pk: any): Promise<{ error? : string }>;
+
+        /**
+         * Close the three dots dropdown
+         */
+        closeThreeDotsDropdown(): void;
+
+
+        /**
+         * Set a filter in the list
+         * Works only when user located on the list page.
+         * Can be used to set filter from charts or other components in pageInjections.
+         * 
+         * Example:
+         * 
+         * ```ts
+         * import adminforth from '@/adminforth'
+         * 
+         * adminforth.list.setFilter({field: 'name', operator: 'ilike', value: 'john'})
+         * ```
+         * 
+         * @param filter - The filter to set
+         */
+        setFilter(filter: FilterParams): void;
+
+        /**
+         * Update a filter in the list
+         * 
+         * Example:
+         * 
+         * ```ts
+         * import adminforth from '@/adminforth';
+         * 
+         * adminforth.list.updateFilter({field: 'name', operator: 'ilike', value: 'john'})
+         * ```
+         * 
+         * @param filter - The filter to update
+         */
+        updateFilter(filter: FilterParams): void;
+
+        /**
+         * Clear all filters from the list
+         */
+        clearFilters(): void;
+    }
+
+    menu: {
+        /**
+         * Refreshes the badges in the menu, by recalling the badge function for each menu item
+         */
+        refreshMenuBadges(): void;
+    }
+
+    /**
+     * Close the user menu dropdown
+     */
+    closeUserMenuDropdown(): void;
+}
+
+export type ConfirmParams = {
+    /**
+     * The message to display in the dialog
+     */
+    message?: string;
+    /**
+     * The text to display in the "accept" button
+     */
+    yes?: string;
+    /**
+     * The text to display in the "cancel" button
+     */
+    no?: string;
+   
+}
+
+export type AlertParams = {
+    /**
+     * The message to display in the alert
+     */
+    message?: string;
+
+    /**
+     * The message to display in the alert as HTML (can be used instead of message)
+     */
+    messageHtml?: string;
+    
+    /**
+     * The variant of the alert
+     */
+    variant?: AlertVariant | keyof typeof AlertVariant;
+
+    /**
+     * The timeout of the alert in seconds or 'unlimited' to keep the alert open until the user closes it.
+     * Default is 10 seconds;
+     */
+    timeout?: number | 'unlimited';
+    
+}
+
+
+
+export enum AlertVariant {
+    danger = 'danger',
+    success = 'success',
+    warning = 'warning',
+    info = 'info'
+  }
+
+  
+  
+
+

package/dist/spa/src/utils.ts

@@ -0,0 +1,184 @@
+import { onMounted, ref, resolveComponent } from 'vue';
+import type { CoreConfig } from './spa_types/core';
+import type { ValidationObject } from './types/AdminForthConfig';
+import router from "./router";
+import { useCoreStore } from './stores/core';
+import { useUserStore } from './stores/user';
+import { Dropdown } from 'flowbite';
+import adminforth from './adminforth';
+
+const LS_LANG_KEY = `afLanguage`;
+
+export async function callApi({path, method, body=undefined}: {
+  path: string, method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' 
+  body?: any
+}): Promise<any> {
+  const options = {
+    method,
+    headers: {
+      'Content-Type': 'application/json',
+      'accept-language': localStorage.getItem(LS_LANG_KEY) || 'en',
+    },
+    body: JSON.stringify(body),
+  };
+  const fullPath = `${import.meta.env.VITE_ADMINFORTH_PUBLIC_PATH || ''}${path}`;
+  try {
+    const r = await fetch(fullPath, options);
+    if (r.status == 401 ) {
+      useUserStore().unauthorize();
+      await router.push({ name: 'login' });
+      return null;
+    } 
+    return await r.json();
+  } catch(e){
+    adminforth.alert({variant:'danger', message: window.i18n?.global?.t('Something went wrong, please try again later'),})
+    console.error(`error in callApi ${path}`,e);
+  }
+}
+
+export async function callAdminForthApi({ path, method, body=undefined, headers=undefined }: {
+  path: string,
+  method: 'GET' | 'POST' | 'PUT' | 'DELETE',
+  body?: any,
+  headers?: Record<string, string>
+}): Promise<any> {
+  try {
+    return callApi({path: `/adminapi/v1${path}`, method, body} );
+  } catch (e) {
+    console.error('error', e);
+    return { error: `Unexpected error: ${e}` };
+  }
+}
+
+export function getCustomComponent({ file, meta }: { file: string, meta?: any }) {
+  const name = file.replace(/@/g, '').replace(/\./g, '').replace(/\//g, '');
+  return resolveComponent(name);
+}
+
+export function getIcon(icon: string) {
+  // icon format is "feather:icon-name". We need to get IconName in pascal case
+  if (!icon.includes(':')) {
+    throw new Error('Icon name should be in format "icon-set:icon-name"');
+  }
+  const [iconSet, iconName] = icon.split(':');
+  const compName = 'Icon' + iconName.split('-').map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join('');
+  return resolveComponent(compName);
+}
+
+export const loadFile = (file: string) => {
+  if (file.startsWith('http')) {
+    return file;
+  }
+  let path;
+  let baseUrl = '';
+  if (file.startsWith('@/')) {
+    path = file.replace('@/', '');
+    baseUrl = new URL(`./${path}`, import.meta.url).href;
+  } else if (file.startsWith('@@/')) {
+    path = file.replace('@@/', '');
+    baseUrl = new URL(`./custom/${path}`, import.meta.url).href;
+  } else {
+    baseUrl = new URL(`./${file}`, import.meta.url).href;
+  }
+  return baseUrl;
+}
+
+export function checkEmptyValues(value: any, viewType: 'show' | 'list' ) {
+  const config: CoreConfig | {} = useCoreStore().config;
+  let emptyFieldPlaceholder = '';
+  if (config.emptyFieldPlaceholder) {
+    if(typeof config.emptyFieldPlaceholder === 'string') {
+      emptyFieldPlaceholder = config.emptyFieldPlaceholder;
+    } else {
+       emptyFieldPlaceholder = config.emptyFieldPlaceholder?.[viewType] || '';
+    }
+    if (value === null || value === undefined || value === '') {
+      return emptyFieldPlaceholder;
+    }
+  }
+  return value;
+}
+
+export function checkAcessByAllowedActions(allowedActions:any, action:any ) {
+  if (!allowedActions) {
+    console.warn('allowedActions not set');
+    return;
+  }
+  if(allowedActions[action] === false) {
+    console.warn(`Action ${action} is not allowed`);
+    router.back();
+  }
+}
+
+export function initThreeDotsDropdown() {
+  const threeDotsDropdown: HTMLElement | null = document.querySelector('#listThreeDotsDropdown');
+  if (threeDotsDropdown) {
+    // this resource has three dots dropdown
+    const dd = new Dropdown(
+      threeDotsDropdown, 
+      document.querySelector('[data-dropdown-toggle="listThreeDotsDropdown"]') as HTMLElement, 
+    );
+    adminforth.list.closeThreeDotsDropdown = () => {
+      dd.hide();
+    }
+  }
+}
+
+export function applyRegexValidation(value: any, validation: ValidationObject[] | undefined) {
+
+  if ( validation?.length ) {
+    const validationArray = validation;
+    for (let i = 0; i < validationArray.length; i++) {
+      if (validationArray[i].regExp) {
+        let flags = '';
+        if (validationArray[i].caseSensitive) {
+          flags += 'i';
+        }
+        if (validationArray[i].multiline) {
+          flags += 'm';
+        }
+        if (validationArray[i].global) {
+          flags += 'g';
+        }
+
+        const regExp = new RegExp(validationArray[i].regExp, flags);
+        if (value === undefined || value === null) {
+          value = '';
+        }
+        let valueS = `${value}`;
+
+        if (!regExp.test(valueS)) {
+          return validationArray[i].message;
+        }
+      }
+    }
+  }
+}
+
+export function currentQuery() {
+  return router.currentRoute.value.query;
+}
+
+export function setQuery(query: any) {
+  const currentQuery = { ...router.currentRoute.value.query, ...query };
+  router.replace({
+    query: currentQuery,
+  });
+}
+
+export function verySimpleHash(str: string): string {
+  return `${str.split('').reduce((a, b)=>{a=((a<<5)-a)+b.charCodeAt(0);return a&a},0)}`;
+}
+
+export function humanifySize(size) {
+  if (!size) {
+    return '';
+  }
+  const units = ['B', 'KB', 'MB', 'GB', 'TB']
+  let i = 0
+  while (size >= 1024 && i < units.length - 1) {
+    size /= 1024
+    i++
+  }
+  return `${size.toFixed(1)} ${units[i]}`
+}

package/dist/spa/src/views/CreateView.vue

@@ -0,0 +1,167 @@
+<template>
+  <div class="relative w-full">
+
+    <component 
+      v-for="c in coreStore?.resourceOptions?.pageInjections?.create?.beforeBreadcrumbs || []"
+      :is="getCustomComponent(c)"
+      :meta="c.meta"
+      :record="coreStore.record"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+    />
+
+    <BreadcrumbsWithButtons>
+      <!-- save and cancle -->
+      <button @click="$router.back()"
+        class="flex items-center py-1 px-3 me-2 text-sm font-medium rounded-default text-gray-900 focus:outline-none bg-white rounded border border-gray-300 hover:bg-gray-100 hover:text-lightPrimary focus:z-10 focus:ring-4 focus:ring-gray-100 dark:focus:ring-gray-700 dark:bg-gray-800 dark:text-gray-400 dark:border-gray-600 dark:hover:text-white dark:hover:bg-gray-700"
+      >
+        {{ $t('Cancel') }}
+      </button>
+
+      <button  
+        @click="saveRecord"
+        class="flex items-center py-1 px-3 text-sm font-medium rounded-default text-red-600 focus:outline-none bg-white rounded border border-gray-300 hover:bg-gray-100 hover:text-red-700 focus:z-10 focus:ring-4 focus:ring-gray-100 dark:focus:ring-gray-700 dark:bg-gray-800 dark:text-red-500 dark:border-gray-600 dark:hover:text-white dark:hover:bg-gray-700 disabled:opacity-50"
+        :disabled="saving || (validating && !isValid)"
+      > 
+        <svg v-if="saving"
+         aria-hidden="true" class="w-4 h-4 mr-1 text-gray-200 animate-spin dark:text-gray-600 fill-red-600" viewBox="0 0 100 101" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z" fill="currentColor"/><path d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z" fill="currentFill"/></svg>
+        
+        <IconFloppyDiskSolid v-else class="w-4 h-4 mr-1" />
+        {{ $t('Save') }}
+      </button>
+
+      <ThreeDotsMenu 
+        :threeDotsDropdownItems="coreStore.resourceOptions?.pageInjections?.create?.threeDotsDropdownItems"
+      ></ThreeDotsMenu>
+
+    </BreadcrumbsWithButtons>
+
+    <component 
+      v-for="c in coreStore?.resourceOptions?.pageInjections?.create?.afterBreadcrumbs || []"
+      :is="getCustomComponent(c)"
+      :meta="c.meta"
+      :record="coreStore.record"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+    />
+
+    <SingleSkeletLoader v-if="loading"></SingleSkeletLoader>
+
+    
+    <ResourceForm 
+      v-else
+      :record="record"
+      :resource="coreStore.resource"
+      @update:record="onUpdateRecord"
+      @update:isValid="isValid = $event"
+      :validating="validating"
+      :source="'create'"
+    >
+    </ResourceForm>
+
+    <component 
+      v-for="c in coreStore?.resourceOptions?.pageInjections?.create?.bottom || []"
+      :is="getCustomComponent(c)"
+      :meta="c.meta"
+      :record="coreStore.record"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+    />
+
+  </div>
+</template>
+
+
+<script setup lang="ts">
+
+import BreadcrumbsWithButtons from '@/components/BreadcrumbsWithButtons.vue';
+import ResourceForm from '@/components/ResourceForm.vue';
+import SingleSkeletLoader from '@/components/SingleSkeletLoader.vue';
+import { useCoreStore } from '@/stores/core';
+import { callAdminForthApi, getCustomComponent,checkAcessByAllowedActions, initThreeDotsDropdown } from '@/utils';
+import { IconFloppyDiskSolid } from '@iconify-prerendered/vue-flowbite';
+import { onMounted, ref, watch } from 'vue';
+import { useRoute, useRouter } from 'vue-router';
+import { computed } from 'vue';
+import { showErrorTost } from '@/composables/useFrontendApi';
+import ThreeDotsMenu from '@/components/ThreeDotsMenu.vue';
+import adminforth from '@/adminforth';
+
+
+const isValid = ref(false);
+const validating = ref(false);
+
+const loading = ref(true);
+const saving = ref(false);
+
+const route = useRoute();
+const router = useRouter();
+
+const record = ref({});
+
+const coreStore = useCoreStore();
+
+const initalValues = computed(() => {
+  if (!route.query.values) {
+    return {};
+  }
+  return JSON.parse(decodeURIComponent(route.query.values));
+});
+
+
+async function onUpdateRecord(newRecord) {
+  console.log('newRecord', newRecord);
+  record.value = newRecord;
+}
+
+onMounted(async () => {
+  loading.value = true;
+  record.value = initalValues.value;
+  await coreStore.fetchResourceFull({
+    resourceId: route.params.resourceId
+  });
+  loading.value = false;
+  checkAcessByAllowedActions(coreStore.resourceOptions.allowedActions,'create');
+  initThreeDotsDropdown();
+});
+
+async function saveRecord() {
+  console.log('saveRecord isValid', isValid.value);
+  if (!isValid.value) {
+    validating.value = true;
+    return;
+  } else {
+    validating.value = false;
+  }
+  saving.value = true;
+  const response = await callAdminForthApi({
+    method: 'POST',
+    path: `/create_record`,
+    body: {
+      resourceId: route.params.resourceId,
+      record: record.value,
+    },
+  });
+  if (response?.error) {
+    showErrorTost(response.error);
+  }
+  saving.value = false;
+  if (route.query.returnTo) {
+    router.push(route.query.returnTo);
+  } else {
+    router.push({ 
+      name: 'resource-show', 
+      params: { 
+        resourceId: route.params.resourceId, 
+        primaryKey: response.newRecordId
+      } 
+    });
+    adminforth.alert({
+      message: 'Record created successfully',
+      variant: 'success'
+    });
+  }
+}
+
+
+</script>

package/dist/spa/src/views/EditView.vue

@@ -0,0 +1,171 @@
+<template>
+  <div class="relative w-full">
+    <component 
+      v-for="c in coreStore?.resourceOptions?.pageInjections?.edit?.beforeBreadcrumbs || []"
+      :is="getCustomComponent(c)"
+      :meta="c.meta"
+      :record="editableRecord"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+    />
+
+    <BreadcrumbsWithButtons>
+      <!-- save and cancle -->
+      <button @click="$router.back()"
+        class="flex items-center py-1 px-3 me-2 text-sm font-medium text-gray-900  rounded-default focus:outline-none bg-white rounded border border-gray-300 hover:bg-gray-100 hover:text-lightPrimary focus:z-10 focus:ring-4 focus:ring-gray-100 dark:focus:ring-gray-700 dark:bg-gray-800 dark:text-gray-400 dark:border-gray-600 dark:hover:text-white dark:hover:bg-gray-700"
+      >
+        {{ $t('Cancel') }}
+      </button>
+
+      <button
+        @click="saveRecord"
+        class="flex items-center py-1 px-3 text-sm font-medium  rounded-default text-red-600 focus:outline-none bg-white rounded border border-gray-300 hover:bg-gray-100 hover:text-red-700 focus:z-10 focus:ring-4 focus:ring-gray-100 dark:focus:ring-gray-700 dark:bg-gray-800 dark:text-red-500 dark:border-gray-600 dark:hover:text-white dark:hover:bg-gray-700 disabled:opacity-50"
+        :disabled="saving || (validating && !isValid)"
+      >
+        <IconFloppyDiskSolid class="w-4 h-4" />
+        {{ $t('Save') }}
+      </button>
+
+      <ThreeDotsMenu 
+        :threeDotsDropdownItems="coreStore.resourceOptions?.pageInjections?.edit?.threeDotsDropdownItems"
+      ></ThreeDotsMenu>
+
+    </BreadcrumbsWithButtons>
+
+    <component 
+      v-for="c in coreStore?.resourceOptions?.pageInjections?.edit?.afterBreadcrumbs || []"
+      :is="getCustomComponent(c)"
+      :meta="c.meta"
+      :record="coreStore.record"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+    />
+
+    <SingleSkeletLoader v-if="loading"></SingleSkeletLoader>
+
+    <ResourceForm 
+      v-else
+      :record="editableRecord"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+      @update:record="onUpdateRecord"
+      @update:isValid="isValid = $event"
+      :validating="validating"
+      :source="'edit'"
+    >
+    </ResourceForm>
+
+    <component 
+      v-for="c in coreStore?.resourceOptions?.pageInjections?.edit?.bottom || []"
+      :is="getCustomComponent(c)"
+      :meta="c.meta"
+      :record="coreStore.record"
+      :resource="coreStore.resource"
+      :adminUser="coreStore.adminUser"
+    />
+
+  </div>
+</template>
+
+
+<script setup lang="ts">
+
+import BreadcrumbsWithButtons from '@/components/BreadcrumbsWithButtons.vue';
+import ResourceForm from '@/components/ResourceForm.vue';
+import SingleSkeletLoader from '@/components/SingleSkeletLoader.vue';
+import { useCoreStore } from '@/stores/core';
+import { callAdminForthApi, getCustomComponent,checkAcessByAllowedActions, initThreeDotsDropdown } from '@/utils';
+import { IconFloppyDiskSolid } from '@iconify-prerendered/vue-flowbite';
+import { computed, onMounted, ref } from 'vue';
+import { useRoute, useRouter } from 'vue-router';
+import { showErrorTost } from '@/composables/useFrontendApi';
+import ThreeDotsMenu from '@/components/ThreeDotsMenu.vue';
+import adminforth from '@/adminforth';
+
+const coreStore = useCoreStore();
+
+const isValid = ref(false);
+const validating = ref(false);
+
+const route = useRoute();
+const router = useRouter();
+
+const loading = ref(true);
+
+const saving = ref(false);
+
+const record = ref({});
+
+async function onUpdateRecord(newRecord) {
+  record.value = newRecord;
+}
+
+const editableRecord = computed(() => {
+  const newRecord = { ...coreStore.record };
+  if (!coreStore.resource) {
+    return {};
+  }
+  coreStore.resource.columns.forEach(column => {
+    if (column.foreignResource) {
+      newRecord[column.name] = newRecord[column.name]?.pk
+    }
+  });
+  return newRecord;
+})
+
+onMounted(async () => {
+  loading.value = true;
+
+  await coreStore.fetchResourceFull({
+    resourceId: route.params.resourceId
+  });
+  initThreeDotsDropdown();
+
+  await coreStore.fetchRecord({
+    resourceId: route.params.resourceId, 
+    primaryKey: route.params.primaryKey,
+    source: 'edit',
+  });
+  checkAcessByAllowedActions(coreStore.resourceOptions.allowedActions,'edit');
+  loading.value = false;
+});
+
+async function saveRecord() {
+  if (!isValid.value) {
+    validating.value = true;
+    return;
+  } else {
+    validating.value = false;
+  }
+
+  saving.value = true;
+  const updates = {};
+  for (const key in record.value) {
+    if (record.value[key] !== coreStore.record[key]) {
+      updates[key] = record.value[key];
+    }
+  }
+
+  const resp = await callAdminForthApi({
+    method: 'POST',
+    path: `/update_record`,
+    body: {
+      resourceId: route.params.resourceId,
+      recordId: route.params.primaryKey,
+      record: updates,
+    },
+  });
+  if (resp.error) {
+    showErrorTost(resp.error);
+  } else {
+    adminforth.alert({
+      message: 'Record updated successfully',
+      variant: 'success',
+      timeout: 400000
+    });
+  }
+  saving.value = false;
+  router.push({ name: 'resource-show', params: { resourceId: route.params.resourceId, primaryKey: coreStore.record[coreStore.primaryKey] } });
+}
+
+</script>