@promptbook/cli 0.114.0-3 → 0.114.0-30

package/src/commitments/META_FULLNAME/META_FULLNAME.ts

@@ -0,0 +1,70 @@
+import { spaceTrim } from 'spacetrim';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { TODO_USE } from '../../utils/organization/TODO_USE';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+
+/**
+ * META FULLNAME commitment definition
+ *
+ * The `META FULLNAME` commitment sets the full display name of the agent, which can differ
+ * from the agent name on the first line of the agent source, for example when the agent
+ * should be presented with academic titles.
+ * This commitment is metadata-only and does not modify model requirements.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export class MetaFullnameCommitmentDefinition extends BaseCommitmentDefinition<'META FULLNAME'> {
+    public constructor() {
+        super('META FULLNAME');
+    }
+
+    /**
+     * Short one-line description of META FULLNAME.
+     */
+    get description(): string {
+        return "Set the agent's full display name.";
+    }
+
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string {
+        return '🪪';
+    }
+
+    /**
+     * Markdown documentation for META FULLNAME commitment.
+     */
+    get documentation(): string {
+        return spaceTrim(`
+            # META FULLNAME
+
+            Sets the full display name of the agent shown in profiles, chats, and exports.
+
+            ## Key aspects
+
+            - Does not modify the agent's behavior or responses.
+            - If not present, the agent name from the first line of the agent source is used.
+            - If multiple \`META FULLNAME\` commitments are specified, the last one takes precedence.
+
+            ## Examples
+
+            \`\`\`book
+            Pavol Hejný
+
+            META FULLNAME Dr. Ing. Pavol Hejný, PhD.
+            PERSONA Developer with 10 years of experience in building AI applications.
+            \`\`\`
+        `);
+    }
+
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements {
+        TODO_USE(content);
+
+        // META FULLNAME does not modify the model requirements.
+        // It is consumed by profile parsing.
+        return requirements;
+    }
+}
+
+// Note: [💞] Ignore a discrepancy between file name and entity name

package/src/commitments/META_ID/META_ID.ts

@@ -0,0 +1,78 @@
+import { spaceTrim } from 'spacetrim';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { TODO_USE } from '../../utils/organization/TODO_USE';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+
+/**
+ * META ID commitment definition
+ *
+ * The `META ID` commitment carries the permanent id of the agent when an agent source is moved
+ * between systems. It is a low-level commitment which is normally written and stripped by the
+ * persistence layer instead of being written by hand.
+ * This commitment is metadata-only and does not modify model requirements.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export class MetaIdCommitmentDefinition extends BaseCommitmentDefinition<'META ID'> {
+    public constructor() {
+        super('META ID');
+    }
+
+    /**
+     * Short one-line description of META ID.
+     */
+    get description(): string {
+        return "Set the agent's permanent id.";
+    }
+
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string {
+        return '🔖';
+    }
+
+    /**
+     * `META ID` is written by the persistence layer, not by agent authors.
+     */
+    override get isLowLevel(): boolean {
+        return true;
+    }
+
+    /**
+     * Markdown documentation for META ID commitment.
+     */
+    get documentation(): string {
+        return spaceTrim(`
+            # META ID
+
+            Carries the permanent id of the agent inside the agent source.
+
+            ## Key aspects
+
+            - Does not modify the agent's behavior or responses.
+            - Written and stripped by the persistence layer, it should not be written by hand.
+            - When an agent source without \`META ID\` is stored, a fresh permanent id is assigned.
+            - If multiple \`META ID\` commitments are specified, the last one takes precedence.
+
+            ## Examples
+
+            \`\`\`book
+            My agent
+
+            META ID doQMRg82izNfJa
+            PERSONA My agent is an expert in something.
+            \`\`\`
+        `);
+    }
+
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements {
+        TODO_USE(content);
+
+        // META ID does not modify the model requirements.
+        // It is consumed by profile parsing and agent persistence.
+        return requirements;
+    }
+}
+
+// Note: [💞] Ignore a discrepancy between file name and entity name

package/src/commitments/WRITING_RULES/WRITING_RULES.ts

