feat: show warning on non "dataset" tabs (#899) (#3609)

Co-authored-by: Fran McDade <franmcdade@Frans-MacBook-Pro.local>

Author: frano-m

explorer/app/viewModelBuilders/azul/anvil-cmg/common/viewModelBuilders.ts

@@ -542,6 +542,26 @@ export const buildLibraryId = (
   };
 };
 
+/**
+ * Build props for list view access warning Alert component.
+ * @param _ - Unused.
+ * @param viewContext - View context.
+ * @returns model to be used as props for the Alert component.
+ */
+export const buildListWarning = (
+  _: Record<string, never>,
+  viewContext: ViewContext
+): React.ComponentProps<typeof C.Alert> => {
+  const {
+    entityConfig: { label },
+  } = viewContext;
+  return {
+    severity: "warning",
+    title: `For datasets with a 'Required' access status, ${label} are not listed.`,
+    variant: "banner",
+  };
+};
+
 /**
  * Build props for organism type cell component from the given donors response.
  * @param response - Response model return from index/donors API endpoint.

explorer/site-config/anvil-cmg/dev/index/activitiesEntityConfig.ts

@@ -11,6 +11,7 @@ import {
   ANVIL_CMG_CATEGORY_KEY,
   ANVIL_CMG_CATEGORY_LABEL,
 } from "../../category";
+import { listHero } from "../listView/listHero";
 
 /**
  * Entity config object responsible for config related to the /explore/activities route.
@@ -116,6 +117,9 @@ export const activitiesEntityConfig: EntityConfig<ActivitiesResponse> = {
       id: ANVIL_CMG_CATEGORY_KEY.ACTIVITY_DOCUMENT_ID,
     },
   } as ListConfig<ActivitiesResponse>,
+  listView: {
+    listHero,
+  },
   route: "activities",
   staticLoad: false,
 };

explorer/site-config/anvil-cmg/dev/index/biosamplesEntityConfig.ts

@@ -11,6 +11,7 @@ import {
   ANVIL_CMG_CATEGORY_KEY,
   ANVIL_CMG_CATEGORY_LABEL,
 } from "../../category";
+import { listHero } from "../listView/listHero";
 
 /**
  * Entity config object responsible for config related to the /explore/biosamples route.
@@ -106,6 +107,9 @@ export const biosamplesEntityConfig: EntityConfig<BioSamplesResponse> = {
       id: ANVIL_CMG_CATEGORY_KEY.BIOSAMPLE_BIOSAMPLE_ID,
     },
   } as ListConfig<BioSamplesResponse>,
+  listView: {
+    listHero,
+  },
   route: "biosamples",
   staticLoad: false,
 };

explorer/site-config/anvil-cmg/dev/index/donorsEntityConfig.ts

@@ -11,6 +11,7 @@ import {
   ANVIL_CMG_CATEGORY_KEY,
   ANVIL_CMG_CATEGORY_LABEL,
 } from "../../category";
+import { listHero } from "../listView/listHero";
 
 /**
  * Entity config object responsible for config related to the /explore/donors route.
@@ -86,6 +87,9 @@ export const donorsEntityConfig: EntityConfig<DonorsResponse> = {
       id: ANVIL_CMG_CATEGORY_KEY.DONOR_DONOR_ID,
     },
   } as ListConfig<DonorsResponse>,
+  listView: {
+    listHero,
+  },
   route: "donors",
   staticLoad: false,
 };

explorer/site-config/anvil-cmg/dev/index/filesEntityConfig.ts

@@ -12,6 +12,7 @@ import {
   ANVIL_CMG_CATEGORY_KEY,
   ANVIL_CMG_CATEGORY_LABEL,
 } from "../../category";
+import { listHero } from "../listView/listHero";
 
 export const downloadColumn: ColumnConfig = {
   componentConfig: {
@@ -130,6 +131,9 @@ export const filesEntityConfig: EntityConfig<FilesResponse> = {
       id: ANVIL_CMG_CATEGORY_KEY.FILE_FILE_NAME,
     },
   } as ListConfig<FilesResponse>,
+  listView: {
+    listHero,
+  },
   route: "files",
   staticLoad: false,
 };

explorer/site-config/anvil-cmg/dev/listView/listHero.ts

@@ -0,0 +1,13 @@
+import {
+  ComponentConfig,
+  ComponentsConfig,
+} from "../../../../../../data-explorer/packages/data-explorer-ui/src/config/entities";
+import * as C from "../../../../app/components";
+import * as T from "../../../../app/viewModelBuilders/azul/anvil-cmg/common/viewModelBuilders";
+
+export const listHero: ComponentsConfig = [
+  {
+    component: C.Alert,
+    viewBuilder: T.buildListWarning,
+  } as ComponentConfig<typeof C.Alert>,
+];