@promptbook/types 0.113.0-1 → 0.113.0-10

package/umd/src/conversion/validation/validatePipeline/validatePipelineTasks.d.ts

@@ -0,0 +1,7 @@
+import type { PipelineValidationContext } from './createPipelineValidationContext';
+/**
+ * Validates all pipeline tasks and their per-task invariants.
+ *
+ * @private function of `validatePipeline`
+ */
+export declare function validatePipelineTasks({ pipeline, pipelineIdentification }: PipelineValidationContext): void;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/RegisteredLlmToolsMessageContext.d.ts

@@ -0,0 +1,46 @@
+import type { string_name } from '../../../../types/string_name';
+import type { Registered } from '../../../../utils/misc/$Register';
+import type { LlmToolsMetadata } from '../LlmToolsMetadata';
+/**
+ * Environment variables available for provider resolution.
+ *
+ * @private type of `$registeredLlmToolsMessage`
+ */
+export type AvailableEnvironmentVariables = Record<string_name, string>;
+/**
+ * Mixed provider entry assembled from both provider registers.
+ *
+ * @private type of `$registeredLlmToolsMessage`
+ */
+export type RegisteredLlmToolEntry = Registered & Partial<Pick<LlmToolsMetadata, 'title' | 'envVariables'>>;
+/**
+ * Provider entry enriched with runtime availability and configuration flags.
+ *
+ * @private type of `$registeredLlmToolsMessage`
+ */
+export type RegisteredLlmToolStatus = RegisteredLlmToolEntry & {
+    readonly isMetadataAvailable: boolean;
+    readonly isInstalled: boolean;
+    readonly isFullyConfigured: boolean;
+    readonly isPartiallyConfigured: boolean;
+};
+/**
+ * Provider register snapshots used to build the summary.
+ *
+ * @private type of `$registeredLlmToolsMessage`
+ */
+export type RegisteredLlmToolRegisters = {
+    readonly registeredMetadata: ReadonlyArray<LlmToolsMetadata>;
+    readonly registeredTools: ReadonlyArray<Registered>;
+};
+/**
+ * Message-rendering context for the registered providers summary.
+ *
+ * @private type of `$registeredLlmToolsMessage`
+ */
+export type RegisteredLlmToolsMessageContext = {
+    readonly env: AvailableEnvironmentVariables;
+    readonly llmToolStatuses: ReadonlyArray<RegisteredLlmToolStatus>;
+    readonly usedEnvMessage: string;
+    readonly isRunningInNode: boolean;
+};

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/USED_ENV_FILENAME.d.ts

@@ -0,0 +1,11 @@
+import type { string_filename } from '../../../../types/string_filename';
+import type { $side_effect } from '../../../../utils/organization/$side_effect';
+/**
+ * Shared state for the `.env` file used to configure LLM tools.
+ *
+ * @private internal state of `$registeredLlmToolsMessage`
+ */
+export declare const USED_ENV_FILENAME: {
+    set(filepath: string_filename): $side_effect;
+    createMessage(): string;
+};

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/createRegisteredLlmToolConfigurationStatusMessage.d.ts

