@promptbook/cli 0.105.0-12 → 0.105.0-15

package/esm/index.es.js

@@ -16,8 +16,8 @@ import { spawn } from 'child_process';
 import JSZip from 'jszip';
 import { parse, unparse } from 'papaparse';
 import { lookup, extension } from 'mime-types';
-import glob from 'glob-promise';
 import moment from 'moment';
+import glob from 'glob-promise';
 import express from 'express';
 import * as OpenApiValidator from 'express-openapi-validator';
 import http from 'http';
@@ -47,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.105.0-12';
+const PROMPTBOOK_ENGINE_VERSION = '0.105.0-15';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2555,6 +2555,56 @@ const RESERVED_PARAMETER_NAMES = exportJson({
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
     ],
 });
+/**
+ * Limits for IDs, names, and other strings
+ *
+ * @public exported from `@promptbook/core`
+ */
+const LIMITS = {
+    /**
+     * Minimum length of a name (e.g. agent name, persona name)
+     */
+    NAME_MIN_LENGTH: 3,
+    /**
+     * Recommended maximum length of a name
+     */
+    NAME_MAX_LENGTH: 20,
+    /**
+     * Maximum length of a short description or a hash
+     */
+    SHORT_TEXT_MAX_LENGTH: 30,
+    /**
+     * Gone
+     */
+    GONE: 410,
+    /**
+     * Gateway timeout
+     */
+    GATEWAY_TIMEOUT: 504,
+    /**
+     * Too many requests
+     */
+    TOO_MANY_REQUESTS: 429,
+    /**
+     * Maximum length of a file path segment
+     */
+    FILE_PATH_SEGMENT_MAX_LENGTH: 8,
+    /**
+     * Default length of a short name (e.g. for default agent names)
+     */
+    SHORT_NAME_LENGTH: 6,
+};
+/**
+ * Common ports and network limits
+ *
+ * @public exported from `@promptbook/core`
+ */
+const NETWORK_LIMITS = {
+    /**
+     * Maximum valid port number
+     */
+    MAX_PORT: 65535,
+};
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
@@ -16822,6 +16872,25 @@ class SerpSearchEngine {
     }
 }
 
+/**
+ * @@@
+ *
+ * @private utility for commitments
+ */
+function formatOptionalInstructionBlock(label, content) {
+    const trimmedContent = spaceTrim$1(content);
+    if (!trimmedContent) {
+        return '';
+    }
+    return spaceTrim$1((block) => `
+        - ${label}:
+            ${block(trimmedContent
+        .split('\n')
+        .map((line) => `- ${line}`)
+        .join('\n'))}
+    `);
+}
+
 /**
  * USE SEARCH ENGINE commitment definition
  *
@@ -16843,6 +16912,9 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('USE SEARCH ENGINE', ['USE SEARCH']);
     }
+    get requiresContent() {
+        return false;
+    }
     /**
      * Short one-line description of USE SEARCH ENGINE.
      */
@@ -16891,6 +16963,7 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
         `);
     }
     applyToAgentModelRequirements(requirements, content) {
+        const extraInstructions = formatOptionalInstructionBlock('Search instructions', content);
         // Get existing tools array or create new one
         const existingTools = requirements.tools || [];
         // Add 'web_search' to tools if not already present
@@ -16949,13 +17022,14 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
                 ...requirements.metadata,
                 useSearchEngine: content || true,
             },
-        }, spaceTrim$1(`
-                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.
+        }, spaceTrim$1((block) => `
+                    Tool:
+                    - 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.
+                    ${block(extraInstructions)}
             `));
     }
     /**
@@ -17007,6 +17081,7 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
  *
  * ```book
  * USE TIME
+ * USE TIME Prefer the user's local timezone.
  * ```
  *
  * @private [🪔] Maybe export the commitments through some package
@@ -17015,6 +17090,9 @@ class UseTimeCommitmentDefinition extends BaseCommitmentDefinition {
     constructor() {
         super('USE TIME', ['CURRENT TIME', 'TIME', 'DATE']);
     }
+    get requiresContent() {
+        return false;
+    }
     /**
      * Short one-line description of USE TIME.
      */
