@promptbook/remote-server 0.101.0 → 0.102.0-1

package/esm/typings/src/_packages/components.index.d.ts

@@ -7,9 +7,6 @@ import type { AvatarProfileProps } from '../book-components/AvatarProfile/Avatar
 import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
-import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
-import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
-import { MockedChat } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
@@ -20,6 +17,23 @@ import type { SendMessageToLlmChatFunction } from '../book-components/Chat/hooks
 import { useSendMessageToLlmChat } from '../book-components/Chat/hooks/useSendMessageToLlmChat';
 import { LlmChat } from '../book-components/Chat/LlmChat/LlmChat';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
+import { NORMAL_FLOW } from '../book-components/Chat/MockedChat/constants';
+import { FAST_FLOW } from '../book-components/Chat/MockedChat/constants';
+import { SLOW_FLOW } from '../book-components/Chat/MockedChat/constants';
+import { BLOCKY_FLOW } from '../book-components/Chat/MockedChat/constants';
+import { RANDOM_FLOW } from '../book-components/Chat/MockedChat/constants';
+import { MOCKED_CHAT_DELAY_CONFIGS } from '../book-components/Chat/MockedChat/constants';
+import type { MockedChatDelayConfig } from '../book-components/Chat/MockedChat/MockedChat';
+import type { MockedChatProps } from '../book-components/Chat/MockedChat/MockedChat';
+import { MockedChat } from '../book-components/Chat/MockedChat/MockedChat';
+import type { string_chat_format_name } from '../book-components/Chat/save/savePlugins';
+import type { ChatSaveFormatDefinition } from '../book-components/Chat/save/savePlugins';
+import { jsonSaveFormatDefinition } from '../book-components/Chat/save/savePlugins';
+import { txtSaveFormatDefinition } from '../book-components/Chat/save/savePlugins';
+import { mdSaveFormatDefinition } from '../book-components/Chat/save/savePlugins';
+import { htmlSaveFormatDefinition } from '../book-components/Chat/save/savePlugins';
+import { CHAT_SAVE_FORMATS } from '../book-components/Chat/save/savePlugins';
+import { getChatSaveFormatDefinitions } from '../book-components/Chat/save/savePlugins';
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
@@ -41,9 +55,6 @@ export type { AvatarProfileProps };
 export { AvatarProfile };
 export type { AvatarProfileFromSourceProps };
 export { AvatarProfileFromSource };
-export type { MockedChatDelayConfig };
-export type { MockedChatProps };
-export { MockedChat };
 export type { BookEditorProps };
 export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };
@@ -54,6 +65,23 @@ export type { SendMessageToLlmChatFunction };
 export { useSendMessageToLlmChat };
 export { LlmChat };
 export type { LlmChatProps };
+export { NORMAL_FLOW };
+export { FAST_FLOW };
+export { SLOW_FLOW };
+export { BLOCKY_FLOW };
+export { RANDOM_FLOW };
+export { MOCKED_CHAT_DELAY_CONFIGS };
+export type { MockedChatDelayConfig };
+export type { MockedChatProps };
+export { MockedChat };
+export type { string_chat_format_name };
+export type { ChatSaveFormatDefinition };
+export { jsonSaveFormatDefinition };
+export { txtSaveFormatDefinition };
+export { mdSaveFormatDefinition };
+export { htmlSaveFormatDefinition };
+export { CHAT_SAVE_FORMATS };
+export { getChatSaveFormatDefinitions };
 export type { ChatMessage };
 export type { ChatParticipant };
 export type { MessageButton };

package/esm/typings/src/_packages/types.index.d.ts

@@ -9,13 +9,15 @@ import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChi
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
 import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
-import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
-import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatAutoScrollConfig } from '../book-components/Chat/hooks/useChatAutoScroll';
 import type { SendMessageToLlmChatFunction } from '../book-components/Chat/hooks/useSendMessageToLlmChat';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
+import type { MockedChatDelayConfig } from '../book-components/Chat/MockedChat/MockedChat';
+import type { MockedChatProps } from '../book-components/Chat/MockedChat/MockedChat';
+import type { string_chat_format_name } from '../book-components/Chat/save/savePlugins';
+import type { ChatSaveFormatDefinition } from '../book-components/Chat/save/savePlugins';
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
@@ -338,13 +340,15 @@ export type { AvatarChipProps };
 export type { AvatarChipFromSourceProps };
 export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
-export type { MockedChatDelayConfig };
-export type { MockedChatProps };
 export type { BookEditorProps };
 export type { ChatProps };
 export type { ChatAutoScrollConfig };
 export type { SendMessageToLlmChatFunction };
 export type { LlmChatProps };
+export type { MockedChatDelayConfig };
+export type { MockedChatProps };
+export type { string_chat_format_name };
+export type { ChatSaveFormatDefinition };
 export type { ChatMessage };
 export type { ChatParticipant };
 export type { MessageButton };

