@databiosphere/findable-ui 21.1.1 → 21.3.0

package/tests/dataDictionary_utils.test.ts

@@ -0,0 +1,153 @@
+import {
+  annotateColumnConfig,
+  annotateDefaultCategoryConfig,
+  annotateEntityCategoryConfig,
+  annotateEntityConfig,
+} from "../src/components/DataDictionary/common/utils";
+import { SiteConfig } from "../src/config/entities";
+
+describe("Data Dictionary", () => {
+  it("annotates entity", () => {
+    const key = "entity";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for entity",
+      label: "entity",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      entities: [
+        {
+          key,
+          list: {
+            columns: [{ id: "col150" }, { id: "col1" }],
+          },
+        },
+      ],
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateEntityConfig(siteConfig, annotationsByKey);
+
+    // Confirm entity is annotated.
+    const entity = siteConfig.entities[0];
+    expect(entity.annotation).toEqual(annotation);
+  });
+
+  it("annotates entity category config", () => {
+    const key = "filter0";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for filter 0",
+      label: "filter 0",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      entities: [
+        {
+          categoryGroupConfig: {
+            categoryGroups: [
+              {
+                categoryConfigs: [
+                  {
+                    key,
+                    label: "filter 0",
+                  },
+                ],
+              },
+            ],
+          },
+        },
+      ],
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateEntityCategoryConfig(siteConfig, annotationsByKey);
+
+    // Confirm filter is annotated.
+    const categoryConfig =
+      siteConfig.entities[0].categoryGroupConfig?.categoryGroups[0]
+        .categoryConfigs[0];
+    expect(categoryConfig?.annotation).toEqual(annotation);
+  });
+
+  it("annotates default category config", () => {
+    const key = "filter0";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for filter 0",
+      label: "filter 0",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      categoryGroupConfig: {
+        categoryGroups: [
+          {
+            categoryConfigs: [
+              {
+                key,
+                label: "filter 0",
+              },
+            ],
+          },
+        ],
+      },
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateDefaultCategoryConfig(siteConfig, annotationsByKey);
+
+    // Confirm filter is annotated.
+    const categoryConfig =
+      siteConfig.categoryGroupConfig?.categoryGroups[0].categoryConfigs[0];
+    expect(categoryConfig?.annotation).toEqual(annotation);
+  });
+
+  it("annotates column", () => {
+    const key = "col0";
+
+    // Create annotation for column and add to dummy annotation map.
+    const annotation = {
+      description: "description for column 0",
+      label: "column 0",
+    };
+    const annotationsByKey = {
+      [key]: annotation,
+    };
+
+    // Create dummy site config.
+    const siteConfig = {
+      entities: [
+        {
+          list: {
+            columns: [{ id: key }, { id: "col1" }],
+          },
+          name: "entity",
+        },
+      ],
+    } as unknown as SiteConfig;
+
+    // Annotate
+    annotateColumnConfig(siteConfig, annotationsByKey);
+
+    // Confirm column 0 is annotated and column 1 is not.
+    const columns = siteConfig.entities[0].list.columns ?? [];
+    expect((columns[0]?.meta as any)?.annotation).toEqual(annotation);
+    expect((columns[1]?.meta as any)?.annotation).toBeUndefined();
+  });
+});

package/types/data-explorer-ui.d.ts

@@ -18,6 +18,7 @@ import type {} from "@mui/material/Typography";
 import type {} from "@tanstack/react-table";
 import { RowData } from "@tanstack/react-table";
 import { DataLayer } from "../src/common/analytics/entities";
+import { DataDictionaryAnnotation } from "../src/common/entities";
 import {
   CustomFeatureInitialTableState,
   CustomFeatureInstance,
@@ -268,6 +269,7 @@ declare module "@tanstack/react-table" {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars -- TData and TValue are unused variables.
   interface ColumnMeta<TData extends RowData, TValue> {
     align?: TableCellProps["align"];
+    annotation?: DataDictionaryAnnotation;
     columnPinned?: boolean;
     header?: string;
     width?: GridTrackSize;