@promptbook/cli 0.103.0-10 → 0.103.0-100

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

@@ -2,14 +2,12 @@ import type { BookParameter } from '../book-2.0/agent-source/AgentBasicInformati
 import type { AgentBasicInformation } from '../book-2.0/agent-source/AgentBasicInformation';
 import type { AgentModelRequirements } from '../book-2.0/agent-source/AgentModelRequirements';
 import type { string_book } from '../book-2.0/agent-source/string_book';
-import type { BookCommitment } from '../book-2.0/commitments/_base/BookCommitment';
-import type { CommitmentDefinition } from '../book-2.0/commitments/_base/CommitmentDefinition';
-import type { ParsedCommitment } from '../book-2.0/commitments/_base/ParsedCommitment';
 import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChip';
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
 import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
+import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChatProps';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatAutoScrollConfig } from '../book-components/Chat/hooks/useChatAutoScroll';
 import type { SendMessageToLlmChatFunction } from '../book-components/Chat/hooks/useSendMessageToLlmChat';
@@ -21,7 +19,17 @@ import type { string_chat_format_name } from '../book-components/Chat/save/_comm
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
-import type { PipelineCollection } from '../collection/PipelineCollection';
+import type { QrCodeOptions } from '../book-components/Qr/useQrCode';
+import type { AgentCollection } from '../collection/agent-collection/AgentCollection';
+import type { AgentCollectionInSupabaseOptions } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions';
+import type { Json } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { AgentsDatabaseSchema } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { Tables } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { TablesInsert } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { TablesUpdate } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { Enums } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { CompositeTypes } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
+import type { PipelineCollection } from '../collection/pipeline-collection/PipelineCollection';
 import type { Command } from '../commands/_common/types/Command';
 import type { CommandParser } from '../commands/_common/types/CommandParser';
 import type { PipelineBothCommandParser } from '../commands/_common/types/CommandParser';
@@ -46,6 +54,10 @@ import type { SectionCommand } from '../commands/SECTION/SectionCommand';
 import type { UrlCommand } from '../commands/URL/UrlCommand';
 import type { ActionCommand } from '../commands/X_ACTION/ActionCommand';
 import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentCommand';
+import type { BookCommitment } from '../commitments/_base/BookCommitment';
+import type { CommitmentDefinition } from '../commitments/_base/CommitmentDefinition';
+import type { ParsedCommitment } from '../commitments/_base/ParsedCommitment';
+import type { GroupedCommitmentDefinition } from '../commitments/index';
 import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
 import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
 import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
@@ -98,7 +110,9 @@ import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmTools
 import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
 import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
-import type { CreateAgentLlmExecutionToolsOptions } from '../llm-providers/agent/createAgentLlmExecutionTools';
+import type { AgentOptions } from '../llm-providers/agent/AgentOptions';
+import type { CreateAgentLlmExecutionToolsOptions } from '../llm-providers/agent/CreateAgentLlmExecutionToolsOptions';
+import type { RemoteAgentOptions } from '../llm-providers/agent/RemoteAgentOptions';
 import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AnthropicClaudeExecutionToolsNonProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
@@ -166,7 +180,10 @@ import type { PostprocessingFunction } from '../scripting/javascript/JavascriptE
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
 import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
+import type { BookTranspiler } from '../transpilers/_common/BookTranspiler';
+import type { BookTranspilerOptions } from '../transpilers/_common/BookTranspilerOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
+import type { LlmCall } from '../types/LlmCall';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
@@ -203,6 +220,8 @@ import type { string_reserved_parameter_name } from '../types/typeAliases';
 import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 import type { string_agent_name } from '../types/typeAliases';
+import type { string_agent_name_in_book } from '../types/typeAliases';
+import type { string_agent_hash } from '../types/typeAliases';
 import type { string_persona_description } from '../types/typeAliases';
 import type { string_model_description } from '../types/typeAliases';
 import type { string_knowledge_source_content } from '../types/typeAliases';
@@ -232,6 +251,7 @@ import type { string_url } from '../types/typeAliases';
 import type { string_promptbook_server_url } from '../types/typeAliases';
 import type { string_base_url } from '../types/typeAliases';
 import type { string_pipeline_root_url } from '../types/typeAliases';
