@databiosphere/findable-ui 50.6.1 → 50.7.1

package/src/providers/fileManifestState/constants.ts

@@ -1,17 +0,0 @@
-import { FileManifestState } from "../fileManifestState";
-
-export const FILE_MANIFEST_STATE: FileManifestState = {
-  fileCount: undefined,
-  fileSummary: undefined,
-  fileSummaryFacetName: undefined,
-  fileSummaryFilters: [],
-  filesFacets: [],
-  filters: [],
-  isEnabled: false,
-  isFacetsLoading: false,
-  isFacetsSuccess: false,
-  isFileSummaryLoading: false,
-  isLoading: false,
-  isSummaryLoading: false,
-  summary: undefined,
-};

package/src/providers/fileManifestState.tsx

@@ -1,392 +0,0 @@
-import {
-  createContext,
-  Dispatch,
-  JSX,
-  ReactNode,
-  useEffect,
-  useReducer,
-} from "react";
-import { AzulSummaryResponse } from "../apis/azul/common/entities";
-import { getFilterParameterValue } from "../apis/azul/common/utils";
-import {
-  CategoryKey,
-  CategoryValueKey,
-  Filters,
-  SelectedFilterValue,
-} from "../common/entities";
-import { useCatalog } from "../hooks/useCatalog";
-import { buildNextFilterState } from "../hooks/useCategoryFilter";
-import { FileFacet } from "../hooks/useFileManifest/common/entities";
-import { useFetchFilesFacets } from "../hooks/useFileManifest/useFetchFilesFacets";
-import { useFetchSummary } from "../hooks/useFileManifest/useFetchSummary";
-import { FILE_MANIFEST_STATE } from "./fileManifestState/constants";
-
-/**
- * File manifest state.
- */
-export type FileManifestState = {
-  fileCount: number | undefined;
-  filesFacets: FileFacet[];
-  fileSummary?: AzulSummaryResponse;
-  fileSummaryFacetName?: string;
-  fileSummaryFilters: Filters;
-  filters: Filters;
-  isEnabled: boolean;
-  isFacetsLoading: boolean;
-  isFacetsSuccess: boolean;
-  isFileSummaryLoading: boolean;
-  isLoading: boolean;
-  isSummaryLoading: boolean;
-  summary?: AzulSummaryResponse;
-};
-
-/**
- * Model of file manifest state context.
- */
-export type FileManifestStateContextProps = {
-  fileManifestDispatch: Dispatch<FileManifestAction>;
-  fileManifestState: FileManifestState;
-};
-
-export const FileManifestStateContext =
-  createContext<FileManifestStateContextProps>({
-    // eslint-disable-next-line @typescript-eslint/no-empty-function -- allow dummy function for default state.
-    fileManifestDispatch: () => {},
-    fileManifestState: FILE_MANIFEST_STATE,
-  });
-
-export interface FileManifestStateProps {
-  children: ReactNode | ReactNode[];
-}
-
-export function FileManifestStateProvider({
-  children,
-}: FileManifestStateProps): JSX.Element {
-  // Determine catalog.
-  const catalog = useCatalog() as string; // catalog should be defined.
-
-  // File manifest state.
-  const [fileManifestState, fileManifestDispatch] = useReducer(
-    (s: FileManifestState, a: FileManifestAction) => fileManifestReducer(s, a),
-    FILE_MANIFEST_STATE,
-  );
-
-  const { fileSummaryFacetName, fileSummaryFilters, filters, isEnabled } =
-    fileManifestState;
-
-  // Fetch files facets.
-  const {
-    filesFacets,
-    isLoading: isFacetsLoading,
-    isSuccess: isFacetsSuccess,
-  } = useFetchFilesFacets(filters, catalog, { size: "25" }, isEnabled);
-
-  // Fetch summary.
-  const { isLoading: isSummaryLoading, summary } = useFetchSummary(
-    filters,
-    catalog,
-    isEnabled,
-  );
-
-  // Fetch file summary.
-  const { isLoading: isFileSummaryLoading, summary: fileSummary } =
-    useFetchSummary(fileSummaryFilters, catalog, Boolean(fileSummaryFacetName));
-
-  // Update file manifest state.
-  useEffect(() => {
-    fileManifestDispatch({
-      payload: {
-        fileSummary,
-        filesFacets,
-        isFacetsLoading,
-        isFacetsSuccess,
-        isFileSummaryLoading,
-        isLoading: isFacetsLoading || isFileSummaryLoading || isSummaryLoading,
-        isSummaryLoading,
-        summary,
-      },
-      type: FileManifestActionKind.UpdateFileManifest,
-    });
-  }, [
-    filesFacets,
-    fileSummary,
-    isFacetsLoading,
-    isFacetsSuccess,
-    isFileSummaryLoading,
-    isSummaryLoading,
-    summary,
-  ]);
-
-  return (
-    <FileManifestStateContext.Provider
-      value={{
-        fileManifestDispatch,
-        fileManifestState,
-      }}
-    >
-      {children}
-    </FileManifestStateContext.Provider>
-  );
-}
-
-/**
- * File manifest action kind.
- */
-export enum FileManifestActionKind {
-  ClearFileManifest = "CLEAR_FILE_MANIFEST",
-  FetchFileManifest = "FETCH_FILE_MANIFEST",
-  UpdateFileCount = "UPDATE_FILE_COUNT",
-  UpdateFileManifest = "UPDATE_FILE_MANIFEST",
-  UpdateFilter = "UPDATE_FILTER",
-  UpdateFiltersCategory = "UPDATE_FILTERS_CATEGORY",
-}
-
-/**
- * File manifest action.
- */
-export type FileManifestAction =
-  | ClearFileManifestAction
-  | FetchFileManifestAction
-  | UpdateFileCountAction
-  | UpdateFileManifestAction
-  | UpdateFilterAction
-  | UpdateFiltersCategoryAction;
-
-/**
- * Resets file manifest state.
- */
-type ClearFileManifestAction = {
-  payload: undefined;
-  type: FileManifestActionKind.ClearFileManifest;
-};
-
-/**
- * Fetch file manifest action.
- */
-type FetchFileManifestAction = {
-  payload: FetchFileManifestPayload;
-  type: FileManifestActionKind.FetchFileManifest;
-};
-
-/**
- * Update file manifest action.
- */
-type UpdateFileManifestAction = {
-  payload: UpdateFileManifestPayload;
-  type: FileManifestActionKind.UpdateFileManifest;
-};
-
-/**
- * Update file count action.
- */
-type UpdateFileCountAction = {
-  payload: UpdateFileCountPayload;
-  type: FileManifestActionKind.UpdateFileCount;
-};
-
-/**
- * Update filter action.
- */
-type UpdateFilterAction = {
-  payload: UpdateFilterPayload;
-  type: FileManifestActionKind.UpdateFilter;
-};
-
-/**
- * Update filters by category action.
- */
-type UpdateFiltersCategoryAction = {
-  payload: CategoryKey;
-  type: FileManifestActionKind.UpdateFiltersCategory;
-};
-
-/**
- * Initialize file manifest payload.
- */
-type FetchFileManifestPayload = {
-  fileSummaryFacetName?: string;
-  filters: Filters;
-};
-
-/**
- * Update file count payload.
- */
-export type UpdateFileCountPayload = {
-  fileCount: number | undefined;
-};
-
-/**
- * Update file manifest payload.
- */
-export type UpdateFileManifestPayload = {
-  filesFacets: FileFacet[];
-  fileSummary?: AzulSummaryResponse;
-  isFacetsLoading: boolean;
-  isFacetsSuccess: boolean;
-  isFileSummaryLoading: boolean;
-  isLoading: boolean;
-  isSummaryLoading: boolean;
-  summary?: AzulSummaryResponse;
-};
-
-/**
- * Update filter payload.
- */
-export type UpdateFilterPayload = {
-  categoryKey: CategoryKey;
-  selected: boolean;
-  selectedValue: CategoryValueKey;
-};
-
-/**
- * File manifest reducer.
- * @param state - File manifest state.
- * @param action - File manifest action.
- * @returns file manifest state.
- */
-function fileManifestReducer(
-  state: FileManifestState,
-  action: FileManifestAction,
-): FileManifestState {
-  const { payload, type } = action;
-  switch (type) {
-    // Resets file manifest.
-    case FileManifestActionKind.ClearFileManifest: {
-      return {
-        ...state,
-        fileCount: undefined,
-        isEnabled: false,
-      };
-    }
-    // Fetches file manifest.
-    case FileManifestActionKind.FetchFileManifest: {
-      // Get file summary filters.
-      const fileSummaryFilters = buildNextFileSummaryFilterState(
-        payload.filters,
-        payload.fileSummaryFacetName,
-      );
-      return {
-        ...state,
-        ...payload,
-        fileSummaryFilters,
-        isEnabled: true,
-      };
-    }
-    // Updates file count.
-    case FileManifestActionKind.UpdateFileCount: {
-      return { ...state, ...payload };
-    }
-    // Updates file manifest.
-    case FileManifestActionKind.UpdateFileManifest: {
-      return { ...state, ...payload };
-    }
-    // Updates selected file manifest filters with given selected category value.
-    case FileManifestActionKind.UpdateFilter: {
-      // Build next filter state.
-      const filters = buildNextFilterState(
-        state.filters,
-        payload.categoryKey,
-        getFilterParameterValue(payload.selectedValue),
-        payload.selected,
-      );
-      // Get file summary filters.
-      const fileSummaryFilters = buildNextFileSummaryFilterState(
-        filters,
-        state.fileSummaryFacetName,
-      );
-      return {
-        ...state,
-        fileSummaryFilters,
-        filters,
-      };
-    }
-    // Updates selected file manifest filters by category.
-    case FileManifestActionKind.UpdateFiltersCategory: {
-      // Build next filter state.
-      const filters = updateCategoryFilterState(
-        state.filters,
-        payload,
-        state.filesFacets,
-      );
-      // Get file summary filters.
-      const fileSummaryFilters = buildNextFileSummaryFilterState(
-        filters,
-        state.fileSummaryFacetName,
-      );
-      return {
-        ...state,
-        fileSummaryFilters,
-        filters,
-      };
-    }
-    default:
-      return state;
-  }
-}
-
-/**
- * Returns the file summary filters; comprising selected facets except any of the given facet name.
- * @param filters - Current set of selected category and category values.
- * @param facetName - Name of facet to exclude from file summary filters.
- * @returns file summary filters.
- */
-function buildNextFileSummaryFilterState(
-  filters: Filters,
-  facetName?: string,
-): Filters {
-  if (!facetName) {
-    return [];
-  }
-  return filters.filter(({ categoryKey }) => categoryKey !== facetName);
-}
-
-/**
- * Returns all terms for the given category.
- * @param fileFacet - File facet.
- * @returns all terms for the given category.
- */
-function getFileFacetTerms(fileFacet: FileFacet): SelectedFilterValue {
-  return fileFacet.terms.map((term) => getFilterParameterValue(term.name));
-}
-
-/**
- * Build new set of selected filters on de/select of filter category.
- * @param filters - Current set of selected category and category values.
- * @param categoryKey - Key of category that has been de/selected.
- * @param filesFacets - File facets.
- * @returns New filter state generated from the current set of selected values and the newly selected category.
- */
-function updateCategoryFilterState(
-  filters: Filters,
-  categoryKey: CategoryKey,
-  filesFacets: FileFacet[],
-): Filters {
-  // Find the selected category facet.
-  const categoryFacet = filesFacets.find(({ name }) => name === categoryKey);
-
-  if (!categoryFacet) {
-    return filters;
-  }
-
-  const { selectedTermCount, termCount } = categoryFacet;
-
-  // Create a copy of the current filter state. Remove the selected filter for the selected category, if any.
-  const nextFilterState = filters.filter(
-    ({ categoryKey: key }) => key !== categoryKey,
-  );
-
-  // If the selected category already has all selected values, return the next filter state with removed selected category.
-  if (selectedTermCount === termCount) {
-    return nextFilterState;
-  }
-
-  // Create new selected filter for this category.
-  const nextCategorySelectedFilter = {
-    categoryKey,
-    value: getFileFacetTerms(categoryFacet),
-  };
-
-  nextFilterState.push(nextCategorySelectedFilter);
-
-  return nextFilterState;
-}

