@databiosphere/findable-ui 50.6.1 → 50.7.1

package/src/hooks/useEntityList.ts

@@ -1,206 +0,0 @@
-import { useEffect } from "react";
-import {
-  AzulEntitiesResponse,
-  AzulEntitiesStaticResponse,
-  AzulListParams,
-} from "../apis/azul/common/entities";
-import {
-  transformAzulPagination,
-  transformFilters,
-  transformTermFacets,
-} from "../apis/azul/common/filterTransformer";
-import { EntityMapper } from "../config/entities";
-import { getEntityConfig } from "../config/utils";
-import { ExploreActionKind } from "../providers/exploreState";
-import { DEFAULT_PAGINATION_STATE } from "../providers/exploreState/initializer/constants";
-import { useToken } from "./authentication/token/useToken";
-import { useAsync } from "./useAsync";
-import { useConfig } from "./useConfig";
-import { useEntityService } from "./useEntityService";
-import { EXPLORE_MODE, ExploreMode } from "./useExploreMode/types";
-import { useExploreMode } from "./useExploreMode/useExploreMode";
-import { useExploreState } from "./useExploreState";
-
-/**
- * Hook handling the load and transformation of the values used by index pages. If the current entity loaded statically,
- * this hook will return the already loaded data. Otherwise, it will make a request for the entity's pathUrl.
- * @param staticResponse - Statically loaded data, if any.
- * @returns Model of the entities list including pagination, sort, filter and loading indicator.
- */
-export const useEntityList = (
-  staticResponse: AzulEntitiesStaticResponse,
-): void => {
-  const { data: staticData, entityListType } = staticResponse;
-  const { token } = useToken();
-  const { config } = useConfig();
-  const { apiPath } = getEntityConfig(config.entities, entityListType);
-  const exploreMode = useExploreMode();
-  const {
-    catalog,
-    entityMapper,
-    fetchAllEntities,
-    fetchEntitiesFromQuery,
-    path,
-  } = useEntityService();
-  const { exploreDispatch, exploreState } = useExploreState();
-  const { data, isIdle, isLoading, run } = useAsync<AzulEntitiesResponse>();
-  const { entityPageState, filterState, tabValue } = exploreState;
-  const { pagination, termFacets } = data || {};
-  const { sorting } = entityPageState[tabValue];
-  const entities = getEntities(staticData, data);
-  const shouldDispatchResponse = isDispatchable(
-    exploreMode,
-    data?.apiPath === apiPath,
-    entityListType === tabValue,
-  );
-  const isFetching = isIdle || isLoading;
-
-  // Fetch entities - on change of filter state - server-side fetching and server-side filtering.
-  useEffect(() => {
-    if (exploreMode === EXPLORE_MODE.SS_FETCH_SS_FILTERING) {
-      // Build basic list params
-      const [sort] = sorting;
-      const listParams: AzulListParams = sort
-        ? { order: sort.desc ? "desc" : "asc", sort: sort.id }
-        : {};
-
-      // Build filter query params, if any
-      const filtersParam = transformFilters(filterState);
-      if (filtersParam) {
-        listParams.filters = filtersParam;
-      }
-
-      if (
-        exploreState.paginationState?.index?.type &&
-        exploreState.paginationState.index.value
-      ) {
-        listParams[exploreState.paginationState.index.type] =
-          exploreState.paginationState.index.value;
-      }
-
-      // Execute the fetch.
-      run(fetchEntitiesFromQuery(path, listParams, catalog, token));
-    }
-  }, [
-    catalog,
-    exploreMode,
-    exploreState.paginationState.index,
-    fetchEntitiesFromQuery,
-    filterState,
-    path,
-    run,
-    sorting,
-    token,
-  ]);
-
-  // Process explore response - on change of filter state - server-side fetching and server-side filtering.
-  useEffect(() => {
-    if (!termFacets) return;
-    if (!shouldDispatchResponse) return;
-    if (exploreMode === EXPLORE_MODE.SS_FETCH_SS_FILTERING) {
-      exploreDispatch({
-        payload: {
-          listItems: entities,
-          loading: isFetching,
-          paginationResponse: transformAzulPagination(pagination),
-          selectCategories: transformTermFacets(termFacets, filterState),
-        },
-        type: ExploreActionKind.ProcessExploreResponse,
-      });
-    }
-  }, [
-    entities,
-    exploreDispatch,
-    exploreMode,
-    filterState,
-    isFetching,
-    pagination,
-    shouldDispatchResponse,
-    termFacets,
-  ]);
-
-  // Fetch entities - server-side fetching and client-side filtering.
-  useEffect(() => {
-    if (exploreMode === EXPLORE_MODE.SS_FETCH_CS_FILTERING) {
-      run(fetchAllEntities(path, token));
-    }
-  }, [exploreMode, fetchAllEntities, path, run, token]);
-
-  // Process explore response - server-side or client-side fetching and client-side filtering.
-  useEffect(() => {
-    if (!entities) return;
-    if (!shouldDispatchResponse) return;
-    if (
-      exploreMode === EXPLORE_MODE.SS_FETCH_CS_FILTERING ||
-      exploreMode === EXPLORE_MODE.CS_FETCH_CS_FILTERING
-    ) {
-      exploreDispatch({
-        payload: {
-          listItems: mapEntities(entities, entityMapper),
-          loading: false,
-          paginationResponse: {
-            ...DEFAULT_PAGINATION_STATE,
-            pageSize: entities.length,
-            rows: entities.length,
-          },
-        },
-        type: ExploreActionKind.ProcessExploreResponse,
-      });
-    }
-  }, [
-    entities,
-    entityMapper,
-    exploreDispatch,
-    exploreMode,
-    shouldDispatchResponse,
-  ]);
-};
-
-/**
- * Returns the entities from the static data if present, otherwise returns the entities from the server data.
- * @param staticData - Static data.
- * @param serverData - Server data.
- * @returns entities.
- */
-function getEntities<T>(
-  staticData?: AzulEntitiesResponse<T>,
-  serverData?: AzulEntitiesResponse<T>,
-): AzulEntitiesResponse<T>["hits"] | undefined {
-  if (staticData && staticData.hits.length > 0) {
-    return staticData.hits;
-  }
-  return serverData?.hits;
-}
-
-/**
- * Returns true if the response should be dispatched for the given explore mode.
- * @param exploreMode - Explore mode.
- * @param shouldDispatchServerResponse - Boolean indicating whether the server response should be dispatched.
- * @param shouldDispatchStaticResponse - Boolean indicating whether the static response should be dispatched.
- * @returns true if the response should be dispatched.
- */
-function isDispatchable(
-  exploreMode: ExploreMode,
-  shouldDispatchServerResponse: boolean,
-  shouldDispatchStaticResponse: boolean,
-): boolean {
-  return exploreMode === EXPLORE_MODE.CS_FETCH_CS_FILTERING
-    ? shouldDispatchStaticResponse
-    : shouldDispatchServerResponse;
-}
-
-/**
- * Maps the entities using the given entity mapper.
- * @param entities - Entities.
- * @param entityMapper - Entity mapper.
- * @returns entities mapped using the given entity mapper.
- */
-function mapEntities<T, I>(
-  entities: (T | I)[],
-  entityMapper?: EntityMapper<T, I>,
-): T[] {
-  if (entityMapper) {
-    return (entities as I[]).map(entityMapper);
-  }
-  return entities as T[];
-}

