@databiosphere/findable-ui 50.7.0 → 50.7.1

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

@@ -1,218 +0,0 @@
-import {
-  AzulEntitiesResponse,
-  AzulTerm,
-  AzulTermFacet,
-  AzulTermFacets,
-  LABEL,
-} from "../../../apis/azul/common/entities";
-import { COLLATOR_CASE_INSENSITIVE } from "../../../common/constants";
-import { Filters } from "../../../common/entities";
-import {
-  EntitySearchResults,
-  FileFacet,
-  SelectedSearchTermsBySearchKey,
-  Term,
-  TermsByName,
-} from "./entities";
-
-/**
- * Parse the entity API response and build up entity search results.
- * @param entityResponse - Response model return from the given entity API.
- * @param filters - Selected filters.
- * @returns entity search results.
- */
-export function bindEntitySearchResultsResponse(
-  entityResponse: AzulEntitiesResponse | undefined,
-  filters: Filters,
-): EntitySearchResults {
-  // Grab the search terms by search key
-  const searchTermsBySearchKey = getSelectedSearchTermsBySearchKey(filters);
-  // Build up term facets
-  const facets = bindFacets(searchTermsBySearchKey, entityResponse?.termFacets);
-  return {
-    facets,
-  };
-}
-
-/**
- * Map files API response into FileFacet objects, maintaining selected state of terms. This is specifically for
- * facets returned from the backend (which are facets with a corresponding list of terms) and not other types of
- * facets, for example, facets with a selected range.
- * TODO age range facet to be added, if required.
- * @param searchTermsBySearchKey - Selected search terms by search key.
- * @param responseFacetsByName - Facets returned from the API response.
- * @returns file facets.
- */
-function bindFacets(
-  searchTermsBySearchKey: SelectedSearchTermsBySearchKey,
-  responseFacetsByName: AzulTermFacets | undefined,
-): FileFacet[] {
-  if (!responseFacetsByName) {
-    return [];
-  }
-  return Object.keys(responseFacetsByName).map((facetName) => {
-    return buildFileFacet(
-      facetName,
-      searchTermsBySearchKey,
-      responseFacetsByName[facetName],
-    );
-  });
-}
-
-/**
- * Create a set of terms from the terms returned in the response. Maintain selected state of terms from current set
- * of search terms.
- * @param facetName - Facet name.
- * @param responseTerms - Response terms.
- * @param searchTermNames - Selected search term names.
- * @returns response terms with selected state.
- */
-function bindFacetTerms(
-  facetName: string,
-  responseTerms: AzulTerm[],
-  searchTermNames: unknown[],
-): Term[] {
-  return responseTerms.reduce((accum: Term[], responseTerm) => {
-    // Default term name to "Unspecified" if term name is null.
-    const name = bindTermName(responseTerm);
-    // Determine if term is currently selected as a search term.
-    const selected = searchTermNames.indexOf(responseTerm.term) >= 0;
-    // Create new term - default name to "Unspecified" if no value is returned.
-    accum.push({ count: responseTerm.count, name, selected });
-    return accum;
-  }, []);
-}
-
-/**
- * Update term name returned from response, if null. Otherwise, return term name as is.
- * @param termResponse - Term response.
- * @returns term name, or "Unspecified" if term name is null.
- */
-function bindTermName(termResponse: AzulTerm): string {
-  return termResponse.term === null ? LABEL.UNSPECIFIED : termResponse.term;
-}
-
-/**
- * Build up file facet from response facet values, matching with current selected state of terms.
- * @param facetName - Facet name.
- * @param searchTermsBySearchKey - Selected search terms by search key.
- * @param responseFacet - Response facet of the given facet name.
- * @returns something.
- */
-function buildFileFacet(
-  facetName: string,
-  searchTermsBySearchKey: SelectedSearchTermsBySearchKey,
-  responseFacet: AzulTermFacet,
-): FileFacet {
-  // Determine the set of currently selected search term names for this facet.
-  const searchTermNames = listFacetSearchTermNames(
-    facetName,
-    searchTermsBySearchKey,
-  );
-  // Build up the list of terms from the facet response.
-  const responseTerms = bindFacetTerms(
-    facetName,
-    responseFacet.terms,
-    searchTermNames,
-  );
-  // Create facet from newly built terms and newly calculated total.
-  return getFileFacet(facetName, responseFacet.total || 0, responseTerms);
-}
-
-/**
- * Returns file facet for the given facet name.
- * @param filesFacets - Files facets.
- * @param facetName - Facet name.
- * @returns file facet.
- */
-export function findFacet(
-  filesFacets: FileFacet[],
-  facetName: string,
-): FileFacet | undefined {
-  return filesFacets.find(({ name }) => name === facetName);
-}
-
-/**
- * Returns file facet that contains a list of terms values from given facet name, total, and terms.
- * @param name - Facet name.
- * @param total - Total number of terms.
- * @param terms - List of terms.
- * @returns file facet.
- */
-export function getFileFacet(
-  name: string,
-  total: number,
-  terms: Term[],
-): FileFacet {
-  const selectedTerms = terms.filter(({ selected }) => selected);
-  const selected = selectedTerms.length > 0;
-  const termsByName: TermsByName = terms.reduce((acc, term) => {
-    return acc.set(term.name, term);
-  }, new Map());
-  const termCount = terms.length;
-  const selectedTermCount = selectedTerms.length;
-  return {
-    name,
-    selected,
-    selectedTermCount,
-    selectedTerms,
-    termCount,
-    terms,
-    termsByName,
-    total,
-  };
-}
-
-/**
- * Returns map of selected search terms by search key.
- * @param filters - Selected filters.
- * @returns map of selected search terms by search key.
- */
-export function getSelectedSearchTermsBySearchKey(
-  filters: Filters,
-): SelectedSearchTermsBySearchKey {
-  const selectedSearchTermsBySearchKey: SelectedSearchTermsBySearchKey =
-    new Map();
-  for (const { categoryKey, value } of filters) {
-    selectedSearchTermsBySearchKey.set(categoryKey, new Set(value));
-  }
-  return selectedSearchTermsBySearchKey;
-}
-
-/**
- * Returns true if the file facet term name is selected.
- * @param fileFacet - File facet.
- * @param termName - Term name.
- * @returns true if the file facet term name is selected.
- */
-export function isFacetTermSelected(
-  fileFacet: FileFacet,
-  termName: string,
-): boolean {
-  return Boolean(
-    fileFacet.terms.find((term) => term.name === termName)?.selected,
-  );
-}
-
-/**
- * Returns the selected search terms for the specified facet, if any.
- * @param {string} facetName - Facet name.
- * @param searchTermsBySearchKey - Selected search terms by search key.
- * @returns selected search terms.
- */
-function listFacetSearchTermNames(
-  facetName: string,
-  searchTermsBySearchKey: SelectedSearchTermsBySearchKey,
-): unknown[] {
-  return [...(searchTermsBySearchKey.get(facetName) ?? [])];
-}
-
-/**
- * Sorts terms by term name.
- * @param c0 - First term to compare.
- * @param c1 - Second term to compare.
- * @returns Number indicating sort precedence of c0 vs c1.
- */
-export function sortTerms(c0: Term, c1: Term): number {
-  return COLLATOR_CASE_INSENSITIVE.compare(c0.name, c1.name);
-}

