@smarter.sh/ui-chat 0.7.0 → 0.7.1

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

@@ -8,5 +8,6 @@ export { default as Console } from "./components/Console";
 export { MenuItems } from "./components/Console/enums";
 export { MessageDirectionEnum, SenderRoleEnum, ValidMessageRolesEnum } from "./lib/enums";
 export { projectVersion as version } from "./const";
+export { CHAT_CONTRACT_V2_CAPABILITY, normalizeConfig } from "./lib/api";
 export type { PromptProgressEvent } from "./lib/api";
-export type { ApiMessage, ChatConfig, ChatHistory, ChatMessage, ChatMetaData, ChatbotConfig, SmarterChatProps, } from "./types";
+export type { ApiMessage, ChatConfig, ChatHistory, ChatMessage, ChatMetaData, ChatbotConfig, Contract, LLMClientConfig, SmarterChatProps, } from "./types";

package/dist/types/src/lib/api.d.ts

@@ -5,18 +5,29 @@
  * console's session authenticates them. Each response wraps its payload in "data". See:
  *
  * - smarter.apps.prompt.views.detailviews.prompt_config_view.PromptConfigView: <apiUrl>config/
- * - smarter.apps.llmclient.api.v1.views.base: the LLMClient's prompt api, chatbot.url_chatbot. Its
- *   payload is an AWS Lambda style response, whose body is a JSON string of the completion, with
- *   Smarter's own messages in body.smarter.messages. A failed prompt has the LLM provider's status,
- *   and its body is {error: {status, message}, response: <the completion>}, whose messages include a
- *   "smarter_error" message.
+ * - smarter.apps.llmclient.api.v1.views.base: the LLMClient's prompt api, llmclient.url_llmclient.
+ *
+ * The contract is versioned (see smarter.apps.prompt.contract). Smarter Chat asks for version 2 with
+ * "X-Smarter-Capabilities: chat-contract-v2", and reads version 1 from older platforms, which ignore
+ * the header:
+ *
+ * - version 2: the configuration's LLMClient is "llmclient", and a prompt's response is
+ *   data: {contract: 2, status, messages, completion}, with "error" beside it if the prompt failed.
+ * - version 1: the LLMClient is "chatbot", with "url_chatbot", and a prompt's response is an AWS
+ *   Lambda style response, whose body is a JSON string of the completion, with Smarter's own messages
+ *   in body.smarter.messages. A failed prompt's body is {error: {status, message}, response}.
+ *
+ * Every other error is {error: {errorClass, description, status}}.
  *
  * A prompt can stream its progress, e.g. its tool calls and MCP server requests, as Server-Sent
  * Events: the request accepts text/event-stream, and the response is "progress" events, then a
  * "result" event with the same JSON as a non-streaming response. Servers that don't stream answer
  * with JSON, as before. See smarter.apps.prompt.progress.
  */
