@promptbook/javascript 0.101.0-17 → 0.101.0-19

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.101.0-17';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.0-19';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -15,6 +15,9 @@ import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
 import { Chat } from '../book-components/Chat/Chat/Chat';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
+import { useChatAutoScroll } from '../book-components/Chat/hooks/useChatAutoScroll';
+import type { SendMessageToLlmChatFunction } from '../book-components/Chat/hooks/useSendMessageToLlmChat';
+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 type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
@@ -44,6 +47,9 @@ export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };
 export { Chat };
 export type { ChatProps };
+export { useChatAutoScroll };
+export type { SendMessageToLlmChatFunction };
+export { useSendMessageToLlmChat };
 export { LlmChat };
 export type { LlmChatProps };
 export type { ChatMessage };

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

@@ -120,6 +120,7 @@ import { createLlmToolsFromConfiguration } from '../llm-providers/_common/regist
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
 import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
+import { getSingleLlmExecutionTools } from '../llm-providers/_multiple/getSingleLlmExecutionTools';
 import { joinLlmExecutionTools } from '../llm-providers/_multiple/joinLlmExecutionTools';
 import { MultipleLlmExecutionTools } from '../llm-providers/_multiple/MultipleLlmExecutionTools';
 import { AgentLlmExecutionTools } from '../llm-providers/agent/AgentLlmExecutionTools';
@@ -291,6 +292,7 @@ export { createLlmToolsFromConfiguration };
 export { cacheLlmTools };
 export { countUsage };
 export { limitTotalUsage };
+export { getSingleLlmExecutionTools };
 export { joinLlmExecutionTools };
 export { MultipleLlmExecutionTools };
 export { AgentLlmExecutionTools };

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

