@databiosphere/findable-ui 16.0.0 → 17.0.0

package/tests/useRequestManifest.test.ts

@@ -0,0 +1,193 @@
+import { jest } from "@jest/globals";
+import { renderHook } from "@testing-library/react";
+import { MANIFEST_DOWNLOAD_FORMAT } from "../src/apis/azul/common/entities";
+import { FormFacet } from "../src/components/Export/common/entities";
+import { METHOD } from "../src/hooks/types";
+import {
+  CATALOG,
+  CONFIG,
+  FILE_MANIFEST_STATE,
+  FORM_FACET,
+} from "../src/mocks/useRequestFileManifest.mocks";
+
+jest.unstable_mockModule("../src/hooks/useConfig", () => ({
+  useConfig: jest.fn(),
+}));
+
+jest.unstable_mockModule("../src/hooks/useCatalog", () => ({
+  useCatalog: jest.fn(),
+}));
+
+jest.unstable_mockModule("../src/hooks/useFileManifestState", () => ({
+  useFileManifestState: jest.fn(),
+}));
+
+const { useConfig } = await import("../src/hooks/useConfig");
+const { useCatalog } = await import("../src/hooks/useCatalog");
+const { useFileManifestState } = await import(
+  "../src/hooks/useFileManifestState"
+);
+const { useRequestManifest } = await import(
+  "../src/hooks/useRequestManifest/useRequestManifest"
+);
+
+const MOCK_USE_CATALOG = useCatalog as jest.MockedFunction<typeof useCatalog>;
+const MOCK_USE_CONFIG = useConfig as jest.MockedFunction<
+  () => Partial<ReturnType<typeof useConfig>>
+>;
+const MOCK_USE_FILE_MANIFEST_STATE =
+  useFileManifestState as jest.MockedFunction<
+    () => Partial<ReturnType<typeof useFileManifestState>>
+  >;
+
+describe("useRequestManifest", () => {
+  beforeEach(() => {
+    MOCK_USE_CATALOG.mockReset();
+    MOCK_USE_CONFIG.mockReset();
+    MOCK_USE_FILE_MANIFEST_STATE.mockReset();
+    MOCK_USE_CATALOG.mockReturnValue(CATALOG);
+    MOCK_USE_CONFIG.mockReturnValue(CONFIG);
+    MOCK_USE_FILE_MANIFEST_STATE.mockReturnValue({
+      fileManifestDispatch: jest.fn(),
+      fileManifestState: FILE_MANIFEST_STATE,
+    });
+  });
+
+  describe("useRequestManifest - always returns request method", () => {
+    test("requestMethod is always METHOD.PUT regardless of conditions", () => {
+      MOCK_USE_CATALOG.mockReturnValue(undefined);
+      const { result } = renderHook(() =>
+        useRequestManifest(undefined, FORM_FACET.INITIAL_SET)
+      );
+      expect(result.current.requestMethod).toEqual(METHOD.PUT);
+      expect(result.current.requestParams).toBeUndefined();
+      expect(result.current.requestUrl).toBeUndefined();
+    });
+  });
+
+  describe("useRequestManifest - returns undefined for params and URL when", () => {
+    test("catalog is not defined", () => {
+      MOCK_USE_CATALOG.mockReturnValue(undefined);
+      testRequestManifest({
+        fileManifestFormat: MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+      });
+    });
+
+    describe("fileManifestFormat is not ready", () => {
+      test("when fileManifestFormat is not defined", () => {
+        testRequestManifest({
+          fileManifestFormat: undefined,
+        });
+      });
+
+      test("when fileManifestFormat is invalid", () => {
+        testRequestManifest({
+          fileManifestFormat: "INVALID_FORMAT" as MANIFEST_DOWNLOAD_FORMAT,
+        });
+      });
+    });
+
+    describe("fileManifestState is not ready", () => {
+      test("when fileManifestState is not enabled", () => {
+        MOCK_USE_FILE_MANIFEST_STATE.mockReturnValue({
+          fileManifestDispatch: jest.fn(),
+          fileManifestState: { ...FILE_MANIFEST_STATE, isEnabled: false },
+        });
+        testRequestManifest({
+          fileManifestFormat: MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+        });
+      });
+
+      test("when fileManifestState is loading", () => {
+        MOCK_USE_FILE_MANIFEST_STATE.mockReturnValue({
+          fileManifestDispatch: jest.fn(),
+          fileManifestState: { ...FILE_MANIFEST_STATE, isLoading: true },
+        });
+        testRequestManifest({
+          fileManifestFormat: MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+        });
+      });
+    });
+
+    describe("form selection is not ready", () => {
+      test("when a form facet is undefined", () => {
+        testRequestManifest({
+          fileManifestFormat: MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+          formFacet: {},
+        });
+      });
+
+      test("when a form facet `fileSummaryFacet` and `speciesFacet` are not defined", () => {
+        testRequestManifest({
+          fileManifestFormat: MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+          formFacet: FORM_FACET.INITIAL_SET,
+        });
+      });
+
+      test("when a form facet is not selected", () => {
+        testRequestManifest({
+          fileManifestFormat: MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+          formFacet: FORM_FACET.INCOMPLETE_SET,
+        });
+      });
+    });
+  });
+
+  describe("useRequestManifest - returns the request manifest object when all conditions are met", () => {
+    test("and at least one form facet has an unselected term", () => {
+      const { result } = renderHook(() =>
+        useRequestManifest(
+          MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+          FORM_FACET.SUBSET
+        )
+      );
+      expect(result.current.requestMethod).toEqual(METHOD.PUT);
+      expect(result.current.requestParams).toBeDefined();
+      expect(result.current.requestUrl).toBeDefined();
+    });
+
+    test("and all form facets have all their terms selected", () => {
+      const { result } = renderHook(() =>
+        useRequestManifest(
+          MANIFEST_DOWNLOAD_FORMAT.VERBATIM_PFB,
+          FORM_FACET.COMPLETE_SET
+        )
+      );
+      expect(result.current.requestMethod).toEqual(METHOD.PUT);
+      expect(result.current.requestParams).toBeDefined();
+      expect(result.current.requestUrl).toBeDefined();
+    });
+  });
+});
+
+/**
+ * Utility function to test the behavior of the `useRequestManifest` hook.
+ * This function renders the `useRequestManifest` hook with the provided arguments
+ * and asserts the expected values for `requestMethod`, `requestParams`, and `requestUrl`.
+ * @param testObject - Object containing the expected values for `requestMethod`, `requestParams`, and `requestUrl`.
+ * @param testObject.expectedMethod - The expected request method.
+ * @param testObject.expectedParams - The expected request parameters.
+ * @param testObject.expectedUrl - The expected request URL.
+ * @param testObject.fileManifestFormat - The file manifest format.
+ * @param testObject.formFacet - Form facet.
+ */
+function testRequestManifest({
+  expectedParams = undefined,
+  expectedUrl = undefined,
+  expectedMethod = METHOD.PUT,
+  fileManifestFormat,
+  formFacet = FORM_FACET.COMPLETE_SET,
+}: {
+  expectedMethod?: METHOD;
+  expectedParams?: URLSearchParams;
+  expectedUrl?: string;
+  fileManifestFormat?: MANIFEST_DOWNLOAD_FORMAT;
+  formFacet?: FormFacet;
+}): void {
+  const { result } = renderHook(() =>
+    useRequestManifest(fileManifestFormat, formFacet)
+  );
+  expect(result.current.requestMethod).toEqual(expectedMethod);
+  expect(result.current.requestParams).toEqual(expectedParams);
+  expect(result.current.requestUrl).toEqual(expectedUrl);
+}