package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts

@@ -1,3 +1,4 @@
+import { string_chat_format_name } from '../save/savePlugins';
 import type { ChatProps } from './ChatProps';
 /**
  * Renders a chat with messages and input for new messages
@@ -12,4 +13,7 @@ import type { ChatProps } from './ChatProps';
  *
  * @public exported from `@promptbook/components`
  */
-export declare function Chat(props: ChatProps): import("react/jsx-runtime").JSX.Element;
+export declare function Chat(props: ChatProps & {
+    saveFormats?: string_chat_format_name[];
+    isSaveButtonEnabled?: boolean;
+}): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/{AvatarProfile/AvatarProfile → Chat/MockedChat}/MockedChat.d.ts

@@ -6,25 +6,42 @@ import type { ChatProps } from '../../Chat/Chat/ChatProps';
  */
 export type MockedChatDelayConfig = {
     /**
-     * Delay before showing the first message (in milliseconds)
+     * Delay before showing the first message (ms)
      * @default 1000
      */
-    beforeFirstMessage?: number;
+    beforeFirstMessage?: number | [number, number];
     /**
-     * Emulated thinking time between messages (in milliseconds)
+     * Emulated thinking time between messages (ms)
+     * Can be a fixed number or [min, max] for random range.
      * @default 2000
      */
-    thinkingBetweenMessages?: number;
+    thinkingBetweenMessages?: number | [number, number];
     /**
-     * Wait time after each written word (in milliseconds)
+     * Wait time after each written word (ms)
+     * Can be a fixed number or [min, max] for random range.
      * @default 100
      */
-    waitAfterWord?: number;
+    waitAfterWord?: number | [number, number];
     /**
-     * Extra delay on top of the word waiting (in milliseconds)
+     * Extra delay on top of the word waiting (ms)
+     * Can be a fixed number or [min, max] for random range.
      * @default 50
      */
-    extraWordDelay?: number;
+    extraWordDelay?: number | [number, number];
+    /**
+     * Chance (0-1) that a longer pause occurs before a message (e.g. agent switch)
+     * @default 0.2
+     */
+    longPauseChance?: number;
+    /**
+     * Range for long pause duration (ms), [min, max]
+     * @default [1200, 3500]
+     */
+    longPauseDuration?: [number, number];
+    /**
+     * If true, disables typing effect and shows full message at once (BLOCKY_FLOW)
+     */
+    blocky?: boolean;
 };
 /**
  * Props for MockedChat component

package/esm/typings/src/book-components/Chat/MockedChat/constants.d.ts

@@ -0,0 +1,42 @@
+import { MockedChatDelayConfig } from './MockedChat';
+/**
+ * Normal flow of messages in the `MockedChat` component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const NORMAL_FLOW: MockedChatDelayConfig;
+/**
+ * Fast flow of messages in the `MockedChat` component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const FAST_FLOW: MockedChatDelayConfig;
+/**
+ * Slow flow of messages in the `MockedChat` component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const SLOW_FLOW: MockedChatDelayConfig;
+/**
+ * Blocky flow of messages in the `MockedChat` component
+ *
+ * Messages appear in blocks rather than word-by-word
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const BLOCKY_FLOW: MockedChatDelayConfig;
+/**
+ * Random flow of messages in the `MockedChat` component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const RANDOM_FLOW: MockedChatDelayConfig;
+/**
+ * All predefined delay configurations for the `MockedChat` component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const MOCKED_CHAT_DELAY_CONFIGS: Record<string, MockedChatDelayConfig>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/Chat/save/savePlugins.d.ts

@@ -0,0 +1,105 @@
+import { string_file_extension, string_mime_type } from '../../../types/typeAliases';
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Supported chat export formatNames
+ * @public exported from `@promptbook/components`
+ */
+export type string_chat_format_name = typeof CHAT_SAVE_FORMATS[number]['formatName'];
+/**
+ * Plugin contract for chat export formatNames
+ * @public exported from `@promptbook/components`
+ */
+export type ChatSaveFormatDefinition = {
+    formatName: string_file_extension | string_mime_type | string;
+    label: string;
+    getContent: (messages: ChatMessage[]) => string;
+    mimeType: string;
+    fileExtension: string;
+};
+/**
+ * JSON export plugin (full metadata)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const jsonSaveFormatDefinition: {
+    readonly formatName: "json";
+    readonly label: "JSON (full)";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "application/json";
+    readonly fileExtension: "json";
+};
+/**
+ * Plain text export plugin (messages only)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const txtSaveFormatDefinition: {
+    readonly formatName: "txt";
+    readonly label: "Plain Text";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "text/plain";
+    readonly fileExtension: "txt";
+};
+/**
+ * Markdown export plugin
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const mdSaveFormatDefinition: {
+    readonly formatName: "md";
+    readonly label: "Markdown";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "text/markdown";
+    readonly fileExtension: "md";
+};
+/**
+ * HTML export plugin
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const htmlSaveFormatDefinition: {
+    readonly formatName: "html";
+    readonly label: "HTML";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "text/html";
+    readonly fileExtension: "html";
+};
+/**
+ * Registry of all built-in chat save plugins
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const CHAT_SAVE_FORMATS: readonly [{
+    readonly formatName: "json";
+    readonly label: "JSON (full)";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "application/json";
+    readonly fileExtension: "json";
+}, {
+    readonly formatName: "txt";
+    readonly label: "Plain Text";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "text/plain";
+    readonly fileExtension: "txt";
+}, {
+    readonly formatName: "md";
+    readonly label: "Markdown";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "text/markdown";
+    readonly fileExtension: "md";
+}, {
+    readonly formatName: "html";
+    readonly label: "HTML";
+    readonly getContent: (messages: ChatMessage[]) => string;
+    readonly mimeType: "text/html";
+    readonly fileExtension: "html";
+}];
+/**
+ * Returns enabled chat save plugins filtered by formatNames (or all when omitted)
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function getChatSaveFormatDefinitions(formatNames?: ReadonlyArray<string_chat_format_name>): ReadonlyArray<ChatSaveFormatDefinition>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -31,6 +31,12 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @property {number} port The port number the server will listen on.
      */
     readonly port: number;