package/src/providers/googleSignInAuthentication/common/types.ts

@@ -1,28 +0,0 @@
-import { Dispatch } from "react";
-import { AuthAction, AuthContextProps } from "../../authentication/auth/types";
-import {
-  AuthenticationAction,
-  AuthenticationContextProps,
-} from "../../authentication/authentication/types";
-import {
-  CredentialsAction,
-  CredentialsContextProps,
-} from "../../authentication/credentials/types";
-import {
-  TokenAction,
-  TokenContextProps,
-} from "../../authentication/token/types";
-
-export interface SessionReducer {
-  authenticationReducer: AuthenticationContextProps;
-  authReducer: Omit<AuthContextProps, "service">;
-  credentialsReducer: CredentialsContextProps;
-  tokenReducer: TokenContextProps;
-}
-
-export interface SessionDispatch {
-  authDispatch: Dispatch<AuthAction> | null;
-  authenticationDispatch: Dispatch<AuthenticationAction> | null;
-  credentialsDispatch: Dispatch<CredentialsAction> | null;
-  tokenDispatch: Dispatch<TokenAction> | null;
-}

package/src/providers/googleSignInAuthentication/constants.ts

@@ -1,17 +0,0 @@
-import { DEFAULT_AUTH_STATE } from "../authentication/auth/constants";
-import { AUTH_STATUS, AuthState } from "../authentication/auth/types";
-import { DEFAULT_AUTHENTICATION_STATE } from "../authentication/authentication/constants";
-import {
-  AUTHENTICATION_STATUS,
-  AuthenticationState,
-} from "../authentication/authentication/types";
-
-export const AUTH_STATE: AuthState = {
-  ...DEFAULT_AUTH_STATE,
-  status: AUTH_STATUS.SETTLED,
-};
-
-export const AUTHENTICATION_STATE: AuthenticationState = {
-  ...DEFAULT_AUTHENTICATION_STATE,
-  status: AUTHENTICATION_STATUS.SETTLED,
-};

