@promptbook/wizard 0.103.0-48 → 0.103.0-50

package/esm/index.es.js

@@ -36,7 +36,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-48';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-50';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -75,6 +75,7 @@ const REMOTE_SERVER_URLS = [
     */
 ];
 /**
+ * TODO: [🐱‍🚀] Auto-federated server from url in here
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
@@ -421,6 +422,9 @@ class Color {
         if (hex.length === 3) {
             return Color.fromHex3(hex);
         }
+        if (hex.length === 4) {
+            return Color.fromHex4(hex);
+        }
         if (hex.length === 6) {
             return Color.fromHex6(hex);
         }
@@ -441,6 +445,19 @@ class Color {
         const b = parseInt(hex.substr(2, 1), 16) * 16;
         return take(new Color(r, g, b));
     }
+    /**
+     * Creates a new Color instance from color in hex format with 4 digits (with alpha channel)
+     *
+     * @param color in hex for example `09df`
+     * @returns Color object
+     */
+    static fromHex4(hex) {
+        const r = parseInt(hex.substr(0, 1), 16) * 16;
+        const g = parseInt(hex.substr(1, 1), 16) * 16;
+        const b = parseInt(hex.substr(2, 1), 16) * 16;
+        const a = parseInt(hex.substr(3, 1), 16) * 16;
+        return take(new Color(r, g, b, a));
+    }
     /**
      * Creates a new Color instance from color in hex format with 6 color digits (without alpha channel)
      *
@@ -631,7 +648,8 @@ class Color {
      * @returns true if the value is a valid hex color string (e.g., `#009edd`, `#fff`, etc.)
      */
     static isHexColorString(value) {
-        return typeof value === 'string' && /^#(?:[0-9a-fA-F]{3}){1,2}$/.test(value);
+        return (typeof value === 'string' &&
+            /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/.test(value));
     }
     /**
      * Creates new Color object
@@ -958,6 +976,7 @@ const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
 ({
     TITLE: Color.fromHex('#244EA8'),
     LINE: Color.fromHex('#eeeeee'),
+    SEPARATOR: Color.fromHex('#cccccc'),
     COMMITMENT: Color.fromHex('#DA0F78'),
     PARAMETER: Color.fromHex('#8e44ad'),
 });
@@ -1523,7 +1542,7 @@ function deepClone(objectValue) {
     TODO: [🧠] Is there a better implementation?
     > const propertyNames = Object.getOwnPropertyNames(objectValue);
     > for (const propertyName of propertyNames) {
-    >     const value = (objectValue as really_any)[propertyName];
+    >     const value = (objectValue as chococake)[propertyName];
     >     if (value && typeof value === 'object') {
     >         deepClone(value);
     >     }
@@ -1953,7 +1972,7 @@ class DatabaseError extends Error {
     }
 }
 /**
- * TODO: !!!! Explain that NotFoundError (!!! and other specific errors) has priority over DatabaseError in some contexts
+ * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
  */
 
 /**
@@ -6783,11 +6802,12 @@ class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools {
  *
  * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
  *
- * !!! Note: [🦖] There are several different things in Promptbook:
+ * Note: [🦖] There are several different things in Promptbook:
  * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
  * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
  * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
  * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/openai`
  */
@@ -6822,6 +6842,12 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
      * Calls OpenAI API to use a chat model.
      */
     async callChatModel(prompt) {
+        return this.callChatModelStream(prompt, () => { });
+    }
+    /**
+     * Calls OpenAI API to use a chat model with streaming.
+     */
+    async callChatModelStream(prompt, onProgress) {
         var _a, _b, _c;
         if (this.options.isVerbose) {
             console.info('💬 OpenAI callChatModel call', { prompt });
@@ -6889,21 +6915,24 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                 console.info('connect', stream.currentEvent);
             }
         });