package/src/hooks/useFileManifest/useFetchFilesFacets.ts

@@ -1,57 +0,0 @@
-import { useEffect, useMemo } from "react";
-import {
-  APIEndpoints,
-  AzulEntitiesResponse,
-} from "../../apis/azul/common/entities";
-import { Filters } from "../../common/entities";
-import { fetchEntitiesFromURL } from "../../entity/common/service";
-import { fetchQueryParams, SearchParams } from "../../utils/fetchQueryParams";
-import { useToken } from "../authentication/token/useToken";
-import { useAsync } from "../useAsync";
-import { useFetchRequestURL } from "../useFetchRequestURL";
-import { FetchFilesFacets } from "./common/entities";
-import { bindEntitySearchResultsResponse } from "./common/utils";
-
-/**
- * Fetch files facets from files endpoint, to populate summary in download flows.
- * @param filters - Selected filters.
- * @param catalog - Configured catalog.
- * @param searchParams - Custom search parameters i.e. "size" and sorting behaviour.
- * @param isEnabled - Enable fetch.
- * @returns files facets.
- */
-export const useFetchFilesFacets = (
-  filters: Filters,
-  catalog: string,
-  searchParams: SearchParams | undefined,
-  isEnabled: boolean,
-): FetchFilesFacets => {
-  const { token } = useToken();
-  // Build request params.
-  const requestParams = fetchQueryParams(filters, catalog, searchParams);
-  // Build request URL.
-  const requestURL = useFetchRequestURL(APIEndpoints.FILES, requestParams);
-  // Fetch and bind facets.
-  const { data, isLoading, isSuccess, reset, run } =
-    useAsync<AzulEntitiesResponse>();
-  // Bind facets.
-  const { facets } = useMemo(
-    () => bindEntitySearchResultsResponse(data, filters),
-    [data, filters],
-  );
-
-  // Fetch facets from files endpoint.
-  useEffect(() => {
-    if (isEnabled) {
-      run(fetchEntitiesFromURL(requestURL, token));
-    } else {
-      reset();
-    }
-  }, [isEnabled, requestURL, reset, run, token]);
-
-  return {
-    filesFacets: facets,
-    isLoading,
-    isSuccess,
-  };
-};

