@promptbook/node 0.113.0-8 → 0.114.0-0

package/esm/scripts/run-agent-messages/messages/buildAgentMessagePrompt.d.ts

@@ -1,4 +1,9 @@
+import { type AgentProjectsPromptSectionOptions } from './buildAgentProjectsPromptSection';
+/**
+ * Options adjusting the generated agent message prompt.
+ */
+export type BuildAgentMessagePromptOptions = AgentProjectsPromptSectionOptions;
 /**
  * Builds the prompt sent to the selected coding runner for one queued user-thread book.
  */
-export declare function buildAgentMessagePrompt(messageRelativePath: string, agentSystemMessage: string): string;
+export declare function buildAgentMessagePrompt(messageRelativePath: string, agentSystemMessage: string, options?: BuildAgentMessagePromptOptions): string;

package/esm/scripts/run-agent-messages/messages/buildAgentProjectsPromptSection.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Internal runtime API details available to Agents Server-managed local agents.
+ */
+export type AgentProjectRuntimePromptApi = {
+    /**
+     * Permanent id of the agent currently answering the message.
+     */
+    readonly agentPermanentId: string;
+    /**
+     * Environment variable containing the Agents Server origin.
+     */
+    readonly serverUrlEnvironmentVariableName: string;
+    /**
+     * Environment variable containing the internal worker token.
+     */
+    readonly tokenEnvironmentVariableName: string;
+};
+/**
+ * Options of the projects prompt section shared by every coding harness.
+ */
+export type AgentProjectsPromptSectionOptions = {
+    /**
+     * URL path of the agent projects file endpoint, for example `/agents/<agentId>/projects`.
+     *
+     * When known, the section teaches the agent how to link project files into the chat.
+     */
+    readonly projectsUrlPath?: string;
+    /**
+     * Internal runtime API details, when the agent is managed by Agents Server.
+     */
+    readonly projectRuntimeApi?: AgentProjectRuntimePromptApi;
+};
+/**
+ * Builds the `## Projects` prompt section explaining the agent-owned projects convention.
+ *
+ * The section is part of the prompt of every harness, so each coding agent knows it has its
+ * own isolated project folders it fully controls and how to reference them in the chat.
+ */
+export declare function buildAgentProjectsPromptSection(options?: AgentProjectsPromptSectionOptions): string;

package/esm/scripts/run-codex-prompts/common/parseDuration.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Parses a human-readable duration string into milliseconds.
+ *
+ * Supported formats: `Xh`, `Xm`, `Xs`, and combinations like `1h30m`, `1h30m5s`.
+ *
+ * @returns Duration in milliseconds
+ * @throws When the string does not match any supported format
+ *
+ * @private internal utility of `ptbk coder run`
+ */
+export declare function parseDuration(durationString: string): number;
+/**
+ * Formats a duration in milliseconds into a compact human-readable string.
+ *
+ * Examples: `3600000` → `"1h"`, `90000` → `"1m 30s"`, `5000` → `"5s"`.
+ *
+ * @private internal utility of `ptbk coder run`
+ */
+export declare function formatDurationMs(ms: number): string;

package/esm/scripts/run-codex-prompts/common/waitUntilWorldTimeDeadline.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Callback called before each short sleep while waiting for a wall-clock deadline.
+ */
+export type WorldTimeDeadlineTick = (remainingDurationMs: number) => void | Promise<void>;
+/**
+ * Callback used to perform one wait segment.
+ */
+export type WorldTimeDeadlineWait = (durationMs: number) => Promise<void>;
+/**
+ * Callback that can stop the deadline wait before the wall-clock deadline is reached.
+ */
+export type WorldTimeDeadlineStopCheck = () => boolean;
+/**
+ * Waits until one wall-clock deadline has passed.
+ *
+ * The remaining time is recalculated from `Date.now()` after every poll and after every tick callback.
+ * This makes waits elapse while the process is paused at a checkpoint or the computer is asleep.
+ *
+ * @private internal utility of `ptbk coder` wait handling
+ */
+export declare function waitUntilWorldTimeDeadline(options: {
+    readonly deadlineTimeMs: number;
+    readonly pollIntervalMs: number;
+    readonly onTick?: WorldTimeDeadlineTick;
+    readonly shouldStopWaiting?: WorldTimeDeadlineStopCheck;
+    readonly waitForMilliseconds?: WorldTimeDeadlineWait;
+}): Promise<void>;