@@ -17041,6 +17119,7 @@ class UseTimeCommitmentDefinition extends BaseCommitmentDefinition {
             - This tool won't receive any input.
             - It outputs the current date and time as an ISO 8601 string.
             - Allows the agent to answer questions about the current time or date.
+            - The content following \`USE TIME\` is an arbitrary text that the agent should know (e.g. timezone preference).
 
             ## Examples
 
@@ -17050,9 +17129,17 @@ class UseTimeCommitmentDefinition extends BaseCommitmentDefinition {
             PERSONA You are a helpful assistant who knows the current time.
             USE TIME
             \`\`\`
+
+            \`\`\`book
+            Travel Assistant
+
+            PERSONA You help travelers with planning.
+            USE TIME Prefer the user's local timezone.
+            \`\`\`
         `);
     }
     applyToAgentModelRequirements(requirements, content) {
+        const extraInstructions = formatOptionalInstructionBlock('Time instructions', content);
         // Get existing tools array or create new one
         const existingTools = requirements.tools || [];
         // Add 'get_current_time' to tools if not already present
@@ -17083,13 +17170,12 @@ class UseTimeCommitmentDefinition extends BaseCommitmentDefinition {
             metadata: {
                 ...requirements.metadata,
             },
-        }, spaceTrim$1(`
-                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.
-            `));
+        }, spaceTrim$1((block) => `
+                    Time and date context:
+                    - It is ${moment().format('MMMM YYYY')} now.
+                    - If you need more precise current time information, use the tool "get_current_time".
+                    ${block(extraInstructions)}
+                `));
     }
     /**
      * Gets human-readable titles for tool functions provided by this commitment.
@@ -19335,7 +19421,7 @@ function $initializeStartAgentsServerCommand(program) {
         const { port: portRaw, reload: isCacheReloaded, verbose: isVerbose } = cliOptions;
         // TODO: [🐱‍🚀] [🌕] DRY
         const port = parseInt(portRaw, 10);
-        if (isNaN(port) || port <= 0 || port > 65535) {
+        if (isNaN(port) || port <= 0 || port > NETWORK_LIMITS.MAX_PORT) {
             console.error(colors.red(`Invalid port number: ${portRaw}`));
             return process.exit(1);
         }
@@ -23739,18 +23825,26 @@ class OpenAiCompatibleExecutionTools {
                 const usage = this.computeUsage(content || '', responseMessage.content || '', rawResponse);
                 totalUsage = addUsage(totalUsage, usage);
                 if (responseMessage.tool_calls && responseMessage.tool_calls.length > 0) {
+                    const toolCallStartedAt = new Map();
                     if (onProgress) {
                         onProgress({
                             content: responseMessage.content || '',
                             modelName: rawResponse.model || modelName,
                             timing: { start, complete: $getCurrentDate() },
                             usage: totalUsage,
-                            toolCalls: responseMessage.tool_calls.map((toolCall) => ({
-                                name: toolCall.function.name,
-                                arguments: toolCall.function.arguments,
-                                result: '',
-                                rawToolCall: toolCall,
-                            })),
+                            toolCalls: responseMessage.tool_calls.map((toolCall) => {
+                                const calledAt = $getCurrentDate();
+                                if (toolCall.id) {
+                                    toolCallStartedAt.set(toolCall.id, calledAt);
+                                }
+                                return {
+                                    name: toolCall.function.name,
+                                    arguments: toolCall.function.arguments,
+                                    result: '',
+                                    rawToolCall: toolCall,
+                                    createdAt: calledAt,
+                                };
+                            }),
                             rawPromptContent,
                             rawRequest,
                             rawResponse,
@@ -23759,6 +23853,9 @@ class OpenAiCompatibleExecutionTools {
                     await forEachAsync(responseMessage.tool_calls, {}, async (toolCall) => {
                         const functionName = toolCall.function.name;
                         const functionArgs = toolCall.function.arguments;
+                        const calledAt = toolCall.id
+                            ? toolCallStartedAt.get(toolCall.id) || $getCurrentDate()
+                            : $getCurrentDate();
                         const executionTools = this.options
                             .executionTools;
                         if (!executionTools || !executionTools.script) {
@@ -23769,6 +23866,7 @@ class OpenAiCompatibleExecutionTools {
                             ? executionTools.script
                             : [executionTools.script];
                         let functionResponse;
+                        let errors;
                         try {
                             const scriptTool = scriptTools[0]; // <- TODO: [🧠] Which script tool to use?
                             functionResponse = await scriptTool.execute({
@@ -23783,6 +23881,7 @@ class OpenAiCompatibleExecutionTools {
                         catch (error) {
                             assertsError(error);
                             functionResponse = `Error: ${error.message}`;
+                            errors = [serializeError(error)];
                         }
                         messages.push({
                             role: 'tool',
@@ -23794,6 +23893,8 @@ class OpenAiCompatibleExecutionTools {
                             arguments: functionArgs,
                             result: functionResponse,
                             rawToolCall: toolCall,
+                            createdAt: calledAt,
+                            errors,
                         });
                     });
                     continue;
@@ -25127,6 +25228,8 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
             // Create thread and run
             const threadAndRun = await client.beta.threads.createAndRun(rawRequest);
             let run = threadAndRun;
+            const completedToolCalls = [];
+            const toolCallStartedAt = new Map();
             // Poll until run completes or requires action
             while (run.status === 'queued' || run.status === 'in_progress' || run.status === 'requires_action') {
                 if (run.status === 'requires_action' && ((_a = run.required_action) === null || _a === void 0 ? void 0 : _a.type) === 'submit_tool_outputs') {
@@ -25137,6 +25240,10 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                         if (toolCall.type === 'function') {
                             const functionName = toolCall.function.name;
                             const functionArgs = JSON.parse(toolCall.function.arguments);
+                            const calledAt = $getCurrentDate();
+                            if (toolCall.id) {
+                                toolCallStartedAt.set(toolCall.id, calledAt);
+                            }
                             onProgress({
                                 content: '',
                                 modelName: 'assistant',
@@ -25151,6 +25258,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                                         arguments: toolCall.function.arguments,
                                         result: '',
                                         rawToolCall: toolCall,
+                                        createdAt: calledAt,
                                     },
                                 ],
                             });
@@ -25168,6 +25276,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                                 ? executionTools.script
                                 : [executionTools.script];
                             let functionResponse;
+                            let errors;
                             try {
                                 const scriptTool = scriptTools[0]; // <- TODO: [🧠] Which script tool to use?
                                 functionResponse = await scriptTool.execute({
@@ -25184,12 +25293,14 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                             }
                             catch (error) {
                                 assertsError(error);
+                                const serializedError = serializeError(error);
+                                errors = [serializedError];
                                 functionResponse = spaceTrim$2((block) => `
                                     
                                         The invoked tool \`${functionName}\` failed with error:
                                         
                                         \`\`\`json
-                                        ${block(JSON.stringify(serializeError(error), null, 4))}
+                                        ${block(JSON.stringify(serializedError, null, 4))}
                                         \`\`\`
 
                                     `);
@@ -25200,6 +25311,14 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                                 tool_call_id: toolCall.id,
                                 output: functionResponse,
                             });
+                            completedToolCalls.push({
+                                name: functionName,
+                                arguments: toolCall.function.arguments,
+                                result: functionResponse,
+                                rawToolCall: toolCall,
+                                createdAt: toolCall.id ? toolCallStartedAt.get(toolCall.id) || calledAt : calledAt,
+                                errors,
+                            });
                         }
                     }
                     // Submit tool outputs
@@ -25239,6 +25358,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
                 rawPromptContent,
                 rawRequest,
                 rawResponse: { run, messages: messages.data },
+                toolCalls: completedToolCalls.length > 0 ? completedToolCalls : undefined,
             };
             onProgress(finalChunk);
             return exportJson({
@@ -27779,7 +27899,7 @@ function normalizeAgentName(rawAgentName) {
  */
 function createDefaultAgentName(agentSource) {
     const agentHash = computeAgentHash(agentSource);
-    return normalizeAgentName(`Agent ${agentHash.substring(0, 6)}`);
+    return normalizeAgentName(`Agent ${agentHash.substring(0, LIMITS.SHORT_NAME_LENGTH)}`);
 }
 
 /**