package/src/hooks/useEntityService.ts

@@ -1,75 +0,0 @@
-import { EntityConfig, EntityMapper } from "../config/entities";
-import { getEntityConfig } from "../config/utils";
-import { createEntityService } from "../entity/service/factory";
-import { ENTITY_SERVICE_TYPE, EntityService } from "../entity/service/model";
-import { useCatalog } from "./useCatalog";
-import { useConfig } from "./useConfig";
-import { EXPLORE_MODE } from "./useExploreMode/types";
-import { useExploreState } from "./useExploreState";
-
-interface FetcherResponse<T, I> extends EntityService {
-  catalog: string | undefined;
-  detailStaticLoad: boolean;
-  entityMapper?: EntityMapper<T, I>;
-  path: string;
-}
-
-export const getEntityService = <T, I>(
-  entityConfig: EntityConfig,
-  catalog: string | undefined,
-): FetcherResponse<T, I> => {
-  if (entityConfig.apiPath) {
-    // Server-side fetch and filtering.
-    if (entityConfig.exploreMode === EXPLORE_MODE.SS_FETCH_SS_FILTERING) {
-      return {
-        ...createEntityService(ENTITY_SERVICE_TYPE.API),
-        catalog,
-        detailStaticLoad: entityConfig.detail.staticLoad,
-        entityMapper: entityConfig.entityMapper,
-        path: entityConfig.apiPath,
-      };
-    }
-    // Server-side fetch, client-side filtering.
-    if (entityConfig.exploreMode === EXPLORE_MODE.SS_FETCH_CS_FILTERING) {
-      return {
-        ...createEntityService(ENTITY_SERVICE_TYPE.API_CF),
-        catalog,
-        detailStaticLoad: entityConfig.detail.staticLoad,
-        entityMapper: entityConfig.entityMapper,
-        path: entityConfig.apiPath,
-      };
-    }
-  }
-  // Client-side API and filtering.
-  if (entityConfig.exploreMode === EXPLORE_MODE.CS_FETCH_CS_FILTERING) {
-    return {
-      ...createEntityService(ENTITY_SERVICE_TYPE.TSV),
-      catalog: undefined,
-      detailStaticLoad: true,
-      entityMapper: entityConfig.entityMapper,
-      path: entityConfig.route, //the entity list type
-    };
-  }
-  throw Error(
-    `There's no data path for the entity ${entityConfig.label}. Define a tsvPath or an apiPath`,
-  );
-};
-
-/**
- * Hook to determine how the data should be loaded.
- * From API or from a TSV file.
- * @param entityListType - Entity list type (optional).
- * @returns @see FetcherResponse
- */
-export const useEntityService = <T, I>(
-  entityListType?: string,
-): FetcherResponse<T, I> => {
-  const { config } = useConfig();
-  const catalog = useCatalog();
-  const { exploreState } = useExploreState();
-  const entityConfig = getEntityConfig(
-    config.entities,
-    entityListType || exploreState.tabValue, // if entity list type is undefined, use the current state's tab value.
-  );
-  return getEntityService(entityConfig, catalog);
-};

