@promptbook/components 0.110.0-9 → 0.111.0-0

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

@@ -0,0 +1,75 @@
+/**
+ * Default citation identifier used for simplified citation markers without an explicit position.
+ *
+ * @private utility of `<Chat/>`
+ */
+export declare const DEFAULT_SIMPLIFIED_CITATION_ID = "0:0";
+/**
+ * Parsed citation marker normalized to the full OpenAI-style notation.
+ *
+ * @private utility of `<Chat/>`
+ */
+export type CitationMarker = {
+    /**
+     * Citation identifier (for example `7:15`).
+     */
+    id: string;
+    /**
+     * Citation source filename or label.
+     */
+    source: string;
+    /**
+     * Original marker exactly as found in the content.
+     */
+    raw: string;
+    /**
+     * Full normalized marker (`【id†source】`).
+     */
+    normalized: string;
+};
+/**
+ * Creates a global regular expression that matches citation markers wrapped in `【...】`.
+ *
+ * @private utility of `<Chat/>`
+ */
+export declare function createCitationMarkerRegex(): RegExp;
+/**
+ * Parses one citation marker and normalizes it to full notation.
+ *
+ * @param rawMarker - Marker including outer brackets.
+ * @returns Parsed marker or `null` when the marker is invalid.
+ *
+ * @private utility of `<Chat/>`
+ */
+export declare function parseCitationMarker(rawMarker: string): CitationMarker | null;
+/**
+ * Parses all citation markers from content and normalizes each to full notation.
+ *
+ * @param content - Content that may contain citation markers.
+ * @returns Parsed citation markers in their original order.
+ *
+ * @private utility of `<Chat/>`
+ */
+export declare function parseCitationMarkersFromContent(content: string): CitationMarker[];
+/**
+ * Replaces all citation markers in content using normalized marker metadata.
+ *
+ * @param content - Content that may contain citation markers.
+ * @param replacer - Replacement callback for each valid marker.
+ * @returns Content with citation markers replaced.
+ *
+ * @private utility of `<Chat/>`
+ */
+export declare function replaceCitationMarkers(content: string, replacer: (marker: CitationMarker) => string): string;
+/**
+ * Normalizes simplified citation markers to full notation.
+ *
+ * Example:
+ * - `【document.pdf】` -> `【0:0†document.pdf】`
+ *
+ * @param content - Content that may contain simplified markers.
+ * @returns Content where every citation marker is in full notation.
+ *
+ * @private utility of `<Chat/>`
+ */
+export declare function normalizeCitationMarkersToFullNotation(content: string): string;

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

@@ -22,7 +22,9 @@ export type ParsedCitation = {
 };
 /**
  * Parses OpenAI Assistant-style citations from message content
- * Matches patterns like: 【5:13†document.pdf】
+ * Matches both:
+ * - Full notation: `【5:13†document.pdf】`
+ * - Simplified notation: `【document.pdf】`
  *
  * @param content - The markdown content that may contain citations
  * @returns Array of parsed citations

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

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

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/book-components/icons/ArrowIcon.d.ts

@@ -1,9 +1,22 @@
+/**
+ * Supported arrow directions.
+ *
+ * @private internal typing helper for `<ArrowIcon/>`
+ */
+type ArrowDirection = 'DOWN' | 'UP';
+/**
+ * Props for rendering a directional arrow icon.
+ *
+ * @private internal props typing for `<ArrowIcon/>`
+ */
+type ArrowIconProps = {
+    direction: ArrowDirection;
+    size: number;
+};
 /**
  * Shows simple arrow icon pointing up or down
  *
  * @public exported from `@promptbook/components`
  */
-export declare const ArrowIcon: ({ direction, size }: {
-    direction: string;
-    size: number;
-}) => import("react/jsx-runtime").JSX.Element;
+export declare const ArrowIcon: ({ direction, size }: ArrowIconProps) => import("react/jsx-runtime").JSX.Element;
+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-8`).
+ * It follows semantic versioning (e.g., `0.110.0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/components",
-    "version": "0.110.0-9",
+    "version": "0.111.0-0",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -105,8 +105,10 @@
         "crypto": "1.0.1",
         "crypto-js": "4.2.0",
         "destroyable": "0.12.141",
+        "jspdf": "^4.1.0",
         "katex": "0.16.25",
         "moment": "2.30.1",
+        "monaco-editor": "0.54.0",
         "openai": "6.18.0",
         "papaparse": "5.4.1",
         "qrcode": "1.5.4",