@promptbook/javascript 0.110.0 → 0.111.0-1

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/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts

@@ -1,12 +1,10 @@
-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';
 /**
  * USE IMAGE GENERATOR commitment definition
  *
- * The `USE IMAGE GENERATOR` commitment indicates that the agent should utilize an image generation tool
- * to create images based on text prompts.
+ * The `USE IMAGE GENERATOR` commitment indicates that the agent can output
+ * markdown placeholders for UI-driven image generation.
  *
  * Example usage in agent source:
  *
@@ -19,6 +17,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  */
 export declare class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition<'USE IMAGE GENERATOR' | 'USE IMAGE GENERATION' | 'IMAGE GENERATOR' | 'IMAGE GENERATION' | 'USE IMAGE'> {
     constructor(type?: 'USE IMAGE GENERATOR' | 'USE IMAGE GENERATION' | 'IMAGE GENERATOR' | 'IMAGE GENERATION' | 'USE IMAGE');
+    get requiresContent(): boolean;
     /**
      * Short one-line description of USE IMAGE GENERATOR.
      */
@@ -32,14 +31,6 @@ export declare class UseImageGeneratorCommitmentDefinition extends BaseCommitmen
      */
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
-    /**
-     * Gets human-readable titles for tool functions provided by this commitment.
-     */
-    getToolTitles(): Record<string_javascript_name, string>;
-    /**
-     * Gets the `generate_image` tool function implementation.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

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/knowledge/simplifyKnowledgeLabel.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Simplifies knowledge labels for UI chips by:
+ * - extracting filename from URL/path-like values,
+ * - removing extension,
+ * - removing trailing random ID segment when detected,
+ * - truncating to 20 characters with ellipsis.
+ *
+ * @param label - Raw knowledge label or source value.
+ * @returns Display-friendly chip label.
+ * @private utility of knowledge/source chip rendering
+ */
+export declare function simplifyKnowledgeLabel(label: string): string;
+/**
+ * Heuristic that classifies a short text as human-readable, identifier-like, or unknown.
+ *
+ * @param text - Candidate value (typically a filename segment).
+ * @returns `'HUMAN'`, `'ID'`, or `'UNKNOWN'`.
+ * @private utility of knowledge/source chip rendering
+ */
+export declare function isHumanOrID(text: string): 'HUMAN' | 'ID' | 'UNKNOWN';

package/esm/typings/src/utils/knowledge/simplifyKnowledgeLabel.test.d.ts

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

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.111.0-0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.110.0",
+    "version": "0.111.0-1",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -97,7 +97,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/javascript.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.110.0"
+        "@promptbook/core": "0.111.0-1"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.110.0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.111.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name