@databiosphere/findable-ui 0.0.0

package/lib/views/ExploreView/exploreView.js

@@ -0,0 +1,230 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExploreView = void 0;
+const router_1 = require("next/router");
+const react_1 = __importStar(require("react"));
+const analytics_1 = require("../../common/analytics/analytics");
+const entities_1 = require("../../common/analytics/entities");
+const tabs_1 = require("../../components/common/Tabs/tabs");
+const ComponentCreator_1 = require("../../components/ComponentCreator/ComponentCreator");
+const clearAllFilters_1 = require("../../components/Filter/components/ClearAllFilters/clearAllFilters");
+const filters_1 = require("../../components/Filter/components/Filters/filters");
+const searchAllFilters_1 = require("../../components/Filter/components/SearchAllFilters/searchAllFilters");
+const index_1 = require("../../components/Index/index");
+const sidebarButton_1 = require("../../components/Layout/components/Sidebar/components/SidebarButton/sidebarButton");
+const sidebarLabel_1 = require("../../components/Layout/components/Sidebar/components/SidebarLabel/sidebarLabel");
+const sidebarTools_styles_1 = require("../../components/Layout/components/Sidebar/components/SidebarTools/sidebarTools.styles");
+const sidebar_1 = require("../../components/Layout/components/Sidebar/sidebar");
+const tableCreator_1 = require("../../components/TableCreator/tableCreator");
+const useBreakpointHelper_1 = require("../../hooks/useBreakpointHelper");
+const useConfig_1 = require("../../hooks/useConfig");
+const useEntityList_1 = require("../../hooks/useEntityList");
+const useEntityListRelatedView_1 = require("../../hooks/useEntityListRelatedView");
+const useExploreState_1 = require("../../hooks/useExploreState");
+const useSummary_1 = require("../../hooks/useSummary");
+const exploreState_1 = require("../../providers/exploreState");
+const breakpoints_1 = require("../../theme/common/breakpoints");
+/**
+ * Returns tabs to be used as a prop for the Tabs component.
+ * @param entities - Entities config.
+ * @returns tabs list.
+ */
+function getTabs(entities) {
+    return entities.map(({ label, route, tabIcon: icon, tabIconPosition: iconPosition }) => ({
+        icon,
+        iconPosition,
+        label,
+        value: route,
+    }));
+}
+const ExploreView = (props) => {
+    const [isDrawerOpen, setIsDrawerOpen] = (0, react_1.useState)(false);
+    const tabletDown = (0, useBreakpointHelper_1.useBreakpointHelper)(useBreakpointHelper_1.BREAKPOINT_FN_NAME.DOWN, breakpoints_1.DESKTOP_SM);
+    const { config, entityConfig } = (0, useConfig_1.useConfig)(); // Get app level config.
+    const { exploreDispatch, exploreState } = (0, useExploreState_1.useExploreState)(); // Get the useReducer state and dispatch for "Explore".
+    const { categoryGroupConfigs, entities, explorerTitle, summaryConfig, trackingConfig, } = config;
+    const { listView } = entityConfig;
+    const { listHero, subTitleHero } = listView || {};
+    const { categoryViews, filterCount, isRelatedView, tabValue } = exploreState;
+    const { push } = (0, router_1.useRouter)();
+    const tabs = getTabs(entities);
+    const { response: summaryResponse } = (0, useSummary_1.useSummary)(); // Fetch summary.
+    (0, useEntityList_1.useEntityList)(props); // Fetch entities.
+    (0, useEntityListRelatedView_1.useEntityListRelatedView)(); // Fetch related entities.
+    const { entityListType } = props;
+    const categoryFilters = (0, react_1.useMemo)(() => buildCategoryFilters(categoryViews, categoryGroupConfigs), [categoryViews, categoryGroupConfigs]);
+    /**
+     * Closes filter drawer.
+     */
+    const onCloseDrawer = () => {
+        setIsDrawerOpen(false);
+    };
+    /**
+     * Callback fired when selected state of a category value is toggled.
+     * @param fromSearchAll - Indication if the filter was originated from the search all field.
+     * @param categoryKey - The category being filtered.
+     * @param selectedCategoryValue - The value to set or clear.
+     * @param selected - Indication of whether the selected value is being set or cleared.
+     * @param categorySection - Name of group the category is in.
+     * @param searchTerm - Search term used to find the value.
+     */
+    const onFilterChange = (fromSearchAll, categoryKey, selectedCategoryValue, selected, categorySection, searchTerm) => {
+        var _a;
+        exploreDispatch({
+            payload: {
+                categoryKey,
+                selected,
+                selectedValue: selectedCategoryValue,
+            },
+            type: exploreState_1.ExploreActionKind.UpdateFilter,
+        });
+        (_a = trackingConfig === null || trackingConfig === void 0 ? void 0 : trackingConfig.trackFilterApplied) === null || _a === void 0 ? void 0 : _a.call(trackingConfig, {
+            category: categoryKey,
+            fromSearchAll,
+            searchTerm: searchTerm !== null && searchTerm !== void 0 ? searchTerm : "",
+            section: categorySection !== null && categorySection !== void 0 ? categorySection : "",
+            selected,
+            value: selectedCategoryValue,
+        });
+        // Execute GTM tracking.
+        if (selected) {
+            (0, analytics_1.track)(entities_1.EVENT_NAME.FILTER_SELECTED, {
+                [entities_1.EVENT_PARAM.FILTER_NAME]: categoryKey,
+                [entities_1.EVENT_PARAM.FILTER_VALUE]: selectedCategoryValue,
+            });
+        }
+    };
+    /**
+     * Opens filter drawer.
+     */
+    const onOpenDrawer = () => {
+        setIsDrawerOpen(true);
+    };
+    /**
+     * Callback fired when selected tab value changes.
+     * - Sets state tabsValue to selected tab value.
+     * - Executes a pushState and resets pagination.
+     * @param tabValue - Selected tab value.
+     */
+    const onTabChange = (tabValue) => {
+        push(`/${tabValue}`);
+    };
+    /**
+     * Dispatch a SelectedEntityType action when entityListType changes.
+     */
+    (0, react_1.useEffect)(() => {
+        if (entityListType) {
+            exploreDispatch({
+                payload: entityListType,
+                type: exploreState_1.ExploreActionKind.SelectEntityType,
+            });
+            (0, analytics_1.track)(entities_1.EVENT_NAME.ENTITY_SELECTED, {
+                [entities_1.EVENT_PARAM.ENTITY_NAME]: entityListType,
+            });
+        }
+    }, [entityListType, exploreDispatch]);
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        categoryViews && !!categoryViews.length && (react_1.default.createElement(sidebar_1.Sidebar, { drawerOpen: isDrawerOpen, onDrawerClose: onCloseDrawer },
+            react_1.default.createElement(sidebarTools_styles_1.SidebarTools, null,
+                react_1.default.createElement(sidebarLabel_1.SidebarLabel, { label: "Filters" }),
+                react_1.default.createElement(clearAllFilters_1.ClearAllFilters, null),
+                react_1.default.createElement(searchAllFilters_1.SearchAllFilters, { categoryViews: categoryViews, drawerOpen: isDrawerOpen, onFilter: onFilterChange.bind(null, true) })),
+            react_1.default.createElement(filters_1.Filters, { categoryFilters: categoryFilters, closeAncestor: onCloseDrawer, disabled: isRelatedView, onFilter: onFilterChange.bind(null, false), trackFilterOpened: trackingConfig === null || trackingConfig === void 0 ? void 0 : trackingConfig.trackFilterOpened }))),
+        react_1.default.createElement(index_1.Index, { List: renderList(exploreState, entityConfig, entityListType), ListHero: renderComponent(listHero), SideBarButton: tabletDown ? (react_1.default.createElement(sidebarButton_1.SidebarButton, { count: filterCount, label: "Filter", onClick: onOpenDrawer })) : undefined, SubTitleHero: renderComponent(subTitleHero), Summaries: renderSummary(summaryConfig, summaryResponse), Tabs: react_1.default.createElement(tabs_1.Tabs, { onTabChange: onTabChange, tabs: tabs, value: tabValue }), title: explorerTitle })));
+};
+exports.ExploreView = ExploreView;
+/**
+ * Builds the category views into category views grouped by the given category group configuration.
+ * @param selectCategoryViews - View models of categories to display.
+ * @param categoryGroupConfigs - Category group configuration.
+ * @returns category filters.
+ */
+function buildCategoryFilters(selectCategoryViews, categoryGroupConfigs) {
+    if (!categoryGroupConfigs) {
+        return [{ categoryViews: selectCategoryViews }];
+    }
+    return categoryGroupConfigs.map(({ categoryConfigs, label }) => {
+        // Grab the category views for the configured grouped categories.
+        const categoryViews = categoryConfigs.reduce((acc, { key: categoryKey }) => {
+            const categoryView = selectCategoryViews.find(({ key }) => key === categoryKey);
+            if (categoryView) {
+                acc.push(categoryView);
+            }
+            return acc;
+        }, []);
+        // Return the configured label and category views.
+        return { categoryViews, label };
+    });
+}
+/**
+ * Optionally renders component config.
+ * @param componentsConfig - SubHero config.
+ * @param response - Response data.
+ * @returns components.
+ */
+function renderComponent(componentsConfig, response) {
+    if (!componentsConfig) {
+        return;
+    }
+    return react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: componentsConfig, response: response });
+}
+/**
+ * Render either a loading view, empty result set notification or the table itself.
+ * @param exploreState - ExploreView responses from Azul, such as projects (index/projects), samples (index/samples) and files (index/files).
+ * @param entityConfig - Entity configuration.
+ * @param entityListType - Entity list type.
+ * @returns rendered Table component.
+ */
+function renderList(exploreState, entityConfig, entityListType) {
+    const { isRelatedView, listItems, loading, paginationState, relatedListItems, tabValue, } = exploreState;
+    const { list, listView } = entityConfig;
+    const { columns: columnsConfig, defaultSort } = list;
+    if (!exploreState || !tabValue) {
+        return react_1.default.createElement(react_1.default.Fragment, null); //TODO: return the loading UI component
+    }
+    if (entityListType !== tabValue) {
+        // required currently for client-side fetching as the pre-rendered page
+        // loads with the previous tabs data on the first render after switching tabs. (or similar)
+        return react_1.default.createElement(react_1.default.Fragment, null); // TODO(Fran) review loading and return.
+    }
+    return (react_1.default.createElement(tableCreator_1.TableCreator, { columns: columnsConfig, defaultSort: defaultSort, items: isRelatedView && relatedListItems ? relatedListItems : listItems !== null && listItems !== void 0 ? listItems : [], listView: listView, loading: loading, pages: paginationState.pages, pageSize: paginationState.pageSize, pagination: undefined, total: paginationState.rows }));
+}
+/**
+ * Renders Summaries component when all the following requirements are fulfilled:
+ * - defined summary config,
+ * - valid summary response, and
+ * - defined summaries transformed from the given summary response.
+ * @param summaryConfig - Summary config.
+ * @param summaryResponse - Response model return from summary API.
+ * @returns rendered Summaries component.
+ */
+function renderSummary(summaryConfig, summaryResponse) {
+    if (!summaryConfig || !summaryResponse) {
+        return;
+    }
+    /* Render the Summaries component. */
+    return (react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: summaryConfig.components, response: summaryResponse }));
+}