@@ -6,32 +6,39 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * `WRITING RULES` commitment definition.
  *
- * It adds constraints that apply strictly to writing style and presentation
- * rather than task-solving behavior.
+ * The `WRITING RULES`/`WRITING RULE` commitment adds constraints that apply strictly to writing style
+ * and presentation rather than task-solving behavior.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * WRITING RULES Keep every response under 120 words
+ * WRITING RULE Always end the message with an emoji
+ * ```
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'WRITING RULES'> {
-    public constructor() {
-        super('WRITING RULES');
+export class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'WRITING RULES' | 'WRITING RULE'> {
+    public constructor(type: 'WRITING RULES' | 'WRITING RULE' = 'WRITING RULES') {
+        super(type);
     }
 
     /**
-     * Short one-line description of `WRITING RULES`.
+     * Short one-line description of `WRITING RULES`/`WRITING RULE`.
      */
     public get description(): string {
         return 'Add writing-only constraints such as tone, length, formatting, or emoji usage.';
     }
 
     /**
-     * Icon for `WRITING RULES`.
+     * Icon for `WRITING RULES`/`WRITING RULE`.
      */
     public get icon(): string {
         return '📝';
     }
 
     /**
-     * Markdown documentation for `WRITING RULES`.
+     * Markdown documentation for `WRITING RULES`/`WRITING RULE` commitment.
      */
     public get documentation(): string {
         return spaceTrim(`
@@ -41,6 +48,7 @@ export class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'
 
             ## Key aspects
 