package/lib/hooks/useFileManifest/common/buildFileManifestRequestURL.d.ts

@@ -1,15 +0,0 @@
-import { ManifestDownloadFormat } from "../../../apis/azul/common/entities";
-import { Filters } from "../../../common/entities";
-export interface FileManifestRequestURL {
-    requestParams: URLSearchParams;
-    requestURL: string;
-}
-/**
- * Build up file manifest request params and URL query string for the given search results, catalog and format.
- * @param url - Data URL.
- * @param filters - Selected filters.
- * @param catalog - Configured catalog.
- * @param manifestFormat - Manifest format.
- * @returns file manifest request params and URL query string.
- */
-export declare const buildFileManifestRequestURL: (url: string, filters: Filters | undefined, catalog: string, manifestFormat: ManifestDownloadFormat | undefined) => FileManifestRequestURL | undefined;

package/lib/hooks/useFileManifest/common/buildFileManifestRequestURL.js

@@ -1,28 +0,0 @@
-import { AZUL_PARAM, } from "../../../apis/azul/common/entities";
-import { transformFilters } from "../../../apis/azul/common/filterTransformer";
-/**
- * Build up file manifest request params and URL query string for the given search results, catalog and format.
- * @param url - Data URL.
- * @param filters - Selected filters.
- * @param catalog - Configured catalog.
- * @param manifestFormat - Manifest format.
- * @returns file manifest request params and URL query string.
- */
-export const buildFileManifestRequestURL = (url, filters, catalog, manifestFormat) => {
-    if (!manifestFormat)
-        return;
-    if (!filters)
-        return;
-    // Build request params.
-    const requestParams = new URLSearchParams({
-        [AZUL_PARAM.CATALOG]: catalog,
-        [AZUL_PARAM.FILTERS]: transformFilters(filters),
-        format: manifestFormat,
-    });
-    // Build file manifest URL
-    const requestURL = `${url}fetch/manifest/files?${requestParams.toString()}`;
-    return {
-        requestParams,
-        requestURL,
-    };
-};