@@ -13,6 +13,8 @@ import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/Ava
 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 { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
@@ -340,6 +342,8 @@ export type { MockedChatDelayConfig };
 export type { MockedChatProps };
 export type { BookEditorProps };
 export type { ChatProps };
+export type { ChatAutoScrollConfig };
+export type { SendMessageToLlmChatFunction };
 export type { LlmChatProps };
 export type { ChatMessage };
 export type { ChatParticipant };

package/esm/typings/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts

@@ -8,3 +8,6 @@ import { string_agent_name, string_url_image } from '../../types/typeAliases';
  * @public exported from `@promptbook/core`
  */
 export declare function generatePlaceholderAgentProfileImageUrl(agentName?: string_agent_name): string_url_image;
+/**
+ * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
+ */

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

@@ -31,7 +31,13 @@ export type MockedChatDelayConfig = {
  *
  * @public exported from `@promptbook/components`
  */
-export type MockedChatProps = ChatProps & {
+export type MockedChatProps = Omit<ChatProps, 'onReset' | /*'onMessage' | */ 'onUseTemplate' | 'isVoiceRecognitionButtonShown'> & {
+    /**
+     * Whether to show the reset button
+     *
+     * @default false
+     */
+    isResetShown?: boolean;
     /**
      * Optional delays configuration for emulating typing behavior
      */

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

@@ -2,6 +2,7 @@ import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
 import type { ChatProps } from '../Chat/ChatProps';
 import type { ChatMessage } from '../types/ChatMessage';
 import type { ChatParticipant } from '../types/ChatParticipant';
+import type { SendMessageToLlmChatFunction } from '../hooks/useSendMessageToLlmChat';
 /**
  * Props for LlmChat component, derived from ChatProps but with LLM-specific modifications
  *
@@ -17,8 +18,20 @@ export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'
      * When provided, the conversation will be saved and restored from localStorage
      */
     readonly persistenceKey?: string;
+    /**
+     * Optional initial messages to pre-populate the chat.
+     * - They can include both USER and ASSISTANT messages.
+     * - They are only used when there is no persisted conversation (persistence takes precedence).
+     * - They are not automatically persisted until the user sends a new message.
+     */
+    readonly initialMessages?: ReadonlyArray<ChatMessage>;
     /**
      * Called when the chat state changes (messages, participants, etc.)
      */
     onChange?(messages: ReadonlyArray<ChatMessage>, participants: ReadonlyArray<ChatParticipant>): void;
+    /**
+     * Optional external sendMessage function produced by useSendMessageToLlmChat hook.
+     * When provided, LlmChat will attach its internal handler to it (no React context needed).
+     */
+    readonly sendMessage?: SendMessageToLlmChatFunction;
 };

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

@@ -0,0 +1,2 @@
+export * from './useChatAutoScroll';
+export * from './useSendMessageToLlmChat';

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

@@ -0,0 +1,41 @@
+/**
+ * Configuration for the auto-scroll behavior
+ */
+export type ChatAutoScrollConfig = {
+    /**
+     * Threshold in pixels from bottom to consider as "at bottom"
+     * @default 100
+     */
+    bottomThreshold?: number;
+    /**
+     * Whether to use smooth scrolling
+     * @default true
+     */
+    smoothScroll?: boolean;
+    /**
+     * Delay before checking scroll position after new messages (in milliseconds)
+     * @default 100
+     */
+    scrollCheckDelay?: number;
+};
+/**
+ * Hook for managing auto-scroll behavior in chat components
+ *
+ * This hook provides:
+ * - Automatic scrolling to bottom when new messages arrive (if user is already at bottom)
+ * - Detection of when user scrolls away from bottom
+ * - Scroll-to-bottom functionality with smooth animation
+ * - Mobile-optimized scrolling behavior
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function useChatAutoScroll(config?: ChatAutoScrollConfig): {
+    isAutoScrolling: boolean;
+    chatMessagesRef: (element: HTMLDivElement | null) => void;
+    handleScroll: (event: React.UIEvent<HTMLDivElement>) => void;
+    handleMessagesChange: () => void;
+    scrollToBottom: () => void;
+    enableAutoScroll: () => void;
+    disableAutoScroll: () => void;
+    isMobile: boolean;
+};

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

@@ -0,0 +1,44 @@
+/**
+ * Function type for sending a message to LlmChat.
+ *
+ * Implementation detail: The returned function is "attachable".
+ * LlmChat will call the internal `_attach` method (if present) to bind
+ * its real message handler. Messages sent before attachment are queued
+ * and flushed after attachment.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type SendMessageToLlmChatFunction = {
+    /**
+     * Send a message to the bound LlmChat instance (or queue it until attached).
+     */
+    (message: string): void;
+    /**
+     * Internal method used by the <LlmChat/> component to attach its handler.
+     * Not intended for consumer usage.
+     *
+     * @internal
+     */
+    _attach?: (handler: (message: string) => Promise<void> | void) => void;
+};
+/**
+ * Hook to create a sendMessage function for an <LlmChat/> component WITHOUT needing any React Context.
+ *
+ * Usage pattern:
+ * ```tsx
+ * const sendMessage = useSendMessageToLlmChat();
+ * return (
+ *   <>
+ *     <button onClick={() => sendMessage('Hello!')}>Hello</button>
+ *     <LlmChat llmTools={llmTools} sendMessage={sendMessage} />
+ *   </>
+ * );
+ * ```
+ *
+ * - No provider wrapping needed.
+ * - Safe to call before the <LlmChat/> mounts (messages will be queued).
+ * - Keeps DRY by letting <LlmChat/> reuse its internal `handleMessage` logic.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function useSendMessageToLlmChat(): SendMessageToLlmChatFunction;

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,8 +1,7 @@
 import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
-import type { Parameters } from '../../types/typeAliases';
-import type { string_parameter_name } from '../../types/typeAliases';
+import type { Parameters, string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -1,9 +1,7 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
-import type { Parameters } from '../../types/typeAliases';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_parameter_value } from '../../types/typeAliases';
+import type { Parameters, string_markdown, string_parameter_value } from '../../types/typeAliases';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Options for retrieving relevant knowledge for a specific task during pipeline execution.

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts

@@ -1,7 +1,6 @@
 import { Promisable } from 'type-fest';
 import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
-import type { string_app_id } from '../../../types/typeAliases';
-import type { string_url } from '../../../types/typeAliases';
+import type { string_app_id, string_url } from '../../../types/typeAliases';
 import type { really_any } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';

package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts

@@ -1,4 +1,4 @@
-import type { string_user_id } from '../../../types/typeAliases';
+import type { string_markdown_text, string_mime_type_with_wildcard, string_user_id } from '../../../types/typeAliases';
 import { MultipleLlmExecutionTools } from '../../_multiple/MultipleLlmExecutionTools';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
@@ -7,12 +7,18 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
  */
 export type CreateLlmToolsFromConfigurationOptions = {
+    /**
+     * Title of the LLM tools
+     *
+     * @default 'LLM Tools from Configuration'
+     */
+    readonly title?: string_mime_type_with_wildcard & string_markdown_text;
     /**
      * This will will be passed to the created `LlmExecutionTools`
      *
      * @default false
      */
-    isVerbose?: boolean;
+    readonly isVerbose?: boolean;
     /**
      * Identifier of the end user
      *

package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts

@@ -1,16 +1,8 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
-import type { PromptResult } from '../../execution/PromptResult';
-import type { ChatPrompt } from '../../types/Prompt';
-import type { CompletionPrompt } from '../../types/Prompt';
-import type { EmbeddingPrompt } from '../../types/Prompt';
-import type { Prompt } from '../../types/Prompt';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, PromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt, CompletionPrompt, EmbeddingPrompt, Prompt } from '../../types/Prompt';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
@@ -18,6 +10,7 @@ import type { string_title } from '../../types/typeAliases';
  * @public exported from `@promptbook/core`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    readonly title: string_title & string_markdown_text;
     /**
      * Array of execution tools in order of priority
      */
@@ -25,8 +18,7 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
      * Gets array of execution tools in order of priority
      */
-    constructor(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
-    get title(): string_title & string_markdown_text;
+    constructor(title: string_title & string_markdown_text, ...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
     get description(): string_markdown;
     get profile(): {
         name: string;

package/esm/typings/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts

@@ -0,0 +1,11 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
+/**
+ * Just returns the given `LlmExecutionTools` or joins multiple into one
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools: undefined | LlmExecutionTools | ReadonlyArray<LlmExecutionTools>): LlmExecutionTools | MultipleLlmExecutionTools;
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */

package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts

@@ -1,4 +1,5 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import { string_markdown_text, string_title } from '../../types/typeAliases';
 import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
 /**
  * Joins multiple LLM Execution Tools into one
@@ -15,7 +16,7 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function joinLlmExecutionTools(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
+export declare function joinLlmExecutionTools(title: string_title & string_markdown_text, ...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts

@@ -11,5 +11,6 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
  */
 export declare function $fakeTextToExpectations(expectations: Expectations, postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>): Promise<string>;
 /**
+ * TODO: Do not use LoremIpsum, but use some faked text that looks more human-promptbook-like
  * TODO: [💝] Unite object for expecting amount and format - use here also a format
  */

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -1,12 +1,9 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { ChatPromptResult, CompletionPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  *

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -1,13 +1,9 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  *

package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts

@@ -1,6 +1,5 @@
 import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
-import type { Scraper } from '../_common/Scraper';
-import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { Scraper, ScraperSourceHandler } from '../_common/Scraper';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';

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-16`).
+ * It follows semantic versioning (e.g., `0.101.0-18`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.101.0-17",
+    "version": "0.101.0-19",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -94,7 +94,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/javascript.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-17"
+        "@promptbook/core": "0.101.0-19"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-17';
+    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-19';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts

@@ -1,4 +0,0 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
- */

package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts

@@ -1,5 +0,0 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
- * Note: [🤖] For each new model variant consider adding new testing unit like "faked-completion.test.ts", "mocked-chat.test.ts" and "mocked-completion.test.ts"
- */

package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts

@@ -1,4 +0,0 @@
-export {};
-/**
- * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPipelineExecutor.test.ts"
- */

package/esm/typings/src/scripting/_test/postprocessing.test.d.ts

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