+import type { string_agent_url } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
 import type { string_pipeline_url_with_task_hash } from '../types/typeAliases';
 import type { string_data_url } from '../types/typeAliases';
@@ -261,6 +281,8 @@ import type { string_absolute_dirname } from '../types/typeAliases';
 import type { string_relative_dirname } from '../types/typeAliases';
 import type { string_dirname } from '../types/typeAliases';
 import type { string_person_fullname } from '../types/typeAliases';
+import type { string_person_firstname } from '../types/typeAliases';
+import type { string_person_lastname } from '../types/typeAliases';
 import type { string_person_profile } from '../types/typeAliases';
 import type { string_license } from '../types/typeAliases';
 import type { string_legal_entity } from '../types/typeAliases';
@@ -306,6 +328,7 @@ import type { number_kilobytes } from '../types/typeAliases';
 import type { number_megabytes } from '../types/typeAliases';
 import type { number_gigabytes } from '../types/typeAliases';
 import type { number_terabytes } from '../types/typeAliases';
+import type { Updatable } from '../types/Updatable';
 import type { ColorTransformer } from '../utils/color/operators/ColorTransformer';
 import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
 import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
@@ -314,6 +337,7 @@ import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
 import type { Registered } from '../utils/misc/$Register';
 import type { Registration } from '../utils/misc/$Register';
+import type { AboutPromptbookInformationOptions } from '../utils/misc/aboutPromptbookInformation';
 import type { FromtoItems } from '../utils/misc/FromtoItems';
 import type { InjectCssModuleIntoShadowRootOptions } from '../utils/misc/injectCssModuleIntoShadowRoot';
 import type { string_keyword } from '../utils/normalization/IKeywords';
@@ -327,6 +351,7 @@ import type { OrderJsonOptions } from '../utils/normalization/orderJson';
 import type { empty_object } from '../utils/organization/empty_object';
 import type { really_any } from '../utils/organization/really_any';
 import type { TODO_any } from '../utils/organization/TODO_any';
+import type { RandomFullnameWithColorResult } from '../utils/random/$randomFullnameWithColor';
 import type { CheckSerializableAsJsonOptions } from '../utils/serialization/checkSerializableAsJson';
 import type { ExportJsonOptions } from '../utils/serialization/exportJson';
 import type { ITakeChain } from '../utils/take/interfaces/ITakeChain';
@@ -335,14 +360,12 @@ export type { BookParameter };
 export type { AgentBasicInformation };
 export type { AgentModelRequirements };
 export type { string_book };
-export type { BookCommitment };
-export type { CommitmentDefinition };
-export type { ParsedCommitment };
 export type { AvatarChipProps };
 export type { AvatarChipFromSourceProps };
 export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
 export type { BookEditorProps };
+export type { AgentChatProps };
 export type { ChatProps };
 export type { ChatAutoScrollConfig };
 export type { SendMessageToLlmChatFunction };
@@ -354,6 +377,16 @@ export type { string_chat_format_name };
 export type { ChatMessage };
 export type { ChatParticipant };
 export type { MessageButton };
+export type { QrCodeOptions };
+export type { AgentCollection };
+export type { AgentCollectionInSupabaseOptions };
+export type { Json };
+export type { AgentsDatabaseSchema };
+export type { Tables };
+export type { TablesInsert };
+export type { TablesUpdate };
+export type { Enums };
+export type { CompositeTypes };
 export type { PipelineCollection };
 export type { Command };
 export type { CommandParser };
@@ -379,6 +412,10 @@ export type { SectionCommand };
 export type { UrlCommand };
 export type { ActionCommand };
 export type { InstrumentCommand };
+export type { BookCommitment };
+export type { CommitmentDefinition };
+export type { ParsedCommitment };
+export type { GroupedCommitmentDefinition };
 export type { PrettifyOptions };
 export type { renderPipelineMermaidOptions };
 export type { CallbackInterfaceToolsOptions };
@@ -431,7 +468,9 @@ export type { LlmToolsOptions };
 export type { CacheItem };
 export type { CacheLlmToolsOptions };
 export type { LlmExecutionToolsWithTotalUsage };