package/src/hooks/useExploreMode/types.ts

@@ -1,7 +0,0 @@
-export enum EXPLORE_MODE {
-  CS_FETCH_CS_FILTERING = "CS_FETCH_CS_FILTERING",
-  SS_FETCH_CS_FILTERING = "SS_FETCH_CS_FILTERING",
-  SS_FETCH_SS_FILTERING = "SS_FETCH_SS_FILTERING",
-}
-
-export type ExploreMode = EXPLORE_MODE;

package/src/hooks/useExploreMode/useExploreMode.ts

@@ -1,16 +0,0 @@
-import { useMemo } from "react";
-import { useConfig } from "../useConfig";
-import { ExploreMode } from "./types";
-
-/**
- * Returns configured explore mode:
- * - Client-side fetch, client-side filtering.
- * - Server-side fetch, client-side filtering.
- * - Server-side fetch, server-side filtering.
- * @returns explore mode.
- */
-export const useExploreMode = (): ExploreMode => {
-  const { entityConfig } = useConfig();
-  const { exploreMode } = entityConfig;
-  return useMemo(() => exploreMode, [exploreMode]);
-};

package/src/hooks/useExploreState.tsx

@@ -1,13 +0,0 @@
-import { useContext } from "react";
-import {
-  ExploreStateContext,
-  ExploreStateContextProps,
-} from "../providers/exploreState";
-
-/**
- * Returns explore state context.
- * @returns explore state context.
- */
-export const useExploreState = (): ExploreStateContextProps => {
-  return useContext(ExploreStateContext);
-};

package/src/hooks/useExportConfig.ts

@@ -1,16 +0,0 @@
-import { ExportConfig } from "../config/entities";
-import { useConfig } from "./useConfig";
-
-/**
- * Returns the export configuration for the given site.
- * @returns export configuration.
- */
-export const useExportConfig = (): ExportConfig => {
-  const { config } = useConfig();
-
-  if (!config.export) {
-    throw new Error(`This config does not have an export field set`);
-  }
-
-  return config.export;
-};

package/src/hooks/useExportToTerraResponseURL.ts

@@ -1,25 +0,0 @@
-import { buildExportToTerraUrl } from "../components/Export/common/utils";
-import { useConfig } from "./useConfig";
-import { FileLocation } from "./useRequestFileLocation";
-
-/**
- * Returns the export to Terra response URL for the given request file location.
- * @param requestParams - Export to terra request params.
- * @param fileLocation - Request file location.
- * @returns export to Terra request and response URLs.
- */
-export const useExportToTerraResponseURL = (
-  requestParams?: URLSearchParams,
-  fileLocation?: FileLocation,
-): string | undefined => {
-  const { config } = useConfig();
-  const { exportToTerraUrl } = config;
-  const { location } = fileLocation || {};
-
-  if (!exportToTerraUrl || !location || !requestParams) {
-    return;
-  }
-
-  // Build export to terra response URL
-  return buildExportToTerraUrl(exportToTerraUrl, requestParams, location);
-};

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

