@databiosphere/findable-ui 32.1.1 → 34.0.0

package/src/components/DataDictionary/components/Entity/entity.tsx

@@ -4,28 +4,37 @@ import React from "react";
 import { Attribute } from "../../../../common/entities";
 import { TYPOGRAPHY_PROPS } from "../../../../styles/common/mui/typography";
 import { AnchorLink } from "../../../common/AnchorLink/anchorLink";
-import { useTable } from "../Table/hook";
 import { Table } from "../Table/table";
 import { GRID_PROPS } from "./constants";
 import { StyledTypography } from "./entity.styles";
 import { EntityProps } from "./types";
+import { getClassMeta } from "./utils";
 
 export const Entity = <T extends RowData = Attribute>({
-  class: cls,
-  columnDefs,
+  row,
   spacing,
-}: EntityProps<T>): JSX.Element => {
-  const table = useTable<T>(cls.attributes, columnDefs);
+  table,
+}: EntityProps<T>): JSX.Element | null => {
+  // Get class key from row.
+  const classKey = row.getValue<string>("classKey");
+
+  // Get class metadata from table options.
+  const cls = getClassMeta<T>(classKey, table);
+
+  // Class not found in table meta - return null.
+  if (!cls) return null;
+
   return (
     <Grid {...GRID_PROPS} rowGap={4}>
+      {/* Class title and description */}
       <Grid {...GRID_PROPS} rowGap={1}>
         <StyledTypography
           component="h3"
-          id={cls.name}
+          id={classKey}
           variant={TYPOGRAPHY_PROPS.VARIANT.TEXT_HEADING_SMALL}
           {...spacing}
         >
-          {cls.title} <AnchorLink anchorLink={cls.name} />
+          {cls.title} <AnchorLink anchorLink={classKey} />
         </StyledTypography>
         <Typography
           color={TYPOGRAPHY_PROPS.COLOR.INK_LIGHT}
@@ -35,7 +44,8 @@ export const Entity = <T extends RowData = Attribute>({
           {cls.description}
         </Typography>
       </Grid>
-      <Table table={table} />
+      {/* Class attributes table */}
+      <Table row={row} table={table} />
     </Grid>
   );
 };

package/src/components/DataDictionary/components/Entity/types.ts

@@ -1,9 +1,9 @@
-import { ColumnDef, RowData } from "@tanstack/react-table";
-import { Attribute, Class } from "../../../../common/entities";
+import { Row, RowData, Table } from "@tanstack/react-table";
+import { Attribute } from "../../../../common/entities";
 import { LayoutSpacing } from "../../hooks/UseLayoutSpacing/types";
 
 export interface EntityProps<T extends RowData = Attribute> {
-  class: Class<T>;
-  columnDefs: ColumnDef<T, T[keyof T]>[];
+  row: Row<T>;
   spacing?: LayoutSpacing;
+  table: Table<T>;
 }

package/src/components/DataDictionary/components/Entity/utils.ts

@@ -0,0 +1,25 @@
+import { RowData, Table } from "@tanstack/react-table";
+import { Attribute, Class } from "../../../../common/entities";
+import { ClassMeta } from "../Table/types";
+
+/**
+ * Retrieves class metadata from the table options meta.
+ * @param classKey - Class key.
+ * @param table - Table instance.
+ * @returns Class metadata or undefined.
+ */
+export function getClassMeta<T extends RowData = Attribute>(
+  classKey: string | undefined,
+  table: Table<T>
+): Pick<Class<T>, "description" | "title"> | undefined {
+  if (!classKey) return;
+
+  // Grab the table meta and return if not defined.
+  const meta = table.options.meta;
+  if (!meta) return;
+
+  // Return class metadata if defined.
+  if ("classMeta" in meta) {
+    return (meta.classMeta as ClassMeta)?.[classKey];
+  }
+}

package/src/components/DataDictionary/components/Filters/components/ColumnFilters/columnFilters.tsx

@@ -0,0 +1,21 @@
+import { ButtonGroup } from "@mui/material";
+import { RowData } from "@tanstack/react-table";
+import React from "react";
+import { Attribute } from "../../../../../../common/entities";
+import { BUTTON_GROUP_PROPS } from "../../../../../common/ButtonGroup/constants";
+import { ColumnFilter } from "../../../../../Table/components/TableFeatures/ColumnFilter/columnFilter";
+import { ColumnFiltersProps } from "./types";
+
+export const ColumnFilters = <T extends RowData = Attribute>({
+  table,
+}: ColumnFiltersProps<T>): JSX.Element => {
+  const columns = table.getAllColumns();
+  const columnFilters = columns.filter((column) => column.getCanFilter());
+  return (
+    <ButtonGroup {...BUTTON_GROUP_PROPS.SECONDARY_OUTLINED}>
+      {columnFilters.map((column) => (
+        <ColumnFilter key={column.id} column={column} />
+      ))}
+    </ButtonGroup>
+  );
+};

package/src/components/DataDictionary/components/Filters/components/ColumnFilters/types.ts

@@ -0,0 +1,6 @@
+import { RowData, Table } from "@tanstack/react-table";
+import { Attribute } from "../../../../../../common/entities";
+
+export interface ColumnFiltersProps<T extends RowData = Attribute> {
+  table: Table<T>;
+}

package/src/components/DataDictionary/components/Filters/filters.styles.ts

@@ -0,0 +1,14 @@
+import styled from "@emotion/styled";
+import { Grid } from "@mui/material";
+import { BUTTON_GROUP_PROPS } from "../../../../styles/common/mui/buttonGroup";
+
+export const StyledGrid = styled(Grid)`
+  align-items: center;
+  display: grid;
+  gap: 16px;
+  grid-template-columns: 1fr auto;
+
+  .${BUTTON_GROUP_PROPS.CLASSES.ROOT} {
+    grid-column: 2;
+  }
+`;

package/src/components/DataDictionary/components/Filters/filters.tsx

@@ -0,0 +1,16 @@
+import { RowData } from "@tanstack/react-table";
+import React from "react";
+import { Attribute } from "../../../../common/entities";
+import { ColumnFilters } from "./components/ColumnFilters/columnFilters";
+import { StyledGrid } from "./filters.styles";
+import { FiltersProps } from "./types";
+
+export const Filters = <T extends RowData = Attribute>({
+  table,
+}: FiltersProps<T>): JSX.Element => {
+  return (
+    <StyledGrid>
+      <ColumnFilters table={table} />
+    </StyledGrid>
+  );
+};

package/src/components/DataDictionary/components/Filters/stories/constants.ts

@@ -0,0 +1,31 @@
+import { PartialColumn } from "./types";
+
+export const BIONETWORK: PartialColumn = {
+  columnDef: { header: "BioNetwork" },
+  getCanFilter: () => true,
+  getFacetedUniqueValues: () =>
+    new Map([
+      ["Nervous System", 3],
+      ["Brain", 2],
+      ["Lung", 1],
+    ]),
+  id: "bioNetwork",
+};
+
+export const EXAMPLE: PartialColumn = {
+  columnDef: { header: "Example" },
+  getCanFilter: () => false,
+  getFacetedUniqueValues: () => new Map([["EFO:0008563", 1]]),
+  id: "example",
+};
+
+export const REQUIRED: PartialColumn = {
+  columnDef: { header: "Required" },
+  getCanFilter: () => true,
+  getFacetedUniqueValues: () =>
+    new Map([
+      ["Required", 16],
+      ["Not Required", 30],
+    ]),
+  id: "required",
+};

package/src/components/DataDictionary/components/Filters/stories/filters.stories.tsx

@@ -0,0 +1,42 @@
+import { action } from "@storybook/addon-actions";
+import { Meta, StoryObj } from "@storybook/react";
+import { functionalUpdate, Table } from "@tanstack/react-table";
+import React from "react";
+import { Filters } from "../filters";
+import { BIONETWORK, EXAMPLE, REQUIRED } from "./constants";
+import { useFilterStore } from "./hook";
+import { PartialColumn } from "./types";
+
+const meta: Meta<typeof Filters> = {
+  component: Filters,
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+const DefaultStory = (): JSX.Element => {
+  const { filterStore, setFilterStore } = useFilterStore();
+
+  const makeColumn = (column: PartialColumn): PartialColumn => ({
+    ...column,
+    getFilterValue: () => filterStore[column.id],
+    getIsFiltered: () => !!filterStore[column.id],
+    setFilterValue: (updaterOrValue: unknown): unknown => {
+      const next = functionalUpdate(updaterOrValue, filterStore[column.id]);
+      setFilterStore({ ...filterStore, [column.id]: next });
+      action("setFilterValue")(next);
+      return next;
+    },
+  });
+
+  const table = {
+    getAllColumns: () => [REQUIRED, BIONETWORK, EXAMPLE].map(makeColumn),
+  } as Table<unknown>;
+
+  return <Filters table={table} />;
+};
+
+export const Default: Story = {
+  render: () => <DefaultStory />,
+};

package/src/components/DataDictionary/components/Filters/stories/hook.ts

@@ -0,0 +1,9 @@
+import { Dispatch, SetStateAction, useState } from "react";
+
+export function useFilterStore(): {
+  filterStore: Record<string, unknown>;
+  setFilterStore: Dispatch<SetStateAction<Record<string, unknown>>>;
+} {
+  const [filterStore, setFilterStore] = useState<Record<string, unknown>>({});
+  return { filterStore, setFilterStore };
+}

package/src/components/DataDictionary/components/Filters/stories/types.ts

@@ -0,0 +1,3 @@
+import { Column } from "@tanstack/react-table";
+
+export type PartialColumn = Partial<Column<unknown>> & { id: string };

package/src/components/DataDictionary/components/Filters/types.ts

@@ -0,0 +1,6 @@
+import { RowData, Table } from "@tanstack/react-table";
+import { Attribute } from "../../../../common/entities";
+
+export interface FiltersProps<T extends RowData = Attribute> {
+  table: Table<T>;
+}

package/src/components/DataDictionary/components/Layout/components/EntitiesLayout/entitiesLayout.styles.ts

@@ -5,13 +5,16 @@ import { LAYOUT_SPACING } from "../../constants";
 
 const PB = LAYOUT_SPACING.CONTENT_PADDING_BOTTOM; /* bottom padding */
 const PT = LAYOUT_SPACING.CONTENT_PADDING_TOP; /* top padding */
+const FILTERS_HEIGHT =
+  LAYOUT_SPACING.FILTERS_HEIGHT +
+  LAYOUT_SPACING.FILTERS_PADDING_TOP; /* filters height */
 const TITLE_HEIGHT = LAYOUT_SPACING.TITLE_HEIGHT; /* title height */
 
 export const Layout = styled("div")<LayoutSpacing>`
   grid-column: 2;
   grid-row: 1;
   padding-bottom: ${PB}px;
-  padding-top: ${({ top }) => top + TITLE_HEIGHT + PT}px;
+  padding-top: ${({ top }) => top + TITLE_HEIGHT + FILTERS_HEIGHT + PT}px;
   z-index: 1; /* not required, but helpful in that the entities are always on top */
 
   ${mediaTabletDown} {

package/src/components/DataDictionary/components/Layout/components/FiltersLayout/filtersLayout.styles.ts

@@ -0,0 +1,27 @@
+import styled from "@emotion/styled";
+import { PALETTE } from "../../../../../../styles/common/constants/palette";
+import { mediaTabletDown } from "../../../../../../styles/common/mixins/breakpoints";
+import { LayoutSpacing } from "../../../../hooks/UseLayoutSpacing/types";
+import { LAYOUT_SPACING } from "../../constants";
+
+const PB = LAYOUT_SPACING.FILTERS_PADDING_BOTTOM; /* bottom padding */
+const PT = LAYOUT_SPACING.FILTERS_PADDING_TOP; /* top padding */
+const TITLE_HEIGHT = LAYOUT_SPACING.TITLE_HEIGHT; /* title height */
+
+export const Layout = styled("div")<LayoutSpacing>`
+  align-self: flex-start;
+  background-color: ${PALETTE.BACKGROUND_DEFAULT};
+  grid-column: 2;
+  grid-row: 1;
+  margin-bottom: ${PB}px;
+  padding-top: ${({ top }) => top + TITLE_HEIGHT + PT}px;
+  position: sticky;
+  top: 0;
+  z-index: 2; /* required, filters should be on top of entities */
+
+  ${mediaTabletDown} {
+    grid-column: 1;
+    grid-row: auto;
+    padding-top: ${PT}px;
+  }
+`;

package/src/components/DataDictionary/components/Layout/components/FiltersLayout/filtersLayout.tsx

@@ -0,0 +1,10 @@
+import React from "react";
+import { Layout } from "./filtersLayout.styles";
+import { FiltersLayoutProps } from "./types";
+
+export const FiltersLayout = ({
+  children,
+  ...props
+}: FiltersLayoutProps): JSX.Element => {
+  return <Layout {...props}>{children}</Layout>;
+};

package/src/components/DataDictionary/components/Layout/components/FiltersLayout/types.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from "react";
+import { LayoutSpacing } from "../../../../hooks/UseLayoutSpacing/types";
+
+export interface FiltersLayoutProps extends LayoutSpacing {
+  children: ReactNode;
+}

package/src/components/DataDictionary/components/Layout/components/OutlineLayout/outlineLayout.styles.ts

@@ -4,7 +4,7 @@ import { LayoutSpacing } from "../../../../hooks/UseLayoutSpacing/types";
 import { LAYOUT_SPACING } from "../../constants";
 
 const PB = LAYOUT_SPACING.CONTENT_PADDING_BOTTOM; /* bottom padding */
-const PT = LAYOUT_SPACING.CONTENT_PADDING_TOP; /* top padding */
+const PT = LAYOUT_SPACING.OUTLINE_PADDING_TOP; /* top padding */
 const TITLE_HEIGHT = LAYOUT_SPACING.TITLE_HEIGHT; /* title height */
 
 export const Layout = styled("div")<LayoutSpacing>`

package/src/components/DataDictionary/components/Layout/components/TitleLayout/titleLayout.styles.ts

@@ -9,6 +9,7 @@ export const Layout = styled("div")<LayoutSpacing>`
   padding-top: ${({ top }) => top}px; /* header height */
   position: sticky;
   top: 0;
+  z-index: 4;
 
   ${mediaTabletDown} {
     grid-column: 1;

package/src/components/DataDictionary/components/Layout/constants.ts

@@ -1,5 +1,9 @@
 export const LAYOUT_SPACING = {
   CONTENT_PADDING_BOTTOM: 24,
   CONTENT_PADDING_TOP: 16,
+  FILTERS_HEIGHT: 40,
+  FILTERS_PADDING_BOTTOM: 16,
+  FILTERS_PADDING_TOP: 16,
+  OUTLINE_PADDING_TOP: 16,
   TITLE_HEIGHT: 74,
 };

package/src/components/DataDictionary/components/Outline/utils.ts

@@ -1,21 +1,43 @@
-import { RowData } from "@tanstack/react-table";
-import { Attribute, Class } from "../../../../common/entities";
+import { RowData, Table } from "@tanstack/react-table";
+import { Attribute } from "../../../../common/entities";
 import { OutlineItem } from "../../../Layout/components/Outline/types";
+import { ClassMeta } from "../Table/types";
 
 /**
- * Returns outline items from classes.
- * @param classes - Class entities.
+ * Returns outline items from class metadata.
+ * @param table - Table instance.
  * @returns Outline items.
  */
 export function buildClassesOutline<T extends RowData = Attribute>(
-  classes: Class<T>[]
+  table: Table<T>
 ): OutlineItem[] {
-  return classes.map(({ name, title }) => {
-    return {
-      depth: 2,
-      disabled: false,
-      hash: name,
-      value: title,
-    };
-  });
+  const meta = table.options.meta;
+  if (!meta) return [];
+  if (!("classMeta" in meta)) return [];
+  return Object.entries(meta.classMeta as ClassMeta).map(
+    ([classKey, { title }]) => {
+      return {
+        depth: 2,
+        disabled: !hasGroupedRow(table, classKey),
+        hash: classKey,
+        value: title,
+      };
+    }
+  );
+}
+
+/**
+ * Returns true if a grouped row exists for a class key.
+ * @param table - Table instance.
+ * @param classKey - Class key.
+ * @returns True if a grouped row exists, false otherwise.
+ */
+function hasGroupedRow<T extends RowData = Attribute>(
+  table: Table<T>,
+  classKey: string
+): boolean {
+  const groupRow = table
+    .getGroupedRowModel()
+    .rows.find((row) => row.getValue("classKey") === classKey);
+  return !!groupRow;
 }

package/src/components/DataDictionary/components/Table/hook.ts

@@ -2,22 +2,34 @@ import {
   ColumnDef,
   RowData,
   Table,
+  TableOptions,
   useReactTable,
 } from "@tanstack/react-table";
-import { Attribute } from "../../../../common/entities";
+import { useMemo } from "react";
+import { Attribute, Class } from "../../../../common/entities";
 import { useTableOptions } from "./options/hook";
+import { buildClassMeta, buildTableData } from "./utils";
 
 export const useTable = <T extends RowData = Attribute>(
-  data: T[],
-  columnDefs: ColumnDef<T, T[keyof T]>[]
+  classes: Class<T>[],
+  columnDefs: ColumnDef<T, T[keyof T]>[],
+  tableOptions?: Omit<TableOptions<T>, "columns" | "data" | "getCoreRowModel">
 ): Table<T> => {
-  // Table options.
-  const tableOptions = useTableOptions<T>();
+  // Build table data.
+  const data = useMemo(() => buildTableData(classes), [classes]);
+
+  // Default table options.
+  const defaultTableOptions = useTableOptions<T>();
+
+  // Build class meta.
+  const classMeta = useMemo(() => buildClassMeta(classes), [classes]);
 
   // Table instance.
   return useReactTable<T>({
+    ...defaultTableOptions,
     ...tableOptions,
     columns: columnDefs,
     data,
+    meta: { classMeta },
   });
 };

package/src/components/DataDictionary/components/Table/options/columnFilters/constants.ts

@@ -0,0 +1,16 @@
+import {
+  ColumnFiltersOptions,
+  RowData,
+  getFilteredRowModel,
+} from "@tanstack/react-table";
+import { arrIncludesSome } from "../../../../../Table/columnDef/columnFilters/filterFn";
+
+export const COLUMN_FILTERS_OPTIONS: Pick<
+  ColumnFiltersOptions<RowData>,
+  "enableColumnFilters" | "enableFilters" | "filterFns" | "getFilteredRowModel"
+> = {
+  enableColumnFilters: true,
+  enableFilters: true,
+  filterFns: { arrIncludesSome },
+  getFilteredRowModel: getFilteredRowModel(),
+};

package/src/components/DataDictionary/components/Table/options/columnFilters/hook.ts

@@ -0,0 +1,32 @@
+import {
+  ColumnFiltersOptions,
+  ColumnFiltersState,
+  RowData,
+  Updater,
+} from "@tanstack/react-table";
+import { Dispatch, SetStateAction, useCallback } from "react";
+import { Attribute } from "../../../../../../common/entities";
+import { resolveUpdater } from "../../../../../Table/options/updater";
+import { COLUMN_FILTERS_OPTIONS } from "./constants";
+
+export const useColumnFiltersOptions = <T extends RowData = Attribute>({
+  setColumnFilters,
+}: {
+  setColumnFilters: Dispatch<SetStateAction<ColumnFiltersState>>;
+}): ColumnFiltersOptions<T> => {
+  // Column filters change handler.
+  // TODO dispatch to provider with reducer.
+  const onColumnFiltersChange = useCallback(
+    (updaterOrValue: Updater<ColumnFiltersState>): void => {
+      setColumnFilters((old) =>
+        resolveUpdater<ColumnFiltersState>(updaterOrValue, old)
+      );
+    },
+    [setColumnFilters]
+  );
+
+  return {
+    ...COLUMN_FILTERS_OPTIONS,
+    onColumnFiltersChange,
+  };
+};

package/src/components/DataDictionary/components/Table/options/expanded/constants.ts

@@ -0,0 +1,13 @@
+import {
+  ExpandedOptions,
+  getExpandedRowModel,
+  RowData,
+} from "@tanstack/react-table";
+
+export const EXPANDED_OPTIONS: Pick<
+  ExpandedOptions<RowData>,
+  "enableExpanding" | "getExpandedRowModel"
+> = {
+  enableExpanding: true,
+  getExpandedRowModel: getExpandedRowModel(),
+};

package/src/components/DataDictionary/components/Table/options/faceted/constants.ts

@@ -0,0 +1,14 @@
+import {
+  FacetedOptions,
+  getFacetedRowModel,
+  RowData,
+} from "@tanstack/react-table";
+import { getFacetedUniqueValuesWithArrayValues } from "../../../../../Table/common/utils";
+
+export const FACETED_OPTIONS: Pick<
+  FacetedOptions<RowData>,
+  "getFacetedRowModel" | "getFacetedUniqueValues"
+> = {
+  getFacetedRowModel: getFacetedRowModel(),
+  getFacetedUniqueValues: getFacetedUniqueValuesWithArrayValues(),
+};

package/src/components/DataDictionary/components/Table/options/grouping/constants.ts

@@ -0,0 +1,9 @@
+import { GroupingOptions, getGroupedRowModel } from "@tanstack/react-table";
+
+export const GROUPING_OPTIONS: Pick<
+  GroupingOptions,
+  "enableGrouping" | "getGroupedRowModel"
+> = {
+  enableGrouping: true,
+  getGroupedRowModel: getGroupedRowModel(),
+};

package/src/components/DataDictionary/components/Table/options/hook.ts

@@ -1,14 +1,37 @@
-import { RowData, TableOptions } from "@tanstack/react-table";
+import {
+  ColumnFiltersState,
+  RowData,
+  TableOptions,
+} from "@tanstack/react-table";
+import { useState } from "react";
 import { Attribute } from "../../../../../common/entities";
+import { useColumnFiltersOptions } from "./columnFilters/hook";
 import { CORE_OPTIONS } from "./core/constants";
+import { EXPANDED_OPTIONS } from "./expanded/constants";
+import { FACETED_OPTIONS } from "./faceted/constants";
+import { GROUPING_OPTIONS } from "./grouping/constants";
 import { SORTING_OPTIONS } from "./sorting/constants";
+import { VISIBILITY_OPTIONS } from "./visibility/constants";
 
 export const useTableOptions = <T extends RowData = Attribute>(): Omit<
   TableOptions<T>,
-  "columns" | "data"
+  "columns" | "data" | "initialState"
 > => {
+  // Column filters state - to be moved to a provider with a reducer.
+  const [columnFilters, setColumnFilters] = useState<ColumnFiltersState>([]);
+
+  // Column filters options.
+  const columnFiltersOptions = useColumnFiltersOptions<T>({ setColumnFilters });
+
+  // Table options.
   return {
+    ...columnFiltersOptions,
     ...CORE_OPTIONS,
+    ...EXPANDED_OPTIONS,
+    ...FACETED_OPTIONS,
+    ...GROUPING_OPTIONS,
     ...SORTING_OPTIONS,
-  };
+    ...VISIBILITY_OPTIONS,
+    state: { columnFilters },
+  } as TableOptions<T>;
 };

package/src/components/DataDictionary/components/Table/options/visibility/constants.ts

@@ -0,0 +1,5 @@
+import { VisibilityOptions } from "@tanstack/react-table";
+
+export const VISIBILITY_OPTIONS: Pick<VisibilityOptions, "enableHiding"> = {
+  enableHiding: true,
+};

package/src/components/DataDictionary/components/Table/table.tsx

@@ -11,6 +11,7 @@ import { StyledRoundedPaper } from "./table.styles";
 import { TableProps } from "./types";
 
 export const Table = <T extends RowData>({
+  row,
   table,
 }: TableProps<T>): JSX.Element => {
   return (
@@ -28,6 +29,7 @@ export const Table = <T extends RowData>({
             />
             <TableBody
               rowDirection={ROW_DIRECTION.DEFAULT}
+              rows={row.getLeafRows()}
               tableInstance={table}
             />
           </GridTable>

package/src/components/DataDictionary/components/Table/types.ts

@@ -1,5 +1,12 @@
-import { RowData, Table } from "@tanstack/react-table";
+import { Row, RowData, Table } from "@tanstack/react-table";
+import { Class } from "common/entities";
+
+export type ClassMeta = Record<
+  Class["name"],
+  Pick<Class, "description" | "title">
+>;
 
 export interface TableProps<T extends RowData> {
+  row: Row<T>;
   table: Table<T>;
 }