@promptbook/node 0.100.0-3 → 0.100.0-32

package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts

@@ -0,0 +1,24 @@
+import type { AgentBasicInformation } from '../../agent-source/parseAgentSource';
+import type { string_book } from '../../agent-source/string_book';
+import type { AgentSourceParseResult } from './AgentSourceParseResult';
+/**
+ * Parses agent source using the new commitment system with multiline support
+ * This function replaces the hardcoded commitment parsing in the original parseAgentSource
+ *
+ * @private
+ */
+export declare function parseAgentSourceWithCommitments(agentSource: string_book): AgentSourceParseResult;
+/**
+ * Extracts basic information from agent source using the new commitment system
+ * This maintains compatibility with the original parseAgentSource interface
+ *
+ * @private
+ */
+export declare function parseAgentSourceBasicInfo(agentSource: string_book): AgentBasicInformation;
+/**
+ * Extracts META LINK commitments from agent source
+ * Returns an array of all META LINK URLs found in the agent source
+ *
+ * @private
+ */
+export declare function extractMetaLinks(agentSource: string_book): string[];

package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Removes comment lines (lines starting with #) from a system message
+ * This is used to clean up the final system message before sending it to the AI model
+ * while preserving the original content with comments in metadata
+ *
+ * @param systemMessage The system message that may contain comment lines
+ * @returns The system message with comment lines removed
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function removeCommentsFromSystemMessage(systemMessage: string): string;

package/esm/typings/src/book-2.0/commitments/index.d.ts

@@ -0,0 +1,56 @@
+import type { BookCommitment } from './_base/BookCommitment';
+import type { CommitmentDefinition } from './_base/CommitmentDefinition';
+import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
+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 { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
+import { RuleCommitmentDefinition } from './RULE/RULE';
+import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
+import { StyleCommitmentDefinition } from './STYLE/STYLE';
+import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
+/**
+ * Registry of all available commitment definitions
+ * This array contains instances of all commitment definitions
+ * This is the single source of truth for all commitments in the system
+ *
+ * @private Use functions to access commitments instead of this array directly
+ */
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaLinkCommitmentDefinition, NoteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIO">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOAL">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+/**
+ * Gets a commitment definition by its type
+ * @param type The commitment type to look up
+ * @returns The commitment definition or null if not found
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
+/**
+ * Gets all available commitment definitions
+ * @returns Array of all commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
+/**
+ * Gets all available commitment types
+ * @returns Array of all commitment types
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
+/**
+ * Checks if a commitment type is supported
+ * @param type The commitment type to check
+ * @returns True if the commitment type is supported
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isCommitmentSupported(type: BookCommitment): boolean;
+/**
+ * TODO: !!!! Maybe create through standardized $register
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts

@@ -0,0 +1,39 @@
+import type { string_url_image } from '../../types/typeAliases';
+/**
+ * Extracts profile image URL from agent definition text and returns cleaned system message
+ * @param systemMessage The original system message that may contain META IMAGE line
+ * @returns Object with profileImageUrl (if found) and cleanedSystemMessage (without META IMAGE line)
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function extractProfileImageFromSystemMessage(systemMessage: string): {
+    profileImageUrl?: string_url_image;
+    cleanedSystemMessage: string;
+};
+/**
+ * Extracts persona, examples, and profile image from agent definition text
+ * @param systemMessage The original system message that may contain PERSONA, EXAMPLE, and META IMAGE lines
+ * @returns Object with extracted information and cleaned system message
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function extractAgentMetadata(systemMessage: string): {
+    persona?: {
+        name: string;
+        description?: string;
+    };
+    examples: string[];
+    profileImageUrl?: string_url_image;
+    cleanedSystemMessage: string;
+};
+/**
+ * Generates a gravatar URL based on agent name for fallback avatar
+ * @param name The agent name to generate avatar for
+ * @returns Gravatar URL
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function generateGravatarUrl(name?: string | null): string;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -0,0 +1,26 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+export interface BookEditorProps {
+    /**
+     * Additional CSS classes to apply to the editor container.
+     */
+    className?: string;
+    /**
+     * CSS className for a font (e.g. from next/font) to style the editor text.
+     * If omitted, defaults to system serif fonts.
+     */
+    fontClassName?: string;
+    /**
+     * The book which is being edited.
+     */
+    value?: string_book;
+    /**
+     * Callback function to handle changes in the book content.
+     */
+    onChange?: (value: string_book) => void;
+}
+/**
+ * Renders a book editor
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/execution/AvailableModel.d.ts

@@ -40,6 +40,10 @@ export type AvailableModel = {
         readonly prompt: number_usd;
         readonly output: number_usd;
     };
+    /**
+     * If the model is deprecated, it should not be used for new tasks
+     */
+    readonly isDeprecated?: boolean;
 };
 /**
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,10 +1,11 @@
-import type { ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
@@ -46,6 +47,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
      * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * Callback invoked with partial results as the execution progresses.
+     */
+    onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
      * The execution report object, which is updated during execution.
      */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -2,7 +2,6 @@ import Anthropic from '@anthropic-ai/sdk';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -42,10 +41,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      * Calls Anthropic Claude API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
