Merge pull request #302 from devforth/hide-columns-by-showIn

feat: filter returned fields based on column showIn visibility

Author: ivictbor

adminforth/modules/restApi.ts

@@ -29,10 +29,11 @@ export async function interpretResource(
   meta: any, 
   source: ActionCheckSource, 
   adminforth: IAdminForth
-): Promise<{allowedActions: AllowedActionsResolved}> {
+): Promise<{ allowedActions: AllowedActionsResolved; visibleColumns: Record<string, boolean> }> {
   if (process.env.HEAVY_DEBUG) {
     console.log('🪲Interpreting resource', resource.resourceId, source, 'adminUser', adminUser);
   }
+
   const allowedActions = {} as AllowedActionsResolved;
 
   // we need to compute only allowed actions for this source:
@@ -61,8 +62,6 @@ export async function interpretResource(
           allowedActions[key] = false;
           return;
         }
-      
-        // if callable then call
         if (typeof value === 'function') {
           allowedActions[key] = await value({ adminUser, resource, meta, source, adminforth });
         } else {
@@ -71,7 +70,47 @@ export async function interpretResource(
       })
   );
 
-  return { allowedActions };
+  const resolveVisible = async (val: any): Promise<boolean> => {
+    if (typeof val === 'boolean') return val;
+    if (typeof val === 'function') {
+      const r = val({ adminUser, resource, meta, source, adminforth });
+      return r instanceof Promise ? await r : !!r;
+    }
+    return true;
+  };
+
+  const pageMap = {
+    [ActionCheckSource.ListRequest]: 'list',
+    [ActionCheckSource.ShowRequest]: 'show',
+    [ActionCheckSource.EditLoadRequest]: 'edit',
+  } as const;
+  
+  const page = pageMap[source as keyof typeof pageMap] as ('list'|'show'|'edit') | undefined;
+  
+  if (!page) {
+    return { allowedActions, visibleColumns: {} };
+  }
+
+  const isColumnVisible = async (col: any): Promise<boolean> => {
+    const si = col.showIn;
+    if (!si) return true;
+
+    if (Array.isArray(si)) {
+      return si.includes('all') || si.includes(page);
+    }
+
+    if (si[page] !== undefined) return await resolveVisible(si[page]);
+    if (si.all  !== undefined)  return await resolveVisible(si.all);
+    return true;
+  };
+
+  const visibleColumnsEntries = await Promise.all(
+    resource.columns.map(async (col) => [col.name, await isColumnVisible(col)] as const)
+  );
+
+  const visibleColumns = Object.fromEntries(visibleColumnsEntries) as Record<string, boolean>;
+
+  return { allowedActions, visibleColumns };
 }
 
 export default class AdminForthRestAPI implements IAdminForthRestAPI {
@@ -602,7 +641,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           meta.pk = body.filters.find((f) => f.field === resource.columns.find((col) => col.primaryKey).name)?.value;
         }
 
-        const { allowedActions } = await interpretResource(
+        const { allowedActions, visibleColumns } = await interpretResource(
           adminUser,
           resource,
           meta,
@@ -804,7 +843,8 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
         // remove all columns which are not defined in resources, or defined but backendOnly
         data.data.forEach((item) => {
           Object.keys(item).forEach((key) => {
-            if (!resource.columns.find((col) => col.name === key) || resource.columns.find((col) => col.name === key && col.backendOnly)) {
+            console.log(visibleColumns?.[key], key);
+            if (!resource.columns.find((col) => col.name === key) || resource.columns.find((col) => col.name === key && col.backendOnly) || visibleColumns?.[key] === false ) {
               delete item[key];
             }
           })