@databiosphere/findable-ui 19.0.0 → 20.0.0

package/src/providers/authentication/auth/actions.ts

@@ -0,0 +1,17 @@
+import { AuthState, UpdateAuthStatePayload } from "./types";
+
+/**
+ * Update auth state.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function updateAuthState(
+  state: AuthState,
+  payload: UpdateAuthStatePayload
+): AuthState {
+  return {
+    ...state,
+    ...payload,
+  };
+}

package/src/providers/authentication/auth/constants.ts

@@ -0,0 +1,6 @@
+import { AUTH_STATUS, AuthState } from "./types";
+
+export const DEFAULT_AUTH_STATE: AuthState = {
+  isAuthenticated: false,
+  status: AUTH_STATUS.PENDING,
+};

package/src/providers/authentication/auth/context.ts

@@ -0,0 +1,9 @@
+import { createContext } from "react";
+import { DEFAULT_AUTH_STATE } from "./constants";
+import { AuthContextProps } from "./types";
+
+export const AuthContext = createContext<AuthContextProps>({
+  authDispatch: null,
+  authState: DEFAULT_AUTH_STATE,
+  service: undefined,
+});

package/src/providers/authentication/auth/dispatch.ts

@@ -0,0 +1,58 @@
+import {
+  AUTH_STATUS,
+  AuthActionKind,
+  RequestAuthAction,
+  ResetStateAction,
+  UpdateAuthStateAction,
+  UpdateAuthStatePayload,
+} from "./types";
+
+/**
+ * Auth is complete.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export function authComplete(
+  payload: UpdateAuthStatePayload
+): UpdateAuthStateAction {
+  return {
+    payload: { ...payload, status: AUTH_STATUS.SETTLED },
+    type: AuthActionKind.UpdateAuthState,
+  };
+}
+
+/**
+ * Request auth action.
+ * @returns Action.
+ */
+export function requestAuth(): RequestAuthAction {
+  return {
+    payload: undefined,
+    type: AuthActionKind.RequestAuth,
+  };
+}
+
+/**
+ * Reset state action.
+ * @returns state.
+ */
+export function resetState(): ResetStateAction {
+  return {
+    payload: undefined,
+    type: AuthActionKind.ResetState,
+  };
+}
+
+/**
+ * Update auth state action.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export function updateAuthState(
+  payload: UpdateAuthStatePayload
+): UpdateAuthStateAction {
+  return {
+    payload,
+    type: AuthActionKind.UpdateAuthState,
+  };
+}

package/src/providers/authentication/auth/hook.ts

@@ -0,0 +1,11 @@
+import { useContext } from "react";
+import { AuthContext } from "./context";
+import { AuthContextProps } from "./types";
+
+/**
+ * Auth hook.
+ * @returns auth context.
+ */
+export const useAuth = (): AuthContextProps => {
+  return useContext<AuthContextProps>(AuthContext);
+};

package/src/providers/authentication/auth/reducer.ts

