@promptbook/node 0.110.0 → 0.111.0-0

package/esm/typings/src/_packages/utils.index.d.ts

@@ -12,6 +12,12 @@ import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
 import { PromptString } from '../pipeline/prompt-notation';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
+import { CLIENT_VERSION_HEADER } from '../utils/clientVersion';
+import { CLIENT_LATEST_VERSION } from '../utils/clientVersion';
+import { isClientVersionCompatible } from '../utils/clientVersion';
+import { formatClientVersionMismatchMessage } from '../utils/clientVersion';
+import { attachClientVersionHeader } from '../utils/clientVersion';
+import { getClientVersionFromHeaders } from '../utils/clientVersion';
 import { $detectRuntimeEnvironment } from '../utils/environment/$detectRuntimeEnvironment';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInJest } from '../utils/environment/$isRunningInJest';
@@ -103,6 +109,12 @@ export { isValidXmlString };
 export { PromptString };
 export { prompt };
 export { promptTemplate };
+export { CLIENT_VERSION_HEADER };
+export { CLIENT_LATEST_VERSION };
+export { isClientVersionCompatible };
+export { formatClientVersionMismatchMessage };
+export { attachClientVersionHeader };
+export { getClientVersionFromHeaders };
 export { $detectRuntimeEnvironment };
 export { $isRunningInBrowser };
 export { $isRunningInJest };

package/esm/typings/src/book-2.0/agent-source/BookEditable.d.ts

@@ -0,0 +1,41 @@
+import type { string_book } from './string_book';
+/**
+ * Helper for manipulating agent books in-memory.
+ *
+ * @private internal helper for `@promptbook/core`
+ */
+export declare class BookEditable {
+    private readonly lines;
+    /**
+     * Creates a mutable view over the supplied book content.
+     *
+     * @param book - Agent source text to work with.
+     */
+    constructor(book: string_book);
+    /**
+     * Creates a new instance from the supplied book text.
+     *
+     * @param book - Agent source text to work with.
+     * @returns Editable view over the book content.
+     */
+    static from(book: string_book): BookEditable;
+    /**
+     * Returns the editable content as a string_book.
+     *
+     * @returns Current book content with original line breaks preserved.
+     */
+    toString(): string_book;
+    /**
+     * Checks whether the book contains any non-empty lines.
+     *
+     * @returns `true` when the book has meaningful content beyond blank lines.
+     */
+    hasNonEmptyContent(): boolean;
+    /**
+     * Finds the last line index whose trimmed text matches the commitment name.
+     *
+     * @param commitment - Commitment keyword to locate (for example `CLOSED`).
+     * @returns Zero-based line index or `null` when the commitment is absent.
+     */
+    findLastCommitmentLineIndex(commitment: string): number | null;
+}

package/esm/typings/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts

@@ -1,4 +1,5 @@
 import type { AgentReferenceResolver } from './AgentReferenceResolver';
+import type { InlineKnowledgeSourceUploader } from '../../utils/knowledge/inlineKnowledgeSource';
 /**
  * Options for `createAgentModelRequirements` and `createAgentModelRequirementsWithCommitments`.
  *
@@ -9,4 +10,8 @@ export type CreateAgentModelRequirementsOptions = {
      * Resolver that transforms compact agent references (FROM, IMPORT, TEAM) into concrete URLs.
      */
     readonly agentReferenceResolver?: AgentReferenceResolver;
+    /**
+     * Optional hook used to upload inline knowledge files before finalizing the requirements.
+     */
+    readonly inlineKnowledgeSourceUploader?: InlineKnowledgeSourceUploader;
 };