package/src/providers/googleSignInAuthentication/hooks/useGoogleSignInService.ts

@@ -1,53 +0,0 @@
-import { useRouter } from "next/router";
-import { useCallback } from "react";
-import { useProviders } from "../../../hooks/authentication/providers/useProviders";
-import { Service } from "../../authentication/auth/types";
-import { ProviderId } from "../../authentication/common/types";
-import { SessionReducer } from "../common/types";
-import { service } from "../service/service";
-
-export const useGoogleSignInService = (reducer: SessionReducer): Service => {
-  const { findProvider } = useProviders();
-  const { basePath } = useRouter();
-  const {
-    authenticationReducer: { authenticationDispatch },
-    authReducer: { authDispatch },
-    credentialsReducer: { credentialsDispatch },
-    tokenReducer: { tokenDispatch },
-  } = reducer;
-
-  const onLogin = useCallback(
-    (providerId: ProviderId) => {
-      const provider = findProvider(providerId);
-      if (!provider) return;
-      service.login(provider, {
-        authDispatch,
-        authenticationDispatch,
-        tokenDispatch,
-      });
-    },
-    [authDispatch, authenticationDispatch, findProvider, tokenDispatch],
-  );
-
-  const onLogout = useCallback(
-    (options?: { callbackUrl?: string }) => {
-      service.logout({
-        authDispatch,
-        authenticationDispatch,
-        credentialsDispatch,
-        tokenDispatch,
-      });
-      // Request page reload, ensuring that the entity detail page is re-initialized with the correct state and associated data.
-      location.href = options?.callbackUrl || basePath;
-    },
-    [
-      authDispatch,
-      authenticationDispatch,
-      basePath,
-      credentialsDispatch,
-      tokenDispatch,
-    ],
-  );
-
-  return { requestLogin: onLogin, requestLogout: onLogout };
-};