+    /**
+     * Enable rich UI (React + Tailwind) at `/` path.
+     * Default: true
+     * If false, server will respond with markdown as before.
+     */
+    readonly isRichUi?: boolean;
     /**
      * Creates execution tools the client
      *

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.101.0-21`).
+ * It follows semantic versioning (e.g., `0.102.0-0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.101.0",
+    "version": "0.102.0-1",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0"
+        "@promptbook/core": "0.102.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -47,7 +47,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.102.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -8262,57 +8262,125 @@
             if ((_a = request.url) === null || _a === void 0 ? void 0 : _a.includes('socket.io')) {
                 return;
             }
-            response.type('text/markdown').send(await spaceTrim.spaceTrim(async (block) => `
-                    # Promptbook
+            if (options.isRichUi !== false) {
+                // Serve rich React + Tailwind UI with server info injected
+                const serverInfo = {
+                    bookLanguageVersion: BOOK_LANGUAGE_VERSION,
+                    promptbookEngineVersion: PROMPTBOOK_ENGINE_VERSION,
+                    nodeVersion: process.version,
+                    port,
+                    startupDate: startupDate.toISOString(),
+                    isAnonymousModeAllowed,
+                    isApplicationModeAllowed,
+                    pipelines: !isApplicationModeAllowed || collection === null
+                        ? []
+                        : await collection.listPipelines(),
+                    runningExecutions: runningExecutionTasks.length,
+                    paths: [
+                        ...app._router.stack
+                            .map(({ route }) => (route === null || route === void 0 ? void 0 : route.path) || null)
+                            .filter((path) => path !== null),
+                        '/api-docs',
+                    ],
+                };
+                response.type('text/html').send(`
+                <!DOCTYPE html>
+                <html lang="en">
+                <head>
+                    <meta charset="UTF-8" />
+                    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+                    <title>Promptbook Server</title>
+                    <link href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.19/dist/tailwind.min.css" rel="stylesheet">
+                </head>
+                <body class="bg-gray-50 text-gray-900">
+                    <div id="root"></div>
+                    <script>
+                        window.__PROMPTBOOK_SERVER_INFO__ = ${JSON.stringify(serverInfo)};
+                        // TODO: Hydrate React app here
+                        // You will need to bundle and serve a React app for full functionality
+                        const info = window.__PROMPTBOOK_SERVER_INFO__;
+                        document.getElementById('root').innerHTML = \`
+                            <h1 class="text-3xl font-bold mb-4">Promptbook Server Rich UI</h1>
+                            <div class="mb-4">
+                                <strong>Book language version:</strong> \${info.bookLanguageVersion}<br>
+                                <strong>Promptbook engine version:</strong> \${info.promptbookEngineVersion}<br>
+                                <strong>Node.js version:</strong> \${info.nodeVersion}<br>
+                                <strong>Server port:</strong> \${info.port}<br>
+                                <strong>Startup date:</strong> \${info.startupDate}<br>
+                                <strong>Anonymous mode:</strong> \${info.isAnonymousModeAllowed ? 'enabled' : 'disabled'}<br>
+                                <strong>Application mode:</strong> \${info.isApplicationModeAllowed ? 'enabled' : 'disabled'}<br>
+                                <strong>Pipelines in collection:</strong> \${info.pipelines.length ? '<ul>' + info.pipelines.map(p => '<li>' + p + '</li>').join('') + '</ul>' : 'none'}<br>
+                                <strong>Running executions:</strong> \${info.runningExecutions}<br>
+                                <strong>Paths:</strong> <ul>\${info.paths.map(p => '<li>' + p + '</li>').join('')}</ul>
+                            </div>
+                            <div class="mt-8">
+                                <h2 class="text-xl font-semibold mb-2">Instructions</h2>
+                                <ol class="list-decimal ml-6">
+                                    <li>The client <a href="https://www.npmjs.com/package/@promptbook/remote-client" class="text-blue-600 underline">https://www.npmjs.com/package/@promptbook/remote-client</a></li>
+                                    <li>OpenAI compatible client <span class="text-gray-500">(Not working yet)</span></li>
+                                    <li>REST API</li>
+                                </ol>
+                                <p class="mt-2">For more information look at: <a href="https://github.com/webgptorg/promptbook" class="text-blue-600 underline">https://github.com/webgptorg/promptbook</a></p>
+                            </div>
+                        \`;
+                    </script>
+                </body>
+                </html>
+                `);
+            }
+            else {
+                response.type('text/markdown').send(await spaceTrim.spaceTrim(async (block) => `
+                        # Promptbook
 
-                    > ${block(CLAIM)}
+                        > ${block(CLAIM)}
 
-                    **Book language version:** ${BOOK_LANGUAGE_VERSION}
-                    **Promptbook engine version:** ${PROMPTBOOK_ENGINE_VERSION}
-                    **Node.js version:** ${process.version /* <- TODO: [🧠] Is it secure to expose this */}
+                        **Book language version:** ${BOOK_LANGUAGE_VERSION}
+                        **Promptbook engine version:** ${PROMPTBOOK_ENGINE_VERSION}
+                        **Node.js version:** ${process.version /* <- TODO: [🧠] Is it secure to expose this */}
 
