@databiosphere/findable-ui 49.0.0 → 49.2.0

package/lib/views/ResearchView/assistant/stories/assistant.stories.js

@@ -0,0 +1,23 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Box } from "@mui/material";
+import { PALETTE } from "../../../../styles/common/constants/palette";
+import { ChatProvider } from "../../state/provider";
+import { Assistant } from "../assistant";
+import { INITIAL_ARGS, INITIAL_CONFIG } from "./args";
+import { ConfigProvider } from "../../../../providers/config";
+const meta = {
+    component: Assistant,
+    decorators: [
+        (Story) => (_jsx(ConfigProvider, { config: INITIAL_CONFIG, children: _jsx(ChatProvider, { initialArgs: INITIAL_ARGS, url: "https://api.example.com", children: _jsx(Box, { sx: {
+                        backgroundColor: PALETTE.COMMON_WHITE,
+                        display: "flex",
+                        flexDirection: "column",
+                        height: "100vh",
+                        minHeight: 0,
+                        width: "412px",
+                    }, children: _jsx(Story, {}) }) }) })),
+    ],
+    parameters: { layout: "none" },
+};
+export default meta;
+export const Default = {};

package/lib/views/ResearchView/query/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const ERROR_MESSAGE: {
+    readonly RATE_LIMITED: "You're sending too many requests. Please wait a moment.";
+    readonly REQUEST_FAILED: "Request failed";
+    readonly UNKNOWN: "An unknown error occurred.";
+};

package/lib/views/ResearchView/query/constants.js

@@ -0,0 +1,5 @@
+export const ERROR_MESSAGE = {
+    RATE_LIMITED: "You're sending too many requests. Please wait a moment.",
+    REQUEST_FAILED: "Request failed",
+    UNKNOWN: "An unknown error occurred.",
+};

package/lib/views/ResearchView/query/fetch.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Fetches a response from the given API URL.
+ * @param url - Request URL.
+ * @param query - Query to send.
+ * @param options - Fetch options.
+ * @param options.controller - AbortController.
+ * @param options.onError - Callback invoked on error.
+ * @param options.onSettled - Callback invoked when the request is settled (after success or error).
+ * @param options.onSuccess - Callback invoked with response data on success.
+ * @returns Promise that resolves when the request completes.
+ */
+export declare function fetchResponse<T = unknown>(url: string, query: string, { controller, onError, onSettled, onSuccess, }: {
+    controller: AbortController;
+    onError: (error: Error) => void;
+    onSettled: () => void;
+    onSuccess: (data: T) => void;
+}): Promise<T | undefined>;

package/lib/views/ResearchView/query/fetch.js

@@ -0,0 +1,44 @@
+import { ERROR_MESSAGE } from "./constants";
+/**
+ * Fetches a response from the given API URL.
+ * @param url - Request URL.
+ * @param query - Query to send.
+ * @param options - Fetch options.
+ * @param options.controller - AbortController.
+ * @param options.onError - Callback invoked on error.
+ * @param options.onSettled - Callback invoked when the request is settled (after success or error).
+ * @param options.onSuccess - Callback invoked with response data on success.
+ * @returns Promise that resolves when the request completes.
+ */
+export async function fetchResponse(url, query, { controller, onError, onSettled, onSuccess, }) {
+    const timeout = setTimeout(() => controller.abort(), 90_000);
+    try {
+        const res = await fetch(url, {
+            body: JSON.stringify({ query }),
+            headers: { "Content-Type": "application/json" },
+            method: "POST",
+            signal: controller.signal,
+        });
+        const { status } = res;
+        if (status === 429) {
+            onError(new Error(ERROR_MESSAGE.RATE_LIMITED));
+            return;
+        }
+        if (!res.ok)
+            throw new Error(`${ERROR_MESSAGE.REQUEST_FAILED} (${status})`);
+        const data = await res.json();
+        onSuccess(data);
+    }
+    catch (error) {
+        if (controller.signal.aborted)
+            return;
+        if (error instanceof Error)
+            onError(error);
+        else
+            onError(new Error(ERROR_MESSAGE.UNKNOWN));
+    }
+    finally {
+        clearTimeout(timeout);
+        onSettled();
+    }
+}

package/lib/views/ResearchView/researchView.d.ts