package/src/providers/googleSignInAuthentication/profile/types.ts

@@ -1,15 +0,0 @@
-export interface GoogleProfile {
-  email: string;
-  email_verified: boolean;
-  family_name: string;
-  given_name: string;
-  hd: string;
-  locale: string;
-  name: string;
-  picture: string;
-  sub: string;
-}
-
-export interface TokenSetParameters {
-  access_token: string;
-}

package/src/providers/googleSignInAuthentication/profile/utils.ts

@@ -1,29 +0,0 @@
-import { UserProfile } from "../../authentication/authentication/types";
-import { GOOGLE_SIGN_IN_PROVIDER_ID } from "../service/constants";
-import { GoogleProfile } from "./types";
-
-/**
- * Returns full name, from given and family name.
- * @param profile - Google response.
- * @returns full name.
- */
-function getFullName(profile: GoogleProfile): string {
-  const { family_name: lastName = "", given_name: firstName = "" } = profile;
-  return `${firstName} ${lastName}`.trim();
-}
-
-/**
- * Returns user profile from google response.
- * @param profile - Google response.
- * @returns user profile.
- */
-export function mapProfile(profile: GoogleProfile): UserProfile {
-  const { email, picture: image } = profile;
-  const name = getFullName(profile);
-  return {
-    email,
-    id: GOOGLE_SIGN_IN_PROVIDER_ID,
-    image,
-    name,
-  };
-}