-                    ---
+                        ---
 
-                    ## Details
+                        ## Details
 
-                    **Server port:** ${port}
-                    **Startup date:** ${startupDate.toISOString()}
-                    **Anonymous mode:** ${isAnonymousModeAllowed ? 'enabled' : 'disabled'}
-                    **Application mode:** ${isApplicationModeAllowed ? 'enabled' : 'disabled'}
-                    ${block(!isApplicationModeAllowed || collection === null
-            ? ''
-            : '**Pipelines in collection:**\n' +
-                (await collection.listPipelines())
-                    .map((pipelineUrl) => `- ${pipelineUrl}`)
-                    .join('\n'))}
-                    **Running executions:** ${runningExecutionTasks.length}
+                        **Server port:** ${port}
+                        **Startup date:** ${startupDate.toISOString()}
+                        **Anonymous mode:** ${isAnonymousModeAllowed ? 'enabled' : 'disabled'}
+                        **Application mode:** ${isApplicationModeAllowed ? 'enabled' : 'disabled'}
+                        ${block(!isApplicationModeAllowed || collection === null
+                ? ''
+                : '**Pipelines in collection:**\n' +
+                    (await collection.listPipelines())
+                        .map((pipelineUrl) => `- ${pipelineUrl}`)
+                        .join('\n'))}
+                        **Running executions:** ${runningExecutionTasks.length}
 
-                    ---
+                        ---
 
-                    ## Paths
+                        ## Paths
 
-                    ${block([
-            ...app._router.stack
-                .map(({ route }) => (route === null || route === void 0 ? void 0 : route.path) || null)
-                .filter((path) => path !== null),
-            '/api-docs',
-        ]
-            .map((path) => `- ${path}`)
-            .join('\n'))}
+                        ${block([
+                ...app._router.stack
+                    .map(({ route }) => (route === null || route === void 0 ? void 0 : route.path) || null)
+                    .filter((path) => path !== null),
+                '/api-docs',
+            ]
+                .map((path) => `- ${path}`)
+                .join('\n'))}
 
-                    ---
+                        ---
 
-                    ## Instructions
+                        ## Instructions
 
-                    To connect to this server use:
+                        To connect to this server use:
 
-                    1) The client https://www.npmjs.com/package/@promptbook/remote-client
-                    2) OpenAI compatible client *(Not working yet)*
-                    3) REST API
+                        1) The client https://www.npmjs.com/package/@promptbook/remote-client
+                        2) OpenAI compatible client *(Not working yet)*
+                        3) REST API
 
-                    For more information look at:
-                    https://github.com/webgptorg/promptbook
-                `));
+                        For more information look at:
+                        https://github.com/webgptorg/promptbook
+                    `));
+            }
         });
         app.post(`/login`, async (request, response) => {
             if (!isApplicationModeAllowed || login === null) {