@@ -0,0 +1,25 @@
+import { updateAuthState } from "./actions";
+import { AUTH_STATUS, AuthAction, AuthActionKind, AuthState } from "./types";
+
+/**
+ * Auth reducer.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export function authReducer(state: AuthState, action: AuthAction): AuthState {
+  const { payload, type } = action;
+  switch (type) {
+    case AuthActionKind.RequestAuth: {
+      return { ...state, status: AUTH_STATUS.PENDING };
+    }
+    case AuthActionKind.ResetState: {
+      return { ...state, ...state.initialState };
+    }
+    case AuthActionKind.UpdateAuthState: {
+      return updateAuthState(state, payload);
+    }
+    default:
+      return state;
+  }
+}

package/src/providers/authentication/auth/types.ts

@@ -0,0 +1,63 @@
+import { Dispatch } from "react";
+import { ProviderId } from "../common/types";
+
+export type AuthAction =
+  | RequestAuthAction
+  | ResetStateAction
+  | UpdateAuthStateAction;
+
+export enum AuthActionKind {
+  RequestAuth = "REQUEST_AUTH",
+  ResetState = "RESET_STATE",
+  UpdateAuthState = "UPDATE_AUTH_STATE",
+}
+
+export interface AuthContextProps {
+  authDispatch: Dispatch<AuthAction> | null;
+  authState: AuthState;
+  service: Service | undefined;
+}
+
+export interface AuthState {
+  initialState?: AuthState;
+  isAuthenticated: boolean;
+  status: AUTH_STATUS;
+}
+
+export type RequestAuthAction = {
+  payload: RequestAuthPayload;
+  type: AuthActionKind.RequestAuth;
+};
+
+export type RequestAuthPayload = undefined;
+
+export type ResetStateAction = {
+  payload: ResetStatePayload;
+  type: AuthActionKind.ResetState;
+};
+
+export type ResetStatePayload = undefined;
+
+export interface Service {
+  [key: string]: unknown;
+  requestLogin: (providerId: ProviderId) => void;
+  requestLogout: (options?: {
+    callbackUrl?: string;
+    redirect?: boolean;
+  }) => void;
+}
+
+export enum AUTH_STATUS {
+  PENDING = "PENDING",
+  SETTLED = "SETTLED",
+}
+
+export interface UpdateAuthStateAction {
+  payload: UpdateAuthStatePayload;
+  type: AuthActionKind.UpdateAuthState;
+}
+
+export interface UpdateAuthStatePayload {
+  isAuthenticated?: boolean;
+  status?: AUTH_STATUS;
+}

package/src/providers/authentication/authentication/actions.ts

@@ -0,0 +1,17 @@
+import { AuthenticationState, UpdateAuthenticationPayload } from "./types";
+
+/**
+ * Update authentication action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function updateAuthenticationAction(
+  state: AuthenticationState,
+  payload: UpdateAuthenticationPayload
+): AuthenticationState {
+  return {
+    ...state,
+    ...payload,
+  };
+}

package/src/providers/authentication/authentication/constants.ts

@@ -0,0 +1,6 @@
+import { AUTHENTICATION_STATUS, AuthenticationState } from "./types";
+
+export const DEFAULT_AUTHENTICATION_STATE: AuthenticationState = {
+  profile: undefined,
+  status: AUTHENTICATION_STATUS.PENDING,
+};

package/src/providers/authentication/authentication/context.ts

@@ -0,0 +1,8 @@
+import { createContext } from "react";
+import { DEFAULT_AUTHENTICATION_STATE } from "./constants";
+import { AuthenticationContextProps } from "./types";
+
+export const AuthenticationContext = createContext<AuthenticationContextProps>({
+  authenticationDispatch: null,
+  authenticationState: DEFAULT_AUTHENTICATION_STATE,
+});

package/src/providers/authentication/authentication/dispatch.ts

@@ -0,0 +1,55 @@
+import {
+  AUTHENTICATION_STATUS,
+  AuthenticationActionKind,
+  RequestAuthenticationAction,
+  ResetStateAction,
+  UpdateAuthenticationAction,
+  UpdateAuthenticationPayload,
+} from "./types";
+
+/**
+ * Authentication is complete.
+ * @returns Action.
+ */
+export function authenticationComplete(): UpdateAuthenticationAction {
+  return {
+    payload: { status: AUTHENTICATION_STATUS.SETTLED },
+    type: AuthenticationActionKind.UpdateAuthentication,
+  };
+}
+
+/**
+ * Request authentication action.
+ * @returns Action.
+ */
+export function requestAuthentication(): RequestAuthenticationAction {
+  return {
+    payload: undefined,
+    type: AuthenticationActionKind.RequestAuthentication,
+  };
+}
+
+/**
+ * Reset authentication action.
+ * @returns Action.
+ */
+export function resetState(): ResetStateAction {
+  return {
+    payload: undefined,
+    type: AuthenticationActionKind.ResetState,
+  };
+}
+
+/**
+ * Update authentication action.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export function updateAuthentication(
+  payload: UpdateAuthenticationPayload
+): UpdateAuthenticationAction {
+  return {
+    payload,
+    type: AuthenticationActionKind.UpdateAuthentication,
+  };
+}

package/src/providers/authentication/authentication/hook.ts

@@ -0,0 +1,11 @@
+import { useContext } from "react";
+import { AuthenticationContext } from "./context";
+import { AuthenticationContextProps } from "./types";
+
+/**
+ * Authentication hook.
+ * @returns authentication context.
+ */
+export const useAuthentication = (): AuthenticationContextProps => {
+  return useContext(AuthenticationContext);
+};

