@promptbook/core 0.104.0-1 → 0.104.0-3

package/esm/index.es.js

@@ -27,7 +27,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.104.0-1';
+const PROMPTBOOK_ENGINE_VERSION = '0.104.0-3';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -7964,6 +7964,114 @@ class DeleteCommitmentDefinition extends BaseCommitmentDefinition {
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * DICTIONARY commitment definition
+ *
+ * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
+ * in its reasoning and responses. This ensures consistent terminology usage.
+ *
+ * Key features:
+ * - Multiple DICTIONARY commitments are automatically merged into one
+ * - Content is placed in a dedicated section of the system message
+ * - Terms and definitions are stored in metadata.DICTIONARY for debugging
+ * - Agent should use the defined terms correctly in responses
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * Legal Assistant
+ *
+ * PERSONA You are a knowledgeable legal assistant
+ * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+ * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+ * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+class DictionaryCommitmentDefinition extends BaseCommitmentDefinition {
+    constructor() {
+        super('DICTIONARY');
+    }
+    /**
+     * Short one-line description of DICTIONARY.
+     */
+    get description() {
+        return 'Define terms and their meanings for consistent terminology usage.';
+    }
+    /**
+     * Icon for this commitment.
+     */
+    get icon() {
+        return '📚';
+    }
+    /**
+     * Markdown documentation for DICTIONARY commitment.
+     */
+    get documentation() {
+        return spaceTrim$1(`
+            # DICTIONARY
+
+            Defines specific terms and their meanings that the agent should use correctly in reasoning and responses.
+
+            ## Key aspects
+
+            - Multiple \`DICTIONARY\` commitments are merged together.
+            - Terms are defined in the format: "Term is definition"
+            - The agent should use these terms consistently in responses.
+            - Definitions help ensure accurate and consistent terminology.
+
+            ## Examples
+
+            \`\`\`book
+            Legal Assistant
+
+            PERSONA You are a knowledgeable legal assistant specializing in criminal law
+            DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+            DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+            DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+            \`\`\`
+
+            \`\`\`book
+            Medical Assistant
+
+            PERSONA You are a helpful medical assistant
+            DICTIONARY Hypertension is persistently high blood pressure
+            DICTIONARY Diabetes is a chronic condition that affects how the body processes blood sugar
+            DICTIONARY Vaccine is a biological preparation that provides active immunity to a particular disease
+            \`\`\`
+        `);
+    }
+    applyToAgentModelRequirements(requirements, content) {
+        var _a;
+        const trimmedContent = content.trim();
+        if (!trimmedContent) {
+            return requirements;
+        }
+        // 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;
+        // Store the merged dictionary in metadata for debugging and inspection
+        const updatedMetadata = {
+            ...requirements.metadata,
+            DICTIONARY: mergedDictionary,
+        };
+        // Create the dictionary section for the system message
+        // Format: "# DICTIONARY\nTerm: definition\nTerm: definition..."
+        const dictionarySection = `# DICTIONARY\n${mergedDictionary}`;
+        return {
+            ...this.appendToSystemMessage(requirements, dictionarySection),
+            metadata: updatedMetadata,
+        };
+    }
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * FORMAT commitment definition
  *
@@ -10784,6 +10892,7 @@ const COMMITMENT_REGISTRY = [
     new DeleteCommitmentDefinition('CANCEL'),
     new DeleteCommitmentDefinition('DISCARD'),
     new DeleteCommitmentDefinition('REMOVE'),
+    new DictionaryCommitmentDefinition(),
     new OpenCommitmentDefinition(),
     new ClosedCommitmentDefinition(),
     new UseBrowserCommitmentDefinition(),
@@ -10935,17 +11044,64 @@ function parseAgentSourceWithCommitments(agentSource) {
         };
     }
     const lines = agentSource.split('\n');
-    const agentName = (((_a = lines[0]) === null || _a === void 0 ? void 0 : _a.trim()) || null);
+    let agentName = null;
+    let agentNameLineIndex = -1;
+    // Find the agent name: first non-empty line that is not a commitment and not a horizontal line
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        if (line === undefined) {
+            continue;
+        }
+        const trimmed = line.trim();
+        if (!trimmed) {
+            continue;
+        }
+        const isHorizontal = HORIZONTAL_LINE_PATTERN.test(line);
+        if (isHorizontal) {
+            continue;
+        }
+        let isCommitment = false;
+        for (const definition of COMMITMENT_REGISTRY) {
+            const typeRegex = definition.createTypeRegex();
+            const match = typeRegex.exec(trimmed);
+            if (match && ((_a = match.groups) === null || _a === void 0 ? void 0 : _a.type)) {
+                isCommitment = true;
+                break;
+            }
+        }
+        if (!isCommitment) {
+            agentName = trimmed;
+            agentNameLineIndex = i;
+            break;
+        }
+    }
     const commitments = [];
     const nonCommitmentLines = [];
-    // Always add the first line (agent name) to non-commitment lines
-    if (lines[0] !== undefined) {
-        nonCommitmentLines.push(lines[0]);
+    // Add lines before agentName that are horizontal lines (they are non-commitment)
+    for (let i = 0; i < agentNameLineIndex; i++) {
+        const line = lines[i];
+        if (line === undefined) {
+            continue;
+        }
+        const trimmed = line.trim();
+        if (!trimmed) {
+            continue;
+        }
+        const isHorizontal = HORIZONTAL_LINE_PATTERN.test(line);
+        if (isHorizontal) {
+            nonCommitmentLines.push(line);
+        }
+        // Note: Commitments before agentName are not added to nonCommitmentLines
+    }
+    // Add the agent name line to non-commitment lines
+    if (agentNameLineIndex >= 0) {
+        nonCommitmentLines.push(lines[agentNameLineIndex]);
     }
     // Parse commitments with multiline support
     let currentCommitment = null;
-    // Process lines starting from the second line (skip agent name)
-    for (let i = 1; i < lines.length; i++) {
+    // Process lines starting from after the agent name line
+    const startIndex = agentNameLineIndex >= 0 ? agentNameLineIndex + 1 : 0;
+    for (let i = startIndex; i < lines.length; i++) {
         const line = lines[i];
         if (line === undefined) {
             continue;
@@ -11468,13 +11624,14 @@ function prompt(strings, ...values) {
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInBrowser = new Function(`
+function $isRunningInBrowser() {
     try {
-        return this === window;
-    } catch (e) {
+        return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -11486,13 +11643,15 @@ const $isRunningInBrowser = new Function(`
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInJest = new Function(`
+function $isRunningInJest() {
+    var _a;
     try {
-        return process.env.JEST_WORKER_ID !== undefined;
-    } catch (e) {
+        return typeof process !== 'undefined' && ((_a = process.env) === null || _a === void 0 ? void 0 : _a.JEST_WORKER_ID) !== undefined;
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -11504,13 +11663,14 @@ const $isRunningInJest = new Function(`
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInNode = new Function(`
+function $isRunningInNode() {
     try {
-        return this === global;
-    } catch (e) {
+        return typeof process !== 'undefined' && process.versions != null && process.versions.node != null;
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -11522,17 +11682,17 @@ const $isRunningInNode = new Function(`
  *
  * @public exported from `@promptbook/utils`
  */
-const $isRunningInWebWorker = new Function(`
+function $isRunningInWebWorker() {
     try {
-        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {
-            return true;
-        } else {
-            return false;
-        }
-    } catch (e) {
+        // Note: Check for importScripts which is specific to workers
+        //       and not available in the main browser thread
+        return (typeof self !== 'undefined' &&
+            typeof self.importScripts === 'function');
+    }
+    catch (e) {
         return false;
     }
-`);
+}
 /**
  * TODO: [🎺]
  */
@@ -11790,6 +11950,7 @@ function parseAgentSource(agentSource) {
     return {
         agentName: normalizeAgentName(parseResult.agentName || createDefaultAgentName(agentSource)),
         agentHash,
+        permanentId: meta.id,
         personaDescription,
         initialMessage,
         meta,
@@ -11981,6 +12142,41 @@ const DEFAULT_BOOK = padBook(validateBook(spaceTrim$2(`
 //                  <- [🐱‍🚀] Buttons into genesis book
 // <- TODO: [🐱‍🚀] generateBookBoilerplate and deprecate `DEFAULT_BOOK`
 
+/**
+ * Base58 characters
+ */
+const BASE58_ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
+/**
+ * Generates random base58 string
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
+ *
+ * @param length - length of the string
+ * @returns secure random base58 string
+ *
+ * @private internal helper function
+ */
+function $randomBase58(length) {
+    let result = '';
+    while (result.length < length) {
+        // Generate enough bytes to cover the remaining length, plus some extra buffer to reduce calls
+        // But simply generating `length - result.length` is fine for small lengths
+        const bytes = randomBytes(length - result.length);
+        for (let i = 0; i < bytes.length; i++) {
+            const byte = bytes[i];
+            // 58 * 4 = 232
+            // We discard values >= 232 to avoid modulo bias
+            if (byte < 232) {
+                result += BASE58_ALPHABET[byte % 58];
+                if (result.length === length)
+                    break;
+            }
+        }
+    }
+    return result;
+}
+
 // import { getTableName } from '../../../../../apps/agents-server/src/database/getTableName';
 // <- TODO: [🐱‍🚀] Prevent imports from `/apps` -> `/src`
 /**
@@ -12014,19 +12210,20 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
         const { isVerbose = DEFAULT_IS_VERBOSE } = this.options || {};
         const selectResult = await this.supabaseClient
             .from(this.getTableName('Agent'))
-            .select('agentName,agentProfile');
+            .select('agentName,agentProfile,permanentId')
+            .is('deletedAt', null);
         if (selectResult.error) {
             throw new DatabaseError(spaceTrim((block) => `
-                
+
                         Error fetching agents from Supabase:
-                        
+
                         ${block(selectResult.error.message)}
                     `));
         }
         if (isVerbose) {
             console.info(`Found ${selectResult.data.length} agents in directory`);
         }
-        return selectResult.data.map(({ agentName, agentProfile }) => {
+        return selectResult.data.map(({ agentName, agentProfile, permanentId }) => {
             if (isVerbose && agentProfile.agentName !== agentName) {
                 console.warn(spaceTrim(`
                         Agent name mismatch for agent "${agentName}". Using name from database.
@@ -12038,6 +12235,7 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
             return {
                 ...agentProfile,
                 agentName,
+                permanentId: permanentId || agentProfile.permanentId,
             };
         });
     }
@@ -12048,7 +12246,7 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
         const selectResult = await this.supabaseClient
             .from(this.getTableName('Agent'))
             .select('agentSource')
-            .eq('agentName', agentName);
+            .or(`agentName.eq.${agentName},permanentId.eq.${agentName}`);
         if (selectResult.data && selectResult.data.length === 0) {
             throw new NotFoundError(`Agent "${agentName}" not found`);
         }
@@ -12070,12 +12268,26 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
      * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
      */
     async createAgent(agentSource) {
-        const agentProfile = parseAgentSource(agentSource);
+        let agentProfile = parseAgentSource(agentSource);
         //     <- TODO: [🕛]
         const { agentName, agentHash } = agentProfile;
+        let { permanentId } = agentProfile;
+        if (!permanentId) {
+            permanentId = $randomBase58(14);
+            const lines = agentSource.split('\n');
+            if (lines.length > 0) {
+                lines.splice(1, 0, `META ID ${permanentId}`);
+                agentSource = lines.join('\n');
+            }
+            else {
+                agentSource = `META ID ${permanentId}\n${agentSource}`;
+            }
+            agentProfile = parseAgentSource(agentSource);
+        }
         const insertAgentResult = await this.supabaseClient.from(this.getTableName('Agent')).insert({
             agentName,
             agentHash,
+            permanentId,
             agentProfile,
             createdAt: new Date().toISOString(),
             updatedAt: null,
@@ -12099,15 +12311,16 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
             promptbookEngineVersion: PROMPTBOOK_ENGINE_VERSION,
         });
         // <- TODO: [🧠] What to do with `insertAgentHistoryResult.error`, ignore? wait?
-        return agentProfile;
+        return { ...agentProfile, permanentId };
     }
     /**
      * Updates an existing agent in the collection
      */
     async updateAgentSource(agentName, agentSource) {
+        console.log('!!! updateAgentSource', { agentName });
         const selectPreviousAgentResult = await this.supabaseClient
             .from(this.getTableName('Agent'))
-            .select('agentHash,agentName')
+            .select('agentHash,agentName,permanentId')
             .eq('agentName', agentName)
             .single();
         if (selectPreviousAgentResult.error) {
@@ -12121,13 +12334,28 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
         }
         selectPreviousAgentResult.data.agentName;
         const previousAgentHash = selectPreviousAgentResult.data.agentHash;
-        const agentProfile = parseAgentSource(agentSource);
+        const previousPermanentId = selectPreviousAgentResult.data.permanentId;
+        let agentProfile = parseAgentSource(agentSource);
         //     <- TODO: [🕛]
         const { agentHash } = agentProfile;
+        let { permanentId } = agentProfile;
+        if (!permanentId && previousPermanentId) {
+            permanentId = previousPermanentId;
+            const lines = agentSource.split('\n');
+            if (lines.length > 0) {
+                lines.splice(1, 0, `META ID ${permanentId}`);
+                agentSource = lines.join('\n');
+            }
+            else {
+                agentSource = `META ID ${permanentId}\n${agentSource}`;
+            }
+            agentProfile = parseAgentSource(agentSource);
+        }
         const updateAgentResult = await this.supabaseClient
             .from(this.getTableName('Agent'))
             .update({
             // TODO: [🐱‍🚀] Compare not update> agentName: agentProfile.agentName || '[🐱‍🚀]' /* <- TODO: [🐱‍🚀] Remove */,
+            permanentId,
             agentProfile,
             updatedAt: new Date().toISOString(),
             agentHash: agentProfile.agentHash,
@@ -12158,20 +12386,39 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
     // TODO: [🐱‍🚀] public async getAgentSourceSubject(agentName: string_agent_name): Promise<BehaviorSubject<string_book>>
     //            Use Supabase realtime logic
     /**
-     * Deletes an agent from the collection
+     * List agents that are soft deleted (deletedAt IS NOT NULL)
      */
-    async deleteAgent(agentName) {
-        const deleteResult = await this.supabaseClient
+    async listDeletedAgents() {
+        const { isVerbose = DEFAULT_IS_VERBOSE } = this.options || {};
+        const selectResult = await this.supabaseClient
             .from(this.getTableName('Agent'))
-            .delete()
-            .eq('agentName', agentName);
-        if (deleteResult.error) {
+            .select('agentName,agentProfile,permanentId')
+            .not('deletedAt', 'is', null);
+        if (selectResult.error) {
             throw new DatabaseError(spaceTrim((block) => `
-                        Error deleting agent "${agentName}" from Supabase:
-                        
-                        ${block(deleteResult.error.message)}
-                    `));
+                    Error fetching deleted agents from Supabase:
+
+                    ${block(selectResult.error.message)}
+                `));
+        }
+        if (isVerbose) {
+            console.info(`Found ${selectResult.data.length} deleted agents in directory`);
         }
+        return selectResult.data.map(({ agentName, agentProfile, permanentId }) => {
+            if (isVerbose && agentProfile.agentName !== agentName) {
+                console.warn(spaceTrim(`
+                        Agent name mismatch for agent "${agentName}". Using name from database.
+
+                        agentName: "${agentName}"
+                        agentProfile.agentName: "${agentProfile.agentName}"
+                    `));
+            }
+            return {
+                ...agentProfile,
+                agentName,
+                permanentId: permanentId || agentProfile.permanentId,
+            };
+        });
     }
     /**
      * List history of an agent
@@ -12185,71 +12432,70 @@ class AgentCollectionInSupabase /* TODO: [🐱‍🚀] implements Agent */ {
         if (result.error) {
             throw new DatabaseError(spaceTrim((block) => `
                     Error listing history for agent "${agentName}" from Supabase:
-                    
+
                     ${block(result.error.message)}
                 `));
         }
         return result.data;
     }
     /**
-     * List agents that are in history but not in the active agents list
+     * Restore a soft-deleted agent by setting deletedAt to NULL
      */
-    async listDeletedAgents() {
-        const historyNamesResult = await this.supabaseClient.from(this.getTableName('AgentHistory')).select('agentName');
-        const currentNamesResult = await this.supabaseClient.from(this.getTableName('Agent')).select('agentName');
-        if (historyNamesResult.error) {
-            throw new DatabaseError(spaceTrim((block) => `
-                    Error fetching agent history names from Supabase:
-                    
-                    ${block(historyNamesResult.error.message)}
-                `));
-        }
-        if (currentNamesResult.error) {
+    async restoreAgent(agentIdentifier) {
+        const updateResult = await this.supabaseClient
+            .from(this.getTableName('Agent'))
+            .update({ deletedAt: null })
+            .or(`agentName.eq.${agentIdentifier},permanentId.eq.${agentIdentifier}`)
+            .not('deletedAt', 'is', null);
+        if (updateResult.error) {
             throw new DatabaseError(spaceTrim((block) => `
-                    Error fetching current agent names from Supabase:
-                    
-                    ${block(currentNamesResult.error.message)}
+                    Error restoring agent "${agentIdentifier}" from Supabase:
+
+                    ${block(updateResult.error.message)}
                 `));
         }
-        const currentNames = new Set(currentNamesResult.data.map((d) => d.agentName));
-        const deletedNames = new Set();
-        for (const { agentName } of historyNamesResult.data) {
-            if (!currentNames.has(agentName)) {
-                deletedNames.add(agentName);
-            }
-        }
-        return Array.from(deletedNames);
     }
     /**
-     * Restore an agent from history
+     * Restore an agent from a specific history entry
+     *
+     * This will update the current agent with the source from the history entry
      */
-    async restoreAgent(historyId) {
+    async restoreAgentFromHistory(historyId) {
+        // First, get the history entry
         const historyResult = await this.supabaseClient
             .from(this.getTableName('AgentHistory'))
-            .select('*')
+            .select('agentName, agentSource')
             .eq('id', historyId)
             .single();
         if (historyResult.error) {
             throw new DatabaseError(spaceTrim((block) => `
-                    Error fetching agent history item "${historyId}" from Supabase:
-                    
+                    Error fetching history entry with id "${historyId}" from Supabase:
+
                     ${block(historyResult.error.message)}
                 `));
         }
+        if (!historyResult.data) {
+            throw new NotFoundError(`History entry with id "${historyId}" not found`);
+        }
         const { agentName, agentSource } = historyResult.data;
-        // Check if agent exists
-        const agentResult = await this.supabaseClient
+        // Update the agent with the source from the history entry
+        await this.updateAgentSource(agentName, agentSource);
+    }
+    /**
+     * Soft delete an agent by setting deletedAt to current timestamp
+     */
+    async deleteAgent(agentIdentifier) {
+        const updateResult = await this.supabaseClient
             .from(this.getTableName('Agent'))
-            .select('id')
-            .eq('agentName', agentName)
-            .single();
-        if (agentResult.data) {
-            // Update
-            await this.updateAgentSource(agentName, agentSource);
-        }
-        else {
-            // Insert (Restore from deleted)
-            await this.createAgent(agentSource);
+            .update({ deletedAt: new Date().toISOString() })
+            .or(`agentName.eq.${agentIdentifier},permanentId.eq.${agentIdentifier}`)
+            .is('deletedAt', null);
+        if (updateResult.error) {
+            throw new DatabaseError(spaceTrim((block) => `
+                    Error deleting agent "${agentIdentifier}" from Supabase:
+
+                    ${block(updateResult.error.message)}
+                `));
         }
     }
     /**
@@ -16467,7 +16713,7 @@ function $registeredLlmToolsMessage() {
                                 ${i + 1}) **${title}** \`${className}\` from \`${packageName}\`
                                     ${morePieces.join('; ')}
                             `);
-        if ($isRunningInNode) {
+        if ($isRunningInNode()) {
             if (isInstalled && isFullyConfigured) {
                 providerMessage = colors.green(providerMessage);
             }
@@ -17868,7 +18114,7 @@ class OpenAiCompatibleExecutionTools {
         let threadMessages = [];
         if ('thread' in prompt && Array.isArray(prompt.thread)) {
             threadMessages = prompt.thread.map((msg) => ({
-                role: msg.role === 'assistant' ? 'assistant' : 'user',
+                role: msg.sender === 'assistant' ? 'assistant' : 'user',
                 content: msg.content,
             }));
         }