@databiosphere/findable-ui 16.1.0 → 17.0.0

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "16.1.0"
+  ".": "17.0.0"
 }

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [17.0.0](https://github.com/DataBiosphere/findable-ui/compare/v16.1.0...v17.0.0) (2024-12-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* exports via main button don't include orphans ([#287](https://github.com/DataBiosphere/findable-ui/issues/287)) (#288)
+
+### Features
+
+* exports via main button don't include orphans ([#287](https://github.com/DataBiosphere/findable-ui/issues/287)) ([#288](https://github.com/DataBiosphere/findable-ui/issues/288)) ([86e3e40](https://github.com/DataBiosphere/findable-ui/commit/86e3e4047cce84a90348719c9ca7b41a3a93e4c3))
+
 ## [16.1.0](https://github.com/DataBiosphere/findable-ui/compare/v16.0.0...v16.1.0) (2024-12-12)
 
 

package/lib/components/Export/components/DownloadCurlCommand/downloadCurlCommand.d.ts

@@ -2,7 +2,7 @@ import { ElementType } from "react";
 import { Filters } from "../../../../common/entities";
 import { FileManifestType } from "../../../../hooks/useFileManifest/common/entities";
 import { FileManifestState } from "../../../../providers/fileManifestState";
-import { FormFacet } from "../../common/entities";
+import { FormFacet, ManifestDownloadFormat } from "../../common/entities";
 interface DownloadCurlCommandProps {
     DownloadCurlForm: ElementType;
     DownloadCurlStart: ElementType;
@@ -12,6 +12,7 @@ interface DownloadCurlCommandProps {
     fileSummaryFacetName: string;
     filters: Filters;
     formFacet: FormFacet;
+    manifestDownloadFormat?: ManifestDownloadFormat;
 }
-export declare const DownloadCurlCommand: ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, }: DownloadCurlCommandProps) => JSX.Element;
+export declare const DownloadCurlCommand: ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, }: DownloadCurlCommandProps) => JSX.Element;
 export {};

package/lib/components/Export/components/DownloadCurlCommand/downloadCurlCommand.js

@@ -2,16 +2,18 @@ import React, { useState } from "react";
 import { MANIFEST_DOWNLOAD_FORMAT } from "../../../../apis/azul/common/entities";
 import { useExploreState } from "../../../../hooks/useExploreState";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
-import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
+import { useRequestFileLocation, } from "../../../../hooks/useRequestFileLocation";
+import { useRequestManifest } from "../../../../hooks/useRequestManifest/useRequestManifest";
 import { BULK_DOWNLOAD_EXECUTION_ENVIRONMENT, } from "../../common/entities";
 import { trackBulkDownloadRequested } from "../../common/tracking";
 import { DownloadCurlCommandNotStarted } from "./components/DownloadCurlCommandNotStarted/downloadCurlCommandNotStarted";
 import { DownloadCurlCommandReady } from "./components/DownloadCurlCommandReady/downloadCurlCommandReady";
