@databiosphere/findable-ui 35.2.0 → 36.0.0

package/src/utils/stateToUrlQuery.ts

@@ -0,0 +1,40 @@
+import { NextRouter } from "next/router";
+
+/**
+ * Builds a query object from state for URL parameter synchronization.
+ *
+ * This function converts a state object into a format compatible with NextRouter query parameters.
+ * It handles different value types appropriately:
+ *
+ * - Undefined values are excluded.
+ * - Strings are used as-is (empty strings are excluded).
+ * - Arrays are JSON stringified (empty arrays are excluded).
+ *
+ * @param state - State object containing values to convert to URL parameters.
+ * @returns A query object compatible with NextRouter.
+ */
+export function stateToUrlQuery<
+  S extends Record<string, string | unknown[] | undefined>
+>(state: S): NextRouter["query"] {
+  const query: NextRouter["query"] = {};
+
+  for (const [key, value] of Object.entries(state)) {
+    // Handle the undefined case.
+    if (value === undefined) continue;
+
+    // Handle the string case.
+    if (typeof value === "string") {
+      if (!value) continue;
+      query[key] = value;
+      continue;
+    }
+
+    // Handle the array case.
+    if (Array.isArray(value)) {
+      if (value.length === 0) continue;
+      query[key] = JSON.stringify(value);
+    }
+  }
+
+  return query;
+}

package/src/views/DataDictionaryView/dataDictionaryView.tsx

@@ -1,9 +1,35 @@
 import React from "react";
 import { DataDictionary } from "../../components/DataDictionary/dataDictionary";
-import { BaseComponentProps } from "../../components/types";
+import { useStateSyncManager } from "../../hooks/stateSyncManager/hook";
+import { DataDictionaryContext } from "../../providers/dataDictionary/context";
+import { clearMeta } from "../../providers/dataDictionaryState/actions/clearMeta/dispatch";
+import { stateToUrl } from "../../providers/dataDictionaryState/actions/stateToUrl/dispatch";
+import { urlToState } from "../../providers/dataDictionaryState/actions/urlToState/dispatch";
+import { useDataDictionaryState } from "../../providers/dataDictionaryState/hooks/UseDataDictionaryState/hook";
+import { DataDictionaryViewProps } from "./types";
+import { buildStateSyncManagerContext } from "./utils";
 
 export const DataDictionaryView = ({
   className,
-}: BaseComponentProps): JSX.Element => {
-  return <DataDictionary className={className} />;
+  dictionary,
+}: DataDictionaryViewProps): JSX.Element => {
+  const { dataDictionaryDispatch, dataDictionaryState } =
+    useDataDictionaryState();
+
+  useStateSyncManager({
+    actions: { clearMeta, stateToUrl, urlToState },
+    dispatch: dataDictionaryDispatch,
+    state: buildStateSyncManagerContext(dataDictionaryState, dictionary),
+  });
+
+  return (
+    <DataDictionaryContext.Provider value={{ dictionary }}>
+      {/* Using dictionary as `key` to force component mount when dictionary changes to prevent stale outline, global filter value. */}
+      <DataDictionary
+        key={dictionary}
+        className={className}
+        dictionary={dictionary}
+      />
+    </DataDictionaryContext.Provider>
+  );
 };

package/src/views/DataDictionaryView/types.ts

@@ -0,0 +1,5 @@
+import { BaseComponentProps } from "components/types";
+
+export interface DataDictionaryViewProps extends BaseComponentProps {
+  dictionary: string;
+}

package/src/views/DataDictionaryView/utils.ts

@@ -0,0 +1,23 @@
+import { StateSyncManagerContext } from "../../hooks/stateSyncManager/types";
+import { DATA_DICTIONARY_URL_PARAMS } from "../../providers/dataDictionaryState/dictionaries/constants";
+import { DataDictionaryState } from "../../providers/dataDictionaryState/types";
+
+/**
+ * Builds the state sync manager context object for URL-state synchronization.
+ * - Command: The meta command that signals a URL update operation is needed e.g. "STATE_TO_URL_PUSH" or "STATE_TO_URL_REPLACE".
+ * - ParamKeys: Expected list of URL parameter keys that should be synchronized with state e.g. "filter".
+ * - Query: Dictionary related query object from state that should be synchronized with the URL.
+ * @param dataDictionaryState - Data dictionary state.
+ * @param dictionary - Dictionary ID.
+ * @returns The state sync manager context.
+ */
+export function buildStateSyncManagerContext(
+  dataDictionaryState: DataDictionaryState,
+  dictionary: string
+): StateSyncManagerContext {
+  return {
+    command: dataDictionaryState.meta?.command,
+    paramKeys: Object.values(DATA_DICTIONARY_URL_PARAMS),
+    query: dataDictionaryState.dictionaries?.[dictionary]?.query,
+  };
+}

package/src/views/ExploreView/utils.ts