-import type { ApiMessage, ChatConfig, ChatCookies, ClientContext } from "../types";
+import type { ApiMessage, ChatConfig, ChatCookies, ClientContext, Contract } from "../types";
+/** The capability with which Smarter Chat asks for version 2 of the contract. */
+export declare const CHAT_CONTRACT_V2_CAPABILITY = "chat-contract-v2";
+export declare const CHAT_CONTRACT_V2 = 2;
 export declare class SmarterApiError extends Error {
     status: number;
     constructor(message: string, status: number);
@@ -45,6 +56,18 @@ export declare function urlFactory(apiUrl: string, endpoint: string | null, sess
 export declare function requestHeadersFactory(cookies: ChatCookies, context: ClientContext): Record<string, string>;
 /** The error message of an api error response, whatever its shape. */
 export declare function errorMessage(json: Record<string, unknown>, response: ResponseStatus): string;
+/**
+ * A configuration in version 2 of the contract: as is, or converted from version 1, whose keys are
+ * renamed at every depth ("chatbot" for "llmclient", e.g. "url_chatbot" for "url_llmclient"). Null if
+ * it has no LLMClient, or no prompt api url.
+ */
+export declare function normalizeConfig(data: unknown): ChatConfig | null;
+/**
+ * A copy of a version 2 configuration, with the deprecated "chatbot", a read-only alias of its
+ * "llmclient", for code written for version 1. The alias is not enumerable, so it is never serialized,
+ * e.g. by the Console, which displays the configuration as JSON.
+ */
+export declare function withLegacyChatbot(config: Contract.PromptChatApiConfig): ChatConfig;
 /**
  * The LLMClient's configuration. A new chat session's key, and the debug mode, are saved in their
  * cookies, for the next page load.

package/dist/types/src/lib/messages.d.ts

@@ -32,7 +32,7 @@ export declare function messageHtml(content: string, sender: string): string;
  * A new chat message. Messages without text, e.g. an assistant's tool calls, stay in the thread,
  * so that they are sent back to the api, but are not displayed.
  */
-export declare function messageFactory(content: string | null | undefined, sender: string, originalMessage?: ApiMessage, direction?: MessageDirection): ChatMessage;
+export declare function messageFactory(content: ApiMessage["content"], sender: string, originalMessage?: ApiMessage, direction?: MessageDirection): ChatMessage;
 /** The thread of a chat session, from the messages that the backend saved. */
 export declare function chatRestoreFromBackend(chatHistory: ApiMessage[] | null | undefined): ChatMessage[];
 /** Example prompts, which help the user to get started, as a markdown list. */

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

@@ -1,23 +1,22 @@
 /**
  * Types for Smarter Chat: its props, its messages, and the data that the Smarter api returns.
  *
- * The api's types describe the fields that Smarter Chat reads. The api returns more, which the
- * Console displays as is. See smarter.apps.prompt.views.detailviews.prompt_config_view.PromptConfigView,
- * which returns the configuration with its legacy keys ("chatbot" for "llmclient").
+ * The api's types are generated from the contract's JSON Schema (contract/chat-contract.schema.json,
+ * which the Smarter backend generates from smarter.apps.prompt.contract.models) into contract.gen.ts.
+ * They describe the fields that Smarter Chat reads. The api returns more, which the Console displays
+ * as is.
  */
+import type * as Contract from "./contract.gen";
 import type { MessageDirection, SenderRole } from "./lib/enums";
+export type { Contract };
 /** A message in the format of the OpenAI chat completion api, as the backend stores and returns them. */
-export interface ApiMessage {
-    role: string;
-    content: string | null;
-    [key: string]: unknown;
-}
+export type ApiMessage = Contract.PromptChatApiMessage;
 /** A message in the chat thread. */
 export interface ChatMessage {
     /** The message's text, as html, for display. */
     message: string;
     /** The message's text, as sent to the api. */
-    content: string | null;
+    content: ApiMessage["content"];
     direction: MessageDirection;
     sender: SenderRole | string;
     sentTime: string;
@@ -26,60 +25,26 @@ export interface ChatMessage {
     /** The api's original message, whose other fields (e.g. tool_calls) are sent back to the api. */
     originalMessage?: ApiMessage;
 }
-/** The LLMClient, which the config api calls "chatbot". */
-export interface ChatbotConfig {
-    id: number;
-    name: string;
-    version?: string;
-    provider: string;
-    default_model: string;
-    default_system_role: string;
-    app_name: string;
-    app_assistant: string;
-    app_welcome_message: string;
-    app_example_prompts: string[];
-    app_placeholder: string;
-    app_info_url?: string | null;
-    app_file_attachment: boolean;
-    /** The url of the LLMClient's prompt api. */
-    url_chatbot: string;
-    [key: string]: unknown;
-}
-export interface ChatHistory {
-    chat_history?: ApiMessage[];
-    prompt_tool_call_history?: unknown[];
-    prompt_plugin_usage_history?: unknown[];
-    llmclient_request_history?: unknown[];
-    plugin_selector_history?: unknown[];
-    /** Legacy names of prompt_tool_call_history, prompt_plugin_usage_history and llmclient_request_history. */
-    chat_tool_call_history?: unknown[];
-    chat_plugin_usage_history?: unknown[];
-    chatbot_request_history?: unknown[];
-    [key: string]: unknown;
-}
-export interface ChatMetaData {
-    is_valid?: boolean;
-    ready?: boolean;
-    is_deployed?: boolean;
-    [key: string]: unknown;
-}
-/** The LLMClient's configuration, from its config api. */
-export interface ChatConfig {
-    session_key: string;
-    sandbox_mode: boolean;
-    debug_mode: boolean;
-    chatbot: ChatbotConfig;
-    history: ChatHistory;
-    meta_data: ChatMetaData;
-    plugins: {
-        meta_data: {
-            total_plugins: number;
-            plugins_returned: number;
-        };
-        plugins: unknown[];
-    };
-    [key: string]: unknown;
-}
+/** The LLMClient, in the configuration. */
+export type LLMClientConfig = Contract.PromptChatApiLLMClient;
+/** @deprecated Use LLMClientConfig. Version 2 of the contract calls the LLMClient "llmclient", not "chatbot". */
+export type ChatbotConfig = LLMClientConfig;
+/** The chat session's history. Only chat_history is returned to clients that can't read the LLMClient. */
+export type ChatHistory = Contract.PromptChatApiHistory;
+/** The LLMClient's state. */
+export type ChatMetaData = Contract.PromptChatApiMetaData;
+/**
+ * The LLMClient's configuration, from its config api, in version 2 of the contract. A version 1
+ * configuration, from an older Smarter platform, is converted to it. See lib/api.ts.
+ */
+export type ChatConfig = Contract.PromptChatApiConfig & {
+    /**
+     * @deprecated Use llmclient. Version 2 of the contract calls the LLMClient "llmclient". This is a
+     * read-only alias of it, for code written for version 1, which is not enumerable, so it is never
+     * serialized or displayed.
+     */
+    readonly chatbot: LLMClientConfig;
+};
 /** A cookie that Smarter Chat reads, and possibly sets. */
 export interface CookieMeta {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smarter.sh/ui-chat",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "chatbot React.js component for the https://smarter.sh declarative, plugin-based AI resource management platform.",
   "homepage": "https://smarter.sh",
   "type": "module",
@@ -53,6 +53,7 @@
     "dev": "NODE_ENV=dev && vite",
     "build": "tsc -b && vite build",
     "build:lib": "vite build --mode lib && tsc -p tsconfig.lib.json",
+    "contract:types": "node scripts/contract-types.mjs",
     "lint": "eslint --max-warnings=0 .",
     "preview": "vite preview",
     "storybook": "storybook dev -p 6006",
@@ -94,6 +95,7 @@
     "@vitejs/plugin-react": "^6.1.1",
     "@vitest/coverage-v8": "^5.0.3",
     "@vitest/eslint-plugin": "^1.6.27",
+    "ajv": "^8.20.0",
     "bootstrap": "^5.3.8",
     "bootstrap-icons": "^1.13.1",
     "eslint": "^10.11.0",
@@ -106,6 +108,7 @@
     "eslint-plugin-testing-library": "^7.16.2",
     "globals": "^17.13.0",
     "jsdom": "^30.1.2",
+    "json-schema-to-typescript": "^15.0.4",
     "msw": "^2.15.0",
     "prettier": "^3.9.9",
     "react": "^19.3.0",