+export type { AgentOptions };
 export type { CreateAgentLlmExecutionToolsOptions };
+export type { RemoteAgentOptions };
 export type { AnthropicClaudeExecutionToolsOptions };
 export type { AnthropicClaudeExecutionToolsNonProxiedOptions };
 export type { AnthropicClaudeExecutionToolsProxiedOptions };
@@ -499,7 +538,10 @@ export type { PostprocessingFunction };
 export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
 export type { IndexedDbStorageOptions };
+export type { BookTranspiler };
+export type { BookTranspilerOptions };
 export type { IntermediateFilesStrategy };
+export type { LlmCall };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };
 export type { ChatModelRequirements };
@@ -536,6 +578,8 @@ export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };
 export type { string_agent_name };
+export type { string_agent_name_in_book };
+export type { string_agent_hash };
 export type { string_persona_description };
 export type { string_model_description };
 export type { string_knowledge_source_content };
@@ -565,6 +609,7 @@ export type { string_url };
 export type { string_promptbook_server_url };
 export type { string_base_url };
 export type { string_pipeline_root_url };
+export type { string_agent_url };
 export type { string_pipeline_url };
 export type { string_pipeline_url_with_task_hash };
 export type { string_data_url };
@@ -594,6 +639,8 @@ export type { string_absolute_dirname };
 export type { string_relative_dirname };
 export type { string_dirname };
 export type { string_person_fullname };
+export type { string_person_firstname };
+export type { string_person_lastname };
 export type { string_person_profile };
 export type { string_license };
 export type { string_legal_entity };
@@ -639,6 +686,7 @@ export type { number_kilobytes };
 export type { number_megabytes };
 export type { number_gigabytes };
 export type { number_terabytes };
+export type { Updatable };
 export type { ColorTransformer };
 export type { PipelineEditableSerialized };
 export type { ExecCommandOptions };
@@ -647,6 +695,7 @@ export type { CodeBlock };
 export type { MarkdownSection };
 export type { Registered };
 export type { Registration };
+export type { AboutPromptbookInformationOptions };
 export type { FromtoItems };
 export type { InjectCssModuleIntoShadowRootOptions };
 export type { string_keyword };
@@ -660,6 +709,7 @@ export type { OrderJsonOptions };
 export type { empty_object };
 export type { really_any };
 export type { TODO_any };
+export type { RandomFullnameWithColorResult };
 export type { CheckSerializableAsJsonOptions };
 export type { ExportJsonOptions };
 export type { ITakeChain };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -11,6 +11,7 @@ import { jsonParse } from '../formats/json/utils/jsonParse';
 import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
+import { $detectRuntimeEnvironment } from '../utils/environment/$detectRuntimeEnvironment';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInJest } from '../utils/environment/$isRunningInJest';
 import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
@@ -26,6 +27,7 @@ import { countSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
 import { $getCurrentDate } from '../utils/misc/$getCurrentDate';
+import { computeHash } from '../utils/misc/computeHash';
 import { debounce } from '../utils/misc/debounce';
 import { parseNumber } from '../utils/misc/parseNumber';
 import { capitalize } from '../utils/normalization/capitalize';
@@ -38,6 +40,7 @@ import { nameToUriPart } from '../utils/normalization/nameToUriPart';
 import { nameToUriParts } from '../utils/normalization/nameToUriParts';
 import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
 import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeMessageText } from '../utils/normalization/normalizeMessageText';
 import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
 import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
 import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
@@ -96,6 +99,7 @@ export { jsonParse };
 export { isValidXmlString };
 export { prompt };
 export { promptTemplate };
+export { $detectRuntimeEnvironment };
 export { $isRunningInBrowser };
 export { $isRunningInJest };
 export { $isRunningInNode };
@@ -111,6 +115,7 @@ export { countSentences };
 export { countWords };
 export { CountUtils };
 export { $getCurrentDate };
+export { computeHash };
 export { debounce };
 export { parseNumber };
 export { capitalize };
@@ -123,6 +128,7 @@ export { nameToUriPart };
 export { nameToUriParts };
 export type { string_kebab_case };
 export { normalizeToKebabCase };