@@ -0,0 +1,10 @@
+import { JSX } from "react";
+import { ChildrenProps } from "../../components/types";
+/**
+ * Main view for the research assistant feature.
+ * Renders the assistant drawer and any related components.
+ * @param props - Component props.
+ * @param props.children - Children components to be rendered within the research view.
+ * @returns The research view component.
+ */
+export declare const ResearchView: ({ children }: ChildrenProps) => JSX.Element;

package/lib/views/ResearchView/researchView.js

@@ -0,0 +1,13 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Fragment } from "react";
+import { Assistant } from "./assistant/assistant";
+/**
+ * Main view for the research assistant feature.
+ * Renders the assistant drawer and any related components.
+ * @param props - Component props.
+ * @param props.children - Children components to be rendered within the research view.
+ * @returns The research view component.
+ */
+export const ResearchView = ({ children }) => {
+    return (_jsxs(Fragment, { children: [_jsx(Assistant, {}), children] }));
+};

package/lib/views/ResearchView/state/actions/setError/action.d.ts

@@ -0,0 +1,10 @@
+import { ChatState } from "../../types";
+import { SetErrorPayload } from "./types";
+/**
+ * Reducer action to set an error message in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export declare function setErrorAction(state: ChatState, payload: SetErrorPayload): ChatState;

package/lib/views/ResearchView/state/actions/setError/action.js

@@ -0,0 +1,17 @@
+import { MESSAGE_TYPE } from "../../types";
+/**
+ * Reducer action to set an error message in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export function setErrorAction(state, payload) {
+    return {
+        ...state,
+        messages: [
+            ...state.messages,
+            { createdAt: Date.now(), error: payload.error, type: MESSAGE_TYPE.ERROR },
+        ],
+    };
+}

package/lib/views/ResearchView/state/actions/setError/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { SetErrorAction, SetErrorPayload } from "./types";
+/**
+ * Action creator for setting an error message in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function setError(payload: SetErrorPayload): SetErrorAction;

package/lib/views/ResearchView/state/actions/setError/dispatch.js

@@ -0,0 +1,12 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action creator for setting an error message in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export function setError(payload) {
+    return {
+        payload,
+        type: ChatActionKind.SetError,
+    };
+}

package/lib/views/ResearchView/state/actions/setError/types.d.ts

@@ -0,0 +1,14 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action to set an error message in the chat.
+ */
+export interface SetErrorAction {
+    payload: SetErrorPayload;
+    type: ChatActionKind.SetError;
+}
+/**
+ * Payload for the SetError action.
+ */
+export interface SetErrorPayload {
+    error: string;
+}

package/lib/views/ResearchView/state/actions/setError/types.js

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

package/lib/views/ResearchView/state/actions/setMessage/action.d.ts

@@ -0,0 +1,10 @@
+import { ChatState } from "../../types";
+import { SetMessagePayload } from "./types";
+/**
+ * Reducer action to set a message in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export declare function setMessageAction(state: ChatState, payload: SetMessagePayload): ChatState;

package/lib/views/ResearchView/state/actions/setMessage/action.js

@@ -0,0 +1,21 @@
+import { MESSAGE_TYPE } from "../../types";
+/**
+ * Reducer action to set a message in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export function setMessageAction(state, payload) {
+    return {
+        ...state,
+        messages: [
+            ...state.messages,
+            {
+                createdAt: Date.now(),
+                response: payload.response,
+                type: MESSAGE_TYPE.ASSISTANT,
+            },
+        ],
+    };
+}

package/lib/views/ResearchView/state/actions/setMessage/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { SetMessageAction, SetMessagePayload } from "./types";
+/**
+ * Action creator for setting a message in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function setMessage(payload: SetMessagePayload): SetMessageAction;

package/lib/views/ResearchView/state/actions/setMessage/dispatch.js

@@ -0,0 +1,12 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action creator for setting a message in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export function setMessage(payload) {
+    return {
+        payload,
+        type: ChatActionKind.SetMessage,
+    };
+}

package/lib/views/ResearchView/state/actions/setMessage/types.d.ts

@@ -0,0 +1,15 @@
+import { MessageResponse } from "../../types";
+import { ChatActionKind } from "../types";
+/**
+ * Action to set the message for a chat.
+ */
+export interface SetMessageAction {
+    payload: SetMessagePayload;
+    type: ChatActionKind.SetMessage;
+}
+/**
+ * Payload for the SetMessage action.
+ */
+export interface SetMessagePayload<R extends MessageResponse = MessageResponse> {
+    response: R;
+}