-    /**
-     * Calls Anthropic Claude API to use a completion model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Get the model that should be used as default
      */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`

package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Deepseek models with descriptions
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://www.deepseek.com/models
  * @public exported from `@promptbook/deepseek`

package/esm/typings/src/llm-providers/google/google-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Google models with descriptions
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://ai.google.dev/models/gemini
  * @public exported from `@promptbook/google`

package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts

@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
  * List of available models in Ollama library
  *
- * Note: Done at 2025-05-19
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://ollama.com/library
  * @public exported from `@promptbook/ollama`

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
  * List of available OpenAI models with pricing
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://platform.openai.com/docs/models/
  * @see https://openai.com/api/pricing/

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -1,3 +1,4 @@
+import type { string_book } from '../book-2.0/agent-source/string_book';
 import type { PipelineString } from './PipelineString';
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
@@ -12,7 +13,7 @@ import type { PipelineString } from './PipelineString';
  * @returns the pipeline string
  * @public exported from `@promptbook/core`
  */
-export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -87,8 +87,6 @@ export type CommonModelRequirements = {
     readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
-     *
-     * Note: [🌾]
      */
     readonly maxTokens?: number;
 };

package/esm/typings/src/types/typeAliases.d.ts

@@ -136,6 +136,12 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
  * For example `"Ai*nautes"`
  */
 export type string_title = string;
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ */
+export type string_agent_name = string;
 /**
  * Unstructured description of the persona
  *

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.100.0-2`).
+ * It follows semantic versioning (e.g., `0.100.0-31`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.100.0-3",
+    "version": "0.100.0-32",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -93,7 +93,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-3"
+        "@promptbook/core": "0.100.0-32"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -46,7 +46,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-3';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-32';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3824,7 +3824,7 @@
      */
     async function executeAttempts(options) {
         const { jokerParameterNames, priority, maxAttempts, // <- Note: [💂]
-        preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, } = options;
+        preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, onProgress, } = options;
         const $ongoingTaskResult = {
             $result: null,
             $resultString: null,
@@ -4068,6 +4068,10 @@
                     result: $ongoingTaskResult.$resultString,
                     error: error,
                 });
+                // Report failed attempt
+                onProgress({
+                    errors: [error],
+                });
             }
             finally {
                 if (!isJokerAttempt &&
@@ -5626,7 +5630,23 @@
             //    <- TODO: [🥬] Encapsulate sha256 to some private utility function
             const rootDirname = path.join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
             const filepath = path.join(...nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */), `${basename.substring(0, MAX_FILENAME_LENGTH)}.${mimeTypeToExtension(mimeType)}`);
-            await tools.fs.mkdir(path.dirname(path.join(rootDirname, filepath)), { recursive: true });
+            // Note: Try to create cache directory, but don't fail if filesystem has issues
+            try {
+                await tools.fs.mkdir(path.dirname(path.join(rootDirname, filepath)), { recursive: true });
+            }
+            catch (error) {
+                // Note: If we can't create cache directory, we'll handle it when trying to write the file
+                //       This handles read-only filesystems, permission issues, and missing parent directories
+                if (error instanceof Error && (error.message.includes('EROFS') ||
+                    error.message.includes('read-only') ||
+                    error.message.includes('EACCES') ||
+                    error.message.includes('EPERM') ||
+                    error.message.includes('ENOENT'))) ;
+                else {
+                    // Re-throw other unexpected errors
+                    throw error;
+                }
+            }
             const fileContent = Buffer.from(await response.arrayBuffer());
             if (fileContent.length > DEFAULT_MAX_FILE_SIZE /* <- TODO: Allow to pass different value to remote server */) {
                 throw new LimitReachedError(`File is too large (${Math.round(fileContent.length / 1024 / 1024)}MB). Maximum allowed size is ${Math.round(DEFAULT_MAX_FILE_SIZE / 1024 / 1024)}MB.`);
@@ -5641,7 +5661,8 @@
                 if (error instanceof Error && (error.message.includes('EROFS') ||
                     error.message.includes('read-only') ||
                     error.message.includes('EACCES') ||
-                    error.message.includes('EPERM'))) {
+                    error.message.includes('EPERM') ||
+                    error.message.includes('ENOENT'))) {
                     // Return a handler that works directly with the downloaded content
                     return {
                         source: name,
@@ -11337,8 +11358,27 @@
                 throw new UnexpectedError(`The "${key}" you want to store in JSON file is not serializable as JSON`);
             }
             const fileContent = stringifyPipelineJson(value);
-            await promises.mkdir(path.dirname(filename), { recursive: true }); // <- [0]
-            await promises.writeFile(filename, fileContent, 'utf-8');
+            // Note: Try to create cache directory and write file, but don't fail if filesystem is read-only or has permission issues
+            try {
+                await promises.mkdir(path.dirname(filename), { recursive: true }); // <- [0]
+                await promises.writeFile(filename, fileContent, 'utf-8');
+            }
+            catch (error) {
+                // Note: If we can't write to cache, silently ignore the error
+                //       This handles read-only filesystems, permission issues, and missing parent directories
+                if (error instanceof Error && (error.message.includes('EROFS') ||
+                    error.message.includes('read-only') ||
+                    error.message.includes('EACCES') ||
+                    error.message.includes('EPERM') ||
+                    error.message.includes('ENOENT'))) {
+                    // Silently ignore filesystem errors - caching is optional
+                    return;
+                }
+                else {
+                    // Re-throw other unexpected errors
+                    throw error;
+                }
+            }
         }
         /**
          * Removes the key/value pair with the given key from the storage, if a key/value pair with the given key exists.