+export { normalizeMessageText };
 export type { string_camelCase };
 export { normalizeTo_camelCase };
 export type { string_PascalCase };

package/esm/typings/src/_packages/wizard.index.d.ts

@@ -29,6 +29,8 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { _FormattedBookInMarkdownTranspilerRegistration } from '../transpilers/formatted-book-in-markdown/register';
+import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai-sdk/register';
 import { wizard } from '../wizard/wizard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _AnthropicClaudeMetadataRegistration };
@@ -61,4 +63,6 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { _FormattedBookInMarkdownTranspilerRegistration };
+export { _OpenAiSdkTranspilerRegistration };
 export { wizard };

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

@@ -1,4 +1,4 @@
-import type { string_agent_name, string_url_image } from '../../types/typeAliases';
+import type { string_agent_hash, string_agent_name, string_agent_url, string_color, string_url_image } from '../../types/typeAliases';
 /**
  * Unified parameter representation that supports two different notations:
  * 1. @Parameter - single word parameter starting with @
@@ -28,24 +28,37 @@ export type AgentBasicInformation = {
      * Name of the agent
      * This is the first line of the agent source
      */
-    agentName: string_agent_name | null;
+    agentName: string_agent_name;
+    /**
+     * Hash of the agent source for integrity verification
+     */
+    agentHash: string_agent_hash;
     /**
      * Optional description of the agent
      * This is the line starting with "PERSONA"
      */
     personaDescription: string | null;
+    /**
+     * The initial message shown to the user when the chat starts
+     * This is the line starting with "INITIAL MESSAGE"
+     */
+    initialMessage: string | null;
     /**
      * Metadata commitments parsed from META lines
      * Each META commitment has the format "META TYPE content"
      * When there are multiple meta commitments of the same type, later overrides earlier
      */
     meta: {
+        fullname?: string;
         image?: string_url_image;
-        link?: string;
-        title?: string;
-        description?: string;
+        color?: string_color;
         [key: string]: string | undefined;
     };
+    /**
+     * Links found in the agent source
+     * This corresponds to META LINK commitments
+     */
+    links: Array<string_agent_url>;
     /**
      * Parameters found in the agent source
      * Supports two different notations for the same syntax feature:
@@ -55,5 +68,6 @@ export type AgentBasicInformation = {
     parameters: BookParameter[];
 };
 /**
+ * TODO: [🐱‍🚀] Make all properties of `AgentBasicInformation` readonly
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
  */

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

@@ -1,3 +1,4 @@
+import type { string_knowledge_source_link } from '../../types/typeAliases';
 import type { TODO_any } from '../../utils/organization/TODO_any';
 /**
  * Model requirements for an agent
@@ -16,7 +17,22 @@ export type AgentModelRequirements = {
     /**
      * Optional list of MCP servers that the agent can connect to
      */
-    readonly mcpServers?: string[];
+    readonly mcpServers?: ReadonlyArray<string>;
+    /**
+     * Optional link to the parent agent from which this agent inherits
+     */
+    readonly parentAgentUrl?: string_knowledge_source_link;
+    /**
+     * Optional list of knowledge source links that the agent can use
+     */
+    readonly knowledgeSources?: ReadonlyArray<string_knowledge_source_link>;
+    /**
+     * List of sample conversations (question/answer pairs)
+     */
+    readonly samples?: ReadonlyArray<{
+        question: string;
+        answer: string;
+    }>;
     /**
      * Temperature for the agent's responses, controlling randomness
      */

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

@@ -1,4 +1,5 @@
-import type { ParsedCommitment } from '../commitments/_base/ParsedCommitment';
+import type { ParsedCommitment } from '../../commitments/_base/ParsedCommitment';
+import { string_agent_name } from '../../types/typeAliases';
 /**
  * Result of parsing agent source for commitments
  *
@@ -8,7 +9,7 @@ export type AgentSourceParseResult = {
     /**
      * The agent name (first line)
      */
-    agentName: string | null;
+    agentName: string_agent_name | null;
     /**
      * All parsed commitments
      */

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