package/lib/hooks/useFileManifest/useFileManifestURL.d.ts

@@ -1,5 +0,0 @@
-/**
- * Returns data URL for the integrations end point.
- * @returns data URL for the integrations end point.
- */
-export declare const useFileManifestURL: () => string;

package/lib/hooks/useFileManifest/useFileManifestURL.js

@@ -1,11 +0,0 @@
-import { useConfig } from "../useConfig";
-/**
- * Returns data URL for the integrations end point.
- * @returns data URL for the integrations end point.
- */
-export const useFileManifestURL = () => {
-    const { config } = useConfig();
-    const { dataSource } = config;
-    const { url } = dataSource;
-    return url;
-};

package/lib/hooks/useFileManifest/useRequestFileManifest.d.ts

@@ -1,11 +0,0 @@
-import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
-import { Filters } from "../../common/entities";
-import { FileManifestType } from "./common/entities";
-/**
- * Initializes and fetches file manifest comprising file facets and summary for the given file manifest format.
- * @param fileManifestType - File manifest type.
- * @param fileManifestFormat - File manifest format.
- * @param initialFilters - Filters to initialize file manifest request.
- * @param fileSummaryFacetName - File summary facet name.
- */
-export declare const useRequestFileManifest: (fileManifestType: FileManifestType | undefined, fileManifestFormat: ManifestDownloadFormat | undefined, initialFilters?: Filters | undefined, fileSummaryFacetName?: string) => void;

package/lib/hooks/useFileManifest/useRequestFileManifest.js

@@ -1,40 +0,0 @@
-import { useEffect, useState } from "react";
-import { FileManifestActionKind } from "../../providers/fileManifestState";
-import { useFileManifestState } from "../useFileManifestState";
-/**
- * Initializes and fetches file manifest comprising file facets and summary for the given file manifest format.
- * @param fileManifestType - File manifest type.
- * @param fileManifestFormat - File manifest format.
- * @param initialFilters - Filters to initialize file manifest request.
- * @param fileSummaryFacetName - File summary facet name.
- */
-export const useRequestFileManifest = (fileManifestType, fileManifestFormat, initialFilters = [], fileSummaryFacetName) => {
-    // Initial file manifest filter.
-    const [initFilters] = useState(() => initialFilters);
-    // File manifest state.
-    const { fileManifestDispatch } = useFileManifestState();
-    // Fetches file manifest with the given file manifest filters, format.
-    useEffect(() => {
-        fileManifestDispatch({
-            payload: {
-                fileManifestFormat,
-                fileManifestType,
-                fileSummaryFacetName,
-                filters: initFilters,
-            },
-            type: FileManifestActionKind.FetchFileManifest,
-        });
-        return () => {
-            fileManifestDispatch({
-                payload: undefined,
-                type: FileManifestActionKind.ClearFileManifest,
-            });
-        };
-    }, [
-        fileManifestDispatch,
-        fileManifestFormat,
-        fileManifestType,
-        fileSummaryFacetName,
-        initFilters,
-    ]);
-};