package/src/providers/googleSignInAuthentication/provider.tsx

@@ -1,53 +0,0 @@
-import { JSX } from "react";
-import { SessionController as DefaultSessionController } from "../../components/Authentication/components/SessionController/components/GoogleSessionController/SessionController";
-import { useAuthReducer } from "../../hooks/authentication/auth/useAuthReducer";
-import { useAuthenticationReducer } from "../../hooks/authentication/authentication/useAuthenticationReducer";
-import { useCredentialsReducer } from "../../hooks/authentication/credentials/useCredentialsReducer";
-import { useSessionActive } from "../../hooks/authentication/session/useSessionActive";
-import { useSessionCallbackUrl } from "../../hooks/authentication/session/useSessionCallbackUrl";
-import { useSessionIdleTimer } from "../../hooks/authentication/session/useSessionIdleTimer";
-import { useTokenReducer } from "../../hooks/authentication/token/useTokenReducer";
-import { AuthContext } from "../authentication/auth/context";
-import { AuthenticationContext } from "../authentication/authentication/context";
-import { CredentialsContext } from "../authentication/credentials/context";
-import { AUTH_STATE, AUTHENTICATION_STATE } from "./constants";
-import { useGoogleSignInService } from "./hooks/useGoogleSignInService";
-import { GoogleSignInAuthenticationProviderProps } from "./types";
-
-export function GoogleSignInAuthenticationProvider({
-  children,
-  SessionController = DefaultSessionController,
-  timeout,
-}: GoogleSignInAuthenticationProviderProps): JSX.Element {
-  const authReducer = useAuthReducer(AUTH_STATE);
-  const authenticationReducer = useAuthenticationReducer(AUTHENTICATION_STATE);
-  const credentialsReducer = useCredentialsReducer();
-  const tokenReducer = useTokenReducer(); // Reducer, local to Google Sign-In process only.
-  const service = useGoogleSignInService({
-    authReducer,
-    authenticationReducer,
-    credentialsReducer,
-    tokenReducer,
-  });
-  const { callbackUrl } = useSessionCallbackUrl();
-  const { authDispatch, authState } = authReducer;
-  const { isAuthenticated } = authState;
-  const { authenticationState } = authenticationReducer;
-  useSessionActive(authState, authenticationState);
-  useSessionIdleTimer({
-    disabled: !isAuthenticated,
-    onIdle: () => service.requestLogout({ callbackUrl }),
-    timeout,
-  });
-  return (
-    <CredentialsContext.Provider value={credentialsReducer}>
-      <AuthenticationContext.Provider value={authenticationReducer}>
-        <AuthContext.Provider value={{ authDispatch, authState, service }}>
-          <SessionController token={tokenReducer.tokenState.token}>
-            {children}
-          </SessionController>
-        </AuthContext.Provider>
-      </AuthenticationContext.Provider>
-    </CredentialsContext.Provider>
-  );
-}