-        /*
-        stream.on('messageDelta', (messageDelta) => {
-            if (
-                this.options.isVerbose &&
-                messageDelta &&
-                messageDelta.content &&
-                messageDelta.content[0] &&
-                messageDelta.content[0].type === 'text'
-            ) {
-                console.info('messageDelta', messageDelta.content[0].text?.value);
+        stream.on('textDelta', (textDelta, snapshot) => {
+            if (this.options.isVerbose && textDelta.value) {
+                console.info('textDelta', textDelta.value);
             }
-
-            // <- TODO: [🐚] Make streaming and running tasks working
+            const chunk = {
+                content: textDelta.value || '',
+                modelName: 'assistant',
+                timing: {
+                    start,
+                    complete: $getCurrentDate(),
+                },
+                usage: UNCERTAIN_USAGE,
+                rawPromptContent,
+                rawRequest,
+                rawResponse: snapshot,
+            };
+            onProgress(chunk);
         });
-        */
         stream.on('messageCreated', (message) => {
             if (this.options.isVerbose) {
                 console.info('messageCreated', message);
@@ -6939,7 +6968,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
         }
         return exportJson({
             name: 'promptResult',
-            message: `Result of \`OpenAiAssistantExecutionTools.callChatModel\``,
+            message: `Result of \`OpenAiAssistantExecutionTools.callChatModelStream\``,
             order: [],
             value: {
                 content: resultContent,
@@ -7078,9 +7107,9 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
         }
         const assistant = await client.beta.assistants.create(assistantConfig);
         console.log(`✅ Assistant created: ${assistant.id}`);
-        // TODO: !!!! Try listing existing assistants
-        // TODO: !!!! Try marking existing assistants by DISCRIMINANT
-        // TODO: !!!! Allow to update and reconnect to existing assistants
+        // TODO: [🐱‍🚀] Try listing existing assistants
+        // TODO: [🐱‍🚀] Try marking existing assistants by DISCRIMINANT
+        // TODO: [🐱‍🚀] Allow to update and reconnect to existing assistants
         return new OpenAiAssistantExecutionTools({
             ...this.options,
             isCreatingNewAssistantsAllowed: false,
@@ -14044,6 +14073,60 @@ class MemoryCommitmentDefinition extends BaseCommitmentDefinition {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * INITIAL MESSAGE commitment definition
+ *
+ * The INITIAL MESSAGE commitment defines the first message that the user sees when opening the chat.
+ * It is used to greet the user and set the tone of the conversation.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * INITIAL MESSAGE Hello! I am ready to help you with your tasks.
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+class InitialMessageCommitmentDefinition extends BaseCommitmentDefinition {
+    constructor() {
+        super('INITIAL MESSAGE');
+    }
+    /**
+     * Short one-line description of INITIAL MESSAGE.
+     */
+    get description() {
+        return 'Defines the **initial message** shown to the user when the chat starts.';
+    }
+    /**
+     * Markdown documentation for INITIAL MESSAGE commitment.
+     */
+    get documentation() {
+        return spaceTrim$1(`
+            # ${this.type}
+
+            Defines the first message that the user sees when opening the chat. This message is purely for display purposes in the UI and does not inherently become part of the LLM's system prompt context (unless also included via other means).
+
+            ## Key aspects
+
+            - Used to greet the user.
+            - Sets the tone of the conversation.
+            - Displayed immediately when the chat interface loads.
+
+            ## Examples
+
+            \`\`\`book
+            Support Agent
+
+            PERSONA You are a helpful support agent.
+            INITIAL MESSAGE Hi there! How can I assist you today?
+            \`\`\`
+        `);
+    }
+    applyToAgentModelRequirements(requirements, content) {
+        return requirements;
+    }
+}
+
 /**
  * MESSAGE commitment definition
  *
@@ -15205,6 +15288,7 @@ const COMMITMENT_REGISTRY = [
     new NoteCommitmentDefinition('NONCE'),
     new GoalCommitmentDefinition('GOAL'),
     new GoalCommitmentDefinition('GOALS'),
+    new InitialMessageCommitmentDefinition(),
     new MessageCommitmentDefinition('MESSAGE'),
     new MessageCommitmentDefinition('MESSAGES'),
     new ScenarioCommitmentDefinition('SCENARIO'),
@@ -15631,13 +15715,25 @@ function generatePlaceholderAgentProfileImageUrl(agentName) {
  * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
  */
 
+/**
+ * Computes SHA-256 hash of the given object
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function computeHash(value) {
+    return SHA256(hexEncoder.parse(spaceTrim(valueToString(value)))).toString( /* hex */);
+}
+/**
+ * TODO: [🥬][🥬] Use this ACRY
+ */
+
 /**
  * Computes SHA-256 hash of the agent source
  *
  * @public exported from `@promptbook/core`
  */
 function computeAgentHash(agentSource) {
-    return SHA256(hexEncoder.parse(agentSource /* <- TODO: !!!!! spaceTrim */)).toString( /* hex */);
+    return computeHash(agentSource);
 }
 
 /**
@@ -16001,13 +16097,31 @@ function parseAgentSource(agentSource) {
         }
         personaDescription += commitment.content;
     }
+    let initialMessage = null;
+    for (const commitment of parseResult.commitments) {
+        if (commitment.type !== 'INITIAL MESSAGE') {
+            continue;
+        }
+        // Note: Initial message override logic - later overrides earlier
+        //       Or should it append? Usually initial message is just one block.
+        //       Let's stick to "later overrides earlier" for simplicity, or just take the last one.
+        initialMessage = commitment.content;
+    }
     const meta = {};
+    const links = [];
     for (const commitment of parseResult.commitments) {
+        if (commitment.type === 'META LINK') {
+            links.push(spaceTrim(commitment.content));
+            continue;
+        }
         if (commitment.type !== 'META') {
             continue;
         }
         // Parse META commitments - format is "META TYPE content"
         const metaTypeRaw = commitment.content.split(' ')[0] || 'NONE';
+        if (metaTypeRaw === 'LINK') {
+            links.push(spaceTrim(commitment.content.substring(metaTypeRaw.length)));
+        }
         const metaType = normalizeTo_camelCase(metaTypeRaw);
         meta[metaType] = spaceTrim(commitment.content.substring(metaTypeRaw.length));
     }
@@ -16023,7 +16137,9 @@ function parseAgentSource(agentSource) {
         agentName: normalizeAgentName(parseResult.agentName || createDefaultAgentName(agentSource)),
         agentHash,
         personaDescription,
+        initialMessage,
         meta,
+        links,
         parameters,
     };
 }