package/src/providers/authentication/authentication/reducer.ts

@@ -0,0 +1,34 @@
+import { updateAuthenticationAction } from "./actions";
+import {
+  AUTHENTICATION_STATUS,
+  AuthenticationAction,
+  AuthenticationActionKind,
+  AuthenticationState,
+} from "./types";
+
+/**
+ * Authentication reducer.
+ * Reducer for user profile and status.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export function authenticationReducer(
+  state: AuthenticationState,
+  action: AuthenticationAction
+): AuthenticationState {
+  const { payload, type } = action;
+  switch (type) {
+    case AuthenticationActionKind.RequestAuthentication: {
+      return { ...state, status: AUTHENTICATION_STATUS.PENDING };
+    }
+    case AuthenticationActionKind.ResetState: {
+      return { ...state, ...state.initialState };
+    }
+    case AuthenticationActionKind.UpdateAuthentication: {
+      return updateAuthenticationAction(state, payload);
+    }
+    default:
+      return state;
+  }
+}

package/src/providers/authentication/authentication/types.ts

@@ -0,0 +1,64 @@
+import { Dispatch } from "react";
+
+export enum AUTHENTICATION_STATUS {
+  PENDING = "PENDING",
+  SETTLED = "SETTLED",
+}
+
+export type AuthenticationAction =
+  | RequestAuthenticationAction
+  | ResetStateAction
+  | UpdateAuthenticationAction;
+
+export enum AuthenticationActionKind {
+  RequestAuthentication = "REQUEST_AUTHENTICATION",
+  ResetState = "RESET_STATE",
+  UpdateAuthentication = "UPDATE_AUTHENTICATION",
+}
+
+export interface AuthenticationContextProps {
+  authenticationDispatch: Dispatch<AuthenticationAction> | null;
+  authenticationState: AuthenticationState;
+}
+
+export interface AuthenticationState {
+  initialState?: AuthenticationState;
+  profile: Profile<UserProfile>;
+  status: AUTHENTICATION_STATUS;
+}
+
+export interface BaseProfile {
+  id?: string;
+  name: string;
+}
+
+export type Profile<P extends BaseProfile> = P | undefined;
+
+export type RequestAuthenticationAction = {
+  payload: RequestAuthenticationPayload;
+  type: AuthenticationActionKind.RequestAuthentication;
+};
+
+export type RequestAuthenticationPayload = undefined;
+
+export type ResetStateAction = {
+  payload: ResetStatePayload;
+  type: AuthenticationActionKind.ResetState;
+};
+
+export type ResetStatePayload = undefined;
+
+export type UpdateAuthenticationAction = {
+  payload: UpdateAuthenticationPayload;
+  type: AuthenticationActionKind.UpdateAuthentication;
+};
+
+export interface UpdateAuthenticationPayload {
+  profile?: Profile<UserProfile>;
+  status?: AUTHENTICATION_STATUS;
+}
+
+export interface UserProfile extends BaseProfile {
+  email: string;
+  image?: string;
+}

package/src/providers/authentication/authentication/utils.ts

@@ -0,0 +1,25 @@
+/**
+ * Fetches data from given endpoint and options.
+ * @param endpoint - Endpoint.
+ * @param options - Request options.
+ * @param callback - Callback.
+ * @param callback.onError - Error callback.
+ * @param callback.onSuccess - Success callback.
+ */
+export function fetchProfile<R, E>(
+  endpoint: string,
+  options?: RequestInit,
+  callback?: {
+    onError: (error: E) => void;
+    onSuccess: (response: R) => void;
+  }
+): void {
+  fetch(endpoint, options)
+    .then((response) => response.json())
+    .then((r: R) => {
+      callback?.onSuccess(r);
+    })
+    .catch((e: E) => {
+      callback?.onError(e);
+    });
+}

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