package/lib/providers/fileManifestState/actions.d.ts

@@ -1,9 +0,0 @@
-import { FileManifestContext, FileManifestState, UpdateFileManifestPayload } from "../fileManifestState";
-/**
- * Update file manifest action.
- * @param state - State.
- * @param payload - Payload.
- * @param context - Context.
- * @returns state.
- */
-export declare function updateFileManifestAction(state: FileManifestState, payload: UpdateFileManifestPayload, context: FileManifestContext): FileManifestState;

package/lib/providers/fileManifestState/actions.js

@@ -1,19 +0,0 @@
-import { buildFileManifestRequestURL } from "../../hooks/useFileManifest/common/buildFileManifestRequestURL";
-import { getRequestFilters, updateFilesFacetsStatus } from "./utils";
-/**
- * Update file manifest action.
- * @param state - State.
- * @param payload - Payload.
- * @param context - Context.
- * @returns state.
- */
-export function updateFileManifestAction(state, payload, context) {
-    const { catalog, URL } = context;
-    const filesFacetsStatus = updateFilesFacetsStatus(state, payload);
-    const nextState = { ...state, ...payload, filesFacetsStatus };
-    const fileManifestRequest = buildFileManifestRequestURL(URL, getRequestFilters(nextState), catalog, nextState.fileManifestFormat);
-    return {
-        ...nextState,
-        ...fileManifestRequest,
-    };
-}

package/lib/providers/fileManifestState/utils.d.ts

@@ -1,34 +0,0 @@
-import { Filters } from "../../common/entities";
-import { FILES_FACETS_STATUS } from "../../hooks/useFileManifest/common/entities";
-import { FileManifestState, UpdateFileManifestPayload } from "../fileManifestState";
-/**
- * Generates the filters for a request URL based on the file manifest state.
- * If all terms in a facet are selected, the corresponding facet is excluded.
- * @param state - File manifest state.
- * @returns filters for the request URL.
- */
-export declare function getRequestFilters(state: FileManifestState): Filters | undefined;
-/**
- * Returns true if the filters are user-selected, when:
- * - The file manifest type is not set.
- * - The file manifest type is an entity list related type.
- * - Filter values for each selected facet are partially selected.
- * @param state - File manifest state.
- * @returns true if the filters are user-selected.
- */
-export declare function isFiltersUserSelected(state: FileManifestState): boolean;
-/**
- * Transitions the files facets' status.
- * @param shouldTransition - True if transitioning, false otherwise.
- * @param nextStatus - Next files facets' status.
- * @param currentStatus - Current files facets' status.
- * @returns files facets' status.
- */
-export declare function transitionFilesFacetsStatus(shouldTransition: boolean, nextStatus: FILES_FACETS_STATUS, currentStatus: FILES_FACETS_STATUS): FILES_FACETS_STATUS;
-/**
- * Returns the updated files facets' status.
- * @param state - File manifest state.
- * @param payload - Update file manifest payload.
- * @returns files facets' status.
- */
-export declare function updateFilesFacetsStatus(state: FileManifestState, payload: UpdateFileManifestPayload): FILES_FACETS_STATUS;

package/lib/providers/fileManifestState/utils.js

