@promptbook/node 0.112.0-25 → 0.112.0-27

package/esm/src/book-2.0/agent-source/createAgentModelRequirements.useCommitmentAggregation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts

@@ -26,45 +26,6 @@ export type HoistedMenuItem = {
      */
     isActive?: boolean;
 };
-/**
- * Shared actions provided to hoisted mobile menu-section renderers.
- *
- * @private mechanism inside Promptbook
- */
-export type HoistedMobileMenuSectionRenderOptions = {
-    /**
-     * Closes the owning mobile header menu.
-     */
-    readonly closeMenu: () => void;
-};
-/**
- * Mobile-only section hoisted into the shared application menu.
- *
- * @private mechanism inside Promptbook
- */
-export type HoistedMobileMenuSection = {
-    /**
-     * Stable identifier used to preserve section open state.
-     */
-    readonly key: string;
-    /**
-     * Visible section label rendered by the mobile menu.
-     */
-    readonly label: ReactNode;
-    /**
-     * Whether the section should start expanded whenever the menu opens.
-     */
-    readonly isDefaultOpen?: boolean;
-    /**
-     * Lazily renders section content inside the mobile header menu.
-     */
-    readonly renderContent: (options: HoistedMobileMenuSectionRenderOptions) => ReactNode;
-};
-/**
- * Value exposed through the shared menu-hoisting context.
- *
- * @private mechanism inside Promptbook
- */
 type MenuHoistingContextType = {
     /**
      * The currently hoisted menu items
@@ -74,14 +35,6 @@ type MenuHoistingContextType = {
      * Set the hoisted menu items
      */
     setMenu: (items: HoistedMenuItem[]) => void;
-    /**
-     * Mobile-only sections hoisted into the shared application menu.
-     */
-    mobileMenuSections: HoistedMobileMenuSection[];
-    /**
-     * Sets the mobile-only hoisted menu sections.
-     */
-    setMobileMenuSections: (sections: HoistedMobileMenuSection[]) => void;
 };
 /**
  * Provider for menu hoisting

package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts

@@ -0,0 +1,30 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import type { ParsedCommitment } from '../_base/ParsedCommitment';
+/**
+ * `USE` commitment types whose system-message sections are aggregated after the
+ * commitment-by-commitment application step.
+ *
+ * @private internal utility of `createAgentModelRequirementsWithCommitments`
+ */
+type AggregatedUseCommitmentType = 'USE BROWSER' | 'USE SEARCH ENGINE' | 'USE TIME';
+/**
+ * Adds the placeholder for an aggregated `USE` system-message section only once, preserving the section position from the first occurrence.
+ *
+ * @param requirements - Current model requirements.
+ * @param type - Aggregated `USE` commitment type being applied.
+ * @returns Requirements with the placeholder inserted when it was not already present.
+ * @private internal utility of `USE` commitments
+ */
+export declare function appendAggregatedUseCommitmentPlaceholder(requirements: AgentModelRequirements, type: AggregatedUseCommitmentType): AgentModelRequirements;
+/**
+ * Replaces temporary `USE` placeholders with one aggregated system-message block per commitment type.
+ *
+ * Distinct additional-instruction blocks are merged in stable source order while the hard-coded section is emitted only once.
+ *
+ * @param requirements - Model requirements produced by commitment-by-commitment application.
+ * @param commitments - Filtered commitments in their original source order.
+ * @returns Requirements with aggregated `USE` system-message sections.
+ * @private internal utility of `createAgentModelRequirementsWithCommitments`
+ */
+export declare function aggregateUseCommitmentSystemMessages(requirements: AgentModelRequirements, commitments: ReadonlyArray<ParsedCommitment>): AgentModelRequirements;
+export {};

package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts

@@ -12,13 +12,14 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  * 1. One-shot URL fetching: Simple function to fetch and scrape URL content
  * 2. Running browser: For complex tasks like scrolling, clicking, form filling, etc.
  *
- * The content following `USE BROWSER` is ignored (similar to NOTE).
+ * The content following `USE BROWSER` is an arbitrary text that the agent should know
+ * (e.g. browsing scope or preferred sources).
  *
  * Example usage in agent source:
  *
  * ```book
  * USE BROWSER
- * USE BROWSER This will be ignored
+ * USE BROWSER Prefer official documentation and source websites.
  * ```
  *
  * @private [🪔] Maybe export the commitments through some package