package/src/hooks/useFileManifest/useFetchSummary.ts

@@ -1,45 +0,0 @@
-import { useEffect } from "react";
-import {
-  APIEndpoints,
-  AzulSummaryResponse,
-} from "../../apis/azul/common/entities";
-import { Filters } from "../../common/entities";
-import { fetchSummaryFromURL } from "../../entity/api/service";
-import { fetchQueryParams } from "../../utils/fetchQueryParams";
-import { useToken } from "../authentication/token/useToken";
-import { useAsync } from "../useAsync";
-import { useFetchRequestURL } from "../useFetchRequestURL";
-import { FetchFileSummary } from "./common/entities";
-
-/**
- * Fetch file summary from summary endpoint, to populate summary in download flows.
- * @param filters - Selected filters.
- * @param catalog - Configured catalog.
- * @param isEnabled - Enable fetch.
- * @returns file summaries.
- */
-export const useFetchSummary = (
-  filters: Filters,
-  catalog: string,
-  isEnabled: boolean,
-): FetchFileSummary => {
-  const { token } = useToken();
-  // Build request params.
-  const requestParams = fetchQueryParams(filters, catalog, undefined);
-  // Build request URL.
-  const requestURL = useFetchRequestURL(APIEndpoints.SUMMARY, requestParams);
-  // Fetch summary.
-  const { data, isLoading, run } = useAsync<AzulSummaryResponse>();
-
-  // Fetch summary from summary endpoint.
-  useEffect(() => {
-    if (isEnabled) {
-      run(fetchSummaryFromURL(requestURL, token));
-    }
-  }, [isEnabled, requestURL, run, token]);
-
-  return {
-    isLoading,
-    summary: data, // Binding of file summary is completed via configuration.
-  };
-};

package/src/hooks/useFileManifest/useFileManifest.ts

@@ -1,40 +0,0 @@
-import { useEffect, useState } from "react";
-import { Filters } from "../../common/entities";
-import { FileManifestActionKind } from "../../providers/fileManifestState";
-import { useFileManifestState } from "../useFileManifestState";
-
-/**
- * Initializes the file manifest with specified filters and a file summary facet name.
- * This hook sets up the file manifest state by dispatching an action to fetch the manifest
- * based on the provided initial filters and file summary facet name. It also ensures that
- * the manifest state is cleared when the component is unmounted.
- * @param initialFilters - The initial filters used to fetch the file manifest.
- * @param fileSummaryFacetName - The name of the file summary facet to be used in the file manifest request.
- */
-export const useFileManifest = (
-  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: {
-        fileSummaryFacetName,
-        filters: initFilters,
-      },
-      type: FileManifestActionKind.FetchFileManifest,
-    });
-    return (): void => {
-      fileManifestDispatch({
-        payload: undefined,
-        type: FileManifestActionKind.ClearFileManifest,
-      });
-    };
-  }, [fileManifestDispatch, fileSummaryFacetName, initFilters]);
-};