@@ -1,80 +0,0 @@
-import { FILES_FACETS_STATUS, } from "../../hooks/useFileManifest/common/entities";
-import { findFacet } from "../../hooks/useFileManifest/common/utils";
-import { ENTITIES_FILE_MANIFEST_TYPES } from "./constants";
-/**
- * Generates the filters for a request URL based on the file manifest state.
- * If all terms in a facet are selected, the corresponding facet is excluded.
- * @param state - File manifest state.
- * @returns filters for the request URL.
- */
-export function getRequestFilters(state) {
-    if (state.filesFacetsStatus !== FILES_FACETS_STATUS.COMPLETED)
-        return;
-    // Determine if the filters are user-selected.
-    if (isFiltersUserSelected(state)) {
-        return state.filters;
-    }
-    for (const filter of state.filters) {
-        const facet = findFacet(state.filesFacets, filter.categoryKey);
-        if (!facet)
-            return [filter]; // The entity identifier related filter will not have a corresponding term facet.
-    }
-}
-/**
- * Returns true if filter values for each selected facet are partially selected.
- * @param filters - Selected filters.
- * @param filesFacets - Files facets.
- * @returns true if the filters are partially selected.
- */
-function isFiltersPartiallySelected(filters, filesFacets) {
-    for (const { categoryKey, value } of filters) {
-        const facet = findFacet(filesFacets, categoryKey);
-        if (!facet)
-            continue; // Continue; the entity identifier related filter will not have a corresponding term facet.
-        if (value.length < facet.termCount)
-            return true;
-    }
-    return false;
-}
-/**
- * Returns true if the filters are user-selected, when:
- * - The file manifest type is not set.
- * - The file manifest type is an entity list related type.
- * - Filter values for each selected facet are partially selected.
- * @param state - File manifest state.
- * @returns true if the filters are user-selected.
- */
-export function isFiltersUserSelected(state) {
-    if (!state.fileManifestType)
-        return true;
-    if (ENTITIES_FILE_MANIFEST_TYPES.includes(state.fileManifestType))
-        return true;
-    return isFiltersPartiallySelected(state.filters, state.filesFacets);
-}
-/**
- * Transitions the files facets' status.
- * @param shouldTransition - True if transitioning, false otherwise.
- * @param nextStatus - Next files facets' status.
- * @param currentStatus - Current files facets' status.
- * @returns files facets' status.
- */
-export function transitionFilesFacetsStatus(shouldTransition, nextStatus, currentStatus) {
-    return shouldTransition ? nextStatus : currentStatus;
-}
-/**
- * Returns the updated files facets' status.
- * @param state - File manifest state.
- * @param payload - Update file manifest payload.
- * @returns files facets' status.
- */
-export function updateFilesFacetsStatus(state, payload) {
-    if (state.filesFacetsStatus === FILES_FACETS_STATUS.NOT_STARTED) {
-        // If the current status is NOT_STARTED, transition to IN_PROGRESS if facets are loading.
-        return transitionFilesFacetsStatus(payload.isFacetsLoading, FILES_FACETS_STATUS.IN_PROGRESS, FILES_FACETS_STATUS.NOT_STARTED);
-    }
-    if (state.filesFacetsStatus === FILES_FACETS_STATUS.IN_PROGRESS) {
-        // If the current status is IN_PROGRESS, transition to COMPLETED if facets are successfully loaded.
-        return transitionFilesFacetsStatus(payload.isFacetsSuccess, FILES_FACETS_STATUS.COMPLETED, FILES_FACETS_STATUS.IN_PROGRESS);
-    }
-    return FILES_FACETS_STATUS.COMPLETED;
-}

package/src/hooks/useFileManifest/common/buildFileManifestRequestURL.ts

@@ -1,44 +0,0 @@
-import {
-  AZUL_PARAM,
-  ManifestDownloadFormat,
-} from "../../../apis/azul/common/entities";
-import { transformFilters } from "../../../apis/azul/common/filterTransformer";
-import { Filters } from "../../../common/entities";
-
-export interface FileManifestRequestURL {
-  requestParams: URLSearchParams;
-  requestURL: string;
-}
-
-/**
- * Build up file manifest request params and URL query string for the given search results, catalog and format.
- * @param url - Data URL.
- * @param filters - Selected filters.
- * @param catalog - Configured catalog.
- * @param manifestFormat - Manifest format.
- * @returns file manifest request params and URL query string.
- */
-export const buildFileManifestRequestURL = (
-  url: string,
-  filters: Filters | undefined,
-  catalog: string,
-  manifestFormat: ManifestDownloadFormat | undefined
-): FileManifestRequestURL | undefined => {
-  if (!manifestFormat) return;
-  if (!filters) return;
-
-  // Build request params.
-  const requestParams = new URLSearchParams({
-    [AZUL_PARAM.CATALOG]: catalog,
-    [AZUL_PARAM.FILTERS]: transformFilters(filters),
-    format: manifestFormat,
-  });
-
-  // Build file manifest URL
-  const requestURL = `${url}fetch/manifest/files?${requestParams.toString()}`;
-
-  return {
-    requestParams,
-    requestURL,
-  };
-};

