@databiosphere/findable-ui 16.0.0 → 17.0.0

package/src/providers/fileManifestState/utils.ts

@@ -1,108 +0,0 @@
-import { Filters } from "../../common/entities";
-import {
-  FileFacet,
-  FILES_FACETS_STATUS,
-} from "../../hooks/useFileManifest/common/entities";
-import { findFacet } from "../../hooks/useFileManifest/common/utils";
-import {
-  FileManifestState,
-  UpdateFileManifestPayload,
-} from "../fileManifestState";
-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: FileManifestState
-): Filters | undefined {
-  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: Filters,
-  filesFacets: FileFacet[]
-): boolean {
-  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: FileManifestState): boolean {
-  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: boolean,
-  nextStatus: FILES_FACETS_STATUS,
-  currentStatus: FILES_FACETS_STATUS
-): FILES_FACETS_STATUS {
-  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: FileManifestState,
-  payload: UpdateFileManifestPayload
-): FILES_FACETS_STATUS {
-  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/tests/fileManifestRequestFilters.test.ts

@@ -1,160 +0,0 @@
-import { Filters, SelectedFilter } from "../src/common/entities";
-import {
-  FILE_MANIFEST_TYPE,
-  FileFacet,
-  FILES_FACETS_STATUS,
-} from "../src/hooks/useFileManifest/common/entities";
-import { FileManifestState } from "../src/providers/fileManifestState";
-import { FILE_MANIFEST_STATE } from "../src/providers/fileManifestState/constants";
-import { getRequestFilters } from "../src/providers/fileManifestState/utils";
-
-const FILE_MANIFEST_STATE_NOT_STARTED: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
-};
-
-const FILE_MANIFEST_STATE_IN_PROGRESS: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.IN_PROGRESS,
-};
-
-const FILE_MANIFEST_STATE_COMPLETED: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.COMPLETED,
-};
-
-const FILES_FACETS: Partial<FileFacet>[] = [
-  {
-    name: "category01",
-    termCount: 2,
-  },
-  {
-    name: "category02",
-    termCount: 3,
-  },
-];
-
-const FILTER_IDENTIFIER: SelectedFilter = {
-  categoryKey: "identifier",
-  value: ["value05"],
-};
-
-const FILTERS_COMPLETE_SET: Filters = [
-  { categoryKey: "category01", value: ["value01", "value02"] },
-  { categoryKey: "category02", value: ["value02", "value03", "value04"] },
-];
-
-const FILTERS_SUBSET: Filters = [
-  { categoryKey: "category01", value: ["value01"] },
-  { categoryKey: "category02", value: ["value02", "value03", "value04"] },
-];
-
-const FILE_MANIFEST_STATE_USER_SELECT_FILTERS: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.COMPLETED,
-  filters: FILTERS_SUBSET,
-};
-
-describe("fileManifestRequestFilters", () => {
-  describe("when filters and facets are undefined or empty", () => {
-    test("returns undefined for empty filters and facets", () => {
-      expect(
-        getRequestFilters({
-          ...FILE_MANIFEST_STATE,
-        })
-      ).toBeUndefined();
-    });
-  });
-
-  describe("when checking filesFacetsStatus", () => {
-    test("returns undefined when status is NOT_STARTED", () => {
-      expect(
-        getRequestFilters(FILE_MANIFEST_STATE_NOT_STARTED)
-      ).toBeUndefined();
-    });
-
-    test("returns undefined when status is IN_PROGRESS", () => {
-      expect(
-        getRequestFilters(FILE_MANIFEST_STATE_IN_PROGRESS)
-      ).toBeUndefined();
-    });
-
-    test("returns request filters when status is COMPLETED", () => {
-      expect(FILE_MANIFEST_STATE_COMPLETED.fileManifestType).toBeUndefined();
-      expect(getRequestFilters(FILE_MANIFEST_STATE_COMPLETED)).toEqual([]);
-    });
-  });
-
-  describe("when filters are user-selected", () => {
-    describe("and fileManifestType is undefined", () => {
-      test("returns user-selected filters", () => {
-        expect(
-          getRequestFilters(FILE_MANIFEST_STATE_USER_SELECT_FILTERS)
-        ).toEqual(FILTERS_SUBSET);
-      });
-    });
-
-    describe("and fileManifestType is ENTITY LIST", () => {
-      test("returns user-selected filters for BULK_DOWNLOAD", () => {
-        expect(
-          getRequestFilters({
-            ...FILE_MANIFEST_STATE_USER_SELECT_FILTERS,
-            fileManifestType: FILE_MANIFEST_TYPE.BULK_DOWNLOAD,
-          })
-        ).toEqual(FILTERS_SUBSET);
-      });
-
-      test("returns user-selected filters for DOWNLOAD_MANIFEST", () => {
-        expect(
-          getRequestFilters({
-            ...FILE_MANIFEST_STATE_USER_SELECT_FILTERS,
-            fileManifestType: FILE_MANIFEST_TYPE.DOWNLOAD_MANIFEST,
-          })
-        ).toEqual(FILTERS_SUBSET);
-      });
-
-      test("returns user-selected filters for EXPORT_TO_TERRA", () => {
-        expect(
-          getRequestFilters({
-            ...FILE_MANIFEST_STATE_USER_SELECT_FILTERS,
-            fileManifestType: FILE_MANIFEST_TYPE.EXPORT_TO_TERRA,
-          })
-        ).toEqual(FILTERS_SUBSET);
-      });
-    });
-
-    test("returns user-selected filters that are a subset of facet terms", () => {
-      expect(
-        getRequestFilters({
-          ...FILE_MANIFEST_STATE_USER_SELECT_FILTERS,
-          fileManifestType: FILE_MANIFEST_TYPE.ENTITY_BULK_DOWNLOAD, // FILE_MANIFEST_TYPE is NOT ENTITY LIST.
-          filesFacets: FILES_FACETS as FileFacet[],
-        })
-      ).toEqual(FILTERS_SUBSET);
-    });
-  });
-
-  describe("when filters are NOT user-selected", () => {
-    test("returns undefined when all terms are included, and identifier filter is not defined", () => {
-      expect(
-        getRequestFilters({
-          ...FILE_MANIFEST_STATE_USER_SELECT_FILTERS,
-          fileManifestType: FILE_MANIFEST_TYPE.ENTITY_BULK_DOWNLOAD, // FILE_MANIFEST_TYPE is NOT ENTITY LIST.
-          filesFacets: FILES_FACETS as FileFacet[],
-          filters: FILTERS_COMPLETE_SET,
-        })
-      ).toBeUndefined();
-    });
-
-    test("returns identifier filter when all terms are included, and identifier filter is defined", () => {
-      const filters = getRequestFilters({
-        ...FILE_MANIFEST_STATE_USER_SELECT_FILTERS,
-        fileManifestType: FILE_MANIFEST_TYPE.ENTITY_BULK_DOWNLOAD, // FILE_MANIFEST_TYPE is NOT ENTITY LIST.
-        filesFacets: FILES_FACETS as FileFacet[],
-        filters: [...FILTERS_COMPLETE_SET, FILTER_IDENTIFIER],
-      });
-      expect(filters?.length).toBe(1);
-      expect(filters?.[0].categoryKey).toBe(FILTER_IDENTIFIER.categoryKey);
-    });
-  });
-});