package/esm/typings/src/book-components/Chat/Chat/ImagePromptRenderer.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Props for rendering an interactive image prompt placeholder.
+ *
+ * @private internal component of `<ChatMessageItem/>`
+ */
+export type ImagePromptRendererProps = {
+    /**
+     * Alt text provided by the agent for the image.
+     */
+    alt: string;
+    /**
+     * Prompt text that will be sent to the image generation API.
+     */
+    prompt: string;
+};
+/**
+ * Renders a preview area for the `![alt](?image-prompt=...)` notation.
+ *
+ * @private internal component of `<ChatMessageItem/>`
+ */
+export declare function ImagePromptRenderer({ alt, prompt }: ImagePromptRendererProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/Chat/LlmChat/LlmChatProps.d.ts

@@ -68,6 +68,11 @@ export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'
      * @default Shared thinking message variants
      */
     readonly thinkingMessages?: ReadonlyArray<string>;
+    /**
+     * Human-friendly text shown when `LlmChat` fails to process a message.
+     * Use metadata overrides in apps (like Agents Server) instead of copying this string.
+     */
+    readonly chatFailMessage?: string;
     /**
      * Optional custom error handler that will be called when an error occurs during chat.
      * If not provided, errors will be displayed as messages in the chat.

package/esm/typings/src/book-components/Chat/LlmChat/defaults.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Default user-facing error text shown in chats when the generator fails.
+ *
+ * @private internal fallback for `LlmChat` so the same string can be reused across the stack without repetition.
+ */
+export declare const DEFAULT_CHAT_FAIL_MESSAGE = "Sorry, I encountered an error processing your message. Please, try again later.";
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/Chat/save/_common/ChatSaveFormatDefinition.d.ts

@@ -27,7 +27,7 @@ export type ChatSaveFormatDefinition = {
     /**
      * The function that generates the content of the file to be saved
      */
-    getContent(chatExportData: ChatExportData): Promisable<string>;
+    getContent(chatExportData: ChatExportData): Promisable<ChatSaveFormatContent>;
 };
 /**
  * Plugin contract for the data passed to `ChatSaveFormatDefinition.getContent()`
@@ -48,4 +48,10 @@ type ChatExportData = {
      */
     readonly participants: ReadonlyArray<ChatParticipant>;
 };
+/**
+ * Content data that can be wrapped into a browser blob.
+ *
+ * @private Internal helper type for chat save plugins.
+ */
+type ChatSaveFormatContent = string | Blob | ArrayBuffer | ArrayBufferView;
 export {};

package/esm/typings/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts

@@ -1,3 +1,5 @@
+import type { ChatMessage } from '../../types/ChatMessage';
+import type { ChatParticipant } from '../../types/ChatParticipant';
 /**
  * HTML export plugin
  *
@@ -6,15 +8,14 @@
 export declare const htmlSaveFormatDefinition: {
     readonly formatName: "html";
     readonly label: "Html";
-    readonly getContent: ({ messages }: {
+    readonly getContent: ({ title, messages, participants }: {
         readonly title: string;
-        readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
-        readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
+        readonly messages: readonly ChatMessage[];
+        readonly participants: readonly ChatParticipant[];
     }) => string;
     readonly mimeType: "text/html";
     readonly fileExtension: "html";
 };
 /**
- * TODO: !!! Add QR code with branding to the footer
- *  TODO: [😬] Take chat save to HTML from existing parallel implementation
+ * TODO: Enhance branding
  */

package/esm/typings/src/book-components/Chat/save/index.d.ts