package/src/hooks/useFileManifest/useFileManifestURL.ts

@@ -1,12 +0,0 @@
-import { useConfig } from "../useConfig";
-
-/**
- * Returns data URL for the integrations end point.
- * @returns data URL for the integrations end point.
- */
-export const useFileManifestURL = (): string => {
-  const { config } = useConfig();
-  const { dataSource } = config;
-  const { url } = dataSource;
-  return url;
-};

package/src/hooks/useFileManifest/useRequestFileManifest.ts

@@ -1,51 +0,0 @@
-import { useEffect, useState } from "react";
-import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
-import { Filters } from "../../common/entities";
-import { FileManifestActionKind } from "../../providers/fileManifestState";
-import { useFileManifestState } from "../useFileManifestState";
-import { FileManifestType } from "./common/entities";
-
-/**
- * Initializes and fetches file manifest comprising file facets and summary for the given file manifest format.
- * @param fileManifestType - File manifest type.
- * @param fileManifestFormat - File manifest format.
- * @param initialFilters - Filters to initialize file manifest request.
- * @param fileSummaryFacetName - File summary facet name.
- */
-export const useRequestFileManifest = (
-  fileManifestType: FileManifestType | undefined,
-  fileManifestFormat: ManifestDownloadFormat | undefined,
-  initialFilters: Filters | undefined = [],
-  fileSummaryFacetName?: string
-): void => {
-  // Initial file manifest filter.
-  const [initFilters] = useState(() => initialFilters);
-
-  // File manifest state.
-  const { fileManifestDispatch } = useFileManifestState();
-
-  // Fetches file manifest with the given file manifest filters, format.
-  useEffect(() => {
-    fileManifestDispatch({
-      payload: {
-        fileManifestFormat,
-        fileManifestType,
-        fileSummaryFacetName,
-        filters: initFilters,
-      },
-      type: FileManifestActionKind.FetchFileManifest,
-    });
-    return (): void => {
-      fileManifestDispatch({
-        payload: undefined,
-        type: FileManifestActionKind.ClearFileManifest,
-      });
-    };
-  }, [
-    fileManifestDispatch,
-    fileManifestFormat,
-    fileManifestType,
-    fileSummaryFacetName,
-    initFilters,
-  ]);
-};

package/src/providers/fileManifestState/actions.ts

@@ -1,34 +0,0 @@
-import { buildFileManifestRequestURL } from "../../hooks/useFileManifest/common/buildFileManifestRequestURL";
-import {
-  FileManifestContext,
-  FileManifestState,
-  UpdateFileManifestPayload,
-} from "../fileManifestState";
-import { getRequestFilters, updateFilesFacetsStatus } from "./utils";
-
-/**
- * Update file manifest action.
- * @param state - State.
- * @param payload - Payload.
- * @param context - Context.
- * @returns state.
- */
-export function updateFileManifestAction(
-  state: FileManifestState,
-  payload: UpdateFileManifestPayload,
-  context: FileManifestContext
-): FileManifestState {
-  const { catalog, URL } = context;
-  const filesFacetsStatus = updateFilesFacetsStatus(state, payload);
-  const nextState = { ...state, ...payload, filesFacetsStatus };
-  const fileManifestRequest = buildFileManifestRequestURL(
-    URL,
-    getRequestFilters(nextState),
-    catalog,
-    nextState.fileManifestFormat
-  );
-  return {
-    ...nextState,
-    ...fileManifestRequest,
-  };
-}