@@ -1,4 +0,0 @@
-export enum FLAG {
-  FALSE = "false",
-  TRUE = "true",
-}

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

@@ -1,17 +0,0 @@
-import { setLocalStorage } from "../../useLocalStorage/common/utils";
-
-/**
- * Set feature flags from URL.
- * @param features - List of feature flags.
- */
-export function setFeatureFlags(features: string[]): void {
-  const setOfFeatureFlags = new Set(features);
-  if (typeof window === "undefined") return;
-  // Grab the search params from the URL.
-  const params = new URLSearchParams(window.location.search);
-  for (const [key, value] of params) {
-    if (setOfFeatureFlags.has(key)) {
-      setLocalStorage(key, value);
-    }
-  }
-}

package/src/hooks/useFeatureFlag/useFeatureFlag.ts

@@ -1,19 +0,0 @@
-import { useEffect, useState } from "react";
-import { getLocalStorage } from "../useLocalStorage/common/utils";
-import { FLAG } from "./common/entities";
-
-/**
- * Determine if feature is available to user.
- * @param featureFlag - Name of feature.
- * @returns true if feature is available to user.
- */
-export function useFeatureFlag(featureFlag: string): boolean {
-  const [isEnabled, setIsEnabled] = useState<boolean>(false);
-
-  // Sets state of enabled flag.
-  useEffect(() => {
-    setIsEnabled(getLocalStorage(featureFlag) === FLAG.TRUE);
-  }, [featureFlag]);
-
-  return isEnabled;
-}

package/src/hooks/useFetchEntity.tsx

@@ -1,82 +0,0 @@
-import { useRouter } from "next/router";
-import { useEffect, useMemo } from "react";
-import { PARAMS_INDEX_UUID } from "../common/constants";
-import { EntityDetailViewProps } from "../views/EntityDetailView/entityDetailView";
-import { useToken } from "./authentication/token/useToken";
-import { useAsync } from "./useAsync";
-import { useEntityService } from "./useEntityService";
-import { EXPLORE_MODE } from "./useExploreMode/types";
-import { useExploreMode } from "./useExploreMode/useExploreMode";
-import { useExploreState } from "./useExploreState";
-
-interface UseEntityDetailResponse<T> {
-  isLoading: boolean;
-  response?: T;
-}
-
-/**
- * Hook handling the load and transformation of the values used by detail pages. If the current entity loaded statically,
- * this hook will return the already loaded data. Otherwise, it will make a request for the entity's pathUrl
- * @param detailViewProps - Statically loaded data, if any.
- * @returns Object with the loaded data and a flag indicating is the data is loading.
- */
-export const useFetchEntity = <T,>(
-  detailViewProps?: EntityDetailViewProps,
-): UseEntityDetailResponse<T> => {
-  const { data: staticData, entityListType } = detailViewProps || {};
-  const { token } = useToken();
-  const exploreMode = useExploreMode();
-  const { exploreState } = useExploreState();
-  const { catalogState } = exploreState;
-  const { catalog, fetchEntityDetail, path } = useEntityService(entityListType);
-  const { query } = useRouter();
-  const { params } = query;
-  const uuid = params?.[PARAMS_INDEX_UUID] as string;
-  const { data: response, isIdle, isLoading, run } = useAsync<T>();
-  const entityResponse = response || staticData;
-  const shouldFetchEntity = useMemo(
-    () =>
-      isFetchRequired(
-        exploreMode !== EXPLORE_MODE.CS_FETCH_CS_FILTERING,
-        Boolean(token), // TODO(cc), note a fetch is required if the token is true, but is unable to re-fetch on logout when token is undefined! Page is required to reload!
-        Boolean(catalogState),
-        Boolean(entityResponse),
-      ),
-    [catalogState, entityResponse, exploreMode, token],
-  );
-  const isResponseLoading = shouldFetchEntity ? isIdle || isLoading : false;
-
-  useEffect(() => {
-    // Fetch entity if entity data originates from a request, and has not yet been requested.
-    if (shouldFetchEntity && uuid) {
-      run(fetchEntityDetail(uuid, path, catalog, token, undefined));
-    }
-  }, [catalog, fetchEntityDetail, path, run, shouldFetchEntity, token, uuid]);
-
-  return {
-    isLoading: isResponseLoading,
-    response: entityResponse
-      ? { ...entityResponse, isLoading: isResponseLoading }
-      : undefined,
-  };
-};
-
-/**
- * Returns true if fetching the entity is necessary.
- * @param isServerSideFetch - Data is fetched on the server side.
- * @param isAuthenticated - User is authenticated.
- * @param isCatalogState - Catalog state is defined.
- * @param hasEntityReponse - Entity response is defined.
- * @returns true if a fetch is necessary.
- */
-function isFetchRequired(
-  isServerSideFetch: boolean,
-  isAuthenticated: boolean,
-  isCatalogState: boolean,
-  hasEntityReponse: boolean,
-): boolean {
-  if (isServerSideFetch) {
-    return isAuthenticated || isCatalogState || !hasEntityReponse;
-  }
-  return false;
-}