@@ -0,0 +1,8 @@
+import { string_agent_hash } from '../../types/typeAliases';
+import { string_book } from './string_book';
+/**
+ * Computes SHA-256 hash of the agent source
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function computeAgentHash(agentSource: string_book): string_agent_hash;

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

@@ -1,4 +1,4 @@
-import type { BookCommitment } from '../commitments/_base/BookCommitment';
+import type { BookCommitment } from '../../commitments/_base/BookCommitment';
 /**
  * Generates a regex pattern to match a specific commitment
  *
@@ -7,7 +7,7 @@ import type { BookCommitment } from '../commitments/_base/BookCommitment';
  *
  * @private - TODO: [🧠] Maybe should be public?
  */
-export declare function createCommitmentRegex(commitment: BookCommitment): RegExp;
+export declare function createCommitmentRegex(commitment: BookCommitment, aliases?: BookCommitment[]): RegExp;
 /**
  * Generates a regex pattern to match a specific commitment type
  *
@@ -17,4 +17,4 @@ export declare function createCommitmentRegex(commitment: BookCommitment): RegEx
  *
  * @private
  */
-export declare function createCommitmentTypeRegex(commitment: BookCommitment): RegExp;
+export declare function createCommitmentTypeRegex(commitment: BookCommitment, aliases?: BookCommitment[]): RegExp;

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

@@ -0,0 +1,8 @@
+import { string_agent_name } from '../../types/typeAliases';
+import { string_book } from './string_book';
+/**
+ * Creates temporary default agent name based on agent source hash
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function createDefaultAgentName(agentSource: string_book): string_agent_name;

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

@@ -0,0 +1,9 @@
+import { string_agent_name } from '../../types/typeAliases';
+/**
+ * Normalizes agent name from arbitrary string to valid agent name
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function normalizeAgentName(rawAgentName: string): string_agent_name;

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

@@ -0,0 +1,18 @@
+import type { string_book } from './string_book';
+/**
+ *  Number of padding lines to add at the end of the book content
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PADDING_LINES = 11;
+/**
+ * A function that adds padding to the book content
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function padBook(content: string_book): string_book;
+/**
+ * TODO: [🧠] Maybe export
+ */

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

@@ -6,4 +6,4 @@ import type { string_book } from './string_book';
  *
  * @private internal utility of `parseAgentSource`
  */
-export declare function parseAgentSourceWithCommitments(agentSource: string_book): AgentSourceParseResult;
+export declare function parseAgentSourceWithCommitments(agentSource: string_book): Omit<AgentSourceParseResult, 'agentHash'>;

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

@@ -15,12 +15,15 @@ export declare function isValidBook(value: string): value is string_book;
  * This function should be used when you have a string that you know represents agent source
  * but need to convert it to the branded type for type safety
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function validateBook(source: string): string_book;
 /**
  * Default book
  *
+ * @deprecated Use `$generateBookBoilerplate` instead
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_BOOK: string_book;

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

@@ -1,3 +1,4 @@
+import { CSSProperties } from 'react';
 import type { AgentBasicInformation } from '../../../book-2.0/agent-source/AgentBasicInformation';
 import type { string_book } from '../../../book-2.0/agent-source/string_book';
 import type { string_css_class } from '../../../types/typeAliases';
@@ -14,11 +15,15 @@ export type AvatarProfileProps = {
     /**
      * The source of the agent, which will be displayed in the BookEditor.
      */
-    readonly agentSource: string_book;
+    readonly agentSource?: string_book;
     /**
      * Optional CSS class name which will be added to root <div> element
      */
     readonly className?: string_css_class;
+    /**
+     * Optional CSS style which will be added to root <div/> element
+     */
+    readonly style?: CSSProperties;
 };
 /**
  * Shows a box with user avatar, name and description

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

@@ -1,7 +1,15 @@
-import type { CSSProperties } from 'react';
+import { CSSProperties } from 'react';
 import type { Promisable } from 'type-fest';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
-import type { string_knowledge_source_content } from '../../types/typeAliases';
+import type { number_percent, number_positive, string_css_value, string_knowledge_source_content } from '../../types/typeAliases';
+/**
+ * Default height of the book editor
+ *
+ * Note: This height is computed based on the number of lines in the default book + padding multiplied by an estimated line height.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const DEFAULT_BOOK_EDITOR_HEIGHT: number;
 /**
  * Props of `BookEditor`
  *
@@ -20,6 +28,22 @@ export type BookEditorProps = {
      * Optional CSS style which will be added to root <div/> element
      */
     readonly style?: CSSProperties;