package/lib/views/ExportMethodView/exportMethodView.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const ExportMethodView: () => JSX.Element;

package/lib/views/ExportMethodView/exportMethodView.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportMethodView = void 0;
+const router_1 = require("next/router");
+const react_1 = __importDefault(require("react"));
+const ComponentCreator_1 = require("../../components/ComponentCreator/ComponentCreator");
+const backPageView_1 = require("../../components/Layout/components/BackPage/backPageView");
+const useExportConfig_1 = require("../../hooks/useExportConfig");
+const useUpdateURLSearchParams_1 = require("../../hooks/useUpdateURLSearchParams");
+const ExportMethodView = () => {
+    (0, useUpdateURLSearchParams_1.useUpdateURLSearchParams)();
+    const { pathname } = (0, router_1.useRouter)();
+    const { exportMethods, tabs } = (0, useExportConfig_1.useExportConfig)();
+    const { sideColumn } = tabs[0];
+    const { mainColumn, top } = getExportMethodConfig(exportMethods, pathname) || {};
+    return (react_1.default.createElement(backPageView_1.BackPageView, { mainColumn: react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: mainColumn || [], response: {} }), sideColumn: sideColumn ? (react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: sideColumn, response: {} })) : undefined, top: react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: top || [], response: {} }) }));
+};
+exports.ExportMethodView = ExportMethodView;
+/**
+ * Returns the export method configuration for the given pathname.
+ * @param exportMethods - Export methods config.
+ * @param pathname - Pathname.
+ * @returns export method configuration.
+ */
+function getExportMethodConfig(exportMethods, pathname) {
+    return exportMethods.find(({ route }) => route === pathname);
+}

