@databiosphere/findable-ui 50.8.0 → 51.0.0

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

@@ -0,0 +1,5 @@
+import { AuthState } from "../types/auth";
+/**
+ * Default auth state.
+ */
+export declare const DEFAULT_AUTH_STATE: AuthState;

package/lib/{providers/authentication/auth/constants.js → auth/constants/auth.js}

@@ -1,4 +1,7 @@
-import { AUTH_STATUS } from "./types";
+import { AUTH_STATUS } from "../types/auth";
+/**
+ * Default auth state.
+ */
 export const DEFAULT_AUTH_STATE = {
     isAuthenticated: false,
     status: AUTH_STATUS.PENDING,

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

@@ -0,0 +1,5 @@
+import { AuthenticationState } from "../types/authentication";
+/**
+ * Default authentication state.
+ */
+export declare const DEFAULT_AUTHENTICATION_STATE: AuthenticationState;

package/lib/{providers/authentication/authentication/constants.js → auth/constants/authentication.js}

@@ -1,4 +1,7 @@
-import { AUTHENTICATION_STATUS } from "./types";
+import { AUTHENTICATION_STATUS, } from "../types/authentication";
+/**
+ * Default authentication state.
+ */
 export const DEFAULT_AUTHENTICATION_STATE = {
     profile: undefined,
     status: AUTHENTICATION_STATUS.PENDING,

package/lib/auth/constants/credentials.d.ts

@@ -0,0 +1,5 @@
+import { CredentialsState } from "../types/credentials";
+/**
+ * Default credentials state.
+ */
+export declare const DEFAULT_CREDENTIALS_STATE: CredentialsState;

package/lib/{providers/authentication/credentials/constants.js → auth/constants/credentials.js}

@@ -1,3 +1,6 @@
+/**
+ * Default credentials state.
+ */
 export const DEFAULT_CREDENTIALS_STATE = {
     credentials: undefined,
 };

package/lib/auth/constants/token.d.ts

@@ -0,0 +1,5 @@
+import { TokenState } from "../types/token";
+/**
+ * Default token state.
+ */
+export declare const DEFAULT_TOKEN_STATE: TokenState;

package/lib/{providers/authentication/token/constants.js → auth/constants/token.js}

@@ -1,3 +1,6 @@
+/**
+ * Default token state.
+ */
 export const DEFAULT_TOKEN_STATE = {
     providerId: undefined,
     token: undefined,

package/lib/{providers/authentication/auth/context.d.ts → auth/contexts/auth.d.ts}

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

package/lib/{providers/authentication/auth/context.js → auth/contexts/auth.js}

@@ -1,5 +1,8 @@
 import { createContext } from "react";
-import { DEFAULT_AUTH_STATE } from "./constants";
+import { DEFAULT_AUTH_STATE } from "../constants/auth";
+/**
+ * Auth context.
+ */
 export const AuthContext = createContext({
     authDispatch: null,
     authState: DEFAULT_AUTH_STATE,

package/lib/auth/contexts/authentication.d.ts

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

package/lib/{providers/authentication/authentication/context.js → auth/contexts/authentication.js}

@@ -1,5 +1,8 @@
 import { createContext } from "react";
-import { DEFAULT_AUTHENTICATION_STATE } from "./constants";
+import { DEFAULT_AUTHENTICATION_STATE } from "../constants/authentication";
+/**
+ * Authentication context.
+ */
 export const AuthenticationContext = createContext({
     authenticationDispatch: null,
     authenticationState: DEFAULT_AUTHENTICATION_STATE,

package/lib/auth/contexts/credentials.d.ts

@@ -0,0 +1,5 @@
+import { CredentialsContextProps } from "../types/credentials";
+/**
+ * Credentials context.
+ */
+export declare const CredentialsContext: import("react").Context<CredentialsContextProps>;

package/lib/{providers/authentication/credentials/context.js → auth/contexts/credentials.js}

@@ -1,5 +1,8 @@
 import { createContext } from "react";
-import { DEFAULT_CREDENTIALS_STATE } from "./constants";
+import { DEFAULT_CREDENTIALS_STATE } from "../constants/credentials";
+/**
+ * Credentials context.
+ */
 export const CredentialsContext = createContext({
     credentialsDispatch: null,
     credentialsState: DEFAULT_CREDENTIALS_STATE,

package/lib/{providers/authentication/auth/dispatch.d.ts → auth/dispatch/auth.d.ts}

@@ -1,4 +1,4 @@
-import { RequestAuthAction, ResetStateAction, UpdateAuthStateAction, UpdateAuthStatePayload } from "./types";
+import { AuthResetStateAction, RequestAuthAction, UpdateAuthStateAction, UpdateAuthStatePayload } from "../types/auth";
 /**
  * Auth is complete.
  * @param payload - Payload.
@@ -14,7 +14,7 @@ export declare function requestAuth(): RequestAuthAction;
  * Reset state action.
  * @returns state.
  */
-export declare function resetState(): ResetStateAction;
+export declare function resetAuthState(): AuthResetStateAction;
 /**
  * Update auth state action.
  * @param payload - Payload.

package/lib/{providers/authentication/auth/dispatch.js → auth/dispatch/auth.js}

@@ -1,4 +1,4 @@
-import { AUTH_STATUS, AuthActionKind, } from "./types";
+import { AUTH_STATUS, AuthActionKind, } from "../types/auth";
 /**
  * Auth is complete.
  * @param payload - Payload.
@@ -24,7 +24,7 @@ export function requestAuth() {
  * Reset state action.
  * @returns state.
  */
-export function resetState() {
+export function resetAuthState() {
     return {
         payload: undefined,
         type: AuthActionKind.ResetState,

package/lib/{providers/authentication/authentication/dispatch.d.ts → auth/dispatch/authentication.d.ts}

@@ -1,4 +1,4 @@
-import { RequestAuthenticationAction, ResetStateAction, UpdateAuthenticationAction, UpdateAuthenticationPayload } from "./types";
+import { AuthenticationResetStateAction, RequestAuthenticationAction, UpdateAuthenticationAction, UpdateAuthenticationPayload } from "../types/authentication";
 /**
  * Authentication is complete.
  * @returns Action.
@@ -13,7 +13,7 @@ export declare function requestAuthentication(): RequestAuthenticationAction;
  * Reset authentication action.
  * @returns Action.
  */
-export declare function resetState(): ResetStateAction;
+export declare function resetAuthenticationState(): AuthenticationResetStateAction;
 /**
  * Update authentication action.
  * @param payload - Payload.

package/lib/{providers/authentication/authentication/dispatch.js → auth/dispatch/authentication.js}

@@ -1,4 +1,4 @@
-import { AUTHENTICATION_STATUS, AuthenticationActionKind, } from "./types";
+import { AUTHENTICATION_STATUS, AuthenticationActionKind, } from "../types/authentication";
 /**
  * Authentication is complete.
  * @returns Action.
@@ -23,7 +23,7 @@ export function requestAuthentication() {
  * Reset authentication action.
  * @returns Action.
  */
-export function resetState() {
+export function resetAuthenticationState() {
     return {
         payload: undefined,
         type: AuthenticationActionKind.ResetState,

package/lib/auth/dispatch/credentials.d.ts

@@ -0,0 +1,12 @@
+import { CredentialsResetStateAction, UpdateCredentialsAction, UpdateCredentialsPayload } from "../types/credentials";
+/**
+ * Reset credentials state action.
+ * @returns Action.
+ */
+export declare function resetCredentialsState(): CredentialsResetStateAction;
+/**
+ * Update credentials action.
+ * @param payload - Payload.
+ * @returns Action.
+ */
+export declare function updateCredentials(payload: UpdateCredentialsPayload): UpdateCredentialsAction;

package/lib/{providers/authentication/credentials/dispatch.js → auth/dispatch/credentials.js}

@@ -1,9 +1,9 @@
-import { CredentialsActionKind, } from "./types";
+import { CredentialsActionKind, } from "../types/credentials";
 /**
- * Update credentials action.
+ * Reset credentials state action.
  * @returns Action.
  */
-export function resetState() {
+export function resetCredentialsState() {
     return {
         payload: undefined,
         type: CredentialsActionKind.ResetState,

package/lib/{providers/authentication/token/dispatch.d.ts → auth/dispatch/token.d.ts}

@@ -1,9 +1,9 @@
-import { ResetStateAction, UpdateTokenAction, UpdateTokenPayload } from "./types";
+import { TokenResetStateAction, UpdateTokenAction, UpdateTokenPayload } from "../types/token";
 /**
- * Reset state action.
+ * Reset token state action.
  * @returns Action.
  */
-export declare function resetState(): ResetStateAction;
+export declare function resetTokenState(): TokenResetStateAction;
 /**
  * Update token action.
  * @param payload - Payload.

package/lib/{providers/authentication/token/dispatch.js → auth/dispatch/token.js}

@@ -1,9 +1,9 @@
-import { TokenActionKind, } from "./types";
+import { TokenActionKind, } from "../types/token";
 /**
- * Reset state action.
+ * Reset token state action.
  * @returns Action.
  */
-export function resetState() {
+export function resetTokenState() {
     return {
         payload: undefined,
         type: TokenActionKind.ResetState,

package/lib/{providers/authentication/auth/hook.d.ts → auth/hooks/useAuth.d.ts}

@@ -1,4 +1,4 @@
-import { AuthContextProps } from "./types";
+import { AuthContextProps } from "../types/auth";
 /**
  * Auth hook.
  * @returns auth context.

package/lib/{providers/authentication/auth/hook.js → auth/hooks/useAuth.js}

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { AuthContext } from "./context";
+import { AuthContext } from "../contexts/auth";
 /**
  * Auth hook.
  * @returns auth context.

package/lib/auth/hooks/useAuthReducer.d.ts

@@ -0,0 +1,7 @@
+import { AuthContextProps, AuthState } from "../types/auth";
+/**
+ * Auth reducer hook.
+ * @param initialState - Initial state.
+ * @returns auth state and dispatch.
+ */
+export declare const useAuthReducer: (initialState?: AuthState) => Omit<AuthContextProps, "service">;

package/lib/auth/hooks/useAuthReducer.js

@@ -0,0 +1,13 @@
+import { useReducer } from "react";
+import { DEFAULT_AUTH_STATE } from "../constants/auth";
+import { authReducer } from "../reducers/auth";
+import { initializer } from "../utils/initializer";
+/**
+ * Auth reducer hook.
+ * @param initialState - Initial state.
+ * @returns auth state and dispatch.
+ */
+export const useAuthReducer = (initialState = DEFAULT_AUTH_STATE) => {
+    const [authState, authDispatch] = useReducer(authReducer, initialState, initializer);
+    return { authDispatch, authState };
+};

package/lib/{providers/authentication/authentication/hook.d.ts → auth/hooks/useAuthentication.d.ts}

@@ -1,4 +1,4 @@
-import { AuthenticationContextProps } from "./types";
+import { AuthenticationContextProps } from "../types/authentication";
 /**
  * Authentication hook.
  * @returns authentication context.

package/lib/{providers/authentication/authentication/hook.js → auth/hooks/useAuthentication.js}

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { AuthenticationContext } from "./context";
+import { AuthenticationContext } from "../contexts/authentication";
 /**
  * Authentication hook.
  * @returns authentication context.

package/lib/auth/hooks/useAuthenticationReducer.d.ts

@@ -0,0 +1,7 @@
+import { AuthenticationContextProps, AuthenticationState } from "../types/authentication";
+/**
+ * Authentication reducer hook.
+ * @param initialState - Initial state.
+ * @returns authentication state and dispatch.
+ */
+export declare const useAuthenticationReducer: (initialState?: AuthenticationState) => AuthenticationContextProps;

package/lib/auth/hooks/useAuthenticationReducer.js

@@ -0,0 +1,13 @@
+import { useReducer } from "react";
+import { DEFAULT_AUTHENTICATION_STATE } from "../constants/authentication";
+import { authenticationReducer } from "../reducers/authentication";
+import { initializer } from "../utils/initializer";
+/**
+ * Authentication reducer hook.
+ * @param initialState - Initial state.
+ * @returns authentication state and dispatch.
+ */
+export const useAuthenticationReducer = (initialState = DEFAULT_AUTHENTICATION_STATE) => {
+    const [authenticationState, authenticationDispatch] = useReducer(authenticationReducer, initialState, initializer);
+    return { authenticationDispatch, authenticationState };
+};

package/lib/{providers/authentication/credentials/hook.d.ts → auth/hooks/useCredentials.d.ts}

@@ -1,4 +1,4 @@
-import { CredentialsContextProps } from "./types";
+import { CredentialsContextProps } from "../types/credentials";
 /**
  * Credentials hook.
  * @returns credentials context.

package/lib/{providers/authentication/credentials/hook.js → auth/hooks/useCredentials.js}

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { CredentialsContext } from "./context";
+import { CredentialsContext } from "../contexts/credentials";
 /**
  * Credentials hook.
  * @returns credentials context.

package/lib/auth/hooks/useCredentialsReducer.d.ts

@@ -0,0 +1,6 @@
+import { CredentialsContextProps } from "../types/credentials";
+/**
+ * Credentials reducer hook.
+ * @returns credentials state and dispatch.
+ */
+export declare const useCredentialsReducer: () => CredentialsContextProps;

package/lib/{hooks/authentication/credentials → auth/hooks}/useCredentialsReducer.js

@@ -1,6 +1,10 @@
 import { useReducer } from "react";
-import { DEFAULT_CREDENTIALS_STATE } from "../../../providers/authentication/credentials/constants";
-import { credentialsReducer } from "../../../providers/authentication/credentials/reducer";
+import { DEFAULT_CREDENTIALS_STATE } from "../constants/credentials";
+import { credentialsReducer } from "../reducers/credentials";
+/**
+ * Credentials reducer hook.
+ * @returns credentials state and dispatch.
+ */
 export const useCredentialsReducer = () => {
     const [credentialsState, credentialsDispatch] = useReducer(credentialsReducer, undefined, () => DEFAULT_CREDENTIALS_STATE);
     return { credentialsDispatch, credentialsState };

package/lib/{providers/authentication/auth/reducer.d.ts → auth/reducers/auth.d.ts}

@@ -1,4 +1,4 @@
-import { AuthAction, AuthState } from "./types";
+import { AuthAction, AuthState } from "../types/auth";
 /**
  * Auth reducer.
  * @param state - State.

package/lib/{providers/authentication/auth/reducer.js → auth/reducers/auth.js}

@@ -1,5 +1,16 @@
-import { updateAuthState } from "./actions";
-import { AUTH_STATUS, AuthActionKind } from "./types";
+import { AUTH_STATUS, AuthActionKind, } from "../types/auth";
+/**
+ * Update auth state.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+function updateAuthState(state, payload) {
+    return {
+        ...state,
+        ...payload,
+    };
+}
 /**
  * Auth reducer.
  * @param state - State.

package/lib/{providers/authentication/authentication/reducer.d.ts → auth/reducers/authentication.d.ts}

@@ -1,4 +1,4 @@
-import { AuthenticationAction, AuthenticationState } from "./types";
+import { AuthenticationAction, AuthenticationState } from "../types/authentication";
 /**
  * Authentication reducer.
  * Reducer for user profile and status.

package/lib/{providers/authentication/authentication/reducer.js → auth/reducers/authentication.js}

@@ -1,5 +1,16 @@
-import { updateAuthenticationAction } from "./actions";
-import { AUTHENTICATION_STATUS, AuthenticationActionKind, } from "./types";
+import { AUTHENTICATION_STATUS, AuthenticationActionKind, } from "../types/authentication";
+/**
+ * Update authentication action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+function updateAuthenticationAction(state, payload) {
+    return {
+        ...state,
+        ...payload,
+    };
+}
 /**
  * Authentication reducer.
  * Reducer for user profile and status.

package/lib/{providers/authentication/credentials/reducer.d.ts → auth/reducers/credentials.d.ts}

@@ -1,4 +1,4 @@
-import { CredentialsAction, CredentialsState } from "./types";
+import { CredentialsAction, CredentialsState } from "../types/credentials";
 /**
  * Credentials reducer.
  * @param state - State.

package/lib/{providers/authentication/credentials/reducer.js → auth/reducers/credentials.js}

@@ -1,6 +1,17 @@
-import { updateCredentialsAction } from "./actions";
-import { DEFAULT_CREDENTIALS_STATE } from "./constants";
-import { CredentialsActionKind, } from "./types";
+import { DEFAULT_CREDENTIALS_STATE } from "../constants/credentials";
+import { CredentialsActionKind, } from "../types/credentials";
+/**
+ * Update credentials action.
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns state.
+ */
+function updateCredentialsAction(state, payload) {
+    return {
+        ...state,
+        credentials: payload,
+    };
+}
 /**
  * Credentials reducer.
  * @param state - State.

package/lib/{providers/authentication/token/reducer.d.ts → auth/reducers/token.d.ts}

@@ -1,4 +1,4 @@
-import { TokenAction, TokenState } from "./types";
+import { TokenAction, TokenState } from "../types/token";
 /**
  * Token reducer.
  * @param state - State.

package/lib/{providers/authentication/token/reducer.js → auth/reducers/token.js}

@@ -1,5 +1,5 @@
-import { DEFAULT_TOKEN_STATE } from "./constants";
-import { TokenActionKind } from "./types";
+import { DEFAULT_TOKEN_STATE } from "../constants/token";
+import { TokenActionKind } from "../types/token";
 /**
  * Token reducer.
  * @param state - State.

package/lib/{providers/authentication/auth/types.d.ts → auth/types/auth.d.ts}

@@ -1,31 +1,58 @@
 import { Dispatch } from "react";
-import { ProviderId } from "../common/types";
-export type AuthAction = RequestAuthAction | ResetStateAction | UpdateAuthStateAction;
+import { ProviderId } from "./common";
+/**
+ * Auth action type - union of all possible auth actions.
+ */
+export type AuthAction = RequestAuthAction | AuthResetStateAction | UpdateAuthStateAction;
+/**
+ * Auth action kinds.
+ */
 export declare enum AuthActionKind {
     RequestAuth = "REQUEST_AUTH",
     ResetState = "RESET_STATE",
     UpdateAuthState = "UPDATE_AUTH_STATE"
 }
+/**
+ * Auth context properties.
+ */
 export interface AuthContextProps {
     authDispatch: Dispatch<AuthAction> | null;
     authState: AuthState;
     service: Service | undefined;
 }
+/**
+ * Auth state.
+ */
 export interface AuthState {
     initialState?: AuthState;
     isAuthenticated: boolean;
     status: AUTH_STATUS;
 }
+/**
+ * Request auth action.
+ */
 export type RequestAuthAction = {
     payload: RequestAuthPayload;
     type: AuthActionKind.RequestAuth;
 };
+/**
+ * Request auth payload.
+ */
 export type RequestAuthPayload = undefined;
-export type ResetStateAction = {
-    payload: ResetStatePayload;
+/**
+ * Auth reset state action.
+ */
+export type AuthResetStateAction = {
+    payload: AuthResetStatePayload;
     type: AuthActionKind.ResetState;
 };
-export type ResetStatePayload = undefined;
+/**
+ * Auth reset state payload.
+ */
+export type AuthResetStatePayload = undefined;
+/**
+ * Auth service interface.
+ */
 export interface Service {
     [key: string]: unknown;
     requestLogin: (providerId: ProviderId) => void;
@@ -34,14 +61,23 @@ export interface Service {
         redirect?: boolean;
     }) => void;
 }
+/**
+ * Auth status enum.
+ */
 export declare enum AUTH_STATUS {
     PENDING = "PENDING",
     SETTLED = "SETTLED"
 }
+/**
+ * Update auth state action.
+ */
 export interface UpdateAuthStateAction {
     payload: UpdateAuthStatePayload;
     type: AuthActionKind.UpdateAuthState;
 }
+/**
+ * Update auth state payload.
+ */
 export interface UpdateAuthStatePayload {
     isAuthenticated?: boolean;
     status?: AUTH_STATUS;

package/lib/{providers/authentication/auth/types.js → auth/types/auth.js}

@@ -1,9 +1,15 @@
+/**
+ * Auth action kinds.
+ */
 export var AuthActionKind;
 (function (AuthActionKind) {
     AuthActionKind["RequestAuth"] = "REQUEST_AUTH";
     AuthActionKind["ResetState"] = "RESET_STATE";
     AuthActionKind["UpdateAuthState"] = "UPDATE_AUTH_STATE";
 })(AuthActionKind || (AuthActionKind = {}));
+/**
+ * Auth status enum.
+ */
 export var AUTH_STATUS;
 (function (AUTH_STATUS) {
     AUTH_STATUS["PENDING"] = "PENDING";