package/lib/views/ResearchView/state/actions/setMessage/types.js

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

package/lib/views/ResearchView/state/actions/setQuery/action.d.ts

@@ -0,0 +1,10 @@
+import { ChatState } from "../../types";
+import { SetQueryPayload } from "./types";
+/**
+ * Reducer action to set a query in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export declare function setQueryAction(state: ChatState, payload: SetQueryPayload): ChatState;

package/lib/views/ResearchView/state/actions/setQuery/action.js

@@ -0,0 +1,17 @@
+import { MESSAGE_TYPE } from "../../types";
+/**
+ * Reducer action to set a query in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export function setQueryAction(state, payload) {
+    return {
+        ...state,
+        messages: [
+            ...state.messages,
+            { createdAt: Date.now(), text: payload.query, type: MESSAGE_TYPE.USER },
+        ],
+    };
+}

package/lib/views/ResearchView/state/actions/setQuery/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { SetQueryAction, SetQueryPayload } from "./types";
+/**
+ * Action creator for setting a query in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function setQuery(payload: SetQueryPayload): SetQueryAction;

package/lib/views/ResearchView/state/actions/setQuery/dispatch.js

@@ -0,0 +1,12 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action creator for setting a query in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export function setQuery(payload) {
+    return {
+        payload,
+        type: ChatActionKind.SetQuery,
+    };
+}

package/lib/views/ResearchView/state/actions/setQuery/types.d.ts

@@ -0,0 +1,14 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action to set the query for a chat.
+ */
+export interface SetQueryAction {
+    payload: SetQueryPayload;
+    type: ChatActionKind.SetQuery;
+}
+/**
+ * Payload for the SetQuery action.
+ */
+export interface SetQueryPayload {
+    query: string;
+}

package/lib/views/ResearchView/state/actions/setQuery/types.js

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

package/lib/views/ResearchView/state/actions/setStatus/action.d.ts

@@ -0,0 +1,10 @@
+import { ChatState } from "../../types";
+import { SetStatusPayload } from "./types";
+/**
+ * Reducer action to set the loading status in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export declare function setStatusAction(state: ChatState, payload: SetStatusPayload): ChatState;

package/lib/views/ResearchView/state/actions/setStatus/action.js

@@ -0,0 +1,13 @@
+/**
+ * Reducer action to set the loading status in the chat.
+ *
+ * @param state - State.
+ * @param payload - Payload.
+ * @returns State.
+ */
+export function setStatusAction(state, payload) {
+    return {
+        ...state,
+        status: { ...state.status, loading: payload.loading },
+    };
+}

package/lib/views/ResearchView/state/actions/setStatus/dispatch.d.ts

@@ -0,0 +1,7 @@
+import { SetStatusAction, SetStatusPayload } from "./types";
+/**
+ * Action creator for setting the loading status in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export declare function setStatus(payload: SetStatusPayload): SetStatusAction;

package/lib/views/ResearchView/state/actions/setStatus/dispatch.js

@@ -0,0 +1,12 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action creator for setting the loading status in the chat.
+ * @param payload - Payload.
+ * @returns Action with payload and action type.
+ */
+export function setStatus(payload) {
+    return {
+        payload,
+        type: ChatActionKind.SetStatus,
+    };
+}

package/lib/views/ResearchView/state/actions/setStatus/types.d.ts

@@ -0,0 +1,14 @@
+import { ChatActionKind } from "../types";
+/**
+ * Action to set the loading status for a chat.
+ */
+export interface SetStatusAction {
+    payload: SetStatusPayload;
+    type: ChatActionKind.SetStatus;
+}
+/**
+ * Payload for the SetStatus action.
+ */
+export interface SetStatusPayload {
+    loading: boolean;
+}

package/lib/views/ResearchView/state/actions/setStatus/types.js

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

package/lib/views/ResearchView/state/actions/types.d.ts

@@ -0,0 +1,17 @@
+import { SetErrorAction } from "./setError/types";
+import { SetMessageAction } from "./setMessage/types";
+import { SetQueryAction } from "./setQuery/types";
+import { SetStatusAction } from "./setStatus/types";
+/**
+ * Union of all Chat actions.
+ */
+export type ChatAction = SetErrorAction | SetMessageAction | SetQueryAction | SetStatusAction;
+/**
+ * Action kind identifiers for the Chat reducer.
+ */
+export declare enum ChatActionKind {
+    SetError = "SET_ERROR",
+    SetMessage = "SET_MESSAGE",
+    SetQuery = "SET_QUERY",
+    SetStatus = "SET_STATUS"
+}