package/esm/scripts/run-codex-prompts/runners/claude-code/ClaudeCodeRunner.d.ts

@@ -16,4 +16,8 @@ export declare class ClaudeCodeRunner implements PromptRunner {
      * Runs the prompt using Claude Code and parses usage output.
      */
     runPrompt(options: PromptRunOptions): Promise<PromptRunResult>;
+    /**
+     * Runs one Claude Code CLI process and returns its raw output.
+     */
+    private runClaudeCodeOnce;
 }

package/esm/scripts/run-codex-prompts/runners/claude-code/ClaudeCodeSessionResurrection.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Number of milliseconds added after Claude's reported reset timestamp before retrying.
+ */
+export declare const CLAUDE_CODE_SESSION_LIMIT_RESET_BUFFER_MS: number;
+/**
+ * Fallback delay used when Claude reports a session limit without a machine-readable reset timestamp.
+ */
+export declare const DEFAULT_CLAUDE_CODE_SESSION_LIMIT_RETRY_DELAY_MS: number;
+/**
+ * Session-limit detection details needed to resume a Claude Code run.
+ */
+export type ClaudeCodeSessionLimit = {
+    readonly sessionId: string;
+    readonly resetDate?: Date;
+    readonly rateLimitType?: string;
+    readonly summary: string;
+};
+/**
+ * Extracts a Claude Code session-limit failure from a thrown runner error.
+ */
+export declare function extractClaudeCodeSessionLimitFromError(error: unknown): ClaudeCodeSessionLimit | undefined;
+/**
+ * Extracts a Claude Code session-limit failure from raw stream-json output.
+ */
+export declare function extractClaudeCodeSessionLimitFromOutput(output: string): ClaudeCodeSessionLimit | undefined;
+/**
+ * Computes how long to wait before trying to resume the Claude Code session.
+ */
+export declare function getClaudeCodeSessionLimitDelayMs(sessionLimit: ClaudeCodeSessionLimit, nowMs?: number): number;
+/**
+ * Builds the follow-up prompt sent into a resumed Claude Code session after its limit resets.
+ */
+export declare function buildClaudeCodeSessionResurrectionPrompt(originalPrompt: string, sessionId: string): string;
+/**
+ * Builds a compact one-line label for logs and terminal UI messages.
+ */
+export declare function formatClaudeCodeSessionLimitForDisplay(sessionLimit: ClaudeCodeSessionLimit): string;

package/esm/scripts/run-codex-prompts/runners/claude-code/parseClaudeCodeOutputEvents.d.ts

@@ -0,0 +1,47 @@
+/**
+ * One parsed JSON event emitted by the Claude Code `--output-format stream-json` mode.
+ */
+export type ClaudeCodeOutputEvent = {
+    readonly type?: string;
+    readonly subtype?: string;
+    readonly is_error?: boolean;
+    readonly api_error_status?: number;
+    readonly result?: string;
+    readonly session_id?: string;
+    readonly error?: string;
+    readonly rate_limit_info?: {
+        readonly status?: string;
+        readonly resetsAt?: number;
+        readonly rateLimitType?: string;
+    };
+    readonly usage?: {
+        readonly input_tokens?: number;
+        readonly cache_creation_input_tokens?: number;
+        readonly cache_read_input_tokens?: number;
+        readonly output_tokens?: number;
+        readonly server_tool_use?: {
+            readonly web_search_requests?: number;
+            readonly web_fetch_requests?: number;
+        };
+        readonly service_tier?: string;
+        readonly cache_creation?: {
+            readonly ephemeral_1h_input_tokens?: number;
+            readonly ephemeral_5m_input_tokens?: number;
+        };
+    };
+    readonly total_cost_usd?: number;
+    readonly message?: {
+        readonly content?: ReadonlyArray<{
+            readonly type?: string;
+            readonly text?: string;
+        }>;
+    };
+};
+/**
+ * Parses all JSON lines from Claude Code output while ignoring shell prefixes and stack traces.
+ */
+export declare function parseClaudeCodeOutputEvents(output: string): readonly ClaudeCodeOutputEvent[];
+/**
+ * Finds the final Claude Code result event in a stream-json output blob.
+ */
+export declare function findClaudeCodeResultEvent(output: string): ClaudeCodeOutputEvent | undefined;

