adminforth 1.2.75 → 1.2.77

package/dist/modules/restApi.js

@@ -132,7 +132,7 @@ export default class AdminForthRestAPI {
             method: 'GET',
             path: '/get_base_config',
             handler: (_k) => __awaiter(this, [_k], void 0, function* ({ input, adminUser, cookies }) {
-                var _l, _m, _o;
+                var _l, _m, _o, _p, _q;
                 let username = '';
                 let userFullName = '';
                 if (adminUser.isRoot) {
@@ -180,6 +180,7 @@ export default class AdminForthRestAPI {
                     }
                     newMenu.push(newMenuItem);
                 }
+                const announcementBadge = (_o = (_m = this.adminforth.config.customization).announcementBadge) === null || _o === void 0 ? void 0 : _o.call(_m, adminUser);
                 return {
                     user: userData,
                     resources: this.adminforth.config.resources.map((res) => ({
@@ -194,8 +195,9 @@ export default class AdminForthRestAPI {
                         deleteConfirmation: this.adminforth.config.deleteConfirmation,
                         auth: this.adminforth.config.auth,
                         usernameField: this.adminforth.config.auth.usernameField,
-                        title: (_m = this.adminforth.config.customization) === null || _m === void 0 ? void 0 : _m.title,
-                        emptyFieldPlaceholder: (_o = this.adminforth.config.customization) === null || _o === void 0 ? void 0 : _o.emptyFieldPlaceholder,
+                        title: (_p = this.adminforth.config.customization) === null || _p === void 0 ? void 0 : _p.title,
+                        emptyFieldPlaceholder: (_q = this.adminforth.config.customization) === null || _q === void 0 ? void 0 : _q.emptyFieldPlaceholder,
+                        announcementBadge,
                     },
                     adminUser,
                     version: ADMINFORTH_VERSION,
@@ -234,7 +236,7 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/get_resource',
-            handler: (_p) => __awaiter(this, [_p], void 0, function* ({ body, adminUser }) {
+            handler: (_r) => __awaiter(this, [_r], void 0, function* ({ body, adminUser }) {
                 const { resourceId } = body;
                 if (!this.adminforth.statuses.dbDiscover) {
                     return { error: 'Database discovery not started' };
@@ -265,8 +267,8 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/get_resource_data',
-            handler: (_q) => __awaiter(this, [_q], void 0, function* ({ body, adminUser }) {
-                var _r, _s, _t, _u;
+            handler: (_s) => __awaiter(this, [_s], void 0, function* ({ body, adminUser }) {
+                var _t, _u, _v, _w;
                 const { resourceId, source } = body;
                 if (['show', 'list'].includes(source) === false) {
                     return { error: 'Invalid source, should be list or show' };
@@ -286,7 +288,7 @@ export default class AdminForthRestAPI {
                 if (!allowed) {
                     return { error };
                 }
-                for (const hook of listify((_s = (_r = resource.hooks) === null || _r === void 0 ? void 0 : _r[source]) === null || _s === void 0 ? void 0 : _s.beforeDatasourceRequest)) {
+                for (const hook of listify((_u = (_t = resource.hooks) === null || _t === void 0 ? void 0 : _t[source]) === null || _u === void 0 ? void 0 : _u.beforeDatasourceRequest)) {
                     const resp = yield hook({ resource, query: body, adminUser });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook must return object with {ok: true} or { error: 'Error' } `);
@@ -365,7 +367,7 @@ export default class AdminForthRestAPI {
                     item._label = resource.recordLabel(item);
                 });
                 // only after adminforth made all post processing, give user ability to edit it
-                for (const hook of listify((_u = (_t = resource.hooks) === null || _t === void 0 ? void 0 : _t[source]) === null || _u === void 0 ? void 0 : _u.afterDatasourceResponse)) {
+                for (const hook of listify((_w = (_v = resource.hooks) === null || _v === void 0 ? void 0 : _v[source]) === null || _w === void 0 ? void 0 : _w.afterDatasourceResponse)) {
                     const resp = yield hook({ resource, response: data.data, adminUser });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook must return object with {ok: true} or { error: 'Error' } `);
@@ -380,8 +382,8 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/get_resource_foreign_data',
-            handler: (_v) => __awaiter(this, [_v], void 0, function* ({ body, adminUser }) {
-                var _w, _x, _y, _z;
+            handler: (_x) => __awaiter(this, [_x], void 0, function* ({ body, adminUser }) {
+                var _y, _z, _0, _1;
                 const { resourceId, column } = body;
                 if (!this.adminforth.statuses.dbDiscover) {
                     return { error: 'Database discovery not started' };
@@ -402,7 +404,7 @@ export default class AdminForthRestAPI {
                 }
                 const targetResourceId = columnConfig.foreignResource.resourceId;
                 const targetResource = this.adminforth.config.resources.find((res) => res.resourceId == targetResourceId);
-                for (const hook of listify((_x = (_w = columnConfig.foreignResource.hooks) === null || _w === void 0 ? void 0 : _w.dropdownList) === null || _x === void 0 ? void 0 : _x.beforeDatasourceRequest)) {
+                for (const hook of listify((_z = (_y = columnConfig.foreignResource.hooks) === null || _y === void 0 ? void 0 : _y.dropdownList) === null || _z === void 0 ? void 0 : _z.beforeDatasourceRequest)) {
                     const resp = yield hook({ query: body, adminUser, resource: targetResource });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook must return object with {ok: true} or { error: 'Error' } `);
@@ -431,7 +433,7 @@ export default class AdminForthRestAPI {
                 const response = {
                     items
                 };
-                for (const hook of listify((_z = (_y = columnConfig.foreignResource.hooks) === null || _y === void 0 ? void 0 : _y.dropdownList) === null || _z === void 0 ? void 0 : _z.afterDatasourceResponse)) {
+                for (const hook of listify((_1 = (_0 = columnConfig.foreignResource.hooks) === null || _0 === void 0 ? void 0 : _0.dropdownList) === null || _1 === void 0 ? void 0 : _1.afterDatasourceResponse)) {
                     const resp = yield hook({ response, adminUser, resource: targetResource });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook must return object with {ok: true} or { error: 'Error' } `);
@@ -446,7 +448,7 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/get_min_max_for_columns',
-            handler: (_0) => __awaiter(this, [_0], void 0, function* ({ body }) {
+            handler: (_2) => __awaiter(this, [_2], void 0, function* ({ body }) {
                 const { resourceId } = body;
                 if (!this.adminforth.statuses.dbDiscover) {
                     return { error: 'Database discovery not started' };
@@ -475,7 +477,7 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/create_record',
-            handler: (_1) => __awaiter(this, [_1], void 0, function* ({ body, adminUser }) {
+            handler: (_3) => __awaiter(this, [_3], void 0, function* ({ body, adminUser }) {
                 const resource = this.adminforth.config.resources.find((res) => res.resourceId == body['resourceId']);
                 if (!resource) {
                     return { error: `Resource '${body['resourceId']}' not found` };
@@ -499,8 +501,8 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/update_record',
-            handler: (_2) => __awaiter(this, [_2], void 0, function* ({ body, adminUser }) {
-                var _3, _4, _5, _6;
+            handler: (_4) => __awaiter(this, [_4], void 0, function* ({ body, adminUser }) {
+                var _5, _6, _7, _8;
                 const resource = this.adminforth.config.resources.find((res) => res.resourceId == body['resourceId']);
                 if (!resource) {
                     return { error: `Resource '${body['resourceId']}' not found` };
@@ -519,7 +521,7 @@ export default class AdminForthRestAPI {
                     return { error };
                 }
                 // execute hook if needed
-                for (const hook of listify((_4 = (_3 = resource.hooks) === null || _3 === void 0 ? void 0 : _3.edit) === null || _4 === void 0 ? void 0 : _4.beforeSave)) {
+                for (const hook of listify((_6 = (_5 = resource.hooks) === null || _5 === void 0 ? void 0 : _5.edit) === null || _6 === void 0 ? void 0 : _6.beforeSave)) {
                     const resp = yield hook({ resource, record, adminUser });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);
@@ -546,7 +548,7 @@ export default class AdminForthRestAPI {
                     yield connector.updateRecord({ resource, recordId, newValues });
                 }
                 // execute hook if needed
-                for (const hook of listify((_6 = (_5 = resource.hooks) === null || _5 === void 0 ? void 0 : _5.edit) === null || _6 === void 0 ? void 0 : _6.afterSave)) {
+                for (const hook of listify((_8 = (_7 = resource.hooks) === null || _7 === void 0 ? void 0 : _7.edit) === null || _8 === void 0 ? void 0 : _8.afterSave)) {
                     const resp = yield hook({ resource, record, adminUser, oldRecord });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);
@@ -563,8 +565,8 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/delete_record',
-            handler: (_7) => __awaiter(this, [_7], void 0, function* ({ body, adminUser }) {
-                var _8, _9, _10, _11;
+            handler: (_9) => __awaiter(this, [_9], void 0, function* ({ body, adminUser }) {
+                var _10, _11, _12, _13;
                 const resource = this.adminforth.config.resources.find((res) => res.resourceId == body['resourceId']);
                 const record = yield this.adminforth.connectors[resource.dataSource].getRecordByPrimaryKey(resource, body['primaryKey']);
                 if (!resource) {
@@ -582,7 +584,7 @@ export default class AdminForthRestAPI {
                     return { error };
                 }
                 // execute hook if needed
-                for (const hook of listify((_9 = (_8 = resource.hooks) === null || _8 === void 0 ? void 0 : _8.delete) === null || _9 === void 0 ? void 0 : _9.beforeSave)) {
+                for (const hook of listify((_11 = (_10 = resource.hooks) === null || _10 === void 0 ? void 0 : _10.delete) === null || _11 === void 0 ? void 0 : _11.beforeSave)) {
                     const resp = yield hook({ resource, record, adminUser });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook beforeSave must return object with {ok: true} or { error: 'Error' } `);
@@ -594,7 +596,7 @@ export default class AdminForthRestAPI {
                 const connector = this.adminforth.connectors[resource.dataSource];
                 yield connector.deleteRecord({ resource, recordId: body['primaryKey'] });
                 // execute hook if needed
-                for (const hook of listify((_11 = (_10 = resource.hooks) === null || _10 === void 0 ? void 0 : _10.delete) === null || _11 === void 0 ? void 0 : _11.afterSave)) {
+                for (const hook of listify((_13 = (_12 = resource.hooks) === null || _12 === void 0 ? void 0 : _12.delete) === null || _13 === void 0 ? void 0 : _13.afterSave)) {
                     const resp = yield hook({ resource, record, adminUser });
                     if (!resp || (!resp.ok && !resp.error)) {
                         throw new Error(`Hook afterSave must return object with {ok: true} or { error: 'Error' } `);
@@ -611,7 +613,7 @@ export default class AdminForthRestAPI {
         server.endpoint({
             method: 'POST',
             path: '/start_bulk_action',
-            handler: (_12) => __awaiter(this, [_12], void 0, function* ({ body, adminUser }) {
+            handler: (_14) => __awaiter(this, [_14], void 0, function* ({ body, adminUser }) {
                 const { resourceId, actionId, recordIds } = body;
                 const resource = this.adminforth.config.resources.find((res) => res.resourceId == resourceId);
                 if (!resource) {

package/modules/restApi.ts

@@ -207,6 +207,8 @@ export default class AdminForthRestAPI {
           newMenu.push(newMenuItem)
         }
 
+        const announcementBadge = this.adminforth.config.customization.announcementBadge?.(adminUser);
+
         return {
           user: userData,
           resources: this.adminforth.config.resources.map((res) => ({
@@ -223,6 +225,7 @@ export default class AdminForthRestAPI {
             usernameField: this.adminforth.config.auth.usernameField,
             title: this.adminforth.config.customization?.title,
             emptyFieldPlaceholder: this.adminforth.config.customization?.emptyFieldPlaceholder,
+            announcementBadge,
           },
           adminUser,
           version: ADMINFORTH_VERSION,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adminforth",
-  "version": "1.2.75",
+  "version": "1.2.77",
   "description": "OpenSource Vue3 powered forth-generation admin panel",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
     "rollout": "tsc && npm version patch && npm publish && npm run rollout-doc",
     "rollout-doc": "cd documentation && npm run build && npm run deploy",
     "docs": "typedoc",
-    "postinstall": "cd spa/src && ln -sf ../../types types"
+    "postinstall": "cd ./spa/src/ && test ! -d ./types && ln -sf ../../types ./types || echo 'types linked'"
   },
   "author": "devforth.io",
   "license": "ISC",

package/spa/src/App.vue

@@ -8,7 +8,7 @@
         <div class="flex items-center justify-between">
           <div class="flex items-center justify-start rtl:justify-end">
             <button @click="sideBarOpen = !sideBarOpen"
-            type="button" class="inline-flex items-center p-2 text-sm  rounded-lg sm:hidden hover:bg-lightSidebarItemHover focus:outline-none focus:ring-2 focus:ring-lightSidebarDevider dark:text-darkSidebarIcons dark:hover:bg-darkSidebarHover dark:focus:ring-lightSidebarDevider">
+              type="button" class="inline-flex items-center p-2 text-sm  rounded-lg sm:hidden hover:bg-lightSidebarItemHover focus:outline-none focus:ring-2 focus:ring-lightSidebarDevider dark:text-darkSidebarIcons dark:hover:bg-darkSidebarHover dark:focus:ring-lightSidebarDevider">
                 <span class="sr-only">Open sidebar</span>
                 <svg class="w-6 h-6" aria-hidden="true" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
                   <path clip-rule="evenodd" fill-rule="evenodd" d="M2 4.75A.75.75 0 012.75 4h14.5a.75.75 0 010 1.5H2.75A.75.75 0 012 4.75zm0 10.5a.75.75 0 01.75-.75h7.5a.75.75 0 010 1.5h-7.5a.75.75 0 01-.75-.75zM2 10a.75.75 0 01.75-.75h14.5a.75.75 0 010 1.5H2.75A.75.75 0 012 10z"></path>
@@ -73,38 +73,66 @@
           </span>
         </div>
 
-          <ul class="space-y-2 font-medium">
-            <template v-for="(item, i) in coreStore.menu" :key="`menu-${i}`">
-              <div v-if="item.type === 'divider'" class="border-t border-lightSidebarDevider dark:border-darkSidebarDevider"></div>
-              <div v-else-if="item.type === 'gap'" class="flex items-center justify-center h-8"></div>
-              <div v-else-if="item.type === 'heading'" class="flex items-center justify-left pl-2 h-8 text-lightSidebarHeading dark:text-darkSidebarHeading
-              ">{{ item.label }}</div>
-              <li v-else-if="item.children" class="  ">
-                <button @click="clickOnMenuItem(i)" type="button" class="flex items-center w-full p-2 text-base text-lightSidebarText rounded-default transition duration-75  group hover:bg-lightSidebarItemHover hover:text-lightSidebarTextHover dark:text-darkSidebarText dark:hover:bg-darkSidebarHover dark:hover:text-darkSidebarTextHover" 
-                    :aria-controls="`dropdown-example${i}`"
-                    :data-collapse-toggle="`dropdown-example${i}`"
-                >
-                  <component v-if="item.icon" :is="getIcon(item.icon)" class="w-5 h-5 text-lightSidebarIcons group-hover:text-lightSidebarIconsHover transition duration-75    dark:group-hover:text-darkSidebarIconsHover dark:text-darkSidebarIcons" ></component>
-
-                  <span class="flex-1 ms-3 text-left rtl:text-right whitespace-nowrap">{{ item.label }}</span>
-                  <svg :class="{'rotate-180':  opened.includes(i) }" class="w-3 h-3" aria-hidden="true" xmlns="http://www.w3.org/2000/svg"  fill="none" viewBox="0 0 10 6">
-                      <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="m1 1 4 4 4-4"/>
-                  </svg>
-                </button>
+        <ul class="space-y-2 font-medium">
+          <template v-for="(item, i) in coreStore.menu" :key="`menu-${i}`">
+            <div v-if="item.type === 'divider'" class="border-t border-lightSidebarDevider dark:border-darkSidebarDevider"></div>
+            <div v-else-if="item.type === 'gap'" class="flex items-center justify-center h-8"></div>
+            <div v-else-if="item.type === 'heading'" class="flex items-center justify-left pl-2 h-8 text-lightSidebarHeading dark:text-darkSidebarHeading
+            ">{{ item.label }}</div>
+            <li v-else-if="item.children" class="  ">
+              <button @click="clickOnMenuItem(i)" type="button" class="flex items-center w-full p-2 text-base text-lightSidebarText rounded-default transition duration-75  group hover:bg-lightSidebarItemHover hover:text-lightSidebarTextHover dark:text-darkSidebarText dark:hover:bg-darkSidebarHover dark:hover:text-darkSidebarTextHover" 
+                  :aria-controls="`dropdown-example${i}`"
+                  :data-collapse-toggle="`dropdown-example${i}`"
+              >
+                <component v-if="item.icon" :is="getIcon(item.icon)" class="w-5 h-5 text-lightSidebarIcons group-hover:text-lightSidebarIconsHover transition duration-75    dark:group-hover:text-darkSidebarIconsHover dark:text-darkSidebarIcons" ></component>
+
+                <span class="flex-1 ms-3 text-left rtl:text-right whitespace-nowrap">{{ item.label }}</span>
+                <svg :class="{'rotate-180':  opened.includes(i) }" class="w-3 h-3" aria-hidden="true" xmlns="http://www.w3.org/2000/svg"  fill="none" viewBox="0 0 10 6">
+                    <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="m1 1 4 4 4-4"/>
+                </svg>
+              </button>
 
-                <ul :id="`dropdown-example${i}`" role="none" class="pt-1 space-y-1" :class="{ 'hidden': !opened.includes(i) }">
-                  <template v-for="(child, j) in item.children" :key="`menu-${i}-${j}`">
-                    <li>
-                      <MenuLink :item="child" isChild="true" />
-                    </li>
-                  </template>
-                </ul> 
-              </li>
-              <li v-else>
-                <MenuLink :item="item" />
-              </li>
-            </template>
-          </ul>
+              <ul :id="`dropdown-example${i}`" role="none" class="pt-1 space-y-1" :class="{ 'hidden': !opened.includes(i) }">
+                <template v-for="(child, j) in item.children" :key="`menu-${i}-${j}`">
+                  <li>
+                    <MenuLink :item="child" isChild="true" />
+                  </li>
+                </template>
+              </ul> 
+            </li>
+            <li v-else>
+              <MenuLink :item="item" />
+            </li>
+          </template>
+        </ul>
+
+
+        <div id="dropdown-cta" class="p-4 mt-6 rounded-lg bg-blue-50 dark:bg-blue-900" role="alert"
+          v-if="ctaBadge"
+        >
+          <div class="flex items-center mb-3">
+            <span class="bg-blue-200 text-blue-800 text-sm font-semibold me-2 px-2.5 py-0.5 rounded dark:bg-blue-200 dark:text-blue-800"
+              v-if="ctaBadge.title"
+            >
+              {{ctaBadge.title}}
+            </span>
+            <button type="button" 
+              class="ms-auto -mx-1.5 -my-1.5 bg-blue-50 inline-flex justify-center items-center w-6 h-6 text-blue-900 rounded-lg focus:ring-2 focus:ring-blue-400 p-1 hover:bg-blue-200 dark:bg-blue-900 dark:text-blue-400 dark:hover:bg-blue-800" 
+              data-dismiss-target="#dropdown-cta" aria-label="Close"
+              v-if="ctaBadge.closable" @click="closeCTA"
+            >
+              <span class="sr-only">Close</span>
+              <svg class="w-2.5 h-2.5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 14 14">
+                  <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="m1 1 6 6m0 0 6 6M7 7l6-6M7 7l-6 6"/>
+              </svg>
+            </button>
+          </div>
+          <p class="mb-3 text-sm fill-blue-800 dark:fill-blue-400 text-blue-800 dark:text-blue-400" v-if="ctaBadge.html" v-html="ctaBadge.html"></p>
+          <p class="text-sm text-blue-800 dark:text-blue-400" v-else>
+            {{ ctaBadge.text }}  
+          </p>
+          <!-- <a class="text-sm text-blue-800 underline font-medium hover:text-blue-900 dark:text-blue-400 dark:hover:text-blue-300" href="#">Turn new navigation off</a> -->
+        </div>
       </div>
     </aside>
     
@@ -311,4 +339,18 @@ onBeforeMount(()=>{
   document.documentElement.classList.toggle('dark', theme.value === 'dark');
 })
 
+
+const ctaBadge = computed(() => {
+  const badge = coreStore.config?.announcementBadge;
+  const hash = badge.closable ? JSON.stringify(badge).split('').reduce((a,b)=>{a=((a<<5)-a)+b.charCodeAt(0);return a&a},0) : '';
+  if (badge.closable && window.localStorage.getItem(`ctaBadge-${hash}`)) {
+    return null;
+  }
+  return {...badge, hash};
+});
+
+function closeCTA() {
+  const hash = ctaBadge.value.hash;
+  window.localStorage.setItem(`ctaBadge-${hash}`, '1');
+}
 </script>

package/spa/src/router/index.ts

@@ -1,6 +1,6 @@
-import { createRouter, createWebHistory } from 'vue-router'
-import ResourceParent from '@/views/ResourceParent.vue'
-import { useUserStore } from '@/stores/user'
+import { createRouter, createWebHistory } from 'vue-router';
+import ResourceParent from '@/views/ResourceParent.vue';
+import { useFiltersStore } from '@/stores/filters';
 /* IMPORTANT:ADMINFORTH ROUTES IMPORTS */
 
 const router = createRouter({
@@ -51,13 +51,17 @@ const router = createRouter({
 
         },
       ]
-    }, 
+    },
     /* IMPORTANT:ADMINFORTH ROUTES */
   ]
 })
 
-
-
-
+router.beforeEach((to, from, next) => {
+  const filterStore = useFiltersStore();
+  if (to.path.startsWith('/resource/')) {
+    filterStore.clearFilters();
+  }
+  next()
+})
 
 export default router

package/spa/src/stores/filters.ts

@@ -1,9 +1,8 @@
-import { ref } from 'vue'
-import { defineStore } from 'pinia'
-import { callAdminForthApi } from '@/utils';
+import { ref, type Ref } from 'vue';
+import { defineStore } from 'pinia';
 
 export const useFiltersStore = defineStore('filters', () => {
-    const filters = ref([]);
+    const filters: Ref<any[]> = ref([]);
     const setFilter = (filter: any) => {
         filters.value = [...filters.value, filter];
     }
@@ -16,7 +15,5 @@ export const useFiltersStore = defineStore('filters', () => {
     const clearFilters = () => {
         filters.value = [];
     }
-    return {setFilter, getFilters,clearFilters, filters,setFilters}
-    })
-
-    
+    return {setFilter, getFilters, clearFilters, filters, setFilters}
+})

package/types/AdminForthConfig.ts

@@ -798,7 +798,9 @@ export type AdminForthResource = {
      */
     columns: Array<AdminForthResourceColumn>,
 
-    
+    /**
+     * Internal array of columns which are not virtual. You should not edit it. 
+     */
     dataSourceColumns?: Array<AdminForthResourceColumn>,  // TODO, mark as private
 
     /**
@@ -818,25 +820,79 @@ export type AdminForthResource = {
      * 
      */
     plugins?: Array<IAdminForthPlugin>,
+
+    /**
+     * Hooks allow you to change the data on different stages of resource lifecycle.
+     * Hooks are functions which will be called on backend side (only backend side).
+     */
     hooks?: {
       show?: {
+        /**
+         * Typical usecases: 
+         * - request additional data from database before returning to frontend for soft-join 
+         */
         beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+
+        /**
+         * Typical usecases:
+         * - Transform value for some field for record returned from database before returning to frontend (minimize, sanitize, etc)
+         * - If some-why you can't use `backendOnly` you can cleanup sensitive fields here
+         * - Attach additional data to record before returning to frontend 
+         */
         afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
       list?: {
+        /**
+         * Typical usecases:
+         * - add additional filters in addition to what user selected before fetching data from database.
+         * - same as hooks.show.beforeDatasourceRequest 
+         */
         beforeDatasourceRequest?: BeforeDataSourceRequestFunction | Array<BeforeDataSourceRequestFunction>,
+
+        /**
+         * Typical usecases:
+         * - Same as hooks.show.afterDatasourceResponse but applied for each record in list
+         */
         afterDatasourceResponse?: AfterDataSourceResponseFunction | Array<AfterDataSourceResponseFunction>,
       },
       create?: {
+        /**
+         * Typical usecases:
+         * - Validate record before saving to database and interrupt execution if validation failed (`allowedActions.create` should be preferred in most cases)
+         * - fill-in adminUser as creator of record
+         * - Attach additional data to record before saving to database (mostly fillOnCreate should be used instead)
+         */
         beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+
+        /**
+         * Typical usecases:
+         * - Initiate some trigger after record saved to database (e.g sync to another datasource)
+         */
         afterSave?: AfterSaveFunction | Array<AfterSaveFunction>,
       },
       edit?: {
+        /**
+         * Typical usecases:
+         * - Same as hooks.create.beforeSave but for edit page
+         */
         beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+
+        /**
+         * Typical usecases:
+         * - Same as hooks.create.afterSave but for edit page
+         */
         afterSave?: AfterSaveFunction | Array<AfterSaveFunction>,
       },
       delete?: {
+        /**
+         * Typical usecases:
+         * - Validate that record can be deleted and interrupt execution if validation failed (`allowedActions.delete` should be preferred in most cases)
+         */
         beforeSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
+        /**
+         * Typical usecases:
+         * - Initiate some trigger after record deleted from database (e.g sync to another datasource)
+         */
         afterSave?: BeforeSaveFunction | Array<BeforeSaveFunction>,
       },
     },
@@ -1050,7 +1106,6 @@ export type AdminForthConfig = {
        * Function or functions  which will be called before user try to login.
        * Each function will resive User object as an argument
        */
-
       beforeLoginConfirmation?: BeforeLoginConfirmationFunction | Array<BeforeLoginConfirmationFunction>,
 
       /**
@@ -1205,14 +1260,21 @@ export type AdminForthConfig = {
        * Object to redefine default styles for AdminForth components.  Use this file as reference for all possible adjustments https://github.com/devforth/adminforth/blob/main/adminforth/modules/styles.ts
        */
       styles?: Object,
+
       /**
        * Description of custom pages which will let register custom pages for custom routes in AdminForth.
        */
-
       customPages?: Array<{
         path: string,
         component: AdminForthComponentDeclaration,
       }>,
+
+      /**
+       * Function to return custom badge in side bar for users. Can return text or html
+       * If function is not passed or returns null, badge will not be shown.
+       * Execution is done on admin app load. 
+       */
+      announcementBadge?: (user: AdminUser) => { text?: string, html?: string, closable?: boolean, title?: string } | null,
     }
 
     /**
@@ -1224,7 +1286,8 @@ export type AdminForthConfig = {
      * 
      */
     baseUrl?: string,
-   
+    
+    
     deleteConfirmation?: boolean,