@promptbook/fake-llm 0.105.0-10 → 0.105.0-12

package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts

@@ -31,7 +31,7 @@ export type AgentCapability = {
     /**
      * The type of the capability
      */
-    type: 'browser' | 'search-engine' | 'knowledge' | 'time' | 'inheritance' | 'import';
+    type: 'browser' | 'search-engine' | 'knowledge' | 'time' | 'inheritance' | 'import' | 'image-generator';
     /**
      * The label to display for this capability
      */

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

@@ -1,12 +1,12 @@
 import type { CSSProperties, ReactNode } from 'react';
 import type { Promisable } from 'type-fest';
-import type { string_chat_format_name } from '../save/_common/string_chat_format_name';
-import type { ChatMessage } from '../types/ChatMessage';
-import type { ChatParticipant } from '../types/ChatParticipant';
-import { string_color } from '../../../types/typeAliases';
 import { Color } from '../../../_packages/color.index';
 import { SpeechRecognition } from '../../../types/SpeechRecognition';
+import { string_color } from '../../../types/typeAliases';
 import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { string_chat_format_name } from '../save/_common/string_chat_format_name';
+import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatParticipant } from '../types/ChatParticipant';
 /**
  * @public exported from `@promptbook/components`
  */
@@ -203,6 +203,10 @@ export type ChatProps = {
         arguments?: TODO_any;
         result?: TODO_any;
     }) => void;
+    /**
+     * Visual style of the chat component
+     */
+    readonly visual: 'STANDALONE' | 'FULL_PAGE';
 };
 /**
  * TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)

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

@@ -0,0 +1,22 @@
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+/**
+ * Utility to format tool call information for user-friendly display.
+ */
+/**
+ * Technical to user-friendly tool names and emojis
+ *
+ * @private [🧠] Maybe public?
+ */
+export declare const TOOL_TITLES: Record<string, {
+    title: string;
+    emoji: string;
+}>;
+/**
+ * Gets the user-friendly text for a tool call chiplet.
+ *
+ * @private [🧠] Maybe public?
+ */
+export declare function getToolCallChipletText(toolCall: {
+    name: string;
+    arguments?: string | Record<string, TODO_any>;
+}): string;

package/esm/typings/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts

@@ -0,0 +1,46 @@
+import { string_javascript_name } from '../../_packages/types.index';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE IMAGE GENERATOR commitment definition
+ *
+ * The `USE IMAGE GENERATOR` commitment indicates that the agent should utilize an image generation tool
+ * to create images based on text prompts.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE IMAGE GENERATOR
+ * USE IMAGE GENERATOR Create realistic images of nature
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition<'USE IMAGE GENERATOR' | 'USE IMAGE GENERATION' | 'IMAGE GENERATOR' | 'IMAGE GENERATION' | 'USE IMAGE'> {
+    constructor(type?: 'USE IMAGE GENERATOR' | 'USE IMAGE GENERATION' | 'IMAGE GENERATOR' | 'IMAGE GENERATION' | 'USE IMAGE');
+    /**
+     * Short one-line description of USE IMAGE GENERATOR.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE IMAGE GENERATOR commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets human-readable titles for tool functions provided by this commitment.
+     */
+    getToolTitles(): Record<string_javascript_name, string>;
+    /**
+     * Gets the `generate_image` tool function implementation.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.test.d.ts

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

package/esm/typings/src/commitments/index.d.ts

@@ -33,6 +33,7 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { UseCommitmentDefinition } from './USE/USE';
 import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
+import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
 import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
 import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
@@ -44,7 +45,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

package/esm/typings/src/execution/AvailableModel.d.ts

@@ -1,8 +1,5 @@
 import type { ModelVariant } from '../types/ModelVariant';
-import type { number_usd } from '../types/typeAliases';
-import type { string_model_description } from '../types/typeAliases';
-import type { string_model_name } from '../types/typeAliases';
-import type { string_title } from '../types/typeAliases';
+import type { number_usd, string_model_description, string_model_name, string_title, string_url } from '../types/typeAliases';
 /**
  * Represents a model that can be used for prompt execution
  */
@@ -40,6 +37,10 @@ export type AvailableModel = {
         readonly prompt: number_usd;
         readonly output: number_usd;
     };
+    /**
+     * URL to the model (or provider) documentation
+     */
+    readonly documentationUrl?: string_url;
     /**
      * If the model is deprecated, it should not be used for new tasks
      */

package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts

@@ -10,5 +10,6 @@ export declare const createGoogleExecutionTools: ((options: GoogleExecutionTools
     className: string;
 };
 /**
+ * TODO: !!!!! Rename to `createGoogleLlmExecutionTools`, `...GoogleLlmExecutionTools`
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -33,11 +33,11 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     /**
      * Calls OpenAI API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+    callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
     /**
      * Calls OpenAI API to use a chat model with streaming.
      */
-    callChatModelStream(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Get an existing assistant tool wrapper
      */

package/esm/typings/src/llm-providers/openai/utils/uploadFilesToOpenAi.d.ts

@@ -0,0 +1,7 @@
+import OpenAI from 'openai';
+/**
+ * Uploads files to OpenAI and returns their IDs
+ *
+ * @private utility for `OpenAiAssistantExecutionTools` and `OpenAiCompatibleExecutionTools`
+ */
+export declare function uploadFilesToOpenAi(client: OpenAI, files: Array<File>): Promise<Array<string>>;

package/esm/typings/src/speech-recognition/OpenAiSpeechRecognition.d.ts

@@ -19,6 +19,9 @@ export type OpenAiSpeechRecognitionOptions = {
 export declare class OpenAiSpeechRecognition implements SpeechRecognition {
     private readonly options;
     private mediaRecorder;
+    private audioContext;
+    private analyser;
+    private silenceTimeout;
     private audioChunks;
     private callbacks;
     private _state;

package/esm/typings/src/types/Prompt.d.ts

@@ -57,6 +57,10 @@ export type ChatPrompt = CommonPrompt & {
      * Optional tools that can be called by the model
      */
     tools?: Array<LlmToolDefinition>;
+    /**
+     * Optional file attachments
+     */
+    files?: Array<File>;
 };
 /**
  * Image prompt

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.105.0-9`).
+ * It follows semantic versioning (e.g., `0.105.0-11`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/fake-llm",
-    "version": "0.105.0-10",
+    "version": "0.105.0-12",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -96,7 +96,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/fake-llm.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.105.0-10"
+        "@promptbook/core": "0.105.0-12"
     },
     "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.105.0-10';
+    const PROMPTBOOK_ENGINE_VERSION = '0.105.0-12';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -6109,6 +6109,148 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * USE IMAGE GENERATOR commitment definition
+     *
+     * The `USE IMAGE GENERATOR` commitment indicates that the agent should utilize an image generation tool
+     * to create images based on text prompts.
+     *
+     * Example usage in agent source:
+     *
+     * ```book
+     * USE IMAGE GENERATOR
+     * USE IMAGE GENERATOR Create realistic images of nature
+     * ```
+     *
+     * @private [🪔] Maybe export the commitments through some package
+     */
+    class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition {
+        constructor(type = 'USE IMAGE GENERATOR') {
+            super(type, ['USE IMAGE GENERATION', 'IMAGE GENERATOR', 'IMAGE GENERATION', 'USE IMAGE']);
+        }
+        /**
+         * Short one-line description of USE IMAGE GENERATOR.
+         */
+        get description() {
+            return 'Enable the agent to use an image generation tool for creating images from text prompts.';
+        }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '🖼️';
+        }
+        /**
+         * Markdown documentation for USE IMAGE GENERATOR commitment.
+         */
+        get documentation() {
+            return spaceTrim$1.spaceTrim(`
+            # USE IMAGE GENERATOR
+
+            Enables the agent to use an image generation tool to create images based on text prompts.
+
+            ## Key aspects
+
+            - The content following \`USE IMAGE GENERATOR\` is an arbitrary text that the agent should know (e.g. style instructions or safety guidelines).
+            - The actual image generation is handled by the agent runtime using LLM execution tools.
+            - Allows the agent to generate visual content based on user requests.
+            - Returns the URL of the generated image.
+
+            ## Examples
+
+            \`\`\`book
+            Visual Artist
+
+            PERSONA You are a creative visual artist who can generate images.
+            USE IMAGE GENERATOR
+            RULE Always describe the generated image to the user.
+            \`\`\`
+
+            \`\`\`book
+            Interior Designer
+
+            PERSONA You are an interior designer who helps users visualize their space.
+            USE IMAGE GENERATOR Professional interior design renders.
+            ACTION Generate a preview of the designed room.
+            \`\`\`
+        `);
+        }
+        applyToAgentModelRequirements(requirements, content) {
+            // Get existing tools array or create new one
+            const existingTools = requirements.tools || [];
+            // Add 'generate_image' to tools if not already present
+            const updatedTools = existingTools.some((tool) => tool.name === 'generate_image')
+                ? existingTools
+                : [
+                    ...existingTools,
+                    {
+                        name: 'generate_image',
+                        description: spaceTrim$1.spaceTrim(`
+                        Generate an image from a text prompt.
+                        Use this tool when the user asks to create, draw, or generate an image.
+                        ${!content ? '' : `Style instructions / guidelines: ${content}`}
+                    `),
+                        parameters: {
+                            type: 'object',
+                            properties: {
+                                prompt: {
+                                    type: 'string',
+                                    description: 'The detailed description of the image to generate',
+                                },
+                            },
+                            required: ['prompt'],
+                        },
+                    },
+                ];
+            // Return requirements with updated tools and metadata
+            return this.appendToSystemMessage({
+                ...requirements,
+                tools: updatedTools,
+                metadata: {
+                    ...requirements.metadata,
+                    useImageGenerator: content || true,
+                },
+            }, spaceTrim$1.spaceTrim(`
+                You have access to an image generator. Use it to create images based on user requests.
+                When you generate an image, you will receive a URL of the generated image.
+            `));
+        }
+        /**
+         * Gets human-readable titles for tool functions provided by this commitment.
+         */
+        getToolTitles() {
+            return {
+                generate_image: 'Generate image',
+            };
+        }
+        /**
+         * Gets the `generate_image` tool function implementation.
+         */
+        getToolFunctions() {
+            return {
+                async generate_image(args, ...extra) {
+                    console.log('!!!! [Tool] generate_image called', { args });
+                    const { prompt } = args;
+                    if (!prompt) {
+                        throw new Error('Image prompt is required');
+                    }
+                    const { llmTools } = extra[0] || {};
+                    if (!llmTools || !llmTools.callImageGenerationModel) {
+                        throw new Error('Image generation is not supported by the current model provider');
+                    }
+                    const result = await llmTools.callImageGenerationModel({
+                        content: prompt,
+                        modelName: 'dall-e-3', // Defaulting to dall-e-3, but this could be configurable
+                    });
+                    return result.content;
+                },
+            };
+        }
+    }
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * USE MCP commitment definition
      *
@@ -6357,8 +6499,12 @@
                     useSearchEngine: content || true,
                 },
             }, spaceTrim$1.spaceTrim(`
-                You have access to the web search engine. Use it to find up-to-date information or facts that you don't know.
+                Tools:
+                You have access to the web search engine via the tool "web_search".
+                Use it to find up-to-date information or facts that you don't know.
                 When you need to know some information from the internet, use the tool provided to you.
+                Do not make up information when you can search for it.
+                Do not tell the user you cannot search for information, YOU CAN.
             `));
         }
         /**
@@ -6383,9 +6529,7 @@
                     const searchEngine = new SerpSearchEngine();
                     const results = await searchEngine.search(query, options);
                     return spaceTrim$1.spaceTrim((block) => `
-                        Search results for "${query}"${Object.keys(options).length === 0
-                    ? ''
-                    : ` with options ${JSON.stringify(options)}`}:
+                        Search results for "${query}"${Object.keys(options).length === 0 ? '' : ` with options ${JSON.stringify(options)}`}:
 
                         ${block(results
                     .map((result) => spaceTrim$1.spaceTrim(`
@@ -6489,8 +6633,11 @@
                     ...requirements.metadata,
                 },
             }, spaceTrim$1.spaceTrim(`
-                You have access to the current date and time. Use it to answer questions about the current date and time.
+                Tool:
+                You have access to the current date and time via the tool "get_current_time".
+                Use it to answer questions about the current date and time.
                 When you need to know the current date or time, use the tool provided to you.
+                Do not make up the current date or time; always use the tool to get accurate information.
             `));
         }
         /**
@@ -6672,6 +6819,15 @@
         new UseBrowserCommitmentDefinition(),
         new UseSearchEngineCommitmentDefinition(),
         new UseTimeCommitmentDefinition(),
+        new UseImageGeneratorCommitmentDefinition('USE IMAGE GENERATOR'),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        new UseImageGeneratorCommitmentDefinition('USE IMAGE GENERATION'),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        new UseImageGeneratorCommitmentDefinition('IMAGE GENERATOR'),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        new UseImageGeneratorCommitmentDefinition('IMAGE GENERATION'),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        new UseImageGeneratorCommitmentDefinition('USE IMAGE'),
         new UseMcpCommitmentDefinition(),
         new UseCommitmentDefinition(),
         // Not yet implemented commitments (using placeholder)