@promptbook/utils 0.100.0-6 → 0.100.0-64

package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts

@@ -0,0 +1,22 @@
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
+/**
+ * Placeholder commitment definition for commitments that are not yet implemented
+ *
+ * This commitment simply adds its content 1:1 into the system message,
+ * preserving the original behavior until proper implementation is added.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class NotYetImplementedCommitmentDefinition<TBookCommitment extends string> extends BaseCommitmentDefinition<TBookCommitment> {
+    constructor(type: TBookCommitment);
+    /**
+     * Short one-line description of a placeholder commitment.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation available at runtime.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}

package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts

@@ -0,0 +1,19 @@
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * Creates an empty/basic agent model requirements object
+ * This serves as the starting point for the reduce-like pattern
+ * where each commitment applies its changes to build the final requirements
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function createEmptyAgentModelRequirements(): AgentModelRequirements;
+/**
+ * Creates a basic agent model requirements with just the agent name
+ * This is used when we have an agent name but no commitments
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function createBasicAgentModelRequirements(agentName: string | null): AgentModelRequirements;
+/**
+ * TODO: !!! Deduplicate `AgentModelRequirements` and `ModelRequirements` model requirements
+ */

package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts

@@ -0,0 +1,37 @@
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+/**
+ * Model requirements for an agent
+ *
+ * This is like "compiled" version of agent source
+ */
+export interface AgentModelRequirements {
+    /**
+     * The system message that defines the agent's behavior and personality
+     */
+    readonly systemMessage: string;
+    /**
+     * The model name to use for this agent
+     */
+    readonly modelName: string;
+    /**
+     * Optional list of MCP servers that the agent can connect to
+     */
+    readonly mcpServers?: string[];
+    /**
+     * Temperature for the agent's responses, controlling randomness
+     */
+    readonly temperature?: number;
+    /**
+     * Top-p sampling value for the agent's responses
+     */
+    readonly topP?: number;
+    /**
+     * Top-k sampling value for the agent's responses
+     */
+    readonly topK?: number;
+    /**
+     * Arbitrary metadata storage for commitments
+     * Each commitment can store its own data here
+     */
+    readonly metadata?: Record<string, TODO_any>;
+}

package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts

@@ -0,0 +1,18 @@
+import type { ParsedCommitment } from './ParsedCommitment';
+/**
+ * Result of parsing agent source for commitments
+ */
+export interface AgentSourceParseResult {
+    /**
+     * The agent name (first line)
+     */
+    agentName: string | null;
+    /**
+     * All parsed commitments
+     */
+    commitments: ParsedCommitment[];
+    /**
+     * Lines that are not commitments (for system message)
+     */
+    nonCommitmentLines: string[];
+}

package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts

@@ -0,0 +1,22 @@
+import type { BookCommitment } from '../_base/BookCommitment';
+/**
+ * Parsed commitment line from agent source
+ */
+export interface ParsedCommitment {
+    /**
+     * The commitment type (e.g., 'PERSONA', 'KNOWLEDGE')
+     */
+    type: BookCommitment;
+    /**
+     * The content part of the commitment
+     */
+    content: string;
+    /**
+     * The original line from the agent source
+     */
+    originalLine: string;
+    /**
+     * Line number in the agent source (1-based)
+     */
+    lineNumber: number;
+}

package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts

@@ -0,0 +1,62 @@
+import type { string_model_name } from '../../../types/typeAliases';
+import type { string_book } from '../../agent-source/string_book';
+import type { AgentModelRequirements } from './AgentModelRequirements';
+/**
+ * Creates model requirements for an agent based on its source
+ * Results are cached to improve performance for repeated calls with the same agentSource and modelName
+ *
+ * There are 2 similar functions:
+ * - `parseAgentSource` which is a lightweight parser for agent source, it parses basic information and its purpose is to be quick and synchronous. The commitments there are hardcoded.
+ * - `createAgentModelRequirements` which is an asynchronous function that creates model requirements it applies each commitment one by one and works asynchronously.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function createAgentModelRequirements(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
+/**
+ * Clears the cache for createAgentModelRequirements
+ * Useful when agent sources are updated and cached results should be invalidated
+ *
+ * @private
+ */
+export declare function clearAgentModelRequirementsCache(): void;
+/**
+ * Removes cache entries for a specific agent source (all model variants)
+ * @param agentSource The agent source to remove from cache
+ * @private
+ */
+export declare function invalidateAgentModelRequirementsCache(agentSource: string_book): void;
+/**
+ * Gets the current cache size (for debugging/monitoring)
+ *
+ * @private
+ */
+export declare function getAgentModelRequirementsCacheSize(): number;
+/**
+ * Extracts MCP servers from agent source
+ *
+ * @param agentSource The agent source string that may contain MCP lines
+ * @returns Array of MCP server identifiers
+ *
+ * @private TODO: [🧠] Maybe should be public
+ */
+export declare function extractMcpServers(agentSource: string_book): string[];
+/**
+ * Creates a system message for an agent based on its source
+ * @deprecated Use createAgentModelRequirements instead
+ * @private
+ */
+export declare function createAgentSystemMessage(agentSource: string_book): Promise<string>;
+/**
+ * Extracts the agent name from the first line of the agent source
+ * @deprecated Use parseAgentSource instead
+ * @private
+ */
+export declare function extractAgentName(agentSource: string_book): string;
+/**
+ * Extracts the profile image URL from agent source or returns gravatar fallback
+ * @param agentSource The agent source string that may contain META IMAGE line
+ * @returns Profile image URL (from source or gravatar fallback)
+ * @deprecated Use parseAgentSource instead
+ * @private
+ */
+export declare function extractAgentProfileImage(agentSource: string_book): string;

package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts

@@ -0,0 +1,36 @@
+import type { string_model_name } from '../../../types/typeAliases';
+import type { string_book } from '../../agent-source/string_book';
+import type { AgentModelRequirements } from './AgentModelRequirements';
+/**
+ * Creates agent model requirements using the new commitment system
+ * This function uses a reduce-like pattern where each commitment applies its changes
+ * to build the final requirements starting from a basic empty model
+ *
+ * @private
+ */
+export declare function createAgentModelRequirementsWithCommitments(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
+/**
+ * Cached version of createAgentModelRequirementsWithCommitments
+ * This maintains the same caching behavior as the original function
+ *
+ * @private
+ */
+export declare function createAgentModelRequirementsWithCommitmentsCached(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
+/**
+ * Clears the cache for createAgentModelRequirementsWithCommitments
+ *
+ * @private
+ */
+export declare function clearAgentModelRequirementsWithCommitmentsCache(): void;
+/**
+ * Removes cache entries for a specific agent source
+ *
+ * @private
+ */
+export declare function invalidateAgentModelRequirementsWithCommitmentsCache(agentSource: string_book): void;
+/**
+ * Gets the current cache size
+ *
+ * @private
+ */
+export declare function getAgentModelRequirementsWithCommitmentsCacheSize(): number;

package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts

@@ -0,0 +1,20 @@
+import type { BookCommitment } from '../_base/BookCommitment';
+/**
+ * Generates a regex pattern to match a specific commitment
+ *
+ * Note: It always creates new Regex object
+ * Note: Uses word boundaries to ensure only full words are matched (e.g., "PERSONA" matches but "PERSONALITY" does not)
+ *
+ * @private
+ */
+export declare function createCommitmentRegex(commitment: BookCommitment): RegExp;
+/**
+ * Generates a regex pattern to match a specific commitment type
+ *
+ * Note: It just matches the type part of the commitment
+ * Note: It always creates new Regex object
+ * Note: Uses word boundaries to ensure only full words are matched (e.g., "PERSONA" matches but "PERSONALITY" does not)
+ *
+ * @private
+ */
+export declare function createCommitmentTypeRegex(commitment: BookCommitment): RegExp;

package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts

@@ -0,0 +1,24 @@
+import type { AgentBasicInformation } from '../../agent-source/parseAgentSource';
+import type { string_book } from '../../agent-source/string_book';
+import type { AgentSourceParseResult } from './AgentSourceParseResult';
+/**
+ * Parses agent source using the new commitment system with multiline support
+ * This function replaces the hardcoded commitment parsing in the original parseAgentSource
+ *
+ * @private
+ */
+export declare function parseAgentSourceWithCommitments(agentSource: string_book): AgentSourceParseResult;
+/**
+ * Extracts basic information from agent source using the new commitment system
+ * This maintains compatibility with the original parseAgentSource interface
+ *
+ * @private
+ */
+export declare function parseAgentSourceBasicInfo(agentSource: string_book): AgentBasicInformation;
+/**
+ * Extracts META LINK commitments from agent source
+ * Returns an array of all META LINK URLs found in the agent source
+ *
+ * @private
+ */
+export declare function extractMetaLinks(agentSource: string_book): string[];

package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Removes comment lines (lines starting with #) from a system message
+ * This is used to clean up the final system message before sending it to the AI model
+ * while preserving the original content with comments in metadata
+ *
+ * @param systemMessage The system message that may contain comment lines
+ * @returns The system message with comment lines removed
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function removeCommentsFromSystemMessage(systemMessage: string): string;

package/esm/typings/src/book-2.0/commitments/index.d.ts

@@ -0,0 +1,56 @@
+import type { BookCommitment } from './_base/BookCommitment';
+import type { CommitmentDefinition } from './_base/CommitmentDefinition';
+import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
+import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
+import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
+import { ModelCommitmentDefinition } from './MODEL/MODEL';
+import { NoteCommitmentDefinition } from './NOTE/NOTE';
+import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
+import { RuleCommitmentDefinition } from './RULE/RULE';
+import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
+import { StyleCommitmentDefinition } from './STYLE/STYLE';
+import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
+/**
+ * Registry of all available commitment definitions
+ * This array contains instances of all commitment definitions
+ * This is the single source of truth for all commitments in the system
+ *
+ * @private Use functions to access commitments instead of this array directly
+ */
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaLinkCommitmentDefinition, NoteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIO">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOAL">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+/**
+ * Gets a commitment definition by its type
+ * @param type The commitment type to look up
+ * @returns The commitment definition or null if not found
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
+/**
+ * Gets all available commitment definitions
+ * @returns Array of all commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
+/**
+ * Gets all available commitment types
+ * @returns Array of all commitment types
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
+/**
+ * Checks if a commitment type is supported
+ * @param type The commitment type to check
+ * @returns True if the commitment type is supported
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isCommitmentSupported(type: BookCommitment): boolean;
+/**
+ * TODO: [🧠] Maybe create through standardized $register
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts

@@ -0,0 +1,39 @@
+import type { string_url_image } from '../../types/typeAliases';
+/**
+ * Extracts profile image URL from agent definition text and returns cleaned system message
+ * @param systemMessage The original system message that may contain META IMAGE line
+ * @returns Object with profileImageUrl (if found) and cleanedSystemMessage (without META IMAGE line)
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function extractProfileImageFromSystemMessage(systemMessage: string): {
+    profileImageUrl?: string_url_image;
+    cleanedSystemMessage: string;
+};
+/**
+ * Extracts persona, examples, and profile image from agent definition text
+ * @param systemMessage The original system message that may contain PERSONA, EXAMPLE, and META IMAGE lines
+ * @returns Object with extracted information and cleaned system message
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function extractAgentMetadata(systemMessage: string): {
+    persona?: {
+        name: string;
+        description?: string;
+    };
+    examples: string[];
+    profileImageUrl?: string_url_image;
+    cleanedSystemMessage: string;
+};
+/**
+ * Generates a gravatar URL based on agent name for fallback avatar
+ * @param name The agent name to generate avatar for
+ * @returns Gravatar URL
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function generateGravatarUrl(name?: string | null): string;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts

@@ -0,0 +1,35 @@
+import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
+import type { string_css_class } from '../../../types/typeAliases';
+/**
+ * Props of `AvatarChip`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarChipProps = {
+    /**
+     * Avatar to be shown
+     */
+    readonly avatarBasicInformation: AgentBasicInformation;
+    /**
+     * Whether this chip is a template avatar
+     */
+    readonly isTemplate: boolean;
+    /**
+     * Optional CSS class name which will be added to root <div> element
+     */
+    readonly className?: string_css_class;
+    /**
+     * Called when chip is clicked
+     */
+    readonly onSelect?: (avatar: AgentBasicInformation) => void;
+    /**
+     * Whether this chip is selected
+     */
+    readonly isSelected?: boolean;
+};
+/**
+ * Shows a chip with avatar's avatar and name
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarChip(props: AvatarChipProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChipFromSource.d.ts

@@ -0,0 +1,21 @@
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+import type { AvatarChipProps } from './AvatarChip';
+/**
+ * Props of `AvatarChipFromSource`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarChipFromSourceProps = Omit<AvatarChipProps, 'avatarBasicInformation'> & {
+    /**
+     * Avatar to be shown
+     */
+    readonly source: string_book;
+};
+/**
+ * Shows a chip with avatar's avatar and name based on the avatar source string
+ *
+ * This component is wrapped around the `<AvatarChip/>`, it just parses the avatar source string into `AvatarBasicInformation` and passes it to the `<AvatarChip/>` component.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarChipFromSource(props: AvatarChipFromSourceProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarChip/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AvatarChip';
+export * from './AvatarChipFromSource';

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts

@@ -0,0 +1,26 @@
+import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
+import type { string_css_class } from '../../../types/typeAliases';
+/**
+ * Props of `AvatarProfile`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarProfileProps = {
+    /**
+     * Agent to be shown
+     */
+    readonly agent: AgentBasicInformation & {
+        agentTitle?: string;
+        agentDescription?: string;
+    };
+    /**
+     * Optional CSS class name which will be added to root <div> element
+     */
+    readonly className?: string_css_class;
+};
+/**
+ * Shows a box with user avatar, name and description
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource.d.ts

@@ -0,0 +1,19 @@
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+import type { AvatarProfileProps } from './AvatarProfile';
+/**
+ * Props of `AvatarProfileFromSource`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarProfileFromSourceProps = Omit<AvatarProfileProps, 'agent'> & {
+    /**
+     * Agent source to be shown
+     */
+    readonly agentSource: string_book;
+};
+/**
+ * Shows a box with user avatar, name and description from a string source
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarProfileFromSource(props: AvatarProfileFromSourceProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -0,0 +1,35 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+/**
+ * Props of `BookEditor`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type BookEditorProps = {
+    /**
+     * Additional CSS classes to apply to the editor container.
+     */
+    readonly className?: string;
+    /**
+     * CSS className for a font (e.g. from next/font) to style the editor text.
+     * If omitted, defaults to system serif fonts.
+     */
+    readonly fontClassName?: string;
+    /**
+     * The book which is being edited.
+     */
+    readonly value?: string_book;
+    /**
+     * Callback function to handle changes in the book content.
+     */
+    onChange?(value: string_book): void;
+    /**
+     * If true, logs verbose debug info to the console and shows additional visual cues
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * Renders a book editor
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts

@@ -0,0 +1,15 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+/**
+ * @private util of `<BookEditor />`
+ */
+export type BookEditorInnerProps = {
+    className?: string;
+    fontClassName?: string;
+    value?: string_book;
+    onChange?(value: string_book): void;
+    isVerbose?: boolean;
+};
+/**
+ * @private util of `<BookEditor />`
+ */
+export declare function BookEditorInner(props: BookEditorInnerProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/BookEditor/config.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Default font class name for the BookEditor component
+ * In Next.js environments, you can override this by importing the font directly
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const DEFAULT_BOOK_FONT_CLASS: any;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
+ * This allows CSS modules (which are normally emitted into the document head) to be
+ * available inside the component's shadow DOM.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function injectCssModuleIntoShadowRoot(shadowRoot: ShadowRoot): void;
+/**
+ * TODO: Make some utility functions for working with CSS modules in shadow DOM independent of `BookEditor.module.css`
+ */

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

@@ -0,0 +1,20 @@
+import type { ChatProps } from './ChatProps';
+/**
+ * @deprecated use `isComplete` instead
+ * @private util of `<Chat />`
+ */
+export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
+/**
+ * Renders a chat with messages and input for new messages
+ *
+ * Note: 🔇 This component does NOT have speak functionality, it just allows to trigger voice recognition
+ *
+ * Note: There are multiple chat components:
+ * - `<Chat/>` renders chat as it is without any logic
+ * - `<LlmChat/>` connected to LLM Execution Tools of Promptbook
+ *
+ * Use <WorkerChat/> or <SignalChat/> in most cases.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function Chat(props: ChatProps): import("react/jsx-runtime").JSX.Element;