package/tests/updateFilesFacetsStatus.test.ts

@@ -1,84 +0,0 @@
-import { FILES_FACETS_STATUS } from "../src/hooks/useFileManifest/common/entities";
-import {
-  FileManifestState,
-  UpdateFileManifestPayload,
-} from "../src/providers/fileManifestState";
-import { FILE_MANIFEST_STATE } from "../src/providers/fileManifestState/constants";
-import { updateFilesFacetsStatus } from "../src/providers/fileManifestState/utils";
-
-const FILE_MANIFEST_STATE_NOT_STARTED: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.NOT_STARTED,
-};
-
-const FILE_MANIFEST_STATE_IN_PROGRESS: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.IN_PROGRESS,
-};
-
-const FILE_MANIFEST_STATE_COMPLETED: FileManifestState = {
-  ...FILE_MANIFEST_STATE,
-  filesFacetsStatus: FILES_FACETS_STATUS.COMPLETED,
-};
-
-const UPDATE_FILE_MANIFEST_PAYLOAD_IDLE = {
-  isFacetsLoading: false,
-  isFacetsSuccess: false,
-} as UpdateFileManifestPayload;
-
-const UPDATE_FILE_MANIFEST_PAYLOAD_LOADING = {
-  isFacetsLoading: true,
-  isFacetsSuccess: false,
-} as UpdateFileManifestPayload;
-
-const UPDATE_FILE_MANIFEST_PAYLOAD_SUCCESS = {
-  isFacetsLoading: false,
-  isFacetsSuccess: true,
-} as UpdateFileManifestPayload;
-
-describe("updateFilesFacetsStatus", () => {
-  test("files facets NOT_STARTED, request is IDLE", () => {
-    expect(
-      updateFilesFacetsStatus(
-        FILE_MANIFEST_STATE_NOT_STARTED,
-        UPDATE_FILE_MANIFEST_PAYLOAD_IDLE
-      )
-    ).toBe(FILES_FACETS_STATUS.NOT_STARTED);
-  });
-
-  test("files facets NOT_STARTED, request is LOADING", () => {
-    expect(
-      updateFilesFacetsStatus(
-        FILE_MANIFEST_STATE_NOT_STARTED,
-        UPDATE_FILE_MANIFEST_PAYLOAD_LOADING
-      )
-    ).toBe(FILES_FACETS_STATUS.IN_PROGRESS);
-  });
-
-  test("files facets IN_PROGRESS, request is LOADING", () => {
-    expect(
-      updateFilesFacetsStatus(
-        FILE_MANIFEST_STATE_IN_PROGRESS,
-        UPDATE_FILE_MANIFEST_PAYLOAD_LOADING
-      )
-    ).toBe(FILES_FACETS_STATUS.IN_PROGRESS);
-  });
-
-  test("files facets IN_PROGRESS, request is SUCCESS", () => {
-    expect(
-      updateFilesFacetsStatus(
-        FILE_MANIFEST_STATE_IN_PROGRESS,
-        UPDATE_FILE_MANIFEST_PAYLOAD_SUCCESS
-      )
-    ).toBe(FILES_FACETS_STATUS.COMPLETED);
-  });
-
-  test("files facets COMPLETED, request is SUCCESS", () => {
-    expect(
-      updateFilesFacetsStatus(
-        FILE_MANIFEST_STATE_COMPLETED,
-        UPDATE_FILE_MANIFEST_PAYLOAD_SUCCESS
-      )
-    ).toBe(FILES_FACETS_STATUS.COMPLETED);
-  });
-});