@databiosphere/findable-ui 16.0.0 → 17.0.0

package/src/components/Export/components/ExportToTerra/components/ExportToTerraForm/exportToTerraForm.tsx

@@ -1,4 +1,5 @@
-import React from "react";
+import React, { Dispatch, SetStateAction } from "react";
+import { FileManifestFormatState } from "../../../../../../hooks/useFileManifest/useFileManifestFormat";
 import { FormFacet, ManifestDownloadFormat } from "../../../../common/entities";
 import { ExportButton } from "../../../ExportForm/components/ExportButton/exportButton";
 import { ExportManifestDownloadFormatForm } from "../../../ExportForm/components/ExportManifestDownloadFormatForm/exportManifestDownloadFormatForm";
@@ -8,17 +9,20 @@ import {
 } from "../../../ExportForm/exportForm";
 
 export interface ExportToTerraFormProps {
+  fileManifestFormatState: FileManifestFormatState;
   formFacet: FormFacet;
   isLoading: boolean;
-  manifestDownloadFormat?: ManifestDownloadFormat;
   manifestDownloadFormats: ManifestDownloadFormat[];
   onRequestManifest: OnRequestManifestFn;
+  setFileManifestFormat: Dispatch<
+    SetStateAction<ManifestDownloadFormat | undefined>
+  >;
 }
 
 export const ExportToTerraForm = ({
+  fileManifestFormatState,
   formFacet,
   isLoading,
-  manifestDownloadFormat,
   manifestDownloadFormats,
   onRequestManifest,
 }: ExportToTerraFormProps): JSX.Element => {
@@ -30,7 +34,7 @@ export const ExportToTerraForm = ({
       onRequestManifest={onRequestManifest}
     >
       <ExportManifestDownloadFormatForm
-        manifestDownloadFormat={manifestDownloadFormat}
+        fileManifestFormatState={fileManifestFormatState}
         manifestDownloadFormats={manifestDownloadFormats}
       />
     </ExportForm>

package/src/components/Export/components/ExportToTerra/components/ExportToTerraNotStarted/exportToTerraNotStarted.tsx

@@ -1,4 +1,5 @@
 import React, { ElementType } from "react";
+import { FileManifestFormatState } from "../../../../../../hooks/useFileManifest/useFileManifestFormat";
 import { FileManifestState } from "../../../../../../providers/fileManifestState";
 import { PAPER_PANEL_STYLE } from "../../../../../common/Paper/paper";
 import { FluidPaper } from "../../../../../common/Paper/paper.styles";
@@ -10,6 +11,7 @@ import { OnRequestManifestFn } from "../../../ExportForm/exportForm";
 export interface ExportToTerraNotStartedProps {
   ExportTerraForm: ElementType;
   ExportToTerraStart: ElementType;
+  fileManifestFormatState: FileManifestFormatState;
   fileManifestState: FileManifestState;
   formFacet: FormFacet;
   isLoading: boolean;
@@ -20,6 +22,7 @@ export interface ExportToTerraNotStartedProps {
 export const ExportToTerraNotStarted = ({
   ExportTerraForm,
   ExportToTerraStart,
+  fileManifestFormatState,
   fileManifestState,
   formFacet,
   isLoading,
@@ -39,9 +42,9 @@ export const ExportToTerraNotStarted = ({
             <ExportToTerraStart />
           </SectionContent>
           <ExportTerraForm
+            fileManifestFormatState={fileManifestFormatState}
             formFacet={formFacet}
             isLoading={fileManifestState.isLoading}
-            manifestDownloadFormat={fileManifestState.fileManifestFormat}
             manifestDownloadFormats={manifestDownloadFormats}
             onRequestManifest={onRequestManifest}
           />

package/src/components/Export/components/ExportToTerra/exportToTerra.tsx

@@ -4,7 +4,9 @@ import { useExploreState } from "../../../../hooks/useExploreState";
 import { useExportToTerraResponseURL } from "../../../../hooks/useExportToTerraResponseURL";
 import { FileManifestType } from "../../../../hooks/useFileManifest/common/entities";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
-import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
+import { useFileManifestFormat } from "../../../../hooks/useFileManifest/useFileManifestFormat";
+import { useRequestFileLocation } from "../../../../hooks/useRequestFileLocation";
+import { useRequestManifest } from "../../../../hooks/useRequestManifest/useRequestManifest";
 import { FileManifestState } from "../../../../providers/fileManifestState";
 import { FormFacet, ManifestDownloadFormat } from "../../common/entities";
 import { trackExportToTerraRequested } from "../../common/tracking";
@@ -29,7 +31,6 @@ export const ExportToTerra = ({
   ExportToTerraStart,
   ExportToTerraSuccess,
   fileManifestState,
-  fileManifestType,
   fileSummaryFacetName,
   filters,
   formFacet,
@@ -39,14 +40,16 @@ export const ExportToTerra = ({
   const {
     exploreState: { tabValue: entityList },
   } = useExploreState();
-  useRequestFileManifest(
-    fileManifestType,
-    manifestDownloadFormat,
-    filters,
-    fileSummaryFacetName
+  useFileManifest(filters, fileSummaryFacetName);
+  const fileManifestFormatState = useFileManifestFormat(manifestDownloadFormat);
+  const { requestMethod, requestParams, requestUrl } = useRequestManifest(
+    fileManifestFormatState.fileManifestFormat,
+    formFacet
+  );
+  const { data, isLoading, run } = useRequestFileLocation(
+    requestUrl,
+    requestMethod
   );
-  const { requestParams } = fileManifestState;
-  const { data, isLoading, run } = useFileManifest();
   const exportURL = useExportToTerraResponseURL(requestParams, data);
   return exportURL ? (
     <ExportToTerraReady
@@ -57,6 +60,7 @@ export const ExportToTerra = ({
     <ExportToTerraNotStarted
       ExportTerraForm={ExportForm}
       ExportToTerraStart={ExportToTerraStart}
+      fileManifestFormatState={fileManifestFormatState}
       fileManifestState={fileManifestState}
       formFacet={formFacet}
       isLoading={isLoading}

package/src/components/Export/components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.tsx

@@ -1,28 +1,23 @@
 import React from "react";
-import { MANIFEST_DOWNLOAD_FORMAT } from "../../../../../../apis/azul/common/entities";
 import { Filters } from "../../../../../../common/entities";
 import { FileManifestType } from "../../../../../../hooks/useFileManifest/common/entities";
-import { useRequestFileManifest } from "../../../../../../hooks/useFileManifest/useRequestFileManifest";
+import { useFileManifest } from "../../../../../../hooks/useFileManifest/useFileManifest";
+import { ManifestDownloadFormat } from "../../../../common/entities";
 import { FileManifestDownload } from "./components/FileManifestDownload/fileManifestDownload";
 import { FileManifestSpreadsheet } from "./components/FileManifestSpreadsheet/fileManifestSpreadsheet";
 
 export interface ManifestDownloadEntityProps {
   fileManifestType: FileManifestType;
   filters: Filters; // Initializes manifest download filters.
+  manifestDownloadFormat?: ManifestDownloadFormat;
   metadataFilters: Filters; // Metadata filters filters.
 }
 
 export const ManifestDownloadEntity = ({
-  fileManifestType,
   filters,
   metadataFilters,
 }: ManifestDownloadEntityProps): JSX.Element => {
-  useRequestFileManifest(
-    fileManifestType,
-    MANIFEST_DOWNLOAD_FORMAT.COMPACT,
-    filters,
-    undefined
-  );
+  useFileManifest(filters, undefined);
   return (
     <>
       <FileManifestSpreadsheet filters={metadataFilters} />

package/src/components/Export/components/ManifestDownload/manifestDownload.tsx

@@ -4,10 +4,13 @@ import { Filters } from "../../../../common/entities";
 import { useExploreState } from "../../../../hooks/useExploreState";
 import { FileManifestType } from "../../../../hooks/useFileManifest/common/entities";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
-import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
-import { FileLocation } from "../../../../hooks/useRequestFileLocation";
+import {
+  FileLocation,
+  useRequestFileLocation,
+} from "../../../../hooks/useRequestFileLocation";
+import { useRequestManifest } from "../../../../hooks/useRequestManifest/useRequestManifest";
 import { FileManifestState } from "../../../../providers/fileManifestState";
-import { FormFacet } from "../../common/entities";
+import { FormFacet, ManifestDownloadFormat } from "../../common/entities";
 import { trackFileManifestRequested } from "../../common/tracking";
 import { ManifestDownloadNotStarted } from "./components/ManifestDownloadNotStarted/manifestDownloadNotStarted";
 import { ManifestDownloadReady } from "./components/ManifestDownloadReady/manifestDownloadReady";
@@ -19,30 +22,33 @@ export interface ManifestDownloadProps {
   filters: Filters; // Initializes manifest download filters.
   formFacet: FormFacet;
   ManifestDownloadForm: ElementType;
+  manifestDownloadFormat?: ManifestDownloadFormat;
   ManifestDownloadStart: ElementType;
   ManifestDownloadSuccess: ElementType;
 }
 
 export const ManifestDownload = ({
   fileManifestState,
-  fileManifestType,
   fileSummaryFacetName,
   filters,
   formFacet,
   ManifestDownloadForm,
+  manifestDownloadFormat = MANIFEST_DOWNLOAD_FORMAT.COMPACT,
   ManifestDownloadStart,
   ManifestDownloadSuccess,
 }: ManifestDownloadProps): JSX.Element => {
-  useRequestFileManifest(
-    fileManifestType,
-    MANIFEST_DOWNLOAD_FORMAT.COMPACT,
-    filters,
-    fileSummaryFacetName
-  );
+  useFileManifest(filters, fileSummaryFacetName);
   const {
     exploreState: { tabValue: entityList },
   } = useExploreState();
-  const { data, isLoading, run } = useFileManifest();
+  const { requestMethod, requestUrl } = useRequestManifest(
+    manifestDownloadFormat,
+    formFacet
+  );
+  const { data, isLoading, run } = useRequestFileLocation(
+    requestUrl,
+    requestMethod
+  );
   const manifestURL = getManifestDownloadURL(data);
   return manifestURL ? (
     <ManifestDownloadReady

package/src/components/Links/components/Link/components/ExploreViewLink/exploreViewLink.tsx

@@ -66,7 +66,7 @@ export const ExploreViewLink = ({
  * @returns entity list type.
  */
 function getEntityListType(href: UrlObjectWithHrefAndQuery["href"]): string {
-  return href.substring(1);
+  return href.substring(href.lastIndexOf("/") + 1);
 }
 
 /**
@@ -139,7 +139,7 @@ function isValidExploreURL(
 }
 
 /**
- * Returns true if the given href is a configured key in the explore state's entityPageState.
+ * Returns true if the given href is a path ending with a configured key in the explore state's entityPageState.
  * @param url - Explore link URL.
  * @param exploreState - Explore state.
  * @returns true if the given href is configured in the explore state.
@@ -150,7 +150,10 @@ function isValidHref(
 ): boolean {
   const { entityPageState } = exploreState;
   const { href } = url;
-  return href.startsWith("/") && href.substring(1) in entityPageState;
+  return (
+    href.startsWith("/") &&
+    href.substring(href.lastIndexOf("/") + 1) in entityPageState
+  );
 }
 
 /**

package/src/hooks/types.ts

@@ -0,0 +1,4 @@
+export enum METHOD {
+  GET = "GET",
+  PUT = "PUT",
+}

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

@@ -45,12 +45,6 @@ export enum FILE_MANIFEST_TYPE {
 
 export type FileManifestType = FILE_MANIFEST_TYPE;
 
-export enum FILES_FACETS_STATUS {
-  COMPLETED = "COMPLETED",
-  IN_PROGRESS = "IN_PROGRESS",
-  NOT_STARTED = "NOT_STARTED",
-}
-
 export type SelectedSearchTermsBySearchKey = Map<
   CategoryKey,
   Set<CategoryValueKey>

package/src/hooks/useFileManifest/useFileManifest.ts

@@ -1,19 +1,40 @@
+import { useEffect, useState } from "react";
+import { Filters } from "../../common/entities";
+import { FileManifestActionKind } from "../../providers/fileManifestState";
 import { useFileManifestState } from "../useFileManifestState";
-import {
-  METHOD,
-  useRequestFileLocation,
-  UseRequestFileLocationResult,
-} from "../useRequestFileLocation";
 
 /**
- * Requests file manifest.
- * @param requestURL - Request URL.
- * @returns file manifest request response, function and status.
+ * 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 = (
-  requestURL?: string
-): UseRequestFileLocationResult => {
-  const { fileManifestState } = useFileManifestState();
-  const url = requestURL || fileManifestState.requestURL;
-  return useRequestFileLocation(url, METHOD.PUT);
+  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

@@ -3,10 +3,12 @@ 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 { FileLocation } from "../useRequestFileLocation";
-import { buildFileManifestRequestURL } from "./common/buildFileManifestRequestURL";
-import { useFileManifest } from "./useFileManifest";
-import { useFileManifestURL } from "./useFileManifestURL";
+import { useConfig } from "../useConfig";
+import {
+  FileLocation,
+  useRequestFileLocation,
+} from "../useRequestFileLocation";
+import { buildRequestManifest } from "../useRequestManifest/utils";
 
 export interface ManifestDownload {
   fileName?: string;
@@ -25,19 +27,22 @@ export const useFileManifestDownload = (
   filters: Filters,
   disabled: boolean
 ): ManifestDownload => {
-  // Determine file manifest request data URL.
-  const URL = useFileManifestURL();
+  // 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 URL.
-  const { requestURL } =
-    buildFileManifestRequestURL(
-      URL,
-      filters,
-      catalog,
-      MANIFEST_DOWNLOAD_FORMAT.COMPACT
-    ) || {};
-  const { data, isIdle, isLoading, run } = useFileManifest(requestURL);
+  // Build request manifest request URL.
+  const { requestMethod, requestUrl } = buildRequestManifest(
+    endpointUrl,
+    catalog,
+    filters,
+    MANIFEST_DOWNLOAD_FORMAT.COMPACT
+  );
+  const { data, isIdle, isLoading, run } = useRequestFileLocation(
+    requestUrl,
+    requestMethod
+  );
   const manifestURL = getManifestDownloadURL(data);
   const fileName = getManifestDownloadFileName(data);
 
@@ -45,7 +50,7 @@ export const useFileManifestDownload = (
   useEffect(() => {
     if (disabled) return;
     run();
-  }, [disabled, requestURL, run]);
+  }, [disabled, requestUrl, run]);
 
   return {
     fileName,

package/src/hooks/useFileManifest/useFileManifestFormat.ts

@@ -0,0 +1,23 @@
+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/useRequestFileLocation.ts

@@ -4,6 +4,7 @@ import {
   FILE_LOCATION_SUCCESSFULLY,
 } from "../apis/azul/common/constants";
 import { FileLocationResponse } from "../apis/azul/common/entities";
+import { METHOD } from "./types";
 import { useAsync } from "./useAsync";
 import { useAuthentication } from "./useAuthentication/useAuthentication";
 
@@ -24,11 +25,6 @@ export interface UseRequestFileLocationResult {
 
 export type Method = METHOD;
 
-export enum METHOD {
-  GET = "GET",
-  PUT = "PUT",
-}
-
 type ResolveFn = (file: FileLocation | PromiseLike<FileLocation>) => void;
 type RejectFn = (reason: FileLocation) => void;
 

package/src/hooks/useRequestManifest/constants.ts

@@ -0,0 +1,6 @@
+import { METHOD } from "../types";
+import { UseRequestManifest } from "./types";
+
+export const REQUEST_MANIFEST: UseRequestManifest = {
+  requestMethod: METHOD.PUT,
+};

package/src/hooks/useRequestManifest/types.ts

@@ -0,0 +1,7 @@
+import { Method } from "../useRequestFileLocation";
+
+export interface UseRequestManifest {
+  requestMethod: Method;
+  requestParams?: URLSearchParams;
+  requestUrl?: string;
+}

package/src/hooks/useRequestManifest/useRequestManifest.ts

@@ -0,0 +1,49 @@
+import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
+import { FormFacet } from "../../components/Export/common/entities";
+import { useCatalog } from "../useCatalog";
+import { useConfig } from "../useConfig";
+import { useFileManifestState } from "../useFileManifestState";
+import { REQUEST_MANIFEST } from "./constants";
+import { UseRequestManifest } from "./types";
+import {
+  buildRequestFilters,
+  buildRequestManifest,
+  isCatalogReady,
+  isFileManifestFormatReady,
+  isFileManifestStateReady,
+  isFormSelectionReady,
+} from "./utils";
+
+/**
+ * Returns file manifest request method, params and URL.
+ * @param fileManifestFormat - File manifest format.
+ * @param formFacet - Object containing form related facets.
+ * @returns file manifest request method, params and URL.
+ */
+export const useRequestManifest = (
+  fileManifestFormat: ManifestDownloadFormat | undefined,
+  formFacet: FormFacet
+): UseRequestManifest => {
+  // Retrieve the endpoint URL from configured data source.
+  const config = useConfig();
+  const endpointUrl = config.config.dataSource.url;
+  // Determine catalog.
+  const catalog = useCatalog();
+  // Retrieve file manifest state.
+  const { fileManifestState } = useFileManifestState();
+  // Return file manifest request method etc. when conditions are met.
+  if (
+    isCatalogReady(catalog) &&
+    isFileManifestFormatReady(fileManifestFormat) &&
+    isFileManifestStateReady(fileManifestState) &&
+    isFormSelectionReady(formFacet)
+  ) {
+    return buildRequestManifest(
+      endpointUrl,
+      catalog as string, // Catalog is defined.
+      buildRequestFilters(fileManifestState, formFacet),
+      fileManifestFormat as ManifestDownloadFormat // Manifest format is defined.
+    );
+  }
+  return REQUEST_MANIFEST;
+};

package/src/hooks/useRequestManifest/utils.ts

@@ -0,0 +1,153 @@
+import {
+  AZUL_PARAM,
+  MANIFEST_DOWNLOAD_FORMAT,
+  ManifestDownloadFormat,
+} from "../../apis/azul/common/entities";
+import { transformFilters } from "../../apis/azul/common/filterTransformer";
+import { Filters } from "../../common/entities";
+import { FormFacet } from "../../components/Export/common/entities";
+import { FileManifestState } from "../../providers/fileManifestState";
+import { FileFacet } from "../useFileManifest/common/entities";
+import { REQUEST_MANIFEST } from "./constants";
+import { UseRequestManifest } from "./types";
+
+/**
+ * Returns true if all form facets have all their terms selected.
+ * @param formFacet - Form related file facets.
+ * @returns true if all form facets have all their terms selected.
+ */
+export function areAllFormFilterTermsSelected(formFacet: FormFacet): boolean {
+  return Object.values(formFacet)
+    .filter(Boolean)
+    .every(
+      ({ selectedTermCount, termCount }: FileFacet) =>
+        selectedTermCount === termCount
+    );
+}
+
+/**
+ * Generates the filters for a request URL based on the file manifest state.
+ * - **all form facets have all their terms selected** - returns filters from state without form filters.
+ * - **at least one form facet has an unselected term** - returns filters from state.
+ * @param state - File manifest state.
+ * @param formFacet - Form related file facets.
+ * @returns filters for the request URL.
+ */
+export function buildRequestFilters(
+  state: FileManifestState,
+  formFacet: FormFacet
+): Filters {
+  // Form terms are fully selected; return filters excluding form filters.
+  if (areAllFormFilterTermsSelected(formFacet)) {
+    return excludeFullySelectedFormFilters(state, formFacet);
+  }
+  // Form terms are partially selected; return filters.
+  return state.filters;
+}
+
+/**
+ * Build up file manifest request params and URL query string for the given search results, catalog and format.
+ * @param endpointUrl - Data URL.
+ * @param catalog - Configured catalog.
+ * @param filters - Selected filters.
+ * @param manifestFormat - Manifest format.
+ * @returns file manifest request params and URL query string.
+ */
+export function buildRequestManifest(
+  endpointUrl: string,
+  catalog: string,
+  filters: Filters,
+  manifestFormat: ManifestDownloadFormat
+): Required<UseRequestManifest> {
+  const requestParams = new URLSearchParams({
+    [AZUL_PARAM.CATALOG]: catalog,
+    [AZUL_PARAM.FILTERS]: transformFilters(filters),
+    format: manifestFormat,
+  });
+  const requestUrl = `${endpointUrl}fetch/manifest/files?${requestParams.toString()}`;
+  return {
+    ...REQUEST_MANIFEST,
+    requestParams,
+    requestUrl,
+  };
+}
+
+/**
+ * Returns filters, without form related filters.
+ * @param state - File manifest state.
+ * @param formFacet - Form related file facets.
+ * @returns filters.
+ */
+export function excludeFullySelectedFormFilters(
+  state: FileManifestState,
+  formFacet: FormFacet
+): Filters {
+  const filters: Filters = [];
+  const formFacetNames = getFormFacetNamesSet(formFacet);
+  for (const filter of state.filters) {
+    if (formFacetNames.has(filter.categoryKey)) continue;
+    filters.push(filter);
+  }
+  return filters;
+}
+
+/**
+ * Returns a set of form facet names.
+ * @param formFacet - Form related file facets.
+ * @returns set of form facet names.
+ */
+function getFormFacetNamesSet(formFacet: FormFacet): Set<string> {
+  return new Set(
+    Object.values(formFacet)
+      .filter(Boolean)
+      .map(({ name }: FileFacet) => name)
+  );
+}
+
+/**
+ * Returns true if the catalog is defined.
+ * The catalog is defined via the configuration and is required for the file manifest request.
+ * @param catalog - Catalog.
+ * @returns true if the catalog is defined.
+ */
+export function isCatalogReady(catalog: string | undefined): boolean {
+  return typeof catalog === "string";
+}
+
+/**
+ * Returns true if the file manifest state is ready for a request.
+ * A file manifest state is considered ready if it is both enabled (`isEnabled` is `true`)
+ * and not currently loading (`isLoading` is `false`).
+ * @param fileManifestState - File manifest state.
+ * @returns true if the file manifest state is ready for a request.
+ */
+export function isFileManifestStateReady(
+  fileManifestState: FileManifestState
+): boolean {
+  return fileManifestState.isEnabled && !fileManifestState.isLoading;
+}
+
+/**
+ * Checks if the file manifest format is ready for use.
+ * The file manifest format is considered ready if `fileManifestFormat` is defined.
+ * @param fileManifestFormat - File manifest format.
+ * @returns `true` if the `fileManifestFormat` is defined.
+ */
+export function isFileManifestFormatReady(
+  fileManifestFormat: ManifestDownloadFormat | undefined
+): boolean {
+  if (!fileManifestFormat) return false;
+  return Object.values(MANIFEST_DOWNLOAD_FORMAT).includes(fileManifestFormat);
+}
+
+/**
+ * Checks if the form is ready to request a manifest.
+ * A form is considered ready if all facets have the `selected` term set to `true`.
+ * @param formFacet - Form related file facets.
+ * @returns `true` if all facets in the form are selected.
+ */
+export function isFormSelectionReady(formFacet: FormFacet): boolean {
+  const facets = Object.values(formFacet).filter(Boolean);
+  if (facets.length === 0) return false;
+  return facets.every(({ selected }: FileFacet) => selected);
+}