package/src/hooks/useFileManifest/useFileManifestDownload.ts

@@ -1,118 +0,0 @@
-import { MANIFEST_DOWNLOAD_FORMAT } from "../../apis/azul/common/entities";
-import { Filters } from "../../common/entities";
-import { BULK_DOWNLOAD_EXECUTION_ENVIRONMENT } from "../../components/Export/common/entities";
-import { useCatalog } from "../useCatalog";
-import { useConfig } from "../useConfig";
-import {
-  FileLocation,
-  useRequestFileLocation,
-} from "../useRequestFileLocation";
-import { buildRequestManifest } from "../useRequestManifest/utils";
-
-export interface ManifestDownload {
-  fileName?: string;
-  isIdle: boolean;
-  isLoading: boolean;
-  manifestURL?: string;
-  requestManifest: () => void;
-}
-
-/**
- * Returns file manifest download url and file name.
- * @param filters - Filters.
- * @returns file manifest download url and file name.
- */
-export const useFileManifestDownload = (filters: Filters): ManifestDownload => {
-  // Retrieve the endpoint URL from configured data source.
-  const config = useConfig();
-  const endpointUrl = config.config.dataSource.url;
-  // Determine catalog.
-  const catalog = useCatalog() as string; // catalog should be defined.
-  // Build request manifest request URL.
-  const { requestMethod, requestUrl } = buildRequestManifest(
-    endpointUrl,
-    catalog,
-    filters,
-    MANIFEST_DOWNLOAD_FORMAT.COMPACT,
-  );
-  const {
-    data,
-    isIdle,
-    isLoading,
-    run: requestManifest,
-  } = useRequestFileLocation(requestUrl, requestMethod);
-  const manifestURL = getManifestDownloadURL(data);
-  const fileName = getManifestDownloadFileName(data);
-
-  return {
-    fileName,
-    isIdle,
-    isLoading,
-    manifestURL,
-    requestManifest,
-  };
-};
-
-/**
- * Returns the manifest download URL for the generated manifest.
- * @param fileLocation - Request file location.
- * @returns manifest download URL.
- */
-function getManifestDownloadURL(
-  fileLocation?: FileLocation,
-): string | undefined {
-  const { location } = fileLocation || {};
-  return location;
-}
-
-/**
- * Returns the manifest download file name for the generated manifest.
- * @param fileLocation - File location.
- * @returns manifest download file name.
- */
-function getManifestDownloadFileName(
-  fileLocation?: FileLocation,
-): string | undefined {
-  if (!fileLocation) {
-    return;
-  }
-  const fileName = getFileNameFromLocation(fileLocation.location);
-  if (fileName) {
-    return fileName;
-  }
-  return getFileNameFromBash(fileLocation.commandLine);
-}
-
-/**
- * Returns the file name from the specified bash command line, if it exists.
- * @param commandLine - Command line.
- * @returns file name.
- */
-function getFileNameFromBash(
-  commandLine?: FileLocation["commandLine"],
-): string | undefined {
-  if (!commandLine) {
-    return;
-  }
-  return commandLine[BULK_DOWNLOAD_EXECUTION_ENVIRONMENT.BASH]
-    .split("'")
-    .filter((b) => b.includes("tsv"))
-    .shift();
-}
-
-/**
- * Returns the file name from the specified file location, if it exists.
- * @param location - File location.
- * @returns file name.
- */
-function getFileNameFromLocation(
-  location: FileLocation["location"],
-): string | undefined {
-  const searchParams = new URL(location).searchParams;
-  const paramValue = searchParams.get("response-content-disposition");
-  if (!paramValue) {
-    return;
-  }
-  const match = paramValue.match(/filename=([^&;]*)/);
-  return match?.[1].replace(/"/g, "");
-}

package/src/hooks/useFileManifest/useFileManifestFileCount.ts

@@ -1,65 +0,0 @@
-import { useEffect, useState } from "react";
-import { Filters } from "../../common/entities";
-import { FileManifestActionKind } from "../../providers/fileManifestState";
-import { useCatalog } from "../useCatalog";
-import { useFileManifestState } from "../useFileManifestState";
-import { useFetchSummary } from "./useFetchSummary";
-
-/**
- * Fetches the latest file count from the summary endpoint, excluding filters
- * that match the provided species and file facet names, and updates the file manifest state.
- *
- * @param initialFilters - The initial set of filters to apply.
- * @param speciesFacetName - The facet name representing species to exclude from the summary request.
- * @param fileFacetName - The facet name representing file type to exclude from the summary request.
- */
-export const useFileManifestFileCount = (
-  initialFilters: Filters | undefined,
-  speciesFacetName: string,
-  fileFacetName: string,
-): void => {
-  // Initial file manifest filter.
-  const [initFilters] = useState(() => initialFilters);
-
-  // File manifest dispatch.
-  const { fileManifestDispatch } = useFileManifestState();
-
-  // Determine catalog.
-  const catalog = useCatalog() as string; // catalog should be defined.
-
-  // Get filters required for fetching the summary.
-  const filters = excludeFacetsFromFilters(initFilters, [
-    speciesFacetName,
-    fileFacetName,
-  ]);
-
-  // Fetch file count from summary.
-  const { summary: { fileCount } = {} } = useFetchSummary(
-    filters,
-    catalog,
-    true,
-  );
-
-  useEffect(() => {
-    fileManifestDispatch({
-      payload: { fileCount },
-      type: FileManifestActionKind.UpdateFileCount,
-    });
-  }, [fileCount, fileManifestDispatch]);
-};
-
-/**
- * Returns a new filters array with the specified facet names excluded.
- *
- * @param filters - The list of filters to process.
- * @param facetNames - The facet names to exclude from the filters.
- * @returns The filters array excluding any filters matching the provided facet names.
- */
-function excludeFacetsFromFilters(
-  filters: Filters | undefined,
-  facetNames: string[],
-): Filters {
-  return (filters || []).filter(
-    ({ categoryKey }) => !facetNames.includes(categoryKey),
-  );
-}

package/src/hooks/useFileManifest/useFileManifestFormat.ts

@@ -1,23 +0,0 @@
-import { Dispatch, SetStateAction, useState } from "react";
-import { ManifestDownloadFormat } from "../../components/Export/common/entities";
-
-export interface FileManifestFormatState {
-  fileManifestFormat: ManifestDownloadFormat | undefined;
-  setFileManifestFormat: Dispatch<
-    SetStateAction<ManifestDownloadFormat | undefined>
-  >;
-}
-
-/**
- * Facilitates the management of file manifest format state.
- * @param manifestDownloadFormat - The initial manifest download format used to fetch the file manifest.
- * @returns The file manifest format state and a function to set the file manifest format.
- */
-export const useFileManifestFormat = (
-  manifestDownloadFormat?: ManifestDownloadFormat,
-): FileManifestFormatState => {
-  const [fileManifestFormat, setFileManifestFormat] = useState<
-    ManifestDownloadFormat | undefined
-  >(manifestDownloadFormat);
-  return { fileManifestFormat, setFileManifestFormat };
-};

package/src/hooks/useFileManifest/useFileManifestSpreadsheet.ts

@@ -1,110 +0,0 @@
-import { useCallback, useEffect, useMemo } from "react";
-import {
-  APIEndpoints,
-  AzulEntitiesResponse,
-} from "../../apis/azul/common/entities";
-import { Filters } from "../../common/entities";
-import { fetchEntitiesFromURL } from "../../entity/common/service";
-import { fetchQueryParams } from "../../utils/fetchQueryParams";
-import { useAsync } from "../useAsync";
-import { useCatalog } from "../useCatalog";
-import { useFetchRequestURL } from "../useFetchRequestURL";
-import { useRequestFileLocation } from "../useRequestFileLocation";
-
-export interface ManifestSpreadsheet {
-  fileName?: string;
-  fileUrl?: string;
-  isIdle?: boolean;
-  isLoading?: boolean;
-  requestManifest?: () => void;
-  spreadsheetUrl?: string;
-}
-
-/**
- * Returns file manifest spreadsheet.
- * @param filters - Filters.
- * @returns file manifest spreadsheet.
- */
-export const useFileManifestSpreadsheet = (
-  filters: Filters,
-): Omit<ManifestSpreadsheet, "fileUrl"> => {
-  // Determine catalog.
-  const catalog = useCatalog() as string; // catalog should be defined.
-  // Build request params.
-  const requestParams = fetchQueryParams(filters, catalog, { size: "25" });
-  // Build request URL.
-  const requestURL = useFetchRequestURL(APIEndpoints.FILES, requestParams);
-  // Fetch files to determine if file exists.
-  const {
-    data: files,
-    isIdle,
-    isLoading: isFilesLoading,
-    run: requestFiles,
-  } = useAsync<AzulEntitiesResponse>();
-
-  // Grab manifest spreadsheet.
-  const { fileName, fileUrl } = useMemo(
-    () => getManifestSpreadsheet(files?.hits),
-    [files],
-  );
-
-  // Fetch file manifest.
-  const { data, isLoading, run } = useRequestFileLocation(fileUrl);
-
-  // Fetch response from files endpoint.
-  const requestManifest = useCallback(() => {
-    requestFiles(fetchEntitiesFromURL(requestURL, undefined));
-  }, [requestFiles, requestURL]);
-
-  // Fetch file manifest.
-  useEffect(() => {
-    run();
-  }, [fileUrl, run]);
-
-  return {
-    fileName,
-    isIdle,
-    isLoading: isFilesLoading || isLoading,
-    requestManifest,
-    spreadsheetUrl: data?.location,
-  };
-};
-
-/**
- * Prepend "/fetch" to the path of the specified file URL, if not already included.
- * @param fileUrl - File URL.
- * @returns File URL with "/fetch" prepended to the path.
- */
-function buildFetchFileUrl(fileUrl?: string): string | undefined {
-  if (!fileUrl) {
-    return;
-  }
-  const url = new URL(fileUrl);
-  const path = url.pathname;
-  if (path.indexOf(APIEndpoints.FETCH) !== 0) {
-    url.pathname = `${APIEndpoints.FETCH}${path}`;
-  }
-  return url.toString();
-}
-
-/**
- * Returns manifest spreadsheet.
- * @param files - Files.
- * @returns manifest spreadsheet.
- */
-function getManifestSpreadsheet(
-  files?: AzulEntitiesResponse["hits"],
-): Pick<ManifestSpreadsheet, "fileName" | "fileUrl"> {
-  if (!files) return { fileName: undefined, fileUrl: undefined };
-
-  // Handle case where file does not exist.
-  if (files.length === 0) return { fileName: undefined, fileUrl: undefined };
-
-  // Project manifest spreadsheet exists.
-  const file = files[0];
-
-  return {
-    fileName: file.files[0]?.name,
-    fileUrl: buildFetchFileUrl(file.files[0]?.azul_url),
-  };
-}

package/src/hooks/useFileManifestState.ts

@@ -1,13 +0,0 @@
-import { useContext } from "react";
-import {
-  FileManifestStateContext,
-  FileManifestStateContextProps,
-} from "../providers/fileManifestState";
-
-/**
- * Returns file manifest state context.
- * @returns file manifest  state context.
- */
-export const useFileManifestState = (): FileManifestStateContextProps => {
-  return useContext(FileManifestStateContext);
-};