@@ -5,7 +5,7 @@ import { EXPLORE_URL_PARAMS } from "../../providers/exploreState/constants";
 import { ExploreView } from "./exploreView";
 
 /**
- *Builds the state sync manager context object for URL-state synchronization.
+ * Builds the state sync manager context object for URL-state synchronization.
  * - Command: The meta command that signals a URL update operation is needed e.g. "STATE_TO_URL_PUSH" or "STATE_TO_URL_REPLACE".
  * - ParamKeys: Expected list of URL parameter keys that should be synchronized with state e.g. "filter", "catalog".
  * - Query: Entity related query object from state that should be synchronized with the URL.

package/lib/components/DataDictionary/hooks/UseDataDictionary/hook.d.ts

@@ -1,4 +0,0 @@
-import { RowData } from "@tanstack/react-table";
-import { Attribute } from "../../../../common/entities";
-import { UseDataDictionary } from "./types";
-export declare const useDataDictionary: <T extends RowData = Attribute>() => UseDataDictionary<T>;

package/lib/components/DataDictionary/hooks/UseDataDictionary/hook.js

@@ -1,36 +0,0 @@
-import { useRouter } from "next/router";
-import { useMemo } from "react";
-import { useConfig } from "../../../../hooks/useConfig";
-import { buildClassesOutline } from "../../components/Outline/utils";
-import { useTable } from "../../components/Table/hook";
-export const useDataDictionary = () => {
-    const { config: { dataDictionaries: dataDictionaryConfigs }, } = useConfig();
-    // Dynamic paths must be resolved at this point otherwise the initial settings
-    // passed to useTable on subsequent renders will be ignored (as the table will have
-    // already been initialized).
-    const router = useRouter();
-    const query = router.query;
-    const { dictionary } = query;
-    // Get dictionary config by matching the current path with the data dictionary path
-    const dataDictionaryConfig = useMemo(() => {
-        if (!dataDictionaryConfigs?.length)
-            return undefined;
-        // Find the data dictionary with a path that matches the current route
-        // We check if the current path starts with the dictionary path to handle nested routes
-        return dataDictionaryConfigs.find((config) => config.path === dictionary);
-    }, [dataDictionaryConfigs, dictionary]);
-    // Get configured dictionary classes, column definitions and table options.
-    const { classes, columnDefs, tableOptions, title } = useMemo(() => {
-        return {
-            classes: dataDictionaryConfig?.dataDictionary?.classes || [],
-            columnDefs: dataDictionaryConfig?.columnDefs || [],
-            tableOptions: dataDictionaryConfig?.tableOptions || {},
-            title: dataDictionaryConfig?.dataDictionary?.title || "",
-        };
-    }, [dataDictionaryConfig]);
-    // Build table instance.
-    const table = useTable(classes, columnDefs, tableOptions);
-    // Build outline.
-    const outline = buildClassesOutline(table);
-    return { outline, table, title };
-};

package/lib/components/DataDictionary/hooks/UseDataDictionary/types.d.ts

@@ -1,8 +0,0 @@
-import { RowData, Table } from "@tanstack/react-table";
-import { Attribute } from "../../../../common/entities";
-import { OutlineItem } from "../../../Layout/components/Outline/types";
-export interface UseDataDictionary<T extends RowData = Attribute> {
-    outline: OutlineItem[];
-    table: Table<T>;
-    title: string;
-}

package/src/components/DataDictionary/hooks/UseDataDictionary/hook.ts

@@ -1,51 +0,0 @@
-import { RowData } from "@tanstack/react-table";
-import { useRouter } from "next/router";
-import { useMemo } from "react";
-import { Attribute, DataDictionaryConfig } from "../../../../common/entities";
-import { useConfig } from "../../../../hooks/useConfig";
-import { buildClassesOutline } from "../../components/Outline/utils";
-import { useTable } from "../../components/Table/hook";
-import { UseDataDictionary } from "./types";
-
-export const useDataDictionary = <
-  T extends RowData = Attribute
->(): UseDataDictionary<T> => {
-  const {
-    config: { dataDictionaries: dataDictionaryConfigs },
-  } = useConfig();
-  // Dynamic paths must be resolved at this point otherwise the initial settings
-  // passed to useTable on subsequent renders will be ignored (as the table will have
-  // already been initialized).
-  const router = useRouter();
-  const query = router.query;
-  const { dictionary } = query;
-
-  // Get dictionary config by matching the current path with the data dictionary path
-  const dataDictionaryConfig = useMemo(() => {
-    if (!dataDictionaryConfigs?.length) return undefined;
-
-    // Find the data dictionary with a path that matches the current route
-    // We check if the current path starts with the dictionary path to handle nested routes
-    return dataDictionaryConfigs.find(
-      (config) => config.path === dictionary
-    ) as DataDictionaryConfig<T> | undefined;
-  }, [dataDictionaryConfigs, dictionary]);
-
-  // Get configured dictionary classes, column definitions and table options.
-  const { classes, columnDefs, tableOptions, title } = useMemo(() => {
-    return {
-      classes: dataDictionaryConfig?.dataDictionary?.classes || [],
-      columnDefs: dataDictionaryConfig?.columnDefs || [],
-      tableOptions: dataDictionaryConfig?.tableOptions || {},
-      title: dataDictionaryConfig?.dataDictionary?.title || "",
-    };
-  }, [dataDictionaryConfig]);
-
-  // Build table instance.
-  const table = useTable<T>(classes, columnDefs, tableOptions);
-
-  // Build outline.
-  const outline = buildClassesOutline<T>(table);
-
-  return { outline, table, title };
-};

package/src/components/DataDictionary/hooks/UseDataDictionary/types.ts

@@ -1,9 +0,0 @@
-import { RowData, Table } from "@tanstack/react-table";
-import { Attribute } from "../../../../common/entities";
-import { OutlineItem } from "../../../Layout/components/Outline/types";
-
-export interface UseDataDictionary<T extends RowData = Attribute> {
-  outline: OutlineItem[];
-  table: Table<T>;
-  title: string;
-}