package/esm/scripts/run-codex-prompts/runners/openai-codex/parseCodexLoginMethodFromOutput.d.ts

@@ -0,0 +1,10 @@
+import { type CodexLoginMethod } from '../../../../src/book-3.0/codexLoginMethod';
+/**
+ * Detects which login method Codex used from the captured CLI output.
+ *
+ * The generated Codex runner script prints one `CODEX_LOGIN_METHOD_MARKER` line before invoking Codex.
+ * The most recent marker wins so retries within one captured output resolve to the final decision.
+ *
+ * @returns The resolved login method, or `unknown` when no marker is present.
+ */
+export declare function parseCodexLoginMethodFromOutput(output: string): CodexLoginMethod;

package/esm/src/_packages/components.index.d.ts

@@ -69,6 +69,10 @@ import type { ChatParticipant } from '../book-components/Chat/types/ChatParticip
 import type { CitationLabelResolver } from '../book-components/Chat/types/CitationLabelResolver';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
 import { parseMessageButtons } from '../book-components/Chat/utils/parseMessageButtons';
+import type { MarkdownInlineReference } from '../book-components/Chat/utils/renderMarkdown';
+import type { MarkdownInlineReferenceMenuStatus } from '../book-components/Chat/utils/renderMarkdown';
+import type { MarkdownInlineReferenceMenuOption } from '../book-components/Chat/utils/renderMarkdown';
+import type { MarkdownInlineReferenceMenu } from '../book-components/Chat/utils/renderMarkdown';
 import { ArrowIcon } from '../book-components/icons/ArrowIcon';
 import { MicIcon } from '../book-components/icons/MicIcon';
 import { PauseIcon } from '../book-components/icons/PauseIcon';
@@ -154,6 +158,10 @@ export type { ChatParticipant };
 export type { CitationLabelResolver };
 export type { MessageButton };
 export { parseMessageButtons };
+export type { MarkdownInlineReference };
+export type { MarkdownInlineReferenceMenuStatus };
+export type { MarkdownInlineReferenceMenuOption };
+export type { MarkdownInlineReferenceMenu };
 export { ArrowIcon };
 export { MicIcon };
 export { PauseIcon };

package/esm/src/_packages/core.index.d.ts

@@ -22,6 +22,8 @@ import { parseParameters } from '../book-2.0/agent-source/parseParameters';
 import { isValidBook } from '../book-2.0/agent-source/string_book';
 import { validateBook } from '../book-2.0/agent-source/string_book';
 import { DEFAULT_BOOK } from '../book-2.0/agent-source/string_book';
+import type { BookLanguageDocumentationAgent } from '../book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown';
+import type { CreateStandaloneBookLanguageMarkdownOptions } from '../book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown';
 import { createStandaloneBookLanguageMarkdown } from '../book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown';
 import { generatePlaceholderAgentProfileImageUrl } from '../book-2.0/utils/generatePlaceholderAgentProfileImageUrl';
 import { Book } from '../book-3.0/Book';
@@ -258,6 +260,8 @@ export { parseParameters };
 export { isValidBook };
 export { validateBook };
 export { DEFAULT_BOOK };
+export type { BookLanguageDocumentationAgent };
+export type { CreateStandaloneBookLanguageMarkdownOptions };
 export { createStandaloneBookLanguageMarkdown };
 export { generatePlaceholderAgentProfileImageUrl };
 export { Book };

package/esm/src/_packages/types.index.d.ts

@@ -5,6 +5,8 @@ import type { AgentModelRequirements } from '../book-2.0/agent-source/AgentModel
 import type { AgentVisibility } from '../book-2.0/agent-source/agentSourceVisibility';
 import type { CreateAgentModelRequirementsOptions } from '../book-2.0/agent-source/CreateAgentModelRequirementsOptions';
 import type { string_book } from '../book-2.0/agent-source/string_book';
+import type { BookLanguageDocumentationAgent } from '../book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown';
+import type { CreateStandaloneBookLanguageMarkdownOptions } from '../book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown';
 import type { BookNodeAgentSource } from '../book-3.0/BookNodeAgentSource';
 import type { BookNodeAgentSourceOptions } from '../book-3.0/BookNodeAgentSource';
 import type { CliAgentHarness } from '../book-3.0/CliAgent';
@@ -20,8 +22,8 @@ import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProf
 import type { BookEditorUploadProgressCallback } from '../book-components/BookEditor/BookEditor';
 import type { BookEditorUploadOptions } from '../book-components/BookEditor/BookEditor';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
-import type { UploadItem } from '../book-components/BookEditor/useBookEditorMonacoUploads';
-import type { UploadStats } from '../book-components/BookEditor/useBookEditorMonacoUploads';
+import type { UploadItem } from '../book-components/BookEditor/useBookEditorMonacoUploads/bookEditorMonacoUploadTypes';
+import type { UploadStats } from '../book-components/BookEditor/useBookEditorMonacoUploads/bookEditorMonacoUploadTypes';
 import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChatProps';
 import type { AgentChipData } from '../book-components/Chat/AgentChip/AgentChip';
 import type { AgentChipProps } from '../book-components/Chat/AgentChip/AgentChip';
@@ -59,6 +61,10 @@ import type { ChatParticipant } from '../book-components/Chat/types/ChatParticip
 import type { CitationLabelResolver } from '../book-components/Chat/types/CitationLabelResolver';
 import type { ParsedCitation } from '../book-components/Chat/utils/parseCitationsFromContent';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
+import type { MarkdownInlineReference } from '../book-components/Chat/utils/renderMarkdown';
+import type { MarkdownInlineReferenceMenuStatus } from '../book-components/Chat/utils/renderMarkdown';
+import type { MarkdownInlineReferenceMenuOption } from '../book-components/Chat/utils/renderMarkdown';
+import type { MarkdownInlineReferenceMenu } from '../book-components/Chat/utils/renderMarkdown';
 import type { TeamToolResult } from '../book-components/Chat/utils/toolCallParsing/TeamToolResult';
 import type { QrCodeOptions } from '../book-components/Qr/useQrCode';
 import type { AgentCollection } from '../collection/agent-collection/AgentCollection';
@@ -448,6 +454,8 @@ export type { AgentModelRequirements };
 export type { AgentVisibility };
 export type { CreateAgentModelRequirementsOptions };
 export type { string_book };
+export type { BookLanguageDocumentationAgent };
+export type { CreateStandaloneBookLanguageMarkdownOptions };
 export type { BookNodeAgentSource };
 export type { BookNodeAgentSourceOptions };
 export type { CliAgentHarness };
@@ -502,6 +510,10 @@ export type { ChatParticipant };
 export type { CitationLabelResolver };
 export type { ParsedCitation };
 export type { MessageButton };
+export type { MarkdownInlineReference };
+export type { MarkdownInlineReferenceMenuStatus };
+export type { MarkdownInlineReferenceMenuOption };
+export type { MarkdownInlineReferenceMenu };
 export type { TeamToolResult };
 export type { QrCodeOptions };
 export type { AgentCollection };

package/esm/src/avatars/renderAvatarVisualAsciiArt.d.ts

@@ -1,6 +1,7 @@
 import type { AsciiArtColorDepth } from '../utils/ascii-art/convertImageDataToAsciiArt';
+import type { ResolvedAvatarRenderDefinition } from './renderAvatarVisual';
 import type { AvatarDefinition } from './types/AvatarDefinition';
-import type { AvatarVisualId } from './types/AvatarVisualDefinition';
+import type { AvatarSurfaceStyle, AvatarVisualId } from './types/AvatarVisualDefinition';
 /**
  * Default output width of the ASCII avatar in terminal character cells.
  *
@@ -30,6 +31,12 @@ export type RenderAvatarVisualAsciiArtOptions = {
      * Built-in avatar visual to render, the same one used on the website.
      */
     readonly visualId: AvatarVisualId;
+    /**
+     * Surface used to composite the avatar before ASCII conversion.
+     *
+     * @default 'framed'
+     */
+    readonly surface?: AvatarSurfaceStyle;
     /**
      * Output width in terminal character cells.
      *
@@ -54,6 +61,22 @@ export type RenderAvatarVisualAsciiArtOptions = {
      * @default `STATIC_AVATAR_ASCII_ART_FRAME_TIME_MS`
      */
     readonly timeMs?: number;
+    /**
+     * Source canvas width in CSS pixels before ASCII conversion.
+     *
+     * @default `DEFAULT_AVATAR_SIZE`
+     */
+    readonly canvasWidth?: number;
+    /**
+     * Source canvas height in CSS pixels before ASCII conversion.
+     *
+     * @default `DEFAULT_AVATAR_SIZE`
+     */
+    readonly canvasHeight?: number;
+    /**
+     * Optional stable render data reused across frames.
+     */
+    readonly resolvedAvatarRenderDefinition?: ResolvedAvatarRenderDefinition;
     /**
      * Platform-specific canvas factory used to rasterize the visual.
      */

package/esm/src/avatars/visuals/octopus3dAvatarVisualShared.d.ts

@@ -1,5 +1,5 @@
 import type { AvatarPalette } from '../types/AvatarVisualDefinition';
-import { type Point3D, type ProjectedPoint } from './avatar3dProjectionShared';
+import type { Point3D, ProjectedPoint } from './avatar3dProjectionShared';
 /**
  * Eye-style knobs shared by the proper-3D octopus visuals.
  *

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

@@ -81,6 +81,13 @@ export type AgentBasicInformation = {
      * This is the line starting with "INITIAL MESSAGE"
      */
     initialMessage: string | null;
+    /**
+     * Optional custom thinking placeholder variants shown while this agent is composing a reply.
+     *
+     * This is derived from `META THINKING MESSAGE` commitments.
+     * Multiple commitments are preserved as multiple variants.
+     */
+    thinkingMessages?: Array<string>;
     /**
      * Metadata commitments parsed from META lines
      * Each META commitment has the format "META TYPE content"

package/esm/src/book-2.0/agent-source/parseAgentSource/ParsedAgentProfile.d.ts

@@ -4,4 +4,4 @@ import type { AgentBasicInformation } from '../AgentBasicInformation';
  *
  * @private internal utility of `parseAgentSource`
  */
-export type ParsedAgentProfile = Pick<AgentBasicInformation, 'meta' | 'links' | 'capabilities' | 'samples' | 'knowledgeSources'>;
+export type ParsedAgentProfile = Pick<AgentBasicInformation, 'meta' | 'links' | 'capabilities' | 'samples' | 'knowledgeSources' | 'thinkingMessages'>;

package/esm/src/book-2.0/book-language-documentation/BookLanguageDocumentationExample.d.ts

@@ -1,27 +1,19 @@
 /**
  * One end-to-end Book language example used in standalone documentation.
  *
+ * Only the language-neutral Book source lives here. Title, goal, and
+ * walkthrough are translated and therefore kept in
+ * `BookLanguageManualDictionary.exampleTexts`.
+ *
  * @private internal utility of `createStandaloneBookLanguageMarkdown`
  */
 export type BookLanguageDocumentationExample = {
     /**
-     * Stable identifier used for markdown anchors.
+     * Stable identifier used for markdown anchors and translation lookup.
      */
     readonly id: string;
-    /**
-     * Human-readable example title.
-     */
-    readonly title: string;
-    /**
-     * Goal of the example in one short sentence.
-     */
-    readonly goal: string;
     /**
      * Full Book source shown to readers.
      */
     readonly source: string;
-    /**
-     * Step-by-step walkthrough of how the source works.
-     */
-    readonly walkthrough: ReadonlyArray<string>;
 };

package/esm/src/book-2.0/book-language-documentation/BookLanguageManualDictionary.d.ts

@@ -0,0 +1,195 @@
+import type { string_language } from '../../types/string_token';
+/**
+ * One chapter of the standalone Book language manual.
+ *
+ * The heading anchors are intentionally **not** part of the dictionary, so deep
+ * links stay stable across languages.
+ *
+ * @private internal type of `createStandaloneBookLanguageMarkdown`
+ */
+export type BookLanguageManualChapter = {
+    /**
+     * Translated chapter heading.
+     */
+    readonly title: string;
+    /**
+     * Translated chapter body as markdown.
+     */
+    readonly body: string;
+};
+/**
+ * Translated prose of one end-to-end example.
+ *
+ * The Book source of an example is language-neutral and therefore stays in
+ * `bookLanguageDocumentationExamples`.
+ *
+ * @private internal type of `createStandaloneBookLanguageMarkdown`
+ */
+export type BookLanguageManualExampleText = {
+    /**
+     * Translated example heading.
+     */
+    readonly title: string;
+    /**
+     * Translated one-line goal of the example.
+     */
+    readonly goal: string;
+    /**
+     * Translated walkthrough steps explaining the example source.
+     */
+    readonly walkthrough: ReadonlyArray<string>;
+};
+/**
+ * One practical "don't vs do" pitfall item for Book language authoring.
+ *
+ * @private internal type of `createStandaloneBookLanguageMarkdown`
+ */
+export type BookLanguageManualPitfall = {
+    /**
+     * Short pitfall title.
+     */
+    readonly title: string;
+    /**
+     * Description of what to avoid.
+     */
+    readonly dont: string;
+    /**
+     * Practical corrective action.
+     */
+    readonly doInstead: string;
+};
+/**
+ * Every translatable string of the standalone Book language manual.
+ *
+ * Commitment reference bodies are deliberately excluded, because they are the
+ * canonical English specification maintained next to each commitment in
+ * `src/commitments`.
+ *
+ * @private internal type of `createStandaloneBookLanguageMarkdown`
+ */
+export type BookLanguageManualDictionary = {
+    /**
+     * Language code this dictionary is written in.
+     */
+    readonly language: string_language;
+    /**
+     * Manual title used as the top-level heading.
+     */
+    readonly title: string;
+    /**
+     * Blockquote lines rendered directly under the manual title.
+     */
+    readonly introLines: ReadonlyArray<string>;
+    /**
+     * Labels of the generated manual metadata bullets.
+     */
+    readonly metadataLabels: {
+        readonly bookLanguageVersion: string;
+        readonly generatedAt: string;
+        readonly commitmentGroups: string;
+        readonly implementedCommitments: string;
+        readonly placeholderCommitments: string;
+    };
+    /**
+     * Heading of the table of contents.
+     */
+    readonly tableOfContentsTitle: string;
+    /**
+     * Chapters rendered in their canonical order.
+     */
+    readonly chapters: {
+        readonly whatIs: BookLanguageManualChapter;
+        readonly mentalModel: BookLanguageManualChapter;
+        readonly howToStructure: BookLanguageManualChapter;
+        readonly primitives: BookLanguageManualChapter;
+        readonly commitmentCatalog: BookLanguageManualChapter;
+        readonly examples: Pick<BookLanguageManualChapter, 'title'>;
+        readonly pitfalls: Pick<BookLanguageManualChapter, 'title'>;
+        readonly tutorial: BookLanguageManualChapter;
+        readonly lowLevelCommitments: BookLanguageManualChapter;
+    };
+    /**
+     * Sub-sections of the "Mental model of an agent" chapter.
+     */
+    readonly mentalModelSections: {
+        readonly detectedIntro: string;
+        readonly detectedProfileLabel: string;
+        readonly detectedBehaviorLabel: string;
+        readonly detectedToolingLabel: string;
+        readonly detectedCompositionLabel: string;
+        readonly meta: BookLanguageManualChapter;
+        readonly inheritance: BookLanguageManualChapter;
+        readonly composition: BookLanguageManualChapter;
+        readonly capabilities: BookLanguageManualChapter;
+    };
+    /**
+     * Sub-sections of the "Primitives and constructs reference" chapter.
+     */
+    readonly primitivesSections: {
+        readonly coreSyntax: BookLanguageManualChapter;
+        readonly references: BookLanguageManualChapter;
+        readonly keywordsTitle: string;
+    };
+    /**
+     * Suffixes distinguishing a server-specific catalog from the portable one.
+     */
+    readonly commitmentCatalogTitleSuffixes: {
+        readonly usedFirst: string;
+        readonly all: string;
+    };
+    /**
+     * Labels used in every commitment catalog entry.
+     */
+    readonly commitmentLabels: {
+        readonly status: string;
+        readonly aliases: string;
+        readonly semantics: string;
+        readonly typeSchema: string;
+        readonly blockSchema: string;
+        readonly lowLevelNotice: string;
+        readonly usage: string;
+        readonly usageOccurrence: string;
+        readonly usageOccurrences: string;
+        readonly statusImplemented: string;
+        readonly statusPlaceholder: string;
+        readonly noAliases: string;
+    };
+    /**
+     * Labels used by end-to-end example sections.
+     */
+    readonly exampleLabels: {
+        readonly commitmentsUsed: string;
+        readonly fullSource: string;
+        readonly goal: string;
+        readonly walkthrough: string;
+        readonly noCommitments: string;
+    };
+    /**
+     * Translated prose of the portable examples, keyed by example id.
+     */
+    readonly exampleTexts: Readonly<Record<string, BookLanguageManualExampleText>>;
+    /**
+     * Labels used by the "Do nots and common pitfalls" chapter.
+     */
+    readonly pitfallLabels: {
+        readonly dont: string;
+        readonly doInstead: string;
+    };
+    /**
+     * Translated pitfall entries.
+     */
+    readonly pitfalls: ReadonlyArray<BookLanguageManualPitfall>;
+    /**
+     * Closing parts of the "Build an agent from scratch" chapter.
+     */
+    readonly tutorialSections: {
+        readonly serverAgentsHint: string;
+        readonly templateIntro: string;
+        readonly checklistTitle: string;
+        readonly checklistBody: string;
+    };
+    /**
+     * Closing "Generated from" block of the manual.
+     */
+    readonly footer: BookLanguageManualChapter;
+};