package/esm/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.112.0-24`).
+ * It follows semantic versioning (e.g., `0.112.0-26`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.112.0-25",
+    "version": "0.112.0-27",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -96,7 +96,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.112.0-25"
+        "@promptbook/core": "0.112.0-27"
     },
     "dependencies": {
         "@mozilla/readability": "0.6.0",

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('fs/promises'), require('path'), require('spacetrim'), require('jszip'), require('crypto'), require('crypto-js'), require('crypto-js/enc-hex'), require('@mozilla/readability'), require('jsdom'), require('showdown'), require('child_process'), require('waitasecond'), require('dotenv'), require('crypto-js/sha256'), require('rxjs'), require('mime-types'), require('moment'), require('papaparse'), require('@openai/agents'), require('bottleneck'), require('openai')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'fs/promises', 'path', 'spacetrim', 'jszip', 'crypto', 'crypto-js', 'crypto-js/enc-hex', '@mozilla/readability', 'jsdom', 'showdown', 'child_process', 'waitasecond', 'dotenv', 'crypto-js/sha256', 'rxjs', 'mime-types', 'moment', 'papaparse', '@openai/agents', 'bottleneck', 'openai'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-node"] = {}, global.colors, global.promises, global.path, global._spaceTrim, global.JSZip, global.crypto, global.cryptoJs, global.hexEncoder, global.readability, global.jsdom, global.showdown, global.child_process, global.waitasecond, global.dotenv, global.sha256, global.rxjs, global.mimeTypes, global.moment, global.papaparse, global.agents, global.Bottleneck, global.OpenAI));
-})(this, (function (exports, colors, promises, path, _spaceTrim, JSZip, crypto, cryptoJs, hexEncoder, readability, jsdom, showdown, child_process, waitasecond, dotenv, sha256, rxjs, mimeTypes, moment, papaparse, agents, Bottleneck, OpenAI) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('fs/promises'), require('path'), require('spacetrim'), require('jszip'), require('crypto'), require('crypto-js'), require('crypto-js/enc-hex'), require('@mozilla/readability'), require('jsdom'), require('showdown'), require('child_process'), require('waitasecond'), require('dotenv'), require('crypto-js/sha256'), require('rxjs'), require('moment'), require('mime-types'), require('papaparse'), require('@openai/agents'), require('bottleneck'), require('openai')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'fs/promises', 'path', 'spacetrim', 'jszip', 'crypto', 'crypto-js', 'crypto-js/enc-hex', '@mozilla/readability', 'jsdom', 'showdown', 'child_process', 'waitasecond', 'dotenv', 'crypto-js/sha256', 'rxjs', 'moment', 'mime-types', 'papaparse', '@openai/agents', 'bottleneck', 'openai'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-node"] = {}, global.colors, global.promises, global.path, global._spaceTrim, global.JSZip, global.crypto, global.cryptoJs, global.hexEncoder, global.readability, global.jsdom, global.showdown, global.child_process, global.waitasecond, global.dotenv, global.sha256, global.rxjs, global.moment, global.mimeTypes, global.papaparse, global.agents, global.Bottleneck, global.OpenAI));
+})(this, (function (exports, colors, promises, path, _spaceTrim, JSZip, crypto, cryptoJs, hexEncoder, readability, jsdom, showdown, child_process, waitasecond, dotenv, sha256, rxjs, moment, mimeTypes, papaparse, agents, Bottleneck, OpenAI) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -48,7 +48,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-25';
+    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-27';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -19196,6 +19196,147 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * All `USE` commitment types currently participating in final system-message aggregation.
+     *
+     * @private internal constant for `aggregateUseCommitmentSystemMessages`
+     */
+    const AGGREGATED_USE_COMMITMENT_TYPES = ['USE BROWSER', 'USE SEARCH ENGINE', 'USE TIME'];
+    /**
+     * Prefix used for temporary in-system-message placeholders that preserve the first-occurrence position of aggregated `USE` sections.
+     *
+     * @private internal constant for `appendAggregatedUseCommitmentPlaceholder`
+     */
+    const AGGREGATED_USE_COMMITMENT_PLACEHOLDER_PREFIX = '# AGGREGATED USE COMMITMENT: ';
+    /**
+     * Type guard for `USE` commitment types that are aggregated in the final system message.
+     *
+     * @param type - Commitment type to check.
+     * @returns `true` when the commitment participates in `USE` system-message aggregation.
+     * @private internal utility of `aggregateUseCommitmentSystemMessages`
+     */
+    function isAggregatedUseCommitmentType(type) {
+        return AGGREGATED_USE_COMMITMENT_TYPES.includes(type);
+    }
+    /**
+     * Creates the placeholder token used to reserve the first-occurrence position of an aggregated `USE` system-message section.
+     *
+     * @param type - Aggregated `USE` commitment type.
+     * @returns Single-line placeholder comment stored in the interim system message.
+     * @private internal utility of `appendAggregatedUseCommitmentPlaceholder`
+     */
+    function getAggregatedUseCommitmentPlaceholder(type) {
+        return `${AGGREGATED_USE_COMMITMENT_PLACEHOLDER_PREFIX}${type}`;
+    }
+    /**
+     * Combines distinct additional instruction blocks in source order.
+     *
+     * @param additionalInstructions - Deduplicated instruction blocks collected from the agent source.
+     * @returns Combined instruction text ready for `formatOptionalInstructionBlock`.
+     * @private internal utility of `createAggregatedUseCommitmentSystemMessage`
+     */
+    function combineAdditionalInstructions(additionalInstructions) {
+        return additionalInstructions.join('\n');
+    }
+    /**
+     * Creates the final aggregated system-message section for a supported `USE` commitment type.
+     *
+     * @param type - Aggregated `USE` commitment type.
+     * @param additionalInstructions - Distinct additional instructions in source order.
+     * @returns Final system-message block for the commitment type.
+     * @private internal utility of `aggregateUseCommitmentSystemMessages`
+     */
+    function createAggregatedUseCommitmentSystemMessage(type, additionalInstructions) {
+        const combinedAdditionalInstructions = combineAdditionalInstructions(additionalInstructions);
+        switch (type) {
+            case 'USE TIME':
+                return _spaceTrim.spaceTrim((block) => `
+                    Time and date context:
+                    - It is ${moment__default["default"]().format('MMMM YYYY')} now.
+                    - If you need more precise current time information, use the tool "get_current_time".
+                    ${block(formatOptionalInstructionBlock('Time instructions', combinedAdditionalInstructions))}
+                `);
+            case 'USE BROWSER':
+                return _spaceTrim.spaceTrim((block) => `
+                    You have access to browser tools to fetch and access content from the internet.
+                    - Use "fetch_url_content" to retrieve content from specific URLs (webpages or documents) using scrapers.
+                    - Use "run_browser" for real interactive browser automation (navigation, clicks, typing, waiting, scrolling).
+                    When you need to know information from a specific website or document, use the fetch_url_content tool.
+                    ${block(formatOptionalInstructionBlock('Browser instructions', combinedAdditionalInstructions))}
+                `);
+            case 'USE SEARCH ENGINE':
+                return _spaceTrim.spaceTrim((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(formatOptionalInstructionBlock('Search instructions', combinedAdditionalInstructions))}
+                `);
+        }
+    }
+    /**
+     * Adds the placeholder for an aggregated `USE` system-message section only once, preserving the section position from the first occurrence.
+     *
+     * @param requirements - Current model requirements.
+     * @param type - Aggregated `USE` commitment type being applied.
+     * @returns Requirements with the placeholder inserted when it was not already present.
+     * @private internal utility of `USE` commitments
+     */
+    function appendAggregatedUseCommitmentPlaceholder(requirements, type) {
+        const placeholder = getAggregatedUseCommitmentPlaceholder(type);
+        if (requirements.systemMessage.includes(placeholder)) {
+            return requirements;
+        }
+        const systemMessage = requirements.systemMessage.trim()
+            ? `${requirements.systemMessage}\n\n${placeholder}`
+            : placeholder;
+        return {
+            ...requirements,
+            systemMessage,
+        };
+    }
+    /**
+     * Replaces temporary `USE` placeholders with one aggregated system-message block per commitment type.
+     *
+     * Distinct additional-instruction blocks are merged in stable source order while the hard-coded section is emitted only once.
+     *
+     * @param requirements - Model requirements produced by commitment-by-commitment application.
+     * @param commitments - Filtered commitments in their original source order.
+     * @returns Requirements with aggregated `USE` system-message sections.
+     * @private internal utility of `createAgentModelRequirementsWithCommitments`
+     */
+    function aggregateUseCommitmentSystemMessages(requirements, commitments) {
+        const additionalInstructionsByType = new Map();
+        for (const commitment of commitments) {
+            if (!isAggregatedUseCommitmentType(commitment.type)) {
+                continue;
+            }
+            let additionalInstructions = additionalInstructionsByType.get(commitment.type);
+            if (!additionalInstructions) {
+                additionalInstructions = [];
+                additionalInstructionsByType.set(commitment.type, additionalInstructions);
+            }
+            const normalizedContent = _spaceTrim.spaceTrim(commitment.content);
+            if (normalizedContent && !additionalInstructions.includes(normalizedContent)) {
+                additionalInstructions.push(normalizedContent);
+            }
+        }
+        let systemMessage = requirements.systemMessage;
+        for (const [type, additionalInstructions] of additionalInstructionsByType) {
+            const placeholder = getAggregatedUseCommitmentPlaceholder(type);
+            if (!systemMessage.includes(placeholder)) {
+                continue;
+            }
+            systemMessage = systemMessage.replace(placeholder, createAggregatedUseCommitmentSystemMessage(type, additionalInstructions));
+        }
+        return {
+            ...requirements,
+            systemMessage,
+        };
+    }
+
     /**
      * Client-side safe wrapper for fetching URL content
      *
@@ -19246,13 +19387,14 @@
      * 1. One-shot URL fetching: Simple function to fetch and scrape URL content
      * 2. Running browser: For complex tasks like scrolling, clicking, form filling, etc.
      *
-     * The content following `USE BROWSER` is ignored (similar to NOTE).
+     * The content following `USE BROWSER` is an arbitrary text that the agent should know
+     * (e.g. browsing scope or preferred sources).
      *
      * Example usage in agent source:
      *
      * ```book
      * USE BROWSER
-     * USE BROWSER This will be ignored
+     * USE BROWSER Prefer official documentation and source websites.
      * ```
      *
      * @private [🪔] Maybe export the commitments through some package
@@ -19290,7 +19432,7 @@
 
             ## Key aspects
 
-            - The content following \`USE BROWSER\` is ignored (similar to NOTE)
+            - The content following \`USE BROWSER\` is an arbitrary text that the agent should know (e.g. browsing scope or preferred sources).
             - Provides two levels of browser access:
               1. **One-shot URL fetching**: Simple function to fetch and scrape URL content (active)
               2. **Running browser**: For complex tasks like scrolling, clicking, form filling, etc. (runtime-dependent)
@@ -19407,20 +19549,14 @@
                 });
             }
             const updatedTools = [...existingTools, ...toolsToAdd];
-            // Return requirements with updated tools and metadata
-            return this.appendToSystemMessage({
+            return appendAggregatedUseCommitmentPlaceholder({
                 ...requirements,
                 tools: updatedTools,
                 _metadata: {
                     ...requirements._metadata,
                     useBrowser: true,
                 },
-            }, _spaceTrim.spaceTrim(`
-                You have access to browser tools to fetch and access content from the internet.
-                - Use "fetch_url_content" to retrieve content from specific URLs (webpages or documents) using scrapers.
-                - Use "run_browser" for real interactive browser automation (navigation, clicks, typing, waiting, scrolling).
-                When you need to know information from a specific website or document, use the fetch_url_content tool.
-            `));
+            }, this.type);
         }
         /**
          * Gets the browser tool function implementations.
@@ -23207,7 +23343,6 @@
         `);
         }
         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
@@ -23220,7 +23355,6 @@
                         description: _spaceTrim.spaceTrim(`
                         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',
@@ -23258,23 +23392,14 @@
                         },
                     },
                 ];
-            // Return requirements with updated tools and metadata
-            return this.appendToSystemMessage({
+            return appendAggregatedUseCommitmentPlaceholder({
                 ...requirements,
                 tools: updatedTools,
                 _metadata: {
                     ...requirements._metadata,
                     useSearchEngine: content || true,
                 },
-            }, _spaceTrim.spaceTrim((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)}
-            `));
+            }, this.type);
         }
         /**
          * Gets human-readable titles for tool functions provided by this commitment.
@@ -24385,7 +24510,6 @@
         `);
         }
         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
@@ -24409,19 +24533,13 @@
                     },
                     // <- TODO: !!!! define the function in LLM tools
                 ];
-            // Return requirements with updated tools and metadata
-            return this.appendToSystemMessage({
+            return appendAggregatedUseCommitmentPlaceholder({
                 ...requirements,
                 tools: updatedTools,
                 _metadata: {
                     ...requirements._metadata,
                 },
-            }, _spaceTrim.spaceTrim((block) => `
-                    Time and date context:
-                    - It is ${moment__default["default"]().format('MMMM YYYY')} now.
-                    - If you need more precise current time information, use the tool "get_current_time".
-                    ${block(extraInstructions)}
-                `));
+            }, this.type);
         }
         /**
          * Gets human-readable titles for tool functions provided by this commitment.
@@ -28077,6 +28195,7 @@
                 }
             }
         }
+        requirements = aggregateUseCommitmentSystemMessages(requirements, filteredCommitments);
         // Handle IMPORT commitments for generic files
         // Note: This logic could be moved to ImportCommitmentDefinition, but it needs to be asynchronous
         if (requirements.importedFileUrls && requirements.importedFileUrls.length > 0) {