@databiosphere/findable-ui 18.0.0 → 20.0.0

package/lib/hooks/useRequestFileLocation.js

@@ -1,8 +1,8 @@
 import { useCallback, useEffect, useRef } from "react";
 import { FILE_LOCATION_PENDING, FILE_LOCATION_SUCCESSFULLY, } from "../apis/azul/common/constants";
+import { useToken } from "./authentication/token/useToken";
 import { METHOD } from "./types";
 import { useAsync } from "./useAsync";
-import { useAuthentication } from "./useAuthentication/useAuthentication";
 /**
  * Returns fetch request options.
  * @param accessToken - Access token.
@@ -72,8 +72,7 @@ const scheduleFileLocation = (url, accessToken, resolve, reject, active, retryAf
  * @returns data object with the file location
  */
 export const useRequestFileLocation = (url, method) => {
-    // Grab token from authentication.
-    const { token } = useAuthentication();
+    const { token } = useToken();
     const { data, isIdle, isLoading, isSuccess, run: runAsync, } = useAsync();
     const active = useRef(true);
     useEffect(() => {

package/lib/hooks/useRouteHistory.d.ts

@@ -0,0 +1,14 @@
+export type TransformRouteFn = (routes: string[]) => string | undefined;
+export interface UseRouteHistory {
+    callbackUrl: (transformFn?: TransformRouteFn) => string;
+}
+export declare function useRouteHistory(maxHistory?: number): UseRouteHistory;
+/**
+ * Generates a callback URL based on the provided history and root path.
+ * Returns the callback URL determined by the transform function or the second item in history and if neither condition is met, returns the root path.
+ * @param history - Navigation history.
+ * @param rootPath - The default root path to return if no other conditions are met.
+ * @param [transformFn] - An optional function that transforms the history array to a specific route.
+ * @returns {string} - The callback UR.
+ */
+export declare function getCallbackUrl(history: string[], rootPath: string, transformFn?: TransformRouteFn): string;

package/lib/hooks/useRouteHistory.js

@@ -0,0 +1,40 @@
+import Router, { useRouter } from "next/router";
+import { useCallback, useEffect, useRef } from "react";
+import { useRouteRoot } from "./useRouteRoot";
+const ROUTE_CHANGE_EVENT = "routeChangeComplete";
+const MAX_HISTORY_LENGTH = 4;
+export function useRouteHistory(maxHistory = MAX_HISTORY_LENGTH) {
+    const { asPath } = useRouter();
+    const rootPath = useRouteRoot();
+    const historyRef = useRef([asPath]);
+    const onRouteChange = useCallback((route) => {
+        if (route === historyRef.current[0])
+            return;
+        historyRef.current.unshift(route);
+        if (historyRef.current.length > maxHistory) {
+            historyRef.current.pop();
+        }
+    }, [maxHistory]);
+    useEffect(() => {
+        Router.events.on(ROUTE_CHANGE_EVENT, onRouteChange);
+        return () => {
+            Router.events.off(ROUTE_CHANGE_EVENT, onRouteChange);
+        };
+    }, [onRouteChange]);
+    const callbackUrl = useCallback((transformFn) => getCallbackUrl(historyRef.current, rootPath, transformFn), [rootPath]);
+    return { callbackUrl };
+}
+/**
+ * Generates a callback URL based on the provided history and root path.
+ * Returns the callback URL determined by the transform function or the second item in history and if neither condition is met, returns the root path.
+ * @param history - Navigation history.
+ * @param rootPath - The default root path to return if no other conditions are met.
+ * @param [transformFn] - An optional function that transforms the history array to a specific route.
+ * @returns {string} - The callback UR.
+ */
+export function getCallbackUrl(history, rootPath, transformFn) {
+    if (transformFn) {
+        return transformFn(history) || rootPath;
+    }
+    return history[1] || rootPath;
+}

package/lib/hooks/useRouteRoot.d.ts

@@ -0,0 +1 @@
+export declare function useRouteRoot(): string;

package/lib/hooks/useRouteRoot.js

@@ -0,0 +1,8 @@
+import { useRouter } from "next/router";
+import { useMemo } from "react";
+import { useConfig } from "./useConfig";
+export function useRouteRoot() {
+    const { config: { redirectRootToPath: path }, } = useConfig();
+    const { basePath } = useRouter();
+    return useMemo(() => `${basePath}${path}`, [basePath, path]);
+}

package/lib/hooks/useSummary.js

@@ -1,6 +1,6 @@
 import { useEffect } from "react";
+import { useToken } from "./authentication/token/useToken";
 import { useAsync } from "./useAsync";
-import { useAuthentication } from "./useAuthentication/useAuthentication";
 import { useConfig } from "./useConfig";
 import { useEntityService } from "./useEntityService";
 import { useExploreState } from "./useExploreState";
@@ -9,7 +9,7 @@ import { useExploreState } from "./useExploreState";
  * @returns an object with the loaded data and a flag indicating is the data is loading
  */
 export const useSummary = () => {
-    const { token } = useAuthentication();
+    const { token } = useToken();
     const { config } = useConfig();
     const { exploreState } = useExploreState();
     const { filterState } = exploreState;
@@ -25,7 +25,7 @@ export const useSummary = () => {
     if (!summaryConfig) {
         return { isLoading: false }; //TODO: return a summary placeholder
     }
-    // Return the fetch status and summary data once fetch is complete..
+    // Return the fetch status and summary data once fetch is complete.
     return {
         isLoading: apiIsLoading,
         response,

package/lib/providers/authentication/auth/actions.d.ts

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

package/lib/providers/authentication/auth/actions.js

@@ -0,0 +1,12 @@
+/**
+ * Update auth state.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function updateAuthState(state, payload) {
+    return {
+        ...state,
+        ...payload,
+    };
+}

package/lib/providers/authentication/auth/constants.d.ts

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

package/lib/providers/authentication/auth/constants.js

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

package/lib/providers/authentication/auth/context.d.ts

@@ -0,0 +1,2 @@
+import { AuthContextProps } from "./types";
+export declare const AuthContext: import("react").Context<AuthContextProps>;

package/lib/providers/authentication/auth/context.js

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

package/lib/providers/authentication/auth/dispatch.d.ts

@@ -0,0 +1,23 @@
+import { RequestAuthAction, ResetStateAction, UpdateAuthStateAction, UpdateAuthStatePayload } from "./types";
+/**
+ * Auth is complete.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export declare function authComplete(payload: UpdateAuthStatePayload): UpdateAuthStateAction;
+/**
+ * Request auth action.
+ * @returns Action.
+ */
+export declare function requestAuth(): RequestAuthAction;
+/**
+ * Reset state action.
+ * @returns state.
+ */
+export declare function resetState(): ResetStateAction;
+/**
+ * Update auth state action.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export declare function updateAuthState(payload: UpdateAuthStatePayload): UpdateAuthStateAction;

package/lib/providers/authentication/auth/dispatch.js

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

package/lib/providers/authentication/auth/hook.d.ts

@@ -0,0 +1,6 @@
+import { AuthContextProps } from "./types";
+/**
+ * Auth hook.
+ * @returns auth context.
+ */
+export declare const useAuth: () => AuthContextProps;

package/lib/providers/authentication/auth/hook.js

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

package/lib/providers/authentication/auth/reducer.d.ts

@@ -0,0 +1,8 @@
+import { AuthAction, AuthState } from "./types";
+/**
+ * Auth reducer.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export declare function authReducer(state: AuthState, action: AuthAction): AuthState;

package/lib/providers/authentication/auth/reducer.js

@@ -0,0 +1,24 @@
+import { updateAuthState } from "./actions";
+import { AUTH_STATUS, AuthActionKind } from "./types";
+/**
+ * Auth reducer.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export function authReducer(state, action) {
+    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/lib/providers/authentication/auth/types.d.ts

@@ -0,0 +1,48 @@
+import { Dispatch } from "react";
+import { ProviderId } from "../common/types";
+export type AuthAction = RequestAuthAction | ResetStateAction | UpdateAuthStateAction;
+export declare 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 declare enum AUTH_STATUS {
+    PENDING = "PENDING",
+    SETTLED = "SETTLED"
+}
+export interface UpdateAuthStateAction {
+    payload: UpdateAuthStatePayload;
+    type: AuthActionKind.UpdateAuthState;
+}
+export interface UpdateAuthStatePayload {
+    isAuthenticated?: boolean;
+    status?: AUTH_STATUS;
+}

package/lib/providers/authentication/auth/types.js

@@ -0,0 +1,11 @@
+export var AuthActionKind;
+(function (AuthActionKind) {
+    AuthActionKind["RequestAuth"] = "REQUEST_AUTH";
+    AuthActionKind["ResetState"] = "RESET_STATE";
+    AuthActionKind["UpdateAuthState"] = "UPDATE_AUTH_STATE";
+})(AuthActionKind || (AuthActionKind = {}));
+export var AUTH_STATUS;
+(function (AUTH_STATUS) {
+    AUTH_STATUS["PENDING"] = "PENDING";
+    AUTH_STATUS["SETTLED"] = "SETTLED";
+})(AUTH_STATUS || (AUTH_STATUS = {}));

package/lib/providers/authentication/authentication/actions.d.ts

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

package/lib/providers/authentication/authentication/actions.js

@@ -0,0 +1,12 @@
+/**
+ * Update authentication action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+export function updateAuthenticationAction(state, payload) {
+    return {
+        ...state,
+        ...payload,
+    };
+}

package/lib/providers/authentication/authentication/constants.d.ts

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

package/lib/providers/authentication/authentication/constants.js

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

package/lib/providers/authentication/authentication/context.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticationContextProps } from "./types";
+export declare const AuthenticationContext: import("react").Context<AuthenticationContextProps>;

package/lib/providers/authentication/authentication/context.js

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

package/lib/providers/authentication/authentication/dispatch.d.ts

@@ -0,0 +1,22 @@
+import { RequestAuthenticationAction, ResetStateAction, UpdateAuthenticationAction, UpdateAuthenticationPayload } from "./types";
+/**
+ * Authentication is complete.
+ * @returns Action.
+ */
+export declare function authenticationComplete(): UpdateAuthenticationAction;
+/**
+ * Request authentication action.
+ * @returns Action.
+ */
+export declare function requestAuthentication(): RequestAuthenticationAction;
+/**
+ * Reset authentication action.
+ * @returns Action.
+ */
+export declare function resetState(): ResetStateAction;
+/**
+ * Update authentication action.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export declare function updateAuthentication(payload: UpdateAuthenticationPayload): UpdateAuthenticationAction;

package/lib/providers/authentication/authentication/dispatch.js

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

package/lib/providers/authentication/authentication/hook.d.ts

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

package/lib/providers/authentication/authentication/hook.js

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

package/lib/providers/authentication/authentication/reducer.d.ts

@@ -0,0 +1,9 @@
+import { AuthenticationAction, AuthenticationState } from "./types";
+/**
+ * Authentication reducer.
+ * Reducer for user profile and status.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export declare function authenticationReducer(state: AuthenticationState, action: AuthenticationAction): AuthenticationState;

package/lib/providers/authentication/authentication/reducer.js

@@ -0,0 +1,25 @@
+import { updateAuthenticationAction } from "./actions";
+import { AUTHENTICATION_STATUS, AuthenticationActionKind, } from "./types";
+/**
+ * Authentication reducer.
+ * Reducer for user profile and status.
+ * @param state - State.
+ * @param action - Action.
+ * @returns state.
+ */
+export function authenticationReducer(state, action) {
+    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/lib/providers/authentication/authentication/types.d.ts

@@ -0,0 +1,47 @@
+import { Dispatch } from "react";
+export declare enum AUTHENTICATION_STATUS {
+    PENDING = "PENDING",
+    SETTLED = "SETTLED"
+}
+export type AuthenticationAction = RequestAuthenticationAction | ResetStateAction | UpdateAuthenticationAction;
+export declare 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/lib/providers/authentication/authentication/types.js

@@ -0,0 +1,11 @@
+export var AUTHENTICATION_STATUS;
+(function (AUTHENTICATION_STATUS) {
+    AUTHENTICATION_STATUS["PENDING"] = "PENDING";
+    AUTHENTICATION_STATUS["SETTLED"] = "SETTLED";
+})(AUTHENTICATION_STATUS || (AUTHENTICATION_STATUS = {}));
+export var AuthenticationActionKind;
+(function (AuthenticationActionKind) {
+    AuthenticationActionKind["RequestAuthentication"] = "REQUEST_AUTHENTICATION";
+    AuthenticationActionKind["ResetState"] = "RESET_STATE";
+    AuthenticationActionKind["UpdateAuthentication"] = "UPDATE_AUTHENTICATION";
+})(AuthenticationActionKind || (AuthenticationActionKind = {}));

package/lib/providers/authentication/authentication/utils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 declare function fetchProfile<R, E>(endpoint: string, options?: RequestInit, callback?: {
+    onError: (error: E) => void;
+    onSuccess: (response: R) => void;
+}): void;

package/lib/providers/authentication/authentication/utils.js

@@ -0,0 +1,18 @@
+/**
+ * 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(endpoint, options, callback) {
+    fetch(endpoint, options)
+        .then((response) => response.json())
+        .then((r) => {
+        callback?.onSuccess(r);
+    })
+        .catch((e) => {
+        callback?.onError(e);
+    });
+}

package/lib/providers/authentication/common/types.d.ts

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

package/lib/providers/authentication/common/types.js

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

package/lib/providers/authentication/common/utils.d.ts

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

package/lib/providers/authentication/common/utils.js

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

package/lib/providers/authentication/credentials/actions.d.ts

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