@promptbook/vercel 0.103.0-54 → 0.103.0-56

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

@@ -0,0 +1,53 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE commitment definition
+ *
+ * The USE commitment indicates that the agent should utilize specific tools or capabilities
+ * to access and interact with external systems when necessary.
+ *
+ * Supported USE types:
+ * - USE BROWSER: Enables the agent to use a web browser tool
+ * - USE SEARCH ENGINE (future): Enables search engine access
+ * - USE FILE SYSTEM (future): Enables file system operations
+ * - USE MCP (future): Enables MCP server connections
+ *
+ * The content following the USE commitment is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE BROWSER
+ * USE SEARCH ENGINE
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseCommitmentDefinition extends BaseCommitmentDefinition<`USE${string}`> {
+    constructor();
+    /**
+     * Short one-line description of USE commitments.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the tool type from the USE commitment
+     * This is used by the parsing logic
+     */
+    extractToolType(content: string): string | null;
+    /**
+     * Checks if this is a known USE type
+     */
+    isKnownUseType(useType: string): boolean;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,38 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE BROWSER commitment definition
+ *
+ * The `USE BROWSER` commitment indicates that the agent should utilize a web browser tool
+ * to access and retrieve up-to-date information from the internet when necessary.
+ *
+ * The content following `USE BROWSER` is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE BROWSER
+ * USE BROWSER This will be ignored
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition<'USE BROWSER'> {
+    constructor();
+    /**
+     * Short one-line description of USE BROWSER.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE BROWSER commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

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

package/esm/typings/src/commitments/USE_MCP/USE_MCP.d.ts

@@ -0,0 +1,37 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE MCP commitment definition
+ *
+ * The `USE MCP` commitment allows to specify an MCP server URL which the agent will connect to
+ * for retrieving additional instructions and actions.
+ *
+ * The content following `USE MCP` is the URL of the MCP server.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE MCP http://mcp-server-url.com
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseMcpCommitmentDefinition extends BaseCommitmentDefinition<'USE MCP'> {
+    constructor();
+    /**
+     * Short one-line description of USE MCP.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE MCP commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts

@@ -0,0 +1,38 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE SEARCH ENGINE commitment definition
+ *
+ * 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).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE SEARCH ENGINE
+ * USE SEARCH ENGINE This will be ignored
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
+    constructor();
+    /**
+     * Short one-line description of USE SEARCH ENGINE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE SEARCH ENGINE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/index.d.ts

@@ -1,10 +1,14 @@
 import type { BookCommitment } from './_base/BookCommitment';
 import type { CommitmentDefinition } from './_base/CommitmentDefinition';
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
+import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
 import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { FromCommitmentDefinition } from './FROM/FROM';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
 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';
@@ -12,14 +16,21 @@ import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
 import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
 import { MetaCommitmentDefinition } from './META/META';
 import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
+import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
 import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
+import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
 import { ModelCommitmentDefinition } from './MODEL/MODEL';
 import { NoteCommitmentDefinition } from './NOTE/NOTE';
+import { OpenCommitmentDefinition } from './OPEN/OPEN';
 import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
 import { RuleCommitmentDefinition } from './RULE/RULE';
 import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
 import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
+import { UseCommitmentDefinition } from './USE/USE';
+import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
+import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
+import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
 /**
  * Registry of all available commitment definitions
@@ -28,7 +39,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

package/esm/typings/src/playground/playground.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/utils/color/Color.d.ts

@@ -24,6 +24,14 @@ export declare class Color {
      * @returns Color object
      */
     static from(color: string_color | Color): WithTake<Color>;
+    /**
+     * Creates a new Color instance from miscellaneous formats
+     * It just does not throw error when it fails, it returns PROMPTBOOK_COLOR instead
+     *
+     * @param color
+     * @returns Color object
+     */
+    static fromSafe(color: string_color | Color): WithTake<Color>;
     /**
      * Creates a new Color instance from miscellaneous string formats
      *

package/esm/typings/src/utils/color/css-colors.d.ts

@@ -4,6 +4,7 @@
  * @public exported from `@promptbook/color`
  */
 export declare const CSS_COLORS: {
+    readonly promptbook: "#79EAFD";
     readonly transparent: "rgba(0,0,0,0)";
     readonly aliceblue: "#f0f8ff";
     readonly antiquewhite: "#faebd7";

package/esm/typings/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.103.0-53`).
+ * It follows semantic versioning (e.g., `0.103.0-55`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/vercel",
-    "version": "0.103.0-54",
+    "version": "0.103.0-56",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -87,14 +87,14 @@
     },
     "homepage": "https://ptbk.io/",
     "engines": {
-        "node": ">=16.0.0",
+        "node": ">=18.18.0",
         "npm": ">=8.0.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-54"
+        "@promptbook/core": "0.103.0-56"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -1,13 +1,13 @@
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('spacetrim'), require('crypto')) :
     typeof define === 'function' && define.amd ? define(['exports', 'colors', 'spacetrim', 'crypto'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-vercel"] = {}, global.colors, global.spaceTrim, global.crypto));
-})(this, (function (exports, colors, spaceTrim, crypto) { 'use strict';
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-vercel"] = {}, global.colors, global.spaceTrim$1, global.crypto));
+})(this, (function (exports, colors, spaceTrim$1, crypto) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
-    var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
+    var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim$1);
 
     // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
     /**
@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-56';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -596,6 +596,17 @@
         return new Date().toISOString();
     }
 
+    /**
+     * Trims string from all 4 sides
+     *
+     * Note: This is a re-exported function from the `spacetrim` package which is
+     *       Developed by same author @hejny as this package
+     *
+     * @public exported from `@promptbook/utils`
+     * @see https://github.com/hejny/spacetrim#usage
+     */
+    const spaceTrim = spaceTrim$1.spaceTrim;
+
     /**
      * @private util of `@promptbook/color`
      * @de
@@ -644,6 +655,7 @@
      * @public exported from `@promptbook/color`
      */
     const CSS_COLORS = {
+        promptbook: '#79EAFD',
         transparent: 'rgba(0,0,0,0)',
         aliceblue: '#f0f8ff',
         antiquewhite: '#faebd7',
@@ -859,6 +871,28 @@
                 throw new Error(`Can not create color from given object`);
             }
         }
+        /**
+         * Creates a new Color instance from miscellaneous formats
+         * It just does not throw error when it fails, it returns PROMPTBOOK_COLOR instead
+         *
+         * @param color
+         * @returns Color object
+         */
+        static fromSafe(color) {
+            try {
+                return Color.from(color);
+            }
+            catch (error) {
+                // <- Note: Can not use `assertsError(error)` here because it causes circular dependency
+                console.warn(spaceTrim((block) => `
+                        Color.fromSafe error:
+                        ${block(error.message)}
+
+                        Returning default PROMPTBOOK_COLOR.
+                    `));
+                return Color.fromString('promptbook');
+            }
+        }
         /**
          * Creates a new Color instance from miscellaneous string formats
          *
@@ -1448,7 +1482,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
+    const PROMPTBOOK_COLOR = Color.fromString('promptbook');
     // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
     /**
      * Colors for syntax highlighting in the `<BookEditor/>`
@@ -1600,7 +1634,7 @@
      */
     class UnexpectedError extends Error {
         constructor(message) {
-            super(spaceTrim.spaceTrim((block) => `
+            super(spaceTrim$1.spaceTrim((block) => `
                     ${block(message)}
 
                     Note: This error should not happen.
@@ -1626,7 +1660,7 @@
         constructor(whatWasThrown) {
             const tag = `[🤮]`;
             console.error(tag, whatWasThrown);
-            super(spaceTrim.spaceTrim(`
+            super(spaceTrim$1.spaceTrim(`
                 Non-Error object was thrown
 
                 Note: Look for ${tag} in the console for more details