package/lib/views/ExportView/exportView.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { AzulEntityStaticResponse } from "../../apis/azul/common/entities";
+export declare type ExportViewProps = AzulEntityStaticResponse;
+export declare const ExportView: (props: ExportViewProps) => JSX.Element;

package/lib/views/ExportView/exportView.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportView = void 0;
+const react_1 = __importDefault(require("react"));
+const ComponentCreator_1 = require("../../components/ComponentCreator/ComponentCreator");
+const backPageView_1 = require("../../components/Layout/components/BackPage/backPageView");
+const useExploreState_1 = require("../../hooks/useExploreState");
+const useExportConfig_1 = require("../../hooks/useExportConfig");
+const useRequestFileManifest_1 = require("../../hooks/useFileManifest/useRequestFileManifest");
+const useUpdateURLSearchParams_1 = require("../../hooks/useUpdateURLSearchParams");
+const ExportView = (props) => {
+    const { exploreState: { filterState }, } = (0, useExploreState_1.useExploreState)();
+    (0, useUpdateURLSearchParams_1.useUpdateURLSearchParams)();
+    (0, useRequestFileManifest_1.useRequestFileManifest)(undefined, filterState, undefined);
+    const { tabs, top } = (0, useExportConfig_1.useExportConfig)();
+    const currentTab = tabs[0];
+    const { mainColumn, sideColumn } = currentTab;
+    return (react_1.default.createElement(backPageView_1.BackPageView, { mainColumn: react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: mainColumn, response: props }), sideColumn: sideColumn ? (react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: sideColumn, response: props })) : undefined, top: react_1.default.createElement(ComponentCreator_1.ComponentCreator, { components: top, response: props }) }));
+};
+exports.ExportView = ExportView;