package/lib/views/ResearchView/state/actions/types.js

@@ -0,0 +1,10 @@
+/**
+ * Action kind identifiers for the Chat reducer.
+ */
+export var ChatActionKind;
+(function (ChatActionKind) {
+    ChatActionKind["SetError"] = "SET_ERROR";
+    ChatActionKind["SetMessage"] = "SET_MESSAGE";
+    ChatActionKind["SetQuery"] = "SET_QUERY";
+    ChatActionKind["SetStatus"] = "SET_STATUS";
+})(ChatActionKind || (ChatActionKind = {}));

package/lib/views/ResearchView/state/constants.d.ts

@@ -0,0 +1,5 @@
+import { ChatState } from "./types";
+/**
+ * Initial state for the chat reducer.
+ */
+export declare const INITIAL_STATE: ChatState;

package/lib/views/ResearchView/state/constants.js

@@ -0,0 +1,7 @@
+/**
+ * Initial state for the chat reducer.
+ */
+export const INITIAL_STATE = {
+    messages: [],
+    status: { loading: false },
+};

package/lib/views/ResearchView/state/context.d.ts

@@ -0,0 +1,5 @@
+import { ChatContextValue } from "./types";
+/**
+ * Context for the Chat state provider.
+ */
+export declare const ChatContext: import("react").Context<ChatContextValue>;

package/lib/views/ResearchView/state/context.js

@@ -0,0 +1,9 @@
+import { createContext } from "react";
+import { INITIAL_STATE } from "./constants";
+/**
+ * Context for the Chat state provider.
+ */
+export const ChatContext = createContext({
+    dispatch: () => undefined,
+    state: INITIAL_STATE,
+});

package/lib/views/ResearchView/state/guards/guards.d.ts

@@ -0,0 +1,33 @@
+import { AssistantMessage, ErrorMessage, Message, MessageResponse, PromptMessage, UserMessage } from "../types";
+/**
+ * Returns true if the message is an assistant message.
+ * @param message - Chat message.
+ * @returns True if the message is an assistant message.
+ */
+export declare function isAssistantMessage<R extends MessageResponse = MessageResponse>(message: Message<R>): message is AssistantMessage<R>;
+/**
+ * Returns true if the message is an error message.
+ * @param message - Chat message.
+ * @returns True if the message is an error message.
+ */
+export declare function isErrorMessage(message: Message): message is ErrorMessage;
+/**
+ * Returns true if the message is the initial prompt message.
+ * @param message - Chat message.
+ * @returns True if the message is the initial prompt message.
+ */
+export declare function isInitialPromptMessage(message: Message): message is PromptMessage & {
+    initial: true;
+};
+/**
+ * Returns true if the message is a prompt message.
+ * @param message - Chat message.
+ * @returns True if the message is a prompt message.
+ */
+export declare function isPromptMessage(message: Message): message is PromptMessage;
+/**
+ * Returns true if the message is a user message.
+ * @param message - Chat message.
+ * @returns True if the message is a user message.
+ */
+export declare function isUserMessage(message: Message): message is UserMessage;

package/lib/views/ResearchView/state/guards/guards.js

@@ -0,0 +1,41 @@
+import { MESSAGE_TYPE, } from "../types";
+/**
+ * Returns true if the message is an assistant message.
+ * @param message - Chat message.
+ * @returns True if the message is an assistant message.
+ */
+export function isAssistantMessage(message) {
+    return message.type === MESSAGE_TYPE.ASSISTANT;
+}
+/**
+ * Returns true if the message is an error message.
+ * @param message - Chat message.
+ * @returns True if the message is an error message.
+ */
+export function isErrorMessage(message) {
+    return message.type === MESSAGE_TYPE.ERROR;
+}
+/**
+ * Returns true if the message is the initial prompt message.
+ * @param message - Chat message.
+ * @returns True if the message is the initial prompt message.
+ */
+export function isInitialPromptMessage(message) {
+    return isPromptMessage(message) && message.initial === true;
+}
+/**
+ * Returns true if the message is a prompt message.
+ * @param message - Chat message.
+ * @returns True if the message is a prompt message.
+ */
+export function isPromptMessage(message) {
+    return message.type === MESSAGE_TYPE.PROMPT;
+}
+/**
+ * Returns true if the message is a user message.
+ * @param message - Chat message.
+ * @returns True if the message is a user message.
+ */
+export function isUserMessage(message) {
+    return message.type === MESSAGE_TYPE.USER;
+}

