@smarter.sh/ui-chat 0.3.0 → 0.7.1

package/dist/types/src/components/AppTitle/Component.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The chat's title: the LLMClient's app name and version, with icons for whether it is valid, and
+ * whether it is deployed or is still in the sandbox.
+ */
+import "@/components/AppTitle/styles.css";
+interface AppTitleProps {
+    title: string;
+    isReady: boolean;
+    isValid: boolean;
+    isDeployed: boolean;
+}
+declare function AppTitle({ title, isReady, isValid, isDeployed }: AppTitleProps): import("react").JSX.Element;
+export default AppTitle;

package/dist/types/src/components/AppTitle/index.d.ts

@@ -0,0 +1,2 @@
+import AppTitle from "@/components/AppTitle/Component";
+export default AppTitle;

package/dist/types/src/components/Console/Component.d.ts

@@ -0,0 +1,17 @@
+import { type ConsoleConfig } from "@/components/Console/data";
+import "@/components/Console/styles.css";
+interface ConsoleProps {
+    /** The LLMClient's configuration, from its config api. Empty until it loads. */
+    config: ConsoleConfig;
+    /** The url of the user's server log stream. Without it, there is no "Server Logs" tab. */
+    logStreamUrl?: string | null;
+    /**
+     * The minimum log level of the server logs, e.g. "DEBUG" in sandbox mode. Without it, the server's
+     * own log level. A change reconnects the stream, which replays the history at the new level.
+     */
+    logLevel?: string | null;
+    /** Changes when a new chat session starts, which clears the server logs. */
+    resetKey?: number | string;
+}
+declare function Console({ config, logStreamUrl, logLevel, resetKey }: ConsoleProps): import("react").JSX.Element;
+export default Console;

package/dist/types/src/components/Console/ServerLogs.d.ts

@@ -0,0 +1,8 @@
+import type { LogEvent } from "@/lib/logStream";
+interface ServerLogsProps {
+    logs: LogEvent[];
+    connected: boolean;
+    error: string | null;
+}
+declare function ServerLogs(props: ServerLogsProps): import("react").JSX.Element;
+export default ServerLogs;

package/dist/types/src/components/Console/data.d.ts

@@ -0,0 +1,7 @@
+/** The data that the Console displays for each of its menu items. */
+import type { ChatConfig } from "../../types";
+import { type MenuItem } from "./enums";
+/** The LLMClient's configuration, from its config api. Empty until it loads. */
+export type ConsoleConfig = ChatConfig | Record<string, never> | null;
+/** The JSON objects to display for a menu item. */
+export declare function consoleData(config: ConsoleConfig, item: MenuItem): object[];

package/dist/types/src/components/Console/enums.d.ts

@@ -0,0 +1,9 @@
+/** The Console's menu items: the configuration, the chat session's histories, and the server logs. */
+export declare const MenuItems: {
+    readonly CHAT_CONFIG: "chat_config";
+    readonly LLMCLIENT_REQUEST_HISTORY: "llmclient_request_history";
+    readonly CHAT_TOOL_CALL_HISTORY: "chat_tool_call_history";
+    readonly CHAT_PLUGIN_USAGE_HISTORY: "chat_plugin_usage_history";
+    readonly SERVER_LOGS: "server_logs";
+};
+export type MenuItem = (typeof MenuItems)[keyof typeof MenuItems];

package/dist/types/src/components/Console/index.d.ts

@@ -0,0 +1,2 @@
+import Console from "@/components/Console/Component";
+export default Console;

package/dist/types/src/components/ErrorBoundary/Component.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Catches a rendering error in its children, and displays a message instead of an empty page.
+ */
+import { Component, type ErrorInfo, type ReactNode } from "react";
+interface ErrorBoundaryProps {
+    children: ReactNode;
+}
+interface ErrorBoundaryState {
+    error: Error | null;
+}
+declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    state: ErrorBoundaryState;
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | bigint | boolean | import("react").JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
+}
+export default ErrorBoundary;

package/dist/types/src/components/ErrorBoundary/index.d.ts

@@ -0,0 +1,2 @@
+import ErrorBoundary from "@/components/ErrorBoundary/Component";
+export default ErrorBoundary;

package/dist/types/src/components/SmarterChat/Component.d.ts

@@ -0,0 +1,26 @@
+/**
+ * SmarterChat: a chat with a Smarter LLMClient, with an optional Console beside it.
+ *
+ * It fetches the LLMClient's configuration, which includes the chat session's history, then sends
+ * the chat thread to the LLMClient's prompt api with each new message, and adds the response's
+ * messages to the thread. Failed prompts are displayed in the thread, as "smarter_error" messages.
+ * While a prompt runs, its progress (e.g. its tool calls and MCP server requests) is displayed in
+ * the thread, with a spinner beside its current step, and is replaced by the response's messages
+ * when it finishes. Code blocks in messages
+ * are syntax highlighted, and have a copy button.
+ *
+ * The user can resize the chat and the Console by dragging the separator between them, and can
+ * hide the Console, which slides out to the right. In sandbox mode, the thread also displays
+ * Smarter's system, tool and meta data messages. In production mode, it displays only the
+ * conversation, as the LLMClient's users see it. The Console's server logs follow the mode: DEBUG
+ * and above in sandbox mode, and the server's own log level in production mode. A new chat also
+ * clears the Console's server logs.
+ *
+ * This is the component that the @smarter.sh/ui-chat npm package exports, and that the Smarter web
+ * console's LLMClient prompt workbench renders. See main.tsx.
+ */
+import "@chatscope/chat-ui-kit-styles/dist/default/styles.min.css";
+import type { SmarterChatProps } from "@/types";
+import "@/components/SmarterChat/styles.css";
+declare function SmarterChat({ apiUrl, apiKey, toggleMetadata, csrfCookieName, csrftoken, debugCookieName, debugCookieExpiration, debugMode, sessionCookieName, sessionCookieExpiration, showConsole, cookieDomain, smarterRequestId, logStreamUrl, streamProgress, }: SmarterChatProps): import("react").JSX.Element;
+export default SmarterChat;

package/dist/types/src/components/SmarterChat/icons.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The chat toolbar's icons, from Bootstrap Icons (MIT license, https://icons.getbootstrap.com),
+ * inline so that the package needs neither its font nor its css.
+ */
+/** A blank sheet of paper: a new chat. (bi-file-earmark) */
+export declare function NewChatIcon(): import("react").JSX.Element;
+/**
+ * A window with a panel on its right, as the Console is: filled while the Console is visible
+ * (bi-layout-sidebar-inset-reverse), and empty while it is hidden (bi-layout-sidebar-reverse).
+ */
+export declare function ConsoleIcon({ visible }: {
+    visible: boolean;
+}): import("react").JSX.Element;
+/** Tools: sandbox mode, which displays Smarter's system, tool and meta data messages. (bi-tools) */
+export declare function SandboxIcon(): import("react").JSX.Element;
+/** A shield: production mode, which displays the conversation only, as its users see it. (bi-shield-check) */
+export declare function ProductionIcon(): import("react").JSX.Element;

package/dist/types/src/components/SmarterChat/index.d.ts

@@ -0,0 +1,2 @@
+import SmarterChat from "@/components/SmarterChat/Component";
+export default SmarterChat;

package/dist/types/src/const.d.ts

@@ -0,0 +1,5 @@
+export declare const projectName: string;
+export declare const projectVersion: string;
+export declare const loggerPrefix: string;
+/** The default lifetime of the chat session and debug cookies: one day, in milliseconds. */
+export declare const DEFAULT_COOKIE_EXPIRATION: number;