@@ -0,0 +1 @@
+export type ProviderId = string;

package/src/providers/authentication/common/utils.ts

@@ -0,0 +1,11 @@
+/**
+ * Reducer state initializer.
+ * @param initialState - Initial state.
+ * @returns initial reducer state.
+ */
+export function initializer<S>(initialState: S): S {
+  return {
+    ...initialState,
+    initialState,
+  };
+}

package/src/providers/authentication/credentials/actions.ts

@@ -0,0 +1,17 @@
+import { CredentialsState, UpdateCredentialsPayload } from "./types";
+
+/**
+ * Update credentials action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function updateCredentialsAction(
+  state: CredentialsState,
+  payload: UpdateCredentialsPayload
+): CredentialsState {
+  return {
+    ...state,
+    credentials: payload,
+  };
+}

package/src/providers/authentication/credentials/constants.ts

@@ -0,0 +1,5 @@
+import { CredentialsState } from "./types";
+
+export const DEFAULT_CREDENTIALS_STATE: CredentialsState = {
+  credentials: undefined,
+};

package/src/providers/authentication/credentials/context.ts

@@ -0,0 +1,8 @@
+import { createContext } from "react";
+import { DEFAULT_CREDENTIALS_STATE } from "./constants";
+import { CredentialsContextProps } from "./types";
+
+export const CredentialsContext = createContext<CredentialsContextProps>({
+  credentialsDispatch: null,
+  credentialsState: DEFAULT_CREDENTIALS_STATE,
+});

package/src/providers/authentication/credentials/dispatch.ts

@@ -0,0 +1,31 @@
+import {
+  CredentialsActionKind,
+  ResetStateAction,
+  UpdateCredentialsAction,
+  UpdateCredentialsPayload,
+} from "./types";
+
+/**
+ * Update credentials action.
+ * @returns Action.
+ */
+export function resetState(): ResetStateAction {
+  return {
+    payload: undefined,
+    type: CredentialsActionKind.ResetState,
+  };
+}
+
+/**
+ * Update credentials action.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export function updateCredentials(
+  payload: UpdateCredentialsPayload
+): UpdateCredentialsAction {
+  return {
+    payload,
+    type: CredentialsActionKind.UpdateCredentials,
+  };
+}

package/src/providers/authentication/credentials/hook.ts

@@ -0,0 +1,11 @@
+import { useContext } from "react";
+import { CredentialsContext } from "./context";
+import { CredentialsContextProps } from "./types";
+
+/**
+ * Credentials hook.
+ * @returns credentials context.
+ */
+export const useCredentials = (): CredentialsContextProps => {
+  return useContext<CredentialsContextProps>(CredentialsContext);
+};

package/src/providers/authentication/credentials/reducer.ts