@@ -0,0 +1,7 @@
+import type { AvailableEnvironmentVariables, RegisteredLlmToolStatus } from './RegisteredLlmToolsMessageContext';
+/**
+ * Creates the configuration-status sentence for one provider.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function createRegisteredLlmToolConfigurationStatusMessage({ envVariables, isFullyConfigured, isPartiallyConfigured }: RegisteredLlmToolStatus, env: AvailableEnvironmentVariables): string;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/createRegisteredLlmToolEntryKey.d.ts

@@ -0,0 +1,7 @@
+import type { Registered } from '../../../../utils/misc/$Register';
+/**
+ * Creates a deduplication key for a provider entry.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function createRegisteredLlmToolEntryKey({ packageName, className }: Registered): string;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/createRegisteredLlmToolInstallationStatusMessage.d.ts

@@ -0,0 +1,7 @@
+import type { RegisteredLlmToolStatus } from './RegisteredLlmToolsMessageContext';
+/**
+ * Creates the installation-status sentence for one provider.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function createRegisteredLlmToolInstallationStatusMessage({ isMetadataAvailable, isInstalled, }: Pick<RegisteredLlmToolStatus, 'isMetadataAvailable' | 'isInstalled'>): string;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/createRegisteredLlmToolStatus.d.ts

@@ -0,0 +1,14 @@
+import type { Registered } from '../../../../utils/misc/$Register';
+import type { LlmToolsMetadata } from '../LlmToolsMetadata';
+import type { AvailableEnvironmentVariables, RegisteredLlmToolEntry, RegisteredLlmToolStatus } from './RegisteredLlmToolsMessageContext';
+/**
+ * Builds the runtime status for one provider entry.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function createRegisteredLlmToolStatus({ registeredLlmToolEntry, registeredMetadata, registeredTools, env, }: {
+    readonly registeredLlmToolEntry: RegisteredLlmToolEntry;
+    readonly registeredMetadata: ReadonlyArray<LlmToolsMetadata>;
+    readonly registeredTools: ReadonlyArray<Registered>;
+    readonly env: AvailableEnvironmentVariables;
+}): RegisteredLlmToolStatus;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/createRegisteredLlmToolsMessageContext.d.ts

@@ -0,0 +1,7 @@
+import type { RegisteredLlmToolsMessageContext } from './RegisteredLlmToolsMessageContext';
+/**
+ * Collects all state needed to render the provider summary.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function createRegisteredLlmToolsMessageContext(): RegisteredLlmToolsMessageContext;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/getAvailableRegisteredLlmToolsEnvironmentVariables.d.ts

@@ -0,0 +1,7 @@
+import type { AvailableEnvironmentVariables } from './RegisteredLlmToolsMessageContext';
+/**
+ * Reads environment variables relevant for provider configuration.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function getAvailableRegisteredLlmToolsEnvironmentVariables(isRunningInNode: boolean): AvailableEnvironmentVariables;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/getRegisteredLlmToolRegisters.d.ts

@@ -0,0 +1,7 @@
+import type { RegisteredLlmToolRegisters } from './RegisteredLlmToolsMessageContext';
+/**
+ * Takes stable snapshots of both LLM provider registers.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function getRegisteredLlmToolRegisters(): RegisteredLlmToolRegisters;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/hasRegisteredLlmToolEntry.d.ts

@@ -0,0 +1,7 @@
+import type { Registered } from '../../../../utils/misc/$Register';
+/**
+ * Checks whether the given provider entry already exists in the target register list.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function hasRegisteredLlmToolEntry(registeredLlmToolEntries: ReadonlyArray<Registered>, registeredLlmToolEntry: Registered): boolean;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/listRegisteredLlmToolEntries.d.ts

@@ -0,0 +1,9 @@
+import type { Registered } from '../../../../utils/misc/$Register';
+import type { LlmToolsMetadata } from '../LlmToolsMetadata';
+import type { RegisteredLlmToolEntry } from './RegisteredLlmToolsMessageContext';
+/**
+ * Merges provider entries from the metadata and constructor registers.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function listRegisteredLlmToolEntries(registeredMetadata: ReadonlyArray<LlmToolsMetadata>, registeredTools: ReadonlyArray<Registered>): Array<RegisteredLlmToolEntry>;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/listRegisteredLlmToolStatuses.d.ts

@@ -0,0 +1,7 @@
+import type { AvailableEnvironmentVariables, RegisteredLlmToolRegisters, RegisteredLlmToolStatus } from './RegisteredLlmToolsMessageContext';
+/**
+ * Lists provider entries enriched with installation and configuration state.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function listRegisteredLlmToolStatuses({ registeredMetadata, registeredTools }: RegisteredLlmToolRegisters, env: AvailableEnvironmentVariables): Array<RegisteredLlmToolStatus>;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/renderAvailableRegisteredLlmTools.d.ts

@@ -0,0 +1,7 @@
+import type { AvailableEnvironmentVariables, RegisteredLlmToolStatus } from './RegisteredLlmToolsMessageContext';
+/**
+ * Renders all provider lines in the status summary.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function renderAvailableRegisteredLlmTools(llmToolStatuses: ReadonlyArray<RegisteredLlmToolStatus>, env: AvailableEnvironmentVariables, isRunningInNode: boolean): string;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/renderNoRegisteredLlmToolsMessage.d.ts

@@ -0,0 +1,7 @@
+import type { string_markdown } from '../../../../types/string_markdown';
+/**
+ * Renders the fallback message for environments with no registered providers.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function renderNoRegisteredLlmToolsMessage(usedEnvMessage: string): string_markdown;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/renderRegisteredLlmToolsMessage.d.ts

@@ -0,0 +1,8 @@
+import type { string_markdown } from '../../../../types/string_markdown';
+import type { RegisteredLlmToolsMessageContext } from './RegisteredLlmToolsMessageContext';
+/**
+ * Renders the full provider status summary.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function renderRegisteredLlmToolsMessage({ env, llmToolStatuses, usedEnvMessage, isRunningInNode, }: RegisteredLlmToolsMessageContext): string_markdown;

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage/renderRelevantRegisteredLlmToolsEnvironmentVariables.d.ts

@@ -0,0 +1,7 @@
+import type { AvailableEnvironmentVariables, RegisteredLlmToolStatus } from './RegisteredLlmToolsMessageContext';
+/**
+ * Renders the list of environment variables used by at least one registered provider.
+ *
+ * @private function of `$registeredLlmToolsMessage`
+ */
+export declare function renderRelevantRegisteredLlmToolsEnvironmentVariables(env: AvailableEnvironmentVariables, llmToolStatuses: ReadonlyArray<RegisteredLlmToolStatus>): string;