package/lib/views/ResearchView/state/hooks/UseChatDispatch/hook.d.ts

@@ -0,0 +1,6 @@
+import { UseChatDispatch } from "./types";
+/**
+ * Hook to dispatch Chat actions.
+ * @returns Object containing action dispatch functions.
+ */
+export declare const useChatDispatch: () => UseChatDispatch;

package/lib/views/ResearchView/state/hooks/UseChatDispatch/hook.js

@@ -0,0 +1,26 @@
+import { useCallback, useContext } from "react";
+import { setError } from "../../actions/setError/dispatch";
+import { setMessage } from "../../actions/setMessage/dispatch";
+import { setQuery } from "../../actions/setQuery/dispatch";
+import { setStatus } from "../../actions/setStatus/dispatch";
+import { ChatContext } from "../../context";
+/**
+ * Hook to dispatch Chat actions.
+ * @returns Object containing action dispatch functions.
+ */
+export const useChatDispatch = () => {
+    const { dispatch } = useContext(ChatContext);
+    const onSetError = useCallback((error) => {
+        dispatch(setError({ error }));
+    }, [dispatch]);
+    const onSetMessage = useCallback((response) => {
+        dispatch(setMessage({ response }));
+    }, [dispatch]);
+    const onSetQuery = useCallback((query) => {
+        dispatch(setQuery({ query }));
+    }, [dispatch]);
+    const onSetStatus = useCallback((loading) => {
+        dispatch(setStatus({ loading }));
+    }, [dispatch]);
+    return { onSetError, onSetMessage, onSetQuery, onSetStatus };
+};

package/lib/views/ResearchView/state/hooks/UseChatDispatch/types.d.ts

@@ -0,0 +1,10 @@
+import { MessageResponse } from "../../types";
+/**
+ * Return type for the useChatDispatch hook.
+ */
+export interface UseChatDispatch {
+    onSetError: (error: string) => void;
+    onSetMessage: <R extends MessageResponse>(response: R) => void;
+    onSetQuery: (query: string) => void;
+    onSetStatus: (loading: boolean) => void;
+}

package/lib/views/ResearchView/state/hooks/UseChatDispatch/types.js

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

package/lib/views/ResearchView/state/hooks/UseChatReducer/hook.d.ts

@@ -0,0 +1,8 @@
+import { InitialArgs } from "../../initializer/types";
+import { ChatContextValue } from "../../types";
+/**
+ * Hook that manages the chat reducer with initial state from config.
+ * @param initialArgs - Initial arguments for the chat state.
+ * @returns Chat context value with dispatch and state.
+ */
+export declare const useChatReducer: (initialArgs?: InitialArgs) => ChatContextValue;

package/lib/views/ResearchView/state/hooks/UseChatReducer/hook.js

@@ -0,0 +1,12 @@
+import { useReducer } from "react";
+import { initializer } from "../../initializer/initializer";
+import { chatReducer } from "../../reducer";
+/**
+ * Hook that manages the chat reducer with initial state from config.
+ * @param initialArgs - Initial arguments for the chat state.
+ * @returns Chat context value with dispatch and state.
+ */
+export const useChatReducer = (initialArgs) => {
+    const [state, dispatch] = useReducer(chatReducer, initialArgs, initializer);
+    return { dispatch, state };
+};

package/lib/views/ResearchView/state/hooks/UseChatState/hook.d.ts

@@ -0,0 +1,7 @@
+import { ChatContextValue } from "../../types";
+/**
+ * Hook to access Chat state.
+ *
+ * @returns Chat state.
+ */
+export declare const useChatState: () => Pick<ChatContextValue, "state">;

package/lib/views/ResearchView/state/hooks/UseChatState/hook.js

@@ -0,0 +1,11 @@
+import { useContext } from "react";
+import { ChatContext } from "../../context";
+/**
+ * Hook to access Chat state.
+ *
+ * @returns Chat state.
+ */
+export const useChatState = () => {
+    const { state } = useContext(ChatContext);
+    return { state };
+};