-export const DownloadCurlCommand = ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, }) => {
-    useRequestFileManifest(fileManifestType, MANIFEST_DOWNLOAD_FORMAT.CURL, filters, fileSummaryFacetName);
+export const DownloadCurlCommand = ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat = MANIFEST_DOWNLOAD_FORMAT.CURL, }) => {
+    useFileManifest(filters, fileSummaryFacetName);
     const [executionEnvironment, setExecutionEnvironment] = useState(BULK_DOWNLOAD_EXECUTION_ENVIRONMENT.BASH);
     const { exploreState: { tabValue: entityList }, } = useExploreState();
-    const { data, isLoading, run } = useFileManifest();
+    const { requestMethod, requestUrl } = useRequestManifest(manifestDownloadFormat, formFacet);
+    const { data, isLoading, run } = useRequestFileLocation(requestUrl, requestMethod);
     const curlCommand = getBulkDownloadCurlCommand(data, executionEnvironment);
     return curlCommand ? (React.createElement(DownloadCurlCommandReady, { curlCommand: curlCommand, DownloadCurlSuccess: DownloadCurlSuccess })) : (React.createElement(DownloadCurlCommandNotStarted, { DownloadCurlForm: DownloadCurlForm, DownloadCurlStart: DownloadCurlStart, executionEnvironment: executionEnvironment, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, onRequestManifest: () => {
             // Execute GTM tracking.

package/lib/components/Export/components/ExportForm/components/ExportManifestDownloadFormatForm/exportManifestDownloadFormatForm.d.ts

@@ -1,6 +1,7 @@
+import { FileManifestFormatState } from "../../../../../../hooks/useFileManifest/useFileManifestFormat";
 import { ManifestDownloadFormat } from "../../../../common/entities";
 export interface ExportManifestDownloadFormatFormProps {
-    manifestDownloadFormat?: ManifestDownloadFormat;
+    fileManifestFormatState: FileManifestFormatState;
     manifestDownloadFormats: ManifestDownloadFormat[];
 }
-export declare const ExportManifestDownloadFormatForm: ({ manifestDownloadFormat, manifestDownloadFormats, }: ExportManifestDownloadFormatFormProps) => JSX.Element;
+export declare const ExportManifestDownloadFormatForm: ({ fileManifestFormatState, manifestDownloadFormats, }: ExportManifestDownloadFormatFormProps) => JSX.Element;

package/lib/components/Export/components/ExportForm/components/ExportManifestDownloadFormatForm/exportManifestDownloadFormatForm.js

@@ -1,20 +1,10 @@
 import { FormControlLabel, FormLabel, Radio, RadioGroup } from "@mui/material";
 import React from "react";
-import { useFileManifestState } from "../../../../../../hooks/useFileManifestState";
-import { FileManifestActionKind } from "../../../../../../providers/fileManifestState";
 import { RadioCheckedIcon } from "../../../../../common/CustomIcon/components/RadioCheckedIcon/radioCheckedIcon";
 import { RadioUncheckedIcon } from "../../../../../common/CustomIcon/components/RadioUncheckedIcon/radioUncheckedIcon";
 import { FormControl } from "../../exportForm.styles";
-export const ExportManifestDownloadFormatForm = ({ manifestDownloadFormat, manifestDownloadFormats, }) => {
-    const { fileManifestDispatch } = useFileManifestState();
-    // Updates file manifest format state.
-    const onUpdateManifestFormat = (format) => {
-        fileManifestDispatch({
-            payload: format,
-            type: FileManifestActionKind.UpdateFileManifestFormat,
-        });
-    };
+export const ExportManifestDownloadFormatForm = ({ fileManifestFormatState, manifestDownloadFormats, }) => {
     return (React.createElement(FormControl, null,
         React.createElement(FormLabel, null, "Download Format"),
-        React.createElement(RadioGroup, { value: manifestDownloadFormat ?? "" }, manifestDownloadFormats.map((manifestFormat) => (React.createElement(FormControlLabel, { control: React.createElement(Radio, { checkedIcon: React.createElement(RadioCheckedIcon, null), icon: React.createElement(RadioUncheckedIcon, null), onChange: () => onUpdateManifestFormat(manifestFormat), size: "small", value: manifestFormat }), key: manifestFormat, label: manifestFormat }))))));
+        React.createElement(RadioGroup, { value: fileManifestFormatState.fileManifestFormat ?? "" }, manifestDownloadFormats.map((manifestFormat) => (React.createElement(FormControlLabel, { control: React.createElement(Radio, { checkedIcon: React.createElement(RadioCheckedIcon, null), icon: React.createElement(RadioUncheckedIcon, null), onChange: () => fileManifestFormatState.setFileManifestFormat(manifestFormat), size: "small", value: manifestFormat }), key: manifestFormat, label: manifestFormat }))))));
 };

package/lib/components/Export/components/ExportToTerra/components/ExportToTerraForm/exportToTerraForm.d.ts

@@ -1,10 +1,13 @@
+import { Dispatch, SetStateAction } from "react";
+import { FileManifestFormatState } from "../../../../../../hooks/useFileManifest/useFileManifestFormat";
 import { FormFacet, ManifestDownloadFormat } from "../../../../common/entities";
 import { OnRequestManifestFn } from "../../../ExportForm/exportForm";
 export interface ExportToTerraFormProps {
+    fileManifestFormatState: FileManifestFormatState;
     formFacet: FormFacet;
     isLoading: boolean;
-    manifestDownloadFormat?: ManifestDownloadFormat;
     manifestDownloadFormats: ManifestDownloadFormat[];
     onRequestManifest: OnRequestManifestFn;
+    setFileManifestFormat: Dispatch<SetStateAction<ManifestDownloadFormat | undefined>>;
 }
-export declare const ExportToTerraForm: ({ formFacet, isLoading, manifestDownloadFormat, manifestDownloadFormats, onRequestManifest, }: ExportToTerraFormProps) => JSX.Element;
+export declare const ExportToTerraForm: ({ fileManifestFormatState, formFacet, isLoading, manifestDownloadFormats, onRequestManifest, }: ExportToTerraFormProps) => JSX.Element;

package/lib/components/Export/components/ExportToTerra/components/ExportToTerraForm/exportToTerraForm.js

@@ -2,9 +2,9 @@ import React from "react";
 import { ExportButton } from "../../../ExportForm/components/ExportButton/exportButton";
 import { ExportManifestDownloadFormatForm } from "../../../ExportForm/components/ExportManifestDownloadFormatForm/exportManifestDownloadFormatForm";
 import { ExportForm, } from "../../../ExportForm/exportForm";
-export const ExportToTerraForm = ({ formFacet, isLoading, manifestDownloadFormat, manifestDownloadFormats, onRequestManifest, }) => {
+export const ExportToTerraForm = ({ fileManifestFormatState, formFacet, isLoading, manifestDownloadFormats, onRequestManifest, }) => {
     return (React.createElement(ExportForm, { Button: renderButton, formFacet: formFacet, isLoading: isLoading, onRequestManifest: onRequestManifest },
-        React.createElement(ExportManifestDownloadFormatForm, { manifestDownloadFormat: manifestDownloadFormat, manifestDownloadFormats: manifestDownloadFormats })));
+        React.createElement(ExportManifestDownloadFormatForm, { fileManifestFormatState: fileManifestFormatState, manifestDownloadFormats: manifestDownloadFormats })));
 };
 /**
  * Build the export button.

package/lib/components/Export/components/ExportToTerra/components/ExportToTerraNotStarted/exportToTerraNotStarted.d.ts

@@ -1,14 +1,16 @@
 import { ElementType } from "react";
+import { FileManifestFormatState } from "../../../../../../hooks/useFileManifest/useFileManifestFormat";
 import { FileManifestState } from "../../../../../../providers/fileManifestState";
 import { FormFacet, ManifestDownloadFormat } from "../../../../common/entities";
 import { OnRequestManifestFn } from "../../../ExportForm/exportForm";
 export interface ExportToTerraNotStartedProps {
     ExportTerraForm: ElementType;
     ExportToTerraStart: ElementType;
+    fileManifestFormatState: FileManifestFormatState;
     fileManifestState: FileManifestState;
     formFacet: FormFacet;
     isLoading: boolean;
     manifestDownloadFormats: ManifestDownloadFormat[];
     onRequestManifest: OnRequestManifestFn;
 }
-export declare const ExportToTerraNotStarted: ({ ExportTerraForm, ExportToTerraStart, fileManifestState, formFacet, isLoading, manifestDownloadFormats, onRequestManifest, }: ExportToTerraNotStartedProps) => JSX.Element;
+export declare const ExportToTerraNotStarted: ({ ExportTerraForm, ExportToTerraStart, fileManifestFormatState, fileManifestState, formFacet, isLoading, manifestDownloadFormats, onRequestManifest, }: ExportToTerraNotStartedProps) => JSX.Element;

package/lib/components/Export/components/ExportToTerra/components/ExportToTerraNotStarted/exportToTerraNotStarted.js

@@ -3,12 +3,12 @@ import { PAPER_PANEL_STYLE } from "../../../../../common/Paper/paper";
 import { FluidPaper } from "../../../../../common/Paper/paper.styles";
 import { Loading } from "../../../../../Loading/loading";
 import { Section, SectionContent } from "../../../../export.styles";
-export const ExportToTerraNotStarted = ({ ExportTerraForm, ExportToTerraStart, fileManifestState, formFacet, isLoading, manifestDownloadFormats, onRequestManifest, }) => {
+export const ExportToTerraNotStarted = ({ ExportTerraForm, ExportToTerraStart, fileManifestFormatState, fileManifestState, formFacet, isLoading, manifestDownloadFormats, onRequestManifest, }) => {
     return (React.createElement("div", null,
         React.createElement(Loading, { loading: isLoading, panelStyle: PAPER_PANEL_STYLE.FLUID, text: "Your link will be ready shortly..." }),
         React.createElement(FluidPaper, null,
             React.createElement(Section, null,
                 React.createElement(SectionContent, null,
                     React.createElement(ExportToTerraStart, null)),
-                React.createElement(ExportTerraForm, { formFacet: formFacet, isLoading: fileManifestState.isLoading, manifestDownloadFormat: fileManifestState.fileManifestFormat, manifestDownloadFormats: manifestDownloadFormats, onRequestManifest: onRequestManifest })))));
+                React.createElement(ExportTerraForm, { fileManifestFormatState: fileManifestFormatState, formFacet: formFacet, isLoading: fileManifestState.isLoading, manifestDownloadFormats: manifestDownloadFormats, onRequestManifest: onRequestManifest })))));
 };

package/lib/components/Export/components/ExportToTerra/exportToTerra.d.ts

@@ -15,4 +15,4 @@ export interface ExportToTerraProps {
     manifestDownloadFormat?: ManifestDownloadFormat;
     manifestDownloadFormats: ManifestDownloadFormat[];
 }
-export declare const ExportToTerra: ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }: ExportToTerraProps) => JSX.Element;
+export declare const ExportToTerra: ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }: ExportToTerraProps) => JSX.Element;

package/lib/components/Export/components/ExportToTerra/exportToTerra.js

@@ -2,17 +2,20 @@ import React from "react";
 import { useExploreState } from "../../../../hooks/useExploreState";
 import { useExportToTerraResponseURL } from "../../../../hooks/useExportToTerraResponseURL";
 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 { trackExportToTerraRequested } from "../../common/tracking";
 import { ExportToTerraNotStarted } from "./components/ExportToTerraNotStarted/exportToTerraNotStarted";
 import { ExportToTerraReady } from "./components/ExportToTerraReady/exportToTerraReady";
-export const ExportToTerra = ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }) => {
+export const ExportToTerra = ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }) => {
     const { exploreState: { tabValue: entityList }, } = useExploreState();
-    useRequestFileManifest(fileManifestType, manifestDownloadFormat, filters, fileSummaryFacetName);
-    const { requestParams } = fileManifestState;
-    const { data, isLoading, run } = useFileManifest();
+    useFileManifest(filters, fileSummaryFacetName);
+    const fileManifestFormatState = useFileManifestFormat(manifestDownloadFormat);
+    const { requestMethod, requestParams, requestUrl } = useRequestManifest(fileManifestFormatState.fileManifestFormat, formFacet);
+    const { data, isLoading, run } = useRequestFileLocation(requestUrl, requestMethod);
     const exportURL = useExportToTerraResponseURL(requestParams, data);
-    return exportURL ? (React.createElement(ExportToTerraReady, { ExportToTerraSuccess: ExportToTerraSuccess, exportURL: exportURL })) : (React.createElement(ExportToTerraNotStarted, { ExportTerraForm: ExportForm, ExportToTerraStart: ExportToTerraStart, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, manifestDownloadFormats: manifestDownloadFormats, onRequestManifest: () => {
+    return exportURL ? (React.createElement(ExportToTerraReady, { ExportToTerraSuccess: ExportToTerraSuccess, exportURL: exportURL })) : (React.createElement(ExportToTerraNotStarted, { ExportTerraForm: ExportForm, ExportToTerraStart: ExportToTerraStart, fileManifestFormatState: fileManifestFormatState, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, manifestDownloadFormats: manifestDownloadFormats, onRequestManifest: () => {
             // Execute GA tracking
             trackExportToTerraRequested(entityList);
             // Request manifest

package/lib/components/Export/components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.d.ts

@@ -1,8 +1,10 @@
 import { Filters } from "../../../../../../common/entities";
 import { FileManifestType } from "../../../../../../hooks/useFileManifest/common/entities";
+import { ManifestDownloadFormat } from "../../../../common/entities";
 export interface ManifestDownloadEntityProps {
     fileManifestType: FileManifestType;
     filters: Filters;
+    manifestDownloadFormat?: ManifestDownloadFormat;
     metadataFilters: Filters;
 }
-export declare const ManifestDownloadEntity: ({ fileManifestType, filters, metadataFilters, }: ManifestDownloadEntityProps) => JSX.Element;
+export declare const ManifestDownloadEntity: ({ filters, metadataFilters, }: ManifestDownloadEntityProps) => JSX.Element;

package/lib/components/Export/components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.js

@@ -1,10 +1,9 @@
 import React from "react";
-import { MANIFEST_DOWNLOAD_FORMAT } from "../../../../../../apis/azul/common/entities";
-import { useRequestFileManifest } from "../../../../../../hooks/useFileManifest/useRequestFileManifest";
+import { useFileManifest } from "../../../../../../hooks/useFileManifest/useFileManifest";
 import { FileManifestDownload } from "./components/FileManifestDownload/fileManifestDownload";
 import { FileManifestSpreadsheet } from "./components/FileManifestSpreadsheet/fileManifestSpreadsheet";
-export const ManifestDownloadEntity = ({ fileManifestType, filters, metadataFilters, }) => {
-    useRequestFileManifest(fileManifestType, MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, undefined);
+export const ManifestDownloadEntity = ({ filters, metadataFilters, }) => {
+    useFileManifest(filters, undefined);
     return (React.createElement(React.Fragment, null,
         React.createElement(FileManifestSpreadsheet, { filters: metadataFilters }),
         React.createElement(FileManifestDownload, { filters: filters })));

package/lib/components/Export/components/ManifestDownload/manifestDownload.d.ts

@@ -2,7 +2,7 @@ import { ElementType } from "react";
 import { Filters } from "../../../../common/entities";
 import { FileManifestType } from "../../../../hooks/useFileManifest/common/entities";
 import { FileManifestState } from "../../../../providers/fileManifestState";
-import { FormFacet } from "../../common/entities";
+import { FormFacet, ManifestDownloadFormat } from "../../common/entities";
 export interface ManifestDownloadProps {
     fileManifestState: FileManifestState;
     fileManifestType: FileManifestType;
@@ -10,7 +10,8 @@ export interface ManifestDownloadProps {
     filters: Filters;
     formFacet: FormFacet;
     ManifestDownloadForm: ElementType;
+    manifestDownloadFormat?: ManifestDownloadFormat;
     ManifestDownloadStart: ElementType;
     ManifestDownloadSuccess: ElementType;
 }
-export declare const ManifestDownload: ({ fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, ManifestDownloadStart, ManifestDownloadSuccess, }: ManifestDownloadProps) => JSX.Element;
+export declare const ManifestDownload: ({ fileManifestState, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, manifestDownloadFormat, ManifestDownloadStart, ManifestDownloadSuccess, }: ManifestDownloadProps) => JSX.Element;

package/lib/components/Export/components/ManifestDownload/manifestDownload.js

@@ -2,14 +2,16 @@ import React from "react";
 import { MANIFEST_DOWNLOAD_FORMAT } from "../../../../apis/azul/common/entities";
 import { useExploreState } from "../../../../hooks/useExploreState";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
-import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
+import { useRequestFileLocation, } from "../../../../hooks/useRequestFileLocation";
+import { useRequestManifest } from "../../../../hooks/useRequestManifest/useRequestManifest";
 import { trackFileManifestRequested } from "../../common/tracking";
 import { ManifestDownloadNotStarted } from "./components/ManifestDownloadNotStarted/manifestDownloadNotStarted";
 import { ManifestDownloadReady } from "./components/ManifestDownloadReady/manifestDownloadReady";
-export const ManifestDownload = ({ fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, ManifestDownloadStart, ManifestDownloadSuccess, }) => {
-    useRequestFileManifest(fileManifestType, MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, fileSummaryFacetName);
+export const ManifestDownload = ({ fileManifestState, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, manifestDownloadFormat = MANIFEST_DOWNLOAD_FORMAT.COMPACT, ManifestDownloadStart, ManifestDownloadSuccess, }) => {
+    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 ? (React.createElement(ManifestDownloadReady, { ManifestDownloadSuccess: ManifestDownloadSuccess, manifestURL: manifestURL })) : (React.createElement(ManifestDownloadNotStarted, { ManifestDownloadForm: ManifestDownloadForm, ManifestDownloadStart: ManifestDownloadStart, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, onRequestManifest: () => {
             trackFileManifestRequested(entityList);

package/lib/hooks/types.d.ts

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

package/lib/hooks/types.js

@@ -0,0 +1,5 @@
+export var METHOD;
+(function (METHOD) {
+    METHOD["GET"] = "GET";
+    METHOD["PUT"] = "PUT";
+})(METHOD || (METHOD = {}));

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

@@ -38,11 +38,6 @@ export declare enum FILE_MANIFEST_TYPE {
     EXPORT_TO_TERRA = "EXPORT_TO_TERRA"
 }
 export type FileManifestType = FILE_MANIFEST_TYPE;
-export declare enum FILES_FACETS_STATUS {
-    COMPLETED = "COMPLETED",
-    IN_PROGRESS = "IN_PROGRESS",
-    NOT_STARTED = "NOT_STARTED"
-}
 export type SelectedSearchTermsBySearchKey = Map<CategoryKey, Set<CategoryValueKey>>;
 /**
  * Model of an individual facet value. For example, the term "Homo Sapiens" contained in the facet "Species".

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

@@ -7,9 +7,3 @@ export var FILE_MANIFEST_TYPE;
     FILE_MANIFEST_TYPE["ENTITY_EXPORT_TO_TERRA"] = "ENTITY_EXPORT_TO_TERRA";
     FILE_MANIFEST_TYPE["EXPORT_TO_TERRA"] = "EXPORT_TO_TERRA";
 })(FILE_MANIFEST_TYPE || (FILE_MANIFEST_TYPE = {}));
-export var FILES_FACETS_STATUS;
-(function (FILES_FACETS_STATUS) {
-    FILES_FACETS_STATUS["COMPLETED"] = "COMPLETED";
-    FILES_FACETS_STATUS["IN_PROGRESS"] = "IN_PROGRESS";
-    FILES_FACETS_STATUS["NOT_STARTED"] = "NOT_STARTED";
-})(FILES_FACETS_STATUS || (FILES_FACETS_STATUS = {}));

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

@@ -1,7 +1,10 @@
-import { UseRequestFileLocationResult } from "../useRequestFileLocation";
+import { Filters } from "../../common/entities";
 /**
- * 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 declare const useFileManifest: (requestURL?: string) => UseRequestFileLocationResult;
+export declare const useFileManifest: (initialFilters?: Filters | undefined, fileSummaryFacetName?: string) => void;

package/lib/hooks/useFileManifest/useFileManifest.js

@@ -1,12 +1,33 @@
+import { useEffect, useState } from "react";
+import { FileManifestActionKind } from "../../providers/fileManifestState";
 import { useFileManifestState } from "../useFileManifestState";
-import { METHOD, useRequestFileLocation, } 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) => {
-    const { fileManifestState } = useFileManifestState();
-    const url = requestURL || fileManifestState.requestURL;
-    return useRequestFileLocation(url, METHOD.PUT);
+export const useFileManifest = (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: {
+                fileSummaryFacetName,
+                filters: initFilters,
+            },
+            type: FileManifestActionKind.FetchFileManifest,
+        });
+        return () => {
+            fileManifestDispatch({
+                payload: undefined,
+                type: FileManifestActionKind.ClearFileManifest,
+            });
+        };
+    }, [fileManifestDispatch, fileSummaryFacetName, initFilters]);
 };

package/lib/hooks/useFileManifest/useFileManifestDownload.js

@@ -2,9 +2,9 @@ import { useEffect } from "react";
 import { MANIFEST_DOWNLOAD_FORMAT } from "../../apis/azul/common/entities";
 import { BULK_DOWNLOAD_EXECUTION_ENVIRONMENT } from "../../components/Export/common/entities";
 import { useCatalog } from "../useCatalog";
-import { buildFileManifestRequestURL } from "./common/buildFileManifestRequestURL";
-import { useFileManifest } from "./useFileManifest";
-import { useFileManifestURL } from "./useFileManifestURL";
+import { useConfig } from "../useConfig";
+import { useRequestFileLocation, } from "../useRequestFileLocation";
+import { buildRequestManifest } from "../useRequestManifest/utils";
 /**
  * Returns file manifest download url and file name.
  * @param filters - Filters.
@@ -12,13 +12,14 @@ import { useFileManifestURL } from "./useFileManifestURL";
  * @returns file manifest download url and file name.
  */
 export const useFileManifestDownload = (filters, disabled) => {
-    // 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(); // 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);
     // Requests file manifest.
@@ -26,7 +27,7 @@ export const useFileManifestDownload = (filters, disabled) => {
         if (disabled)
             return;
         run();
-    }, [disabled, requestURL, run]);
+    }, [disabled, requestUrl, run]);
     return {
         fileName,
         isIdle,

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

@@ -0,0 +1,12 @@
+import { Dispatch, SetStateAction } 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 declare const useFileManifestFormat: (manifestDownloadFormat?: ManifestDownloadFormat) => FileManifestFormatState;

package/lib/hooks/useFileManifest/useFileManifestFormat.js

@@ -0,0 +1,10 @@
+import { useState } from "react";
+/**
+ * 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) => {
+    const [fileManifestFormat, setFileManifestFormat] = useState(manifestDownloadFormat);
+    return { fileManifestFormat, setFileManifestFormat };
+};

package/lib/hooks/useRequestFileLocation.d.ts

@@ -1,3 +1,4 @@
+import { METHOD } from "./types";
 export interface FileLocation {
     commandLine?: {
         [key: string]: string;
@@ -14,10 +15,6 @@ export interface UseRequestFileLocationResult {
     run: () => void;
 }
 export type Method = METHOD;
-export declare enum METHOD {
-    GET = "GET",
-    PUT = "PUT"
-}
 /**
  * Function to make a get request and map the result to camelCase
  * @param url - url for the get request

package/lib/hooks/useRequestFileLocation.js

@@ -1,12 +1,8 @@
 import { useCallback, useEffect, useRef } from "react";
 import { FILE_LOCATION_PENDING, FILE_LOCATION_SUCCESSFULLY, } from "../apis/azul/common/constants";
+import { METHOD } from "./types";
 import { useAsync } from "./useAsync";
 import { useAuthentication } from "./useAuthentication/useAuthentication";
-export var METHOD;
-(function (METHOD) {
-    METHOD["GET"] = "GET";
-    METHOD["PUT"] = "PUT";
-})(METHOD || (METHOD = {}));
 /**
  * Returns fetch request options.
  * @param accessToken - Access token.

package/lib/hooks/useRequestManifest/constants.d.ts

@@ -0,0 +1,2 @@
+import { UseRequestManifest } from "./types";
+export declare const REQUEST_MANIFEST: UseRequestManifest;

package/lib/hooks/useRequestManifest/constants.js

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

package/lib/hooks/useRequestManifest/types.d.ts

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

package/lib/hooks/useRequestManifest/types.js

@@ -0,0 +1 @@
+export {};

package/lib/hooks/useRequestManifest/useRequestManifest.d.ts

@@ -0,0 +1,10 @@
+import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
+import { FormFacet } from "../../components/Export/common/entities";
+import { UseRequestManifest } from "./types";
+/**
+ * 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 declare const useRequestManifest: (fileManifestFormat: ManifestDownloadFormat | undefined, formFacet: FormFacet) => UseRequestManifest;

package/lib/hooks/useRequestManifest/useRequestManifest.js

@@ -0,0 +1,30 @@
+import { useCatalog } from "../useCatalog";
+import { useConfig } from "../useConfig";
+import { useFileManifestState } from "../useFileManifestState";
+import { REQUEST_MANIFEST } from "./constants";
+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, formFacet) => {
+    // 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, // Catalog is defined.
+        buildRequestFilters(fileManifestState, formFacet), fileManifestFormat // Manifest format is defined.
+        );
+    }
+    return REQUEST_MANIFEST;
+};

package/lib/hooks/useRequestManifest/utils.d.ts

@@ -0,0 +1,65 @@
+import { ManifestDownloadFormat } from "../../apis/azul/common/entities";
+import { Filters } from "../../common/entities";
+import { FormFacet } from "../../components/Export/common/entities";
+import { FileManifestState } from "../../providers/fileManifestState";
+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 declare function areAllFormFilterTermsSelected(formFacet: FormFacet): boolean;
+/**
+ * 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 declare function buildRequestFilters(state: FileManifestState, formFacet: FormFacet): 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 declare function buildRequestManifest(endpointUrl: string, catalog: string, filters: Filters, manifestFormat: ManifestDownloadFormat): Required<UseRequestManifest>;
+/**
+ * Returns filters, without form related filters.
+ * @param state - File manifest state.
+ * @param formFacet - Form related file facets.
+ * @returns filters.
+ */
+export declare function excludeFullySelectedFormFilters(state: FileManifestState, formFacet: FormFacet): Filters;
+/**
+ * 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 declare function isCatalogReady(catalog: string | undefined): boolean;
+/**
+ * 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 declare function isFileManifestStateReady(fileManifestState: FileManifestState): boolean;
+/**
+ * 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 declare function isFileManifestFormatReady(fileManifestFormat: ManifestDownloadFormat | undefined): boolean;
+/**
+ * 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 declare function isFormSelectionReady(formFacet: FormFacet): boolean;