+    /**
+     * Height of the `BookEditor` component
+     *
+     * - You can use any valid CSS value, e.g., `500px`, `100%`, `50vh`, etc.
+     * - If not set, the default height is `DEFAULT_BOOK_EDITOR_HEIGHT`.
+     * - If set to `null`, the height should be controlled entirely via `className` or `style`, otherwise the editor will have zero height.
+     *
+     * @default `DEFAULT_BOOK_EDITOR_HEIGHT`
+     */
+    readonly height?: string_css_value | null;
+    /**
+     * Zoom level of the editor
+     *
+     * @default 1 (100%)
+     */
+    readonly zoom?: number_percent & number_positive;
     /**
      * The book which is being edited.
      */
@@ -40,17 +64,63 @@ export type BookEditorProps = {
      * If true, disables border radius making the editor have sharp corners
      */
     readonly isBorderRadiusDisabled?: boolean;
-    /**
-     * If true, shows the footer with book title and version information.
-     * By default, the footer is hidden.
-     */
-    readonly isFooterShown?: boolean;
     /**
      * If true, the editor is in read-only mode
      *
      * @default false
      */
     readonly isReadonly?: boolean;
+    /**
+     * Optional translations for the component
+     */
+    readonly translations?: {
+        /**
+         * Message to show when trying to edit a readonly editor
+         *
+         * @default "You cannot edit this book"
+         */
+        readonly readonlyMessage?: string;
+    };
+    /**
+     * If true, shows the download button in the action bar.
+     * By default, the download button is shown.
+     */
+    readonly isDownloadButtonShown?: boolean;
+    /**
+     * If true, shows the about button in the action bar.
+     * By default, the about button is shown.
+     */
+    readonly isAboutButtonShown?: boolean;
+    /**
+     * If true, shows the fullscreen button in the action bar.
+     * By default, the fullscreen button is shown.
+     */
+    readonly isFullscreenButtonShown?: boolean;
+    /**
+     * Callback function to handle fullscreen button click.
+     * Note: This is for internal use between BookEditor and BookEditorMonaco
+     * @private
+     */
+    onFullscreenClick?(): void;
+    /**
+     * If true, the editor is in fullscreen mode.
+     * Note: This is for internal use between BookEditor and BookEditorMonaco
+     * @private
+     */
+    readonly isFullscreen?: boolean;
+    /**
+     * If defined, the editor will be synced with other editors with the same sync configuration.
+     */
+    readonly sync?: {
+        /**
+         * The URL of the y-websocket server.
+         */
+        readonly serverUrl: string;
+        /**
+         * The name of the room to join.
+         */
+        readonly roomName: string;
+    };
 };
 /**
  * Renders a book editor

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

@@ -0,0 +1,14 @@
+type BookEditorActionbarProps = {
+    value: string | undefined;
+    isDownloadButtonShown?: boolean;
+    isAboutButtonShown?: boolean;
+    isFullscreenButtonShown?: boolean;
+    onFullscreenClick?: () => void;
+    isFullscreen?: boolean;
+};
+/**
+ *
+ * @private Internal component used by `BookEditor`
+ */
+export declare function BookEditorActionbar(props: BookEditorActionbarProps): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,14 @@
+import type { AgentChatProps } from './AgentChatProps';
+/**
+ * AgentChat component that provides chat functionality with LLM integration
+ *
+ * This component internally manages messages, participants, and task progress,
+ * and uses the provided LLM tools to generate responses via `LlmExecutionTools.callChatModel`.
+ *
+ * Note: There are multiple chat components:
+ * - `<Chat/>` renders chat as it is without any logic
+ * - `<AgentChat/>` connected to LLM Execution Tools of Promptbook
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AgentChat(props: AgentChatProps): import("react/jsx-runtime").JSX.Element;