package/src/hooks/useFetchRequestURL.ts

@@ -1,20 +0,0 @@
-import { APIEndpoints } from "../apis/azul/common/entities";
-import { useConfig } from "./useConfig";
-
-/**
- * Returns request URL for the given endpoint and request params.
- * @param endpoint - Endpoint.
- * @param requestParams - Request params.
- * @returns request URL.
- */
-export const useFetchRequestURL = (
-  endpoint: APIEndpoints,
-  requestParams: URLSearchParams,
-): string => {
-  const { config } = useConfig();
-  const { dataSource } = config;
-  const { url } = dataSource;
-
-  // Returns request URL.
-  return `${url}index${endpoint}?${requestParams.toString()}`;
-};

package/src/hooks/useFileLocation.ts

@@ -1,37 +0,0 @@
-import {
-  useRequestFileLocation,
-  UseRequestFileLocationResult,
-} from "./useRequestFileLocation";
-
-const NOT_PREPENDED_WITH_FETCH_REGEX = /^(\/(?!fetch))/;
-
-export interface UseFileLocation extends UseRequestFileLocationResult {
-  fileUrl?: string;
-}
-
-export const useFileLocation = (fileUrl?: string): UseFileLocation => {
-  const url = buildFetchFileUrl(fileUrl);
-  const fileLocation = useRequestFileLocation(url);
-  return { ...fileLocation, fileUrl: fileLocation.data?.location };
-};
-
-/**
- * Prepends "/fetch" to the path of the specified file URL, if not already included.
- * @param url - URL.
- * @returns file URL with path prepended with "/fetch".
- */
-export function buildFetchFileUrl(url?: string): string | undefined {
-  if (!url) {
-    return;
-  }
-  try {
-    const urlObj = new URL(url);
-    urlObj.pathname = urlObj.pathname.replace(
-      NOT_PREPENDED_WITH_FETCH_REGEX,
-      "/fetch/",
-    );
-    return urlObj.href;
-  } catch {
-    throw new Error(`Invalid file URL: ${url}`);
-  }
-}

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

@@ -1,51 +0,0 @@
-import { AzulSummaryResponse } from "../../../apis/azul/common/entities";
-import { CategoryKey, CategoryValueKey } from "../../../common/entities";
-
-/**
- * Model of data returned from entity end points, including:
- * - the current set of selected facets, as well as facet terms and their corresponding counts.
- */
-export interface EntitySearchResults {
-  facets: FileFacet[];
-}
-
-export interface FetchFilesFacets {
-  filesFacets: FileFacet[];
-  isLoading: boolean;
-  isSuccess: boolean;
-}
-
-export interface FetchFileSummary {
-  isLoading: boolean;
-  summary?: AzulSummaryResponse;
-}
-
-/**
- * Model of a facet that contains a list of terms values.
- */
-export interface FileFacet {
-  name: string;
-  selected: boolean; // true if any terms are selected
-  selectedTermCount: number; // number of selected terms
-  selectedTerms: Term[];
-  termCount: number; // number of terms available
-  terms: Term[];
-  termsByName: TermsByName;
-  total: number;
-}
-
-export type SelectedSearchTermsBySearchKey = Map<
-  CategoryKey,
-  Set<CategoryValueKey>
->;
-
-/**
- * Model of an individual facet value. For example, the term "Homo Sapiens" contained in the facet "Species".
- */
-export interface Term {
-  count: number;
-  name: string;
-  selected: boolean;
-}
-
-export type TermsByName = Map<string, Term>;