package/lib/views/LoginView/loginView.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const LoginView: () => JSX.Element;

package/lib/views/LoginView/loginView.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoginView = void 0;
+const react_1 = __importDefault(require("react"));
+const login_1 = require("../../components/Login/login");
+const useAuthenticationConfig_1 = require("../../hooks/useAuthenticationConfig");
+const LoginView = () => {
+    const { googleGISAuthConfig, termsOfService, text, title, warning } = (0, useAuthenticationConfig_1.useAuthenticationConfig)();
+    return (react_1.default.createElement(login_1.Login, { isGoogle: !!googleGISAuthConfig, termsOfService: termsOfService, text: text, title: title, warning: warning }));
+};
+exports.LoginView = LoginView;

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@databiosphere/findable-ui",
+  "version": "0.0.0",
+  "description": "",
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint .",
+    "check-format": "prettier --check .",
+    "storybook": "storybook dev -p 6006",
+    "test-compile": "tsc --noEmit",
+    "prepare": "husky install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:DataBiosphere/findable-ui.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/DataBiosphere/findable-ui/issues"
+  },
+  "homepage": "https://github.com/DataBiosphere/findable-ui/tree/main/#readme",
+  "main": "lib/index.js",
+  "devDependencies": {
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
+    "@next/eslint-plugin-next": "^14.1.0",
+    "@storybook/addon-actions": "^7.6.17",
+    "@storybook/addon-essentials": "^7.6.17",
+    "@storybook/addon-interactions": "^7.6.17",
+    "@storybook/addon-links": "^7.6.17",
+    "@storybook/addon-mdx-gfm": "^7.6.17",
+    "@storybook/nextjs": "^7.6.17",
+    "@storybook/react": "^7.6.17",
+    "@storybook/testing-library": "^0.2.2",
+    "@storybook/types": "^7.6.17",
+    "@types/jest": "^29.4.0",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "@types/react-gtm-module": "^2.0.1",
+    "@types/react-window": "^1.8.5",
+    "@types/uuid": "8.3.4",
+    "@typescript-eslint/eslint-plugin": "^5.49.0",
+    "eslint": "^8.33.0",
+    "eslint-config-next": "^14.1.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-jsdoc": "^48.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-sonarjs": "^0.18.0",
+    "eslint-plugin-sort-destructure-keys": "^1.4.0",
+    "eslint-plugin-storybook": "^0.8.0",
+    "eslint-plugin-typescript-sort-keys": "^2.3.0",
+    "husky": "^8.0.3",
+    "jest": "^29.4.1",
+    "jest-environment-jsdom": "^29.4.1",
+    "prettier": "^2.8.3",
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "storybook": "^7.6.17",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.6.4"
+  },
+  "peerDependencies": {
+    "@emotion/react": "11.11.1",
+    "@emotion/styled": "11.11.0",
+    "@mui/icons-material": "5.14.1",
+    "@mui/material": "5.14.1",
+    "@tanstack/react-table": "8.5.11",
+    "@tanstack/react-virtual": "^3.0.0-beta.59",
+    "axios": "^1.6.7",
+    "copy-to-clipboard": "3.3.1",
+    "isomorphic-dompurify": "0.24.0",
+    "next": "^14.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-dropzone": "^14.2.3",
+    "react-gtm-module": "2.0.11",
+    "react-idle-timer": "^5.6.2",
+    "react-window": "1.8.9",
+    "uuid": "8.3.2",
+    "validate.js": "^0.13.1"
+  },
+  "engines": {
+    "node": "20.10.0"
+  }
+}