package/src/providers/googleSignInAuthentication/service/constants.ts

@@ -1,16 +0,0 @@
-import { GoogleIcon } from "../../../components/common/CustomIcon/components/GoogleIcon/googleIcon";
-import { OAuthProvider } from "../../../config/entities";
-import { GoogleProfile } from "../profile/types";
-import { mapProfile } from "../profile/utils";
-
-export const GOOGLE_SIGN_IN_PROVIDER_ID = "google";
-
-export const GOOGLE_SIGN_IN_PROVIDER: Pick<
-  OAuthProvider<GoogleProfile>,
-  "icon" | "id" | "name" | "profile"
-> = {
-  icon: GoogleIcon({}),
-  id: GOOGLE_SIGN_IN_PROVIDER_ID,
-  name: "Google",
-  profile: mapProfile,
-};

package/src/providers/googleSignInAuthentication/service/service.ts

@@ -1,68 +0,0 @@
-import { OAuthProvider } from "../../../config/entities";
-import { requestAuth, resetState } from "../../authentication/auth/dispatch";
-import {
-  requestAuthentication,
-  resetState as resetAuthenticationState,
-  updateAuthentication,
-} from "../../authentication/authentication/dispatch";
-import { AUTHENTICATION_STATUS } from "../../authentication/authentication/types";
-import { fetchProfile } from "../../authentication/authentication/utils";
-import { resetState as resetCredentialsState } from "../../authentication/credentials/dispatch";
-import { getAuthenticationRequestOptions } from "../../authentication/terra/hooks/common/utils";
-import {
-  resetState as resetTokenState,
-  updateToken,
-} from "../../authentication/token/dispatch";
-import { SessionDispatch } from "../common/types";
-import { GoogleProfile, TokenSetParameters } from "../profile/types";
-
-// eslint-disable-next-line  @typescript-eslint/no-explicit-any -- TODO see https://github.com/clevercanary/data-browser/issues/544.
-declare const google: any;
-
-export const service = {
-  login: (
-    provider: OAuthProvider,
-    dispatch: Pick<
-      SessionDispatch,
-      "authDispatch" | "authenticationDispatch" | "tokenDispatch"
-    >,
-  ): void => {
-    const client = google.accounts.oauth2.initTokenClient({
-      callback: (response: TokenSetParameters) => {
-        const { id, profile, userinfo } = provider;
-        const { access_token: token } = response;
-        dispatch.authDispatch?.(requestAuth());
-        dispatch.authenticationDispatch?.(requestAuthentication());
-        dispatch.tokenDispatch?.(updateToken({ providerId: id, token }));
-        fetchProfile(userinfo, getAuthenticationRequestOptions(token), {
-          onError: () => {
-            dispatch.authDispatch?.(resetState());
-            dispatch.authenticationDispatch?.(
-              updateAuthentication({
-                profile: undefined,
-                status: AUTHENTICATION_STATUS.SETTLED,
-              }),
-            );
-            dispatch.tokenDispatch?.(resetTokenState());
-          },
-          onSuccess: (r: GoogleProfile) =>
-            dispatch.authenticationDispatch?.(
-              updateAuthentication({
-                profile: profile(r),
-                status: AUTHENTICATION_STATUS.PENDING, // Authentication is pending until session controller is resolved.
-              }),
-            ),
-        });
-      },
-      client_id: provider.clientId,
-      scope: provider.authorization.params.scope,
-    });
-    client.requestAccessToken();
-  },
-  logout: (dispatch: SessionDispatch): void => {
-    dispatch.authDispatch?.(resetState());
-    dispatch.authenticationDispatch?.(resetAuthenticationState());
-    dispatch.credentialsDispatch?.(resetCredentialsState());
-    dispatch.tokenDispatch?.(resetTokenState());
-  },
-};