@promptbook/cli 0.104.0-11 → 0.104.0-13

package/apps/agents-server/src/app/agents/[agentName]/AgentProfileWrapper.tsx

@@ -4,14 +4,17 @@ import { AgentBasicInformation, string_agent_name } from '@promptbook-local/type
 import { AgentProfile } from '../../../components/AgentProfile/AgentProfile';
 import { AgentOptionsMenu } from './AgentOptionsMenu';
 
+/**
+ * Props for the `AgentProfileWrapper` component
+ */
 type AgentProfileWrapperProps = {
     /***
-     * @@@
+     * Basic information about the agent
      */
     readonly agent: AgentBasicInformation;
 
     /***
-     * @@@
+     * URL where the agent can be accessed
      */
     readonly agentUrl: string;
 
@@ -21,34 +24,37 @@ type AgentProfileWrapperProps = {
     readonly publicUrl: URL;
 
     /***
-     * @@@
+     * Email address associated with the agent
      */
     readonly agentEmail: string;
 
     /***
-     * @@@
+     * Unique name identifier for the agent
      */
     readonly agentName: string_agent_name;
 
     /***
-     * @@@
+     * Brand color for the agent in hexadecimal format
      */
     readonly brandColorHex: string;
 
     /***
-     * @@@
+     * Indicates if the current user has administrative privileges
      */
     readonly isAdmin: boolean;
 
     /***
-     * @@@
+     * Indicates if the agent operates in headless mode
      */
     readonly isHeadless: boolean;
 
+    /***
+     * Actions to be rendered within the agent profile
+     */
     readonly actions: React.ReactNode;
 
     /***
-     * @@@
+     * Child components to render within the agent profile
      */
     readonly children: React.ReactNode;
 };

package/apps/agents-server/src/app/api/upload/route.ts

@@ -1,3 +1,4 @@
+import type { PostgrestSingleResponse, SupabaseClient } from '@supabase/supabase-js';
 import { $getTableName } from '@/src/database/$getTableName';
 import { $provideSupabase } from '@/src/database/$provideSupabase';
 import { serializeError } from '@promptbook-local/utils';
@@ -6,12 +7,13 @@ import { NextRequest, NextResponse } from 'next/server';
 import { assertsError } from '../../../../../../src/errors/assertsError';
 import { getUserIdFromRequest } from '../../../../src/utils/getUserIdFromRequest';
 import { getMetadata } from '../../../database/getMetadata';
+import type { AgentsServerDatabase } from '../../../database/schema';
 
 export async function POST(request: NextRequest) {
     try {
         const body = (await request.json()) as HandleUploadBody;
         const userId = await getUserIdFromRequest(request);
-        const supabase = $provideSupabase();
+        const supabase: SupabaseClient<AgentsServerDatabase> = $provideSupabase();
 
         // Handle Vercel Blob client upload protocol
         const jsonResponse = await handleUpload({
@@ -38,7 +40,7 @@ export async function POST(request: NextRequest) {
 
                 // Create a DB record at the start of the upload to track it
                 const uploadPurpose = purpose || 'GENERIC_UPLOAD';
-                const { data: insertedFile, error: insertError } = await supabase
+                const { data: insertedFile, error: insertError }: PostgrestSingleResponse<Pick<AgentsServerDatabase['public']['Tables']['File']['Row'], 'id'>> = await supabase
                     .from(await $getTableName('File'))
                     .insert({
                         userId: userId || null,

package/apps/agents-server/src/components/AgentProfile/AgentProfile.tsx

@@ -83,7 +83,7 @@ export function AgentProfile(props: AgentProfileProps) {
 
     const { meta, agentName } = agent;
     const fullname = (meta.fullname as string) || agentName || 'Agent';
-    const personaDescription = agent.personaDescription || '';
+    const personaDescription = meta.description || agent.personaDescription || '';
     const imageUrl = meta.image || generatePlaceholderAgentProfileImageUrl(permanentId, publicUrl);
 
     const [isQrModalOpen, setIsQrModalOpen] = useState(false);

package/apps/agents-server/src/components/Homepage/AgentsList.tsx

@@ -17,12 +17,12 @@ type AgentWithVisibility = AgentBasicInformation & {
 
 type AgentsListProps = {
     /**
-     * @@@
+     * List of agents to display, each with basic information and visibility status
      */
     readonly agents: AgentWithVisibility[];
 
     /**
-     * @@@
+     * Indicates if the current user has administrative privileges for managing agents
      */
     readonly isAdmin: boolean;
 

package/apps/agents-server/src/components/Homepage/DeletedAgentsList.tsx

@@ -8,12 +8,12 @@ import { AgentBasicInformation } from '../../../../../src/book-2.0/agent-source/
 
 type DeletedAgentsListProps = {
     /**
-     * @@@
+     * List of deleted agents available for restoration
      */
     readonly agents: readonly AgentBasicInformation[];
 
     /**
-     * @@@
+     * Indicates if the current user has administrative privileges for managing agents
      */
     readonly isAdmin: boolean;
 

package/apps/agents-server/src/components/Homepage/ExternalAgentsSection.tsx

@@ -4,7 +4,7 @@ import { Section } from './Section';
 
 type ExternalAgentsSectionProps = {
     /**
-     * @@@
+     * Agents grouped by their originating server for federated display
      */
     readonly agentsByServer: AgentsByServer[];
 

package/apps/agents-server/src/tools/$provideBrowserForServer.ts

@@ -10,7 +10,7 @@ import { BrowserContext, chromium } from 'playwright';
 let browserInstance: BrowserContext | null = null;
 
 /**
- * @@@
+ * Provides a browser context for server-side operations, with caching to reuse instances.
  */
 export async function $provideBrowserForServer(): Promise<BrowserContext> {
     if (browserInstance !== null && browserInstance.browser() && browserInstance.browser()!.isConnected()) {

package/apps/agents-server/src/tools/$provideCdnForServer.ts

@@ -11,7 +11,7 @@ import { IIFilesStorageWithCdn } from '../utils/cdn/interfaces/IFilesStorage';
 let cdn: IIFilesStorageWithCdn | null = null;
 
 /**
- * @@@
+ * Provides a CDN storage interface for server-side file operations, with caching to reuse instances.
  */
 export function $provideCdnForServer(): IIFilesStorageWithCdn {
     if (!cdn) {

package/apps/agents-server/src/utils/messages/sendMessage.ts

@@ -1,3 +1,4 @@
+import type { PostgrestSingleResponse, SupabaseClient } from '@supabase/supabase-js';
 import type { really_any } from '@promptbook-local/types';
 import { serializeError } from '@promptbook-local/utils';
 import { assertsError } from '../../../../../src/errors/assertsError';
@@ -5,15 +6,16 @@ import { $getTableName } from '../../database/$getTableName';
 import { $provideSupabaseForServer } from '../../database/$provideSupabaseForServer';
 import { EMAIL_PROVIDERS } from '../../message-providers';
 import { OutboundEmail } from '../../message-providers/email/_common/Email';
+import type { AgentsServerDatabase } from '../../database/schema';
 
 /**
  * Sends a message
  */
 export async function sendMessage(message: OutboundEmail): Promise<void> {
-    const supabase = await $provideSupabaseForServer();
+    const supabase: SupabaseClient<AgentsServerDatabase> = await $provideSupabaseForServer();
 
     // 1. Insert message
-    const { data: insertedMessage, error: insertError } = await supabase
+    const { data: insertedMessage, error: insertError }: PostgrestSingleResponse<AgentsServerDatabase['public']['Tables']['Message']['Row']> = await supabase
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         .from(await $getTableName('Message'))
         .insert({
@@ -46,11 +48,11 @@ export async function sendMessage(message: OutboundEmail): Promise<void> {
             return;
         }
 
-        let isSent = false;
+        let isSent: boolean = false;
 
         for (const providerName of providers) {
             const provider = EMAIL_PROVIDERS[providerName];
-            let isSuccessful = false;
+            let isSuccessful: boolean = false;
             let raw: really_any = null;
 
             try {
@@ -67,7 +69,6 @@ export async function sendMessage(message: OutboundEmail): Promise<void> {
             // 3. Log attempt
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             await supabase.from(await $getTableName('MessageSendAttempt')).insert({
-                // @ts-expect-error: insertedMessage is any
                 messageId: insertedMessage.id,
                 providerName,
                 isSuccessful,

package/esm/index.es.js

@@ -47,7 +47,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.104.0-11';
+const PROMPTBOOK_ENGINE_VERSION = '0.104.0-13';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -5663,7 +5663,7 @@ function joinLlmExecutionTools(title, ...llmExecutionTools) {
 }
 /**
  * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
  */
 
 /**
@@ -5848,7 +5848,7 @@ async function $provideLlmToolsForWizardOrCli(options) {
 }
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
  * TODO: [🥃] Allow `ptbk make` without llm tools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
  * TODO: [®] DRY Register logic
@@ -8005,7 +8005,7 @@ function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
 }
 /**
  * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
  */
 
 /**
@@ -11273,7 +11273,12 @@ const jokerCommandParser = {
  * @see {@link ModelVariant}
  * @public exported from `@promptbook/core`
  */
-const MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'IMAGE_GENERATION', 'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */];
+const MODEL_VARIANTS = [
+    'COMPLETION',
+    'CHAT',
+    'IMAGE_GENERATION',
+    'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */,
+];
 
 /**
  * Parses the model command
@@ -19302,6 +19307,22 @@ resultContent, rawResponse) {
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */
 
+/**
+ * Maps Promptbook tools to OpenAI tools.
+ *
+ * @private
+ */
+function mapToolsToOpenAi(tools) {
+    return tools.map((tool) => ({
+        type: 'function',
+        function: {
+            name: tool.name,
+            description: tool.description,
+            parameters: tool.parameters,
+        },
+    }));
+}
+
 /**
  * Parses an OpenAI error message to identify which parameter is unsupported
  *
@@ -19499,6 +19520,9 @@ class OpenAiCompatibleExecutionTools {
                 },
             ],
             user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
+            tools: currentModelRequirements.tools === undefined
+                ? undefined
+                : mapToolsToOpenAi(currentModelRequirements.tools),
         };
         const start = $getCurrentDate();
         if (this.options.isVerbose) {
@@ -19643,6 +19667,7 @@ class OpenAiCompatibleExecutionTools {
         const rawPromptContent = templateParameters(content, { ...parameters, modelName });
         const rawRequest = {
             ...modelSettings,
+            model: modelName,
             prompt: rawPromptContent,
             user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
         };
@@ -19897,8 +19922,8 @@ class OpenAiCompatibleExecutionTools {
         const rawPromptContent = templateParameters(content, { ...parameters, modelName });
         const rawRequest = {
             ...modelSettings,
-            size: modelSettings.size || '1024x1024',
             prompt: rawPromptContent,
+            size: modelSettings.size || '1024x1024',
             user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
             response_format: 'url', // TODO: [🧠] Maybe allow b64_json
         };
@@ -20796,6 +20821,7 @@ class OpenAiAssistantExecutionTools extends OpenAiExecutionTools {
             thread: {
                 messages: threadMessages,
             },
+            tools: modelRequirements.tools === undefined ? undefined : mapToolsToOpenAi(modelRequirements.tools),
             // <- TODO: Add user identification here> user: this.options.user,
         };
         const start = $getCurrentDate();
@@ -23218,9 +23244,7 @@ class DictionaryCommitmentDefinition extends BaseCommitmentDefinition {
         // Get existing dictionary entries from metadata
         const existingDictionary = ((_a = requirements.metadata) === null || _a === void 0 ? void 0 : _a.DICTIONARY) || '';
         // Merge the new dictionary entry with existing entries
-        const mergedDictionary = existingDictionary
-            ? `${existingDictionary}\n${trimmedContent}`
-            : trimmedContent;
+        const mergedDictionary = existingDictionary ? `${existingDictionary}\n${trimmedContent}` : trimmedContent;
         // Store the merged dictionary in metadata for debugging and inspection
         const updatedMetadata = {
             ...requirements.metadata,
@@ -25749,19 +25773,37 @@ class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition {
         `);
     }
     applyToAgentModelRequirements(requirements, content) {
-        // We simply mark that browser capability is enabled in metadata
-        // Get existing metadata
-        const existingMetadata = requirements.metadata || {};
         // Get existing tools array or create new one
-        const existingTools = existingMetadata.tools || [];
-        // Add 'browser' to tools if not already present
-        const updatedTools = existingTools.includes('browser') ? existingTools : [...existingTools, 'browser'];
-        // Return requirements with updated metadata
+        const existingTools = requirements.tools || [];
+        // Add 'web_browser' to tools if not already present
+        const updatedTools = existingTools.some((tool) => tool.name === 'web_browser')
+            ? existingTools
+            : [
+                ...existingTools,
+                {
+                    name: 'web_browser',
+                    description: spaceTrim$1(`
+                        A tool that can browse the web.
+                        Use this tool when you need to access specific websites or browse the internet.
+                    `),
+                    parameters: {
+                        type: 'object',
+                        properties: {
+                            url: {
+                                type: 'string',
+                                description: 'The URL to browse',
+                            },
+                        },
+                        required: ['url'],
+                    },
+                },
+            ];
+        // Return requirements with updated tools and metadata
         return {
             ...requirements,
+            tools: updatedTools,
             metadata: {
-                ...existingMetadata,
-                tools: updatedTools,
+                ...requirements.metadata,
                 useBrowser: true,
             },
         };
@@ -25854,13 +25896,13 @@ class UseMcpCommitmentDefinition extends BaseCommitmentDefinition {
  * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
  * to access and retrieve up-to-date information from the internet when necessary.
  *
- * The content following `USE SEARCH ENGINE` is ignored (similar to NOTE).
+ * The content following `USE SEARCH ENGINE` is an arbitrary text that the agent should know (e.g. search scope or instructions).
  *
  * Example usage in agent source:
  *
  * ```book
  * USE SEARCH ENGINE
- * USE SEARCH ENGINE This will be ignored
+ * USE SEARCH ENGINE Hledej informace o Přemyslovcích
  * ```
  *
  * @private [🪔] Maybe export the commitments through some package
@@ -25892,7 +25934,7 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
 
             ## Key aspects
 
-            - The content following \`USE SEARCH ENGINE\` is ignored (similar to NOTE)
+            - The content following \`USE SEARCH ENGINE\` is an arbitrary text that the agent should know (e.g. search scope or instructions).
             - The actual search engine tool usage is handled by the agent runtime
             - Allows the agent to search for current information from the web
             - Useful for research tasks, finding facts, and accessing dynamic content
@@ -25917,20 +25959,39 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
         `);
     }
     applyToAgentModelRequirements(requirements, content) {
-        // We simply mark that search engine capability is enabled in metadata
-        // Get existing metadata
-        const existingMetadata = requirements.metadata || {};
         // Get existing tools array or create new one
-        const existingTools = existingMetadata.tools || [];
-        // Add 'search-engine' to tools if not already present
-        const updatedTools = existingTools.includes('search-engine') ? existingTools : [...existingTools, 'search-engine'];
-        // Return requirements with updated metadata
+        const existingTools = requirements.tools || [];
+        // Add 'web_search' to tools if not already present
+        const updatedTools = existingTools.some((tool) => tool.name === 'web_search')
+            ? existingTools
+            : [
+                ...existingTools,
+                {
+                    name: 'web_search',
+                    description: spaceTrim$1(`
+                        Search the internet for information.
+                        Use this tool when you need to find up-to-date information or facts that you don't know.
+                        ${!content ? '' : `Search scope / instructions: ${content}`}
+                    `),
+                    parameters: {
+                        type: 'object',
+                        properties: {
+                            query: {
+                                type: 'string',
+                                description: 'The search query',
+                            },
+                        },
+                        required: ['query'],
+                    },
+                },
+            ];
+        // Return requirements with updated tools and metadata
         return {
             ...requirements,
+            tools: updatedTools,
             metadata: {
-                ...existingMetadata,
-                tools: updatedTools,
-                useSearchEngine: true,
+                ...requirements.metadata,
+                useSearchEngine: content || true,
             },
         };
     }
@@ -26595,6 +26656,10 @@ function parseAgentSource(agentSource) {
             meta.image = spaceTrim$2(commitment.content);
             continue;
         }
+        if (commitment.type === 'META DESCRIPTION') {
+            meta.description = spaceTrim$2(commitment.content);
+            continue;
+        }
         if (commitment.type === 'META COLOR') {
             meta.color = normalizeSeparator(commitment.content);
             continue;