@@ -0,0 +1,30 @@
+import { updateCredentialsAction } from "./actions";
+import { DEFAULT_CREDENTIALS_STATE } from "./constants";
+import {
+  CredentialsAction,
+  CredentialsActionKind,
+  CredentialsState,
+} from "./types";
+
+/**
+ * Credentials reducer.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export function credentialsReducer(
+  state: CredentialsState,
+  action: CredentialsAction
+): CredentialsState {
+  const { payload, type } = action;
+  switch (type) {
+    case CredentialsActionKind.ResetState: {
+      return DEFAULT_CREDENTIALS_STATE;
+    }
+    case CredentialsActionKind.UpdateCredentials: {
+      return updateCredentialsAction(state, payload);
+    }
+    default:
+      return state;
+  }
+}

package/src/providers/authentication/credentials/types.ts

@@ -0,0 +1,33 @@
+import { Dispatch } from "react";
+
+export type Credentials<C = string | undefined> = C;
+
+export type CredentialsAction = ResetStateAction | UpdateCredentialsAction;
+
+export enum CredentialsActionKind {
+  ResetState = "RESET_STATE",
+  UpdateCredentials = "STORE_CREDENTIALS",
+}
+
+export interface CredentialsContextProps {
+  credentialsDispatch: Dispatch<CredentialsAction> | null;
+  credentialsState: CredentialsState;
+}
+
+export interface CredentialsState {
+  credentials: Credentials;
+}
+
+export type ResetStateAction = {
+  payload: ResetStatePayload;
+  type: CredentialsActionKind.ResetState;
+};
+
+export type ResetStatePayload = undefined;
+
+export type UpdateCredentialsAction = {
+  payload: UpdateCredentialsPayload;
+  type: CredentialsActionKind.UpdateCredentials;
+};
+
+export type UpdateCredentialsPayload = Credentials;

package/src/providers/authentication/terra/context.ts

@@ -0,0 +1,16 @@
+import { createContext } from "react";
+import { LOGIN_STATUS_NOT_STARTED } from "./hooks/common/constants";
+import { LoginStatus } from "./hooks/common/entities";
+import { TerraNIHResponse } from "./hooks/useFetchTerraNIHProfile";
+import { TerraResponse } from "./hooks/useFetchTerraProfile";
+import { TerraTermsOfServiceResponse } from "./hooks/useFetchTerraTermsOfService";
+import { TerraProfileContextProps } from "./types";
+
+export const TerraProfileContext = createContext<TerraProfileContextProps>({
+  terraNIHProfileLoginStatus:
+    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraNIHResponse>,
+  terraProfileLoginStatus:
+    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraResponse>,
+  terraTOSLoginStatus:
+    LOGIN_STATUS_NOT_STARTED as LoginStatus<TerraTermsOfServiceResponse>,
+});

package/src/providers/authentication/terra/hook.ts

@@ -0,0 +1,11 @@
+import { useContext } from "react";
+import { TerraProfileContext } from "./context";
+import { TerraProfileContextProps } from "./types";
+
+/**
+ * Terra profile hook.
+ * @returns terra profile context.
+ */
+export const useTerraProfile = (): TerraProfileContextProps => {
+  return useContext<TerraProfileContextProps>(TerraProfileContext);
+};

package/src/{hooks/useAuthentication → providers/authentication/terra/hooks}/common/constants.ts

@@ -20,3 +20,12 @@ export const LOGIN_STATUS_NOT_SUPPORTED: LoginStatus<LoginResponse> = {
   requestStatus: REQUEST_STATUS.NOT_STARTED,
   response: undefined,
 };
+
+export const LOGIN_STATUS_PENDING: LoginStatus<LoginResponse> = {
+  isSuccess: false,
+  isSupported: true,
+  requestStatus: REQUEST_STATUS.PENDING,
+  response: undefined,
+};
+
+export const TERRA_SERVICE_ID = "terra";

package/src/{hooks/useAuthentication → providers/authentication/terra/hooks}/common/entities.ts

@@ -1,15 +1,8 @@
-import { GoogleResponse } from "../useFetchGoogleProfile";
 import { TerraNIHResponse } from "../useFetchTerraNIHProfile";
 import { TerraResponse } from "../useFetchTerraProfile";
 import { TerraTermsOfServiceResponse } from "../useFetchTerraTermsOfService";
 
-export enum AUTHENTICATION_STATUS {
-  COMPLETED = "COMPLETED",
-  INCOMPLETE = "INCOMPLETE",
-}
-
 export type LoginResponse =
-  | GoogleResponse
   | TerraResponse
   | TerraNIHResponse
   | TerraTermsOfServiceResponse;
@@ -31,4 +24,5 @@ export enum REQUEST_STATUS {
   COMPLETED = "COMPLETED",
   FAILED = "FAILED",
   NOT_STARTED = "NOT_STARTED",
+  PENDING = "PENDING",
 }