@@ -36,7 +36,7 @@ export declare const CHAT_SAVE_FORMATS: readonly [{
 }, {
     readonly formatName: "html";
     readonly label: "Html";
-    readonly getContent: ({ messages }: {
+    readonly getContent: ({ title, messages, participants }: {
         readonly title: string;
         readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
         readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
@@ -56,11 +56,11 @@ export declare const CHAT_SAVE_FORMATS: readonly [{
 }, {
     readonly formatName: "pdf";
     readonly label: "Pdf";
-    readonly getContent: (chatExportData: {
+    readonly getContent: ({ messages, participants }: {
         readonly title: string;
         readonly messages: readonly import("../types/ChatMessage").ChatMessage[];
         readonly participants: readonly import("../types/ChatParticipant").ChatParticipant[];
-    }) => Promise<string>;
+    }) => Uint8Array;
     readonly mimeType: "application/pdf";
     readonly fileExtension: "pdf";
 }];

package/esm/typings/src/book-components/Chat/save/pdf/buildChatPdf.d.ts

@@ -0,0 +1,11 @@
+import type { ChatMessage } from '../../types/ChatMessage';
+import type { ChatParticipant } from '../../types/ChatParticipant';
+/**
+ * Creates a minimal PDF representation of the provided chat.
+ *
+ * @param messages - Messages that should be included in the PDF export.
+ * @param participants - Optional participant metadata to resolve sender names.
+ * @returns Binary data for the generated PDF file.
+ * @private Internal helper used by `pdfSaveFormatDefinition`.
+ */
+export declare function buildChatPdf(messages: ReadonlyArray<ChatMessage>, participants?: ReadonlyArray<ChatParticipant>): Uint8Array;

package/esm/typings/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts

@@ -6,11 +6,11 @@
 export declare const pdfSaveFormatDefinition: {
     readonly formatName: "pdf";
     readonly label: "Pdf";
-    readonly getContent: (chatExportData: {
+    readonly getContent: ({ messages, participants }: {
         readonly title: string;
         readonly messages: readonly import("../../types/ChatMessage").ChatMessage[];
         readonly participants: readonly import("../../types/ChatParticipant").ChatParticipant[];
-    }) => Promise<string>;
+    }) => Uint8Array;
     readonly mimeType: "application/pdf";
     readonly fileExtension: "pdf";
 };

package/esm/typings/src/book-components/Chat/utils/parseImagePrompts.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Segment representing parts of a chat message that contain either raw text or an image prompt.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type ImagePromptSegment = ImagePromptTextSegment | ImagePromptImageSegment;
+/**
+ * Raw text segment that can be rendered as markdown.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type ImagePromptTextSegment = {
+    type: 'text';
+    content: string;
+};
+/**
+ * Image prompt segment that needs to fire the image generation pipeline.
+ *
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export type ImagePromptImageSegment = {
+    type: 'image';
+    /**
+     * Accessible alt text provided by the agent.
+     */
+    alt: string;
+    /**
+     * Prompt text that will be sent to the image generation API.
+     */
+    prompt: string;
+};
+/**
+ * Splits a chat message into text and image prompt segments.
+ *
+ * @param content - Raw markdown string produced by the agent.
+ * @returns Ordered list of segments that preserves the original message flow.
+ * @private internal helper of `<ChatMessageItem/>`
+ */
+export declare function splitMessageContentByImagePrompts(content: string): ReadonlyArray<ImagePromptSegment>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/Chat/utils/parseImagePrompts.test.d.ts

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

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

@@ -1,5 +1,63 @@
+import { string_javascript_name } from '../../_packages/types.index';
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * Memory record returned by runtime adapters.
+ *
+ * @private internal MEMORY commitment types
+ */
+export type MemoryToolRecord = {
+    id?: string;
+    content: string;
+    isGlobal: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+};
+/**
+ * Runtime context for MEMORY tools resolved from hidden tool arguments.
+ *
+ * @private internal MEMORY commitment types
+ */
+export type MemoryToolRuntimeContext = {
+    readonly enabled: boolean;
+    readonly userId?: number;
+    readonly username?: string;
+    readonly agentId?: string;
+    readonly agentName?: string;
+    readonly isTeamConversation: boolean;
+};
+/**
+ * Runtime adapter interface used by MEMORY tools.
+ *
+ * @private internal MEMORY commitment types
+ */
+export type MemoryToolRuntimeAdapter = {
+    retrieveMemories(args: {
+        query?: string;
+        limit?: number;
+    }, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord[]>;
+    storeMemory(args: {
+        content: string;
+        isGlobal: boolean;
+    }, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord>;
+    updateMemory(args: {
+        memoryId: string;
+        content: string;
+        isGlobal?: boolean;
+    }, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord>;
+    deleteMemory(args: {
+        memoryId: string;
+    }, runtimeContext: MemoryToolRuntimeContext): Promise<{
+        id?: string;
+    }>;
+};
+/**
+ * Sets runtime adapter used by MEMORY commitment tools.
+ *
+ * @private internal runtime wiring for MEMORY commitment
+ */
+export declare function setMemoryToolRuntimeAdapter(adapter: MemoryToolRuntimeAdapter | null): void;
 /**
  * MEMORY commitment definition
  *
@@ -19,6 +77,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  */
 export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
     constructor(type?: 'MEMORY' | 'MEMORIES');
+    get requiresContent(): boolean;
     /**
      * Short one-line description of MEMORY.
      */
@@ -32,6 +91,14 @@ export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition
      */
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets human-readable titles for MEMORY tool functions.
+     */
+    getToolTitles(): Record<string_javascript_name, string>;
+    /**
+     * Gets MEMORY tool function implementations.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

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

package/esm/typings/src/commitments/_common/toolRuntimeContext.d.ts

@@ -0,0 +1,49 @@
+import { TODO_any } from '../../_packages/types.index';
+/**
+ * Prompt parameter key used to pass hidden runtime context to tool execution.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare const TOOL_RUNTIME_CONTEXT_PARAMETER = "promptbookToolRuntimeContext";
+/**
+ * Hidden argument key used to pass runtime context into individual tool calls.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare const TOOL_RUNTIME_CONTEXT_ARGUMENT = "__promptbookToolRuntimeContext";
+/**
+ * Runtime context shape shared across commitment tools.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export type ToolRuntimeContext = {
+    memory?: {
+        enabled?: boolean;
+        userId?: number;
+        username?: string;
+        agentId?: string;
+        agentName?: string;
+        isTeamConversation?: boolean;
+    };
+};
+/**
+ * Parses unknown runtime context payload into a normalized object.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function parseToolRuntimeContext(rawValue: unknown): ToolRuntimeContext | null;
+/**
+ * Reads runtime context attached to tool call arguments.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function readToolRuntimeContextFromToolArgs(args: Record<string, TODO_any>): ToolRuntimeContext | null;
+/**
+ * Serializes runtime context for prompt parameters.
+ *
+ * @private internal runtime wiring for commitment tools
+ */
+export declare function serializeToolRuntimeContext(context: ToolRuntimeContext): string;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/constants/streaming.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Keep-alive helpers used for streaming chat responses.
+ *
+ * These constants coordinate the signal sent by the Agents Server streaming
+ * endpoint and the parser in the SDK so we can distinguish between
+ * real content and occasional pings.
+ *
+ * @private internal streaming helper for Promptbook chat connections
+ */
+export declare const CHAT_STREAM_KEEP_ALIVE_TOKEN = "STREAM_KEEP_ALIVE";
+/**
+ * Interval (milliseconds) between keep-alive pings emitted while the chat server
+ * is still composing the reply.
+ *
+ * @private internal streaming helper for Promptbook chat connections
+ */
+export declare const CHAT_STREAM_KEEP_ALIVE_INTERVAL_MS = 25000;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,9 @@
+/**
+ * Builds a tool invocation script that injects hidden runtime context into tool args.
+ *
+ * @private utility of OpenAI tool execution wrappers
+ */
+export declare function buildToolInvocationScript(options: {
+    readonly functionName: string;
+    readonly functionArgsExpression: string;
+}): string;

package/esm/typings/src/utils/clientVersion.d.ts

@@ -0,0 +1,51 @@
+/**
+ * HTTP header used by Promptbook clients to advertise their release version.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CLIENT_VERSION_HEADER = "x-promptbook-client-version";
+/**
+ * The latest client (engine) version that the server expects.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CLIENT_LATEST_VERSION: string;
+/**
+ * Determines if the provided version string exactly matches the latest release.
+ *
+ * @param version - Version string obtained from a request header.
+ * @returns True when the version equals `CLIENT_LATEST_VERSION`.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isClientVersionCompatible(version: unknown): version is string;
+/**
+ * Formats the message that should be shown when a client is out of date.
+ *
+ * @param clientVersion - The version reported by the client (optional).
+ * @returns User-facing text explaining how to fix the mismatch.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function formatClientVersionMismatchMessage(clientVersion?: string | null): string;
+/**
+ * Creates a headers object that includes the client version header.
+ *
+ * @param headers - Optional base headers to clone.
+ * @returns New headers object augmented with `CLIENT_VERSION_HEADER`.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function attachClientVersionHeader<T extends Record<string, string> = Record<string, string>>(headers?: T): T & Record<typeof CLIENT_VERSION_HEADER, string>;
+/**
+ * Normalizes the client version reported inside a `HeadersInit` object.
+ *
+ * @param headers - Headers collection to read from.
+ * @returns The trimmed client version or `null` when it is missing.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function getClientVersionFromHeaders(headers?: HeadersInit): string | null;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/knowledge/inlineKnowledgeSource.d.ts

@@ -1,20 +1,20 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import type { string_data_url, string_filename } from '../../types/typeAliases';
+import type { string_data_url, string_filename, string_knowledge_source_link } from '../../types/typeAliases';
 /**
- * @@@
- *
- * @private thing of inline knowledge
+ * @private Internal representation of inline knowledge prepared for uploads.
  */
 export type InlineKnowledgeSourceFile = {
     readonly filename: string_filename;
     readonly mimeType: string;
-    readonly url: string_data_url;
+    readonly buffer: Buffer;
 };
 /**
- * Creates a data URL that represents the inline knowledge content as a text file.
- *
- * @private thing of inline knowledge
+ * @private Function signature used to upload inline knowledge files to external storage.
+ */
+export type InlineKnowledgeSourceUploader = (file: InlineKnowledgeSourceFile) => Promise<string_knowledge_source_link>;
+/**
+ * @private Converts inline knowledge into the internal metadata form used for uploads.
  */
 export declare function createInlineKnowledgeSourceFile(content: string): InlineKnowledgeSourceFile;
 /**
@@ -23,10 +23,14 @@ export declare function createInlineKnowledgeSourceFile(content: string): Inline
  * @private thing of inline knowledge
  */
 export declare function isDataUrlKnowledgeSource(source: string): source is string_data_url;
+/**
+ * @private Converts a stored inline knowledge file into a data URL for backwards compatibility.
+ */
+export declare function inlineKnowledgeSourceToDataUrl(source: InlineKnowledgeSourceFile): string_knowledge_source_link;
 /**
  * Parses a data URL-based knowledge source into its raw buffer, filename, and MIME type.
  *
- * @private thing of inline knowledge
+ * @private utility of inline knowledge processing
  */
 export declare function parseDataUrlKnowledgeSource(source: string): {
     readonly buffer: Buffer;

package/esm/typings/src/utils/normalization/constructImageFilename.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Constructs a standardized filename for a generated image based on its prompt and parameters.
+ *
+ * @param params - The parameters for the image generation
+ * @returns The constructed filename
+ *
+ * @private internal helper for image generation pipeline
+ */
+export declare function constructImageFilename(params: {
+    prompt: string;
+    model?: string;
+    size?: string;
+    quality?: string;
+    style?: string;
+    attachments?: Array<{
+        url: string;
+    }>;
+}): string;

package/esm/typings/src/utils/normalization/constructImageFilename.test.d.ts

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

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.110.0-11`).
+ * It follows semantic versioning (e.g., `0.110.0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.110.0",
+    "version": "0.111.0-0",
     "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.110.0"
+        "@promptbook/core": "0.111.0-0"
     },
     "dependencies": {
         "@mozilla/readability": "0.6.0",