package/src/apis/azul/common/constants.ts

@@ -0,0 +1,12 @@
+/**
+ * Path to add to file URL when requesting file location.
+ */
+export const API_FILE_LOCATION_FETCH = "fetch";
+
+export const FILE_LOCATION_SUCCESSFULLY = 302;
+export const FILE_LOCATION_PENDING = 301;
+
+/**
+ * "format" request parameter value to include when generating a link to Terra for PFB.
+ */
+export const EXPORT_TO_TERRA_URL_PFB_FORMAT = "PFB";

package/src/apis/azul/common/entities.ts

@@ -0,0 +1,184 @@
+/**
+ * Set of end point paths accepted by Azul.
+ */
+export enum APIEndpoints {
+  CATALOGS = "/index/catalogs",
+  FETCH = "/fetch", // Required in path for entity matrix downloads and direct file downloads
+  FILES = "/files",
+  INDEX_STATUS = "/health/progress",
+  SUMMARY = "/summary",
+}
+
+/**
+ * Model of response returned from /index/catalogs API endpoint.
+ */
+export interface AzulCatalogResponse {
+  catalogs: AzulCatalogs;
+  default_catalog: string;
+}
+
+/**
+ * Model of catalog returned from Azul catalogs endpoint (e.g. index/catalogs).
+ */
+export interface AzulCatalog {
+  internal: boolean;
+}
+
+/**
+ * Model of catalogs returned from Azul catalogs endpoint (e.g. index/catalogs).
+ */
+export interface AzulCatalogs {
+  [key: string]: AzulCatalog;
+}
+
+/**
+ * Model of index (list) responses from Azul, such as projects (index/projects), samples (index/samples) and
+ * files (index/files).
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- this type can't be determined beforehand
+export interface AzulEntitiesResponse<T = any> {
+  apiPath?: string;
+  hits: T[];
+  pagination: AzulPaginationResponse;
+  termFacets: AzulTermFacets;
+}
+
+/**
+ * Model of statically-built response from hitting Azul index endpoint e.g. /index/projects. That is, the model
+ * is built at build-time.
+ */
+export interface AzulEntitiesStaticResponse {
+  data?: AzulEntitiesResponse;
+  entityListType: string;
+}
+
+/**
+ * Model of statically-built response from hitting Azul detail endpoint e.g. /index/projects/uuid. That is, the model
+ * is built at build-time.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- this data type can't be determined beforehand
+export interface AzulEntityStaticResponse<T = any> {
+  data?: T;
+}
+
+/**
+ * Set of filter operators accepted by Azul.
+ */
+export enum AZUL_FILTER_OPERATOR {
+  "IS" = "is",
+}
+
+/**
+ * Set of valid params accepted by Azul's index (list) endpoints.
+ */
+export interface AzulListParams {
+  filters?: string;
+  order?: string;
+  search_after?: string;
+  search_before?: string;
+  size?: string;
+  sort?: string;
+}
+
+/**
+ * Base index response interface, implemented by specific index responses (e.g. projects, samples, files).
+ */
+export interface AzulPaginationResponse {
+  count: number;
+  next?: string;
+  order?: "asc" | "desc";
+  pages: number;
+  previous?: string;
+  size: number;
+  sort?: string;
+  total: number;
+}
+
+/**
+ * Set of valid request params accepted by Azul.
+ */
+export enum AZUL_PARAM {
+  "CATALOG" = "catalog",
+  "FILTERS" = "filters",
+}
+
+/**
+ * Azul search index.
+ */
+export type AzulSearchIndex = keyof Pick<
+  AzulListParams,
+  "search_before" | "search_after"
+>;
+
+/**
+ * Model of response returned from /index/summary API endpoint.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- this type can't be determined beforehand
+export type AzulSummaryResponse = any;
+
+/**
+ * Model of term returned from Azul entity endpoint (e.g. index/files).
+ */
+export interface AzulTerm {
+  count: number;
+  term: string;
+}
+
+/**
+ * Model of term facet returned from Azul entity endpoint (e.g. index/files).
+ */
+export interface AzulTermFacet {
+  terms: AzulTerm[];
+  total: number;
+  type: AZUL_TERM_TYPE;
+}
+
+/**
+ * Model of term facets returned from Azul entity endpoint (e.g. index/files).
+ */
+export interface AzulTermFacets {
+  [k: string]: AzulTermFacet;
+}
+
+/**
+ * Set of possible term types retured from Azul.
+ */
+enum AZUL_TERM_TYPE {
+  "TERMS" = "terms",
+}
+
+/**
+ * Model of the response to get a download link, using a get-retry approach
+ */
+export interface FileLocationResponse {
+  CommandLine: { [key: string]: string };
+  Location: string;
+  "Retry-After"?: number;
+  Status: number;
+}
+
+/**
+ * Set of labels that values returned from Azul can be sanitized to.
+ */
+export enum LABEL {
+  "EMPTY" = "", // TODO(cc) revisit - temp only? required for file download.
+  "ERROR" = "Error",
+  "NONE" = "None",
+  "UNSPECIFIED" = "Unspecified",
+}
+
+/**
+ * Manifest download format.
+ */
+export type ManifestDownloadFormat = MANIFEST_DOWNLOAD_FORMAT;
+
+/**
+ * Set of possible manifest download formats.
+ */
+export enum MANIFEST_DOWNLOAD_FORMAT {
+  "COMPACT" = "compact",
+  "CURL" = "curl",
+  "FULL" = "full",
+  "TERRA_BDBAG" = "terra.bdbag",
+  "TERRA_PFB" = "terra.pfb",
+}