+            - All writing rules are treated equally regardless of singular/plural form.
             - Use it for writing-only constraints such as tone, formatting, length, emoji usage, punctuation, or reading level.
             - Do **not** use it for problem-solving behavior, policy, tool usage, or decision-making logic. Use \`RULE\` for that.
             - Newer writing-rules blocks override conflicting earlier writing-rules blocks.

package/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.ts

@@ -1,61 +1,13 @@
 import { EnvironmentMismatchError } from '../../errors/EnvironmentMismatchError';
 import { $isRunningInNode } from '../../utils/environment/$isRunningInNode';
 import { spaceTrim } from '../../utils/organization/spaceTrim';
-import { fetchUrlContent } from '../USE_BROWSER/fetchUrlContent';
-import { resolveRunBrowserToolForNode } from '../USE_BROWSER/resolveRunBrowserToolForNode';
-import { resolveSendEmailToolForNode } from '../USE_EMAIL/resolveSendEmailToolForNode';
-import { resolveSpawnAgentToolForNode } from '../USE_SPAWN/resolveSpawnAgentToolForNode';
 import type { CommitmentToolFunctions } from './commitmentToolFunctions';
 import { collectCommitmentToolFunctions, createToolFunctionsProxy } from './commitmentToolFunctions';
 
-/**
- * Map of node tool functions.
- */
-const nodeToolFunctions: CommitmentToolFunctions = {
-    /**
-     * @@@
-     *
-     * Note: [??] This function has implementation both for browser and node, this is the full one for node
-     */
-    async fetch_url_content(args: { url: string }): Promise<string> {
-        console.log('!!!! [Tool] fetch_url_content called', { args });
-
-        const { url } = args;
-
-        return await fetchUrlContent(url);
-    },
-
-    /**
-     * @@@
-     *
-     * Note: [??] This function has implementation both for browser and node, this is the server one for node
-     */
-    run_browser: resolveRunBrowserToolForNode(),
-
-    /**
-     * @@@
-     *
-     * Note: [??] This function has implementation both for browser and node, this is the server one for node
-     */
-    send_email: resolveSendEmailToolForNode(),
-
-    /**
-     * @@@
-     *
-     * Note: [??] This function has implementation both for browser and node, this is the server one for node
-     */
-    spawn_agent: resolveSpawnAgentToolForNode(),
-
-    // TODO: !!!! Unhardcode, make proper server function register from definitions
-};
-
 /**
  * Constant for node tool functions proxy.
  */
-const nodeToolFunctionsProxy = createToolFunctionsProxy(() => ({
-    ...collectCommitmentToolFunctions(),
-    ...nodeToolFunctions,
-}));
+const nodeToolFunctionsProxy = createToolFunctionsProxy(collectCommitmentToolFunctions);
 
 /**
  * Gets all function implementations provided by all commitments

package/src/commitments/index.ts

@@ -3,7 +3,6 @@ import type { CommitmentDefinition } from './_base/CommitmentDefinition';
 // Import all commitment definition classes
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
-import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
 import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
@@ -12,19 +11,20 @@ import { GoalCommitmentDefinition } from './GOAL/GOAL';
 import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
 import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
-import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
 import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
 import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
 import { InternalMessageCommitmentDefinition } from './MESSAGE/InternalMessageCommitmentDefinition';
 import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
 import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
 import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
-import { MetaCommitmentDefinition } from './META/META';
 import { MetaAvatarCommitmentDefinition } from './META_AVATAR/META_AVATAR';
 import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
+import { MetaDescriptionCommitmentDefinition } from './META_DESCRIPTION/META_DESCRIPTION';
 import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
 import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
 import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
+import { MetaFullnameCommitmentDefinition } from './META_FULLNAME/META_FULLNAME';
+import { MetaIdCommitmentDefinition } from './META_ID/META_ID';
 import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
 import { MetaInputPlaceholderCommitmentDefinition } from './META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER';
 import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
@@ -41,21 +41,13 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { TeamCommitmentDefinition } from './TEAM/TEAM';
 import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
-import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
 import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
-import { UseDeepSearchCommitmentDefinition } from './USE_DEEPSEARCH/USE_DEEPSEARCH';
-import { UseEmailCommitmentDefinition } from './USE_EMAIL/USE_EMAIL';
 import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
 import { UsePopupCommitmentDefinition } from './USE_POPUP/USE_POPUP';
 import { UsePrivacyCommitmentDefinition } from './USE_PRIVACY/USE_PRIVACY';
 import { UseProjectCommitmentDefinition } from './USE_PROJECT/USE_PROJECT';
-import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
-import { UseSpawnCommitmentDefinition } from './USE_SPAWN/USE_SPAWN';
-import { UseTimeoutCommitmentDefinition } from './USE_TIMEOUT/USE_TIMEOUT';
-import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
 import { UseUserLocationCommitmentDefinition } from './USE_USER_LOCATION/USE_USER_LOCATION';
-import { WalletCommitmentDefinition } from './WALLET/WALLET';
 import { WritingRulesCommitmentDefinition } from './WRITING_RULES/WRITING_RULES';
 import { WritingSampleCommitmentDefinition } from './WRITING_SAMPLE/WRITING_SAMPLE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
@@ -72,8 +64,6 @@ export const COMMITMENT_REGISTRY = [
     new PersonaCommitmentDefinition('PERSONA'),
     new PersonaCommitmentDefinition('PERSONAE'),
     new KnowledgeCommitmentDefinition(),
-    new MemoryCommitmentDefinition('MEMORY'),
-    new MemoryCommitmentDefinition('MEMORIES'),
     new StyleCommitmentDefinition('STYLE'),
     new StyleCommitmentDefinition('STYLES'),
     new RuleCommitmentDefinition('RULE'),
@@ -81,7 +71,8 @@ export const COMMITMENT_REGISTRY = [
     new LanguageCommitmentDefinition('LANGUAGE'),
     new LanguageCommitmentDefinition('LANGUAGES'),
     new WritingSampleCommitmentDefinition(),
-    new WritingRulesCommitmentDefinition(),
+    new WritingRulesCommitmentDefinition('WRITING RULES'),
+    new WritingRulesCommitmentDefinition('WRITING RULE'),
     new SampleCommitmentDefinition('SAMPLE'),
     new SampleCommitmentDefinition('EXAMPLE'),
     new FormatCommitmentDefinition('FORMAT'),
@@ -95,7 +86,6 @@ export const COMMITMENT_REGISTRY = [
     new ModelCommitmentDefinition('MODELS'),
     new ActionCommitmentDefinition('ACTION'),
     new ActionCommitmentDefinition('ACTIONS'),
-    new ComponentCommitmentDefinition(),
     new MetaAvatarCommitmentDefinition(),
     new MetaAvatarCommitmentDefinition('META VISUAL'),
     new MetaImageCommitmentDefinition(),
@@ -103,11 +93,13 @@ export const COMMITMENT_REGISTRY = [
     new MetaFontCommitmentDefinition(),
     new MetaLinkCommitmentDefinition(),
     new MetaDomainCommitmentDefinition(),
+    new MetaDescriptionCommitmentDefinition(),
     new MetaDisclaimerCommitmentDefinition(),
+    new MetaFullnameCommitmentDefinition(),
+    new MetaIdCommitmentDefinition(),
     new MetaInputPlaceholderCommitmentDefinition(),
     new MetaThinkingMessageCommitmentDefinition(),
     new MetaVisibilityCommitmentDefinition(),
-    new MetaCommitmentDefinition(),
     new MetaVoiceCommitmentDefinition(),
     new NoteCommitmentDefinition('NOTE'),
     new NoteCommitmentDefinition('NOTES'),
@@ -123,8 +115,6 @@ export const COMMITMENT_REGISTRY = [
     new MessageSuffixCommitmentDefinition(),
     new MessageCommitmentDefinition('MESSAGE'),
     new MessageCommitmentDefinition('MESSAGES'),
-    new WalletCommitmentDefinition('WALLET'),
-    new WalletCommitmentDefinition('WALLETS'),
     new ScenarioCommitmentDefinition('SCENARIO'),
     new ScenarioCommitmentDefinition('SCENARIOS'),
     new DeleteCommitmentDefinition('DELETE'),
@@ -135,15 +125,8 @@ export const COMMITMENT_REGISTRY = [
     new OpenCommitmentDefinition(),
     new ClosedCommitmentDefinition(),
     new TeamCommitmentDefinition(),
-    new UseBrowserCommitmentDefinition(),
-    new UseDeepSearchCommitmentDefinition(),
-    new UseSearchEngineCommitmentDefinition(),
-    new UseSpawnCommitmentDefinition(),
-    new UseTimeoutCommitmentDefinition(),
-    new UseTimeCommitmentDefinition(),
     new UseUserLocationCommitmentDefinition(),
     new UseCalendarCommitmentDefinition(),
-    new UseEmailCommitmentDefinition(),
     new UsePopupCommitmentDefinition(),
     new UseImageGeneratorCommitmentDefinition('USE IMAGE GENERATOR'),
     new UseMcpCommitmentDefinition(),

package/src/executables/platforms/locateAppOnWindows.ts

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { delimiter, join } from 'path';
 import { assertsError } from '../../errors/assertsError';
 import { $provideFilesystemForNode } from '../../scrapers/_common/register/$provideFilesystemForNode';
 import type { string_executable_path } from '../../types/string_filename';
@@ -6,7 +6,7 @@ import { isExecutable } from '../../utils/files/isExecutable';
 import type { LocateAppOptions } from '../locateApp';
 
 /**
- * Attempts to locate the specified application on a Windows system by searching common installation directories.
+ * Attempts to locate the specified application on a Windows system by searching PATH and common installation directories.
  * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository
@@ -16,18 +16,21 @@ export async function locateAppOnWindows({
     windowsSuffix,
 }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null> {
     try {
-        const prefixes = [
+        const EXECUTABLE_FILENAME = windowsSuffix.replace(/^.*[\\/]/, '');
+        const PATH_EXECUTABLE_PATHS = (process.env.PATH || '')
+            .split(delimiter)
+            .filter(Boolean)
+            .map((pathPrefix) => join(pathPrefix, EXECUTABLE_FILENAME));
+        const INSTALLATION_EXECUTABLE_PATHS = [
             process.env.LOCALAPPDATA,
             join(process.env.LOCALAPPDATA || '', 'Programs'),
             process.env.PROGRAMFILES,
             process.env['PROGRAMFILES(X86)'],
-        ];
+        ].map((pathPrefix) => pathPrefix + windowsSuffix);
 
-        for (const prefix of prefixes) {
-            const path = prefix + windowsSuffix;
-
-            if (await isExecutable(path, $provideFilesystemForNode())) {
-                return path;
+        for (const executablePath of [...PATH_EXECUTABLE_PATHS, ...INSTALLATION_EXECUTABLE_PATHS]) {
+            if (await isExecutable(executablePath, $provideFilesystemForNode())) {
+                return executablePath;
             }
         }
 

package/src/llm-providers/agent/Agent.ts

@@ -101,7 +101,7 @@ export class Agent extends AgentLlmExecutionTools implements LlmExecutionTools,
 
     /**
      * Capabilities of the agent
-     * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+     * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
      */
     public capabilities: Array<AgentCapability> = [];
 

package/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.ts

@@ -33,7 +33,7 @@ import { loadOpenAiAgentsModule } from './utils/loadOpenAiAgentsModule';
 const DEFAULT_DEEP_SEARCH_MODEL_NAME = 'o4-mini-deep-research';
 
 /**
- * Tool name used by the Book commitment-backed DeepSearch capability.
+ * Tool name used by the DeepSearch capability.
  */
 const DEEP_SEARCH_TOOL_NAME = 'deep_search' as string_javascript_name;
 
@@ -375,7 +375,7 @@ export class OpenAiAgentKitExecutionToolsToolBuilder {
     }
 
     /**
-     * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
+     * Creates the native Agent SDK tool used for the DeepSearch capability.
      */
     private async createDeepSearchAgentKitTool(toolDefinition: AgentKitToolDefinition): Promise<AgentKitTool> {
         const { Agent: AgentFromKit, webSearchTool } = await loadOpenAiAgentsModule();

package/src/llm-providers/openai/utils/buildToolInvocationScript.ts

@@ -1,3 +1,4 @@
+import { spaceTrim } from 'spacetrim';
 import {
     TOOL_PROGRESS_TOKEN_ARGUMENT,
     TOOL_PROGRESS_TOKEN_PARAMETER,
@@ -16,26 +17,28 @@ export function buildToolInvocationScript(options: {
 }): string {
     const { functionName, functionArgsExpression } = options;
 
-    return `
-        const args = ${functionArgsExpression};
-        const runtimeContextRaw =
-            typeof ${TOOL_RUNTIME_CONTEXT_PARAMETER} === 'undefined'
-                ? undefined
-                : ${TOOL_RUNTIME_CONTEXT_PARAMETER};
+    return spaceTrim(
+        (block) => `
+            const args = ${block(functionArgsExpression)};
+            const runtimeContextRaw =
+                typeof ${TOOL_RUNTIME_CONTEXT_PARAMETER} === 'undefined'
+                    ? undefined
+                    : ${TOOL_RUNTIME_CONTEXT_PARAMETER};
 
-        if (runtimeContextRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
-            args.${TOOL_RUNTIME_CONTEXT_ARGUMENT} = runtimeContextRaw;
-        }
+            if (runtimeContextRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
+                args.${TOOL_RUNTIME_CONTEXT_ARGUMENT} = runtimeContextRaw;
+            }
 
-        const toolProgressTokenRaw =
-            typeof ${TOOL_PROGRESS_TOKEN_PARAMETER} === 'undefined'
-                ? undefined
-                : ${TOOL_PROGRESS_TOKEN_PARAMETER};
+            const toolProgressTokenRaw =
+                typeof ${TOOL_PROGRESS_TOKEN_PARAMETER} === 'undefined'
+                    ? undefined
+                    : ${TOOL_PROGRESS_TOKEN_PARAMETER};
 
-        if (toolProgressTokenRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
-            args.${TOOL_PROGRESS_TOKEN_ARGUMENT} = toolProgressTokenRaw;
-        }
+            if (toolProgressTokenRaw !== undefined && args && typeof args === 'object' && !Array.isArray(args)) {
+                args.${TOOL_PROGRESS_TOKEN_ARGUMENT} = toolProgressTokenRaw;
+            }
 
-        return await ${functionName}(args);
-    `;
+            return await ${functionName}(args);
+        `,
+    );
 }