package/umd/src/utils/agent-message-runtime/agentMessageRuntimePaths.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Temporary subdirectory used for agent-message runner shell scripts.
+ *
+ * @private internal constant of agent-message runtime paths
+ */
+export declare const AGENT_MESSAGE_SCRIPT_DIRECTORY_NAME = "agent-messages";
+/**
+ * Builds the temporary shell script path used by one queued agent-message harness run.
+ *
+ * @param projectPath - Local agent project path containing the message queue.
+ * @param sourceFileName - Queued message filename used to name the temporary shell script.
+ * @returns Temporary shell script path.
+ * @private internal utility of agent-message runners
+ */
+export declare function buildAgentMessageScriptPathFromFileName(projectPath: string, sourceFileName: string): string;
+/**
+ * Builds the live runtime log path used by one queued agent-message harness run.
+ *
+ * @param projectPath - Local agent project path containing the message queue.
+ * @param sourceFileName - Queued message filename used to name the temporary shell script.
+ * @returns Temporary live runtime log path.
+ * @private internal utility of agent-message runners
+ */
+export declare function buildAgentMessageRuntimeLogPathFromFileName(projectPath: string, sourceFileName: string): string;

package/umd/src/utils/agents/resolveAgentAvatarImageUrl.d.ts

@@ -39,7 +39,7 @@ export type ResolveAgentAvatarOptions = {
  */
 export type ResolveAgentAvatarImageUrlOptions = ResolveAgentAvatarOptions;
 /**
- * Default built-in avatar visual used when an agent does not define `META IMAGE`.
+ * Default built-in avatar visual used when an agent does not define `META IMAGE`, `META AVATAR`, or `META VISUAL`.
  *
  * @private shared avatar contract
  */
@@ -76,7 +76,7 @@ export declare function resolveAgentAvatarVisualId(agent: ResolveAgentAvatarOpti
 export declare function resolveAgentAvatarFallbackUrl(options: ResolveAgentAvatarOptions): string_url_image | null;
 /**
  * Resolve the best avatar representation for an agent, preferring explicit `META IMAGE`
- * and otherwise returning the default deterministic canvas visual.
+ * and otherwise returning the selected deterministic canvas visual.
  *
  * @private utility of `<Chat/>`
  */

package/umd/src/utils/ascii-art/$detectTerminalAnsiColorDepth.d.ts

@@ -0,0 +1,15 @@
+import type { AsciiArtColorDepth } from './convertImageDataToAsciiArt';
+/**
+ * Detects the ANSI color depth supported by the current terminal.
+ *
+ * Prefers 24-bit true color when the environment advertises it (modern terminals such as
+ * Windows Terminal, ConEmu, VS Code, mintty, iTerm2, and WezTerm) and falls back to the
+ * portable 256-color palette otherwise.
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it reads the process environment
+ *
+ * @returns Color depth usable by `convertImageDataToAsciiArt`
+ *
+ * @private within the repository
+ */
+export declare function $detectTerminalAnsiColorDepth(): AsciiArtColorDepth;

package/umd/src/utils/ascii-art/convertImageDataToAsciiArt.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Color depth of the ANSI escape codes emitted by the ASCII-art conversion.
+ *
+ * - `TRUE_COLOR` emits 24-bit `38;2;r;g;b` / `48;2;r;g;b` sequences
+ * - `ANSI_256` approximates colors on the 256-color ANSI cube for older terminals
+ *
+ * @private within the repository
+ */
+export type AsciiArtColorDepth = 'TRUE_COLOR' | 'ANSI_256';
+/**
+ * Minimal structural subset of the DOM `ImageData` accepted by the ASCII-art conversion.
+ *
+ * Works with browser canvas `ImageData`, `@napi-rs/canvas` image data, or any raw RGBA buffer.
+ *
+ * @private within the repository
+ */
+export type AsciiArtImageData = {
+    /**
+     * Source image width in pixels.
+     */
+    readonly width: number;
+    /**
+     * Source image height in pixels.
+     */
+    readonly height: number;
+    /**
+     * Flat RGBA pixel buffer with 4 bytes per pixel.
+     */
+    readonly data: ArrayLike<number>;
+};
+/**
+ * Options for `convertImageDataToAsciiArt`.
+ *
+ * @private within the repository
+ */
+export type ConvertImageDataToAsciiArtOptions = {
+    /**
+     * Source pixels to convert.
+     */
+    readonly imageData: AsciiArtImageData;
+    /**
+     * Output width in terminal character cells.
+     */
+    readonly columns: number;
+    /**
+     * Output height in terminal character cells.
+     *
+     * Each character cell renders two vertically stacked pixels, so `rows = columns / 2`
+     * keeps a square image visually square in a common terminal font.
+     */
+    readonly rows: number;
+    /**
+     * Color depth of the emitted ANSI escape codes.
+     *
+     * @default 'TRUE_COLOR'
+     */
+    readonly colorDepth?: AsciiArtColorDepth;
+    /**
+     * Alpha channel value (0-255) below which an averaged half-cell is treated as fully transparent.
+     *
+     * @default 32
+     */
+    readonly alphaThreshold?: number;
+};
+/**
+ * Converts raw RGBA image pixels into colored ASCII art for ANSI terminals.
+ *
+ * This is the universal image-to-terminal technique used across the repository:
+ * every output character cell covers a rectangular region of source pixels which is
+ * split into a top and bottom half; each half is area-averaged and rendered with
+ * half-block characters (`▀` / `▄`) so one character shows two "pixels" vertically.
+ * Transparent halves keep the terminal background so non-rectangular images
+ * (for example rounded avatar cards) compose naturally into any terminal UI.
+ *
+ * @param options Source pixels, output grid size, and ANSI color depth.
+ * @returns One ANSI-colored string per output row, each ending with a color reset.
+ *
+ * @private within the repository
+ */
+export declare function convertImageDataToAsciiArt(options: ConvertImageDataToAsciiArtOptions): ReadonlyArray<string>;

package/umd/src/utils/color/Color.d.ts

@@ -1,8 +1,8 @@
 import type { string_color } from '../../types/string_person_fullname';
 import type { string_url_image } from '../../types/string_url_image';
 import type { WithTake } from '../take/interfaces/ITakeChain';
-import { CSS_COLORS } from './css-colors';
 import { ColorValue } from './ColorValue';
+import { CSS_COLORS } from './css-colors';
 /**
  * Color object represents an RGB color with alpha channel
  *

package/umd/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.113.0-0`).
+ * It follows semantic versioning (e.g., `0.113.0-9`).
  *
  * @generated
  */

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

@@ -1,12 +0,0 @@
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;

package/umd/src/book-components/Chat/utils/livePagePreviewConstants.d.ts

@@ -1,12 +0,0 @@
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;