package/esm/src/book-2.0/book-language-documentation/bookLanguageDocumentationExamples.d.ts

@@ -3,7 +3,8 @@ import type { BookLanguageDocumentationExample } from './BookLanguageDocumentati
  * End-to-end examples used by the standalone Book language documentation.
  *
  * These are intentionally compact but complete, so they can be copy-pasted and
- * used as practical starting points.
+ * used as practical starting points. Their prose lives in the manual
+ * dictionaries, keyed by the `id` of each example.
  *
  * @private internal utility of `createStandaloneBookLanguageMarkdown`
  */

package/esm/src/book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown.d.ts

@@ -1,4 +1,46 @@
+import type { string_book } from '../agent-source/string_book';
 import type { string_markdown } from '../../types/string_markdown';
+import type { string_language } from '../../types/string_token';
+/**
+ * Agent source incorporated into a server-specific Book language manual.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type BookLanguageDocumentationAgent = {
+    /**
+     * Human-readable title shown above the baked example.
+     */
+    readonly agentName: string;
+    /**
+     * Current Book source used both as an example and to detect used commitments.
+     */
+    readonly agentSource: string_book;
+};
+/**
+ * Optional context used to tailor a standalone Book language manual.
+ *
+ * An empty `agents` array deliberately has the same effect as omitting this
+ * option, which keeps the non-customized manual portable between servers.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type CreateStandaloneBookLanguageMarkdownOptions = {
+    /**
+     * Server agents whose sources should be baked into examples and usage priority.
+     */
+    readonly agents?: ReadonlyArray<BookLanguageDocumentationAgent>;
+    /**
+     * Language the manual should be written in, English is used as the fallback.
+     */
+    readonly language?: string_language;
+    /**
+     * Whether the closing chapter with low-level commitments should be generated.
+     *
+     * Low-level commitments are intended for advanced use only, so they are
+     * omitted unless they are explicitly requested.
+     */
+    readonly isLowLevelCommitmentsIncluded?: boolean;
+};
 /**
  * Creates one standalone markdown guide for Book language (Book 2.0 / agent language).
  *
@@ -11,4 +53,4 @@ import type { string_markdown } from '../../types/string_markdown';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function createStandaloneBookLanguageMarkdown(): string_markdown;
+export declare function createStandaloneBookLanguageMarkdown(options?: CreateStandaloneBookLanguageMarkdownOptions): string_markdown;