@promptbook/types 0.101.0-1 → 0.101.0-3

package/README.md

@@ -47,7 +47,7 @@ npm i ptbk
 npm i -D @promptbook/types
 ```
 
-The types package provides comprehensive TypeScript type definitions for all Promptbook entities. It enables type-safe development when working with Promptbook APIs, ensuring compile-time validation and excellent IDE support.
+Comprehensive TypeScript type definitions for all Promptbook entities, enabling type-safe development and excellent IDE support throughout the Promptbook ecosystem.
 
 ## 🎯 Purpose and Motivation
 
@@ -56,23 +56,24 @@ This package centralizes all TypeScript type definitions used throughout the Pro
 ## 🔧 High-Level Functionality
 
 The package provides type definitions for:
-- **Pipeline Structures**: Complete type definitions for promptbook JSON structures
-- **Execution Types**: Types for pipeline execution, results, and error handling
-- **LLM Provider Types**: Configuration and option types for all supported providers
-- **Command Types**: Type definitions for all promptbook commands
-- **Utility Types**: Helper types for common patterns and data structures
-- **Component Types**: React component prop types for UI components
+
+-   **Pipeline Structures**: Complete type definitions for promptbook JSON structures
+-   **Execution Types**: Types for pipeline execution, results, and error handling
+-   **LLM Provider Types**: Configuration and option types for all supported providers
+-   **Command Types**: Type definitions for all promptbook commands
+-   **Utility Types**: Helper types for common patterns and data structures
+-   **Component Types**: React component prop types for UI components
 
 ## ✨ Key Features
 
-- 📝 **Complete Type Coverage** - Types for all Promptbook entities and APIs
-- 🔒 **Type Safety** - Compile-time validation and error prevention
-- 💡 **Excellent IntelliSense** - Rich IDE support with autocomplete and documentation
-- 🏗️ **Structural Types** - Detailed types for promptbook JSON structures
-- 🔧 **Provider-Agnostic** - Generic types that work across all LLM providers
-- 📊 **Execution Types** - Comprehensive types for pipeline execution and results
-- 🎨 **Component Types** - React component prop types for UI development
-- 🔄 **Version Compatibility** - Types that evolve with the Promptbook ecosystem
+-   📝 **Complete Type Coverage** - Types for all Promptbook entities and APIs
+-   🔒 **Type Safety** - Compile-time validation and error prevention
+-   💡 **Excellent IntelliSense** - Rich IDE support with autocomplete and documentation
+-   🏗️ **Structural Types** - Detailed types for promptbook JSON structures
+-   🔧 **Provider-Agnostic** - Generic types that work across all LLM providers
+-   📊 **Execution Types** - Comprehensive types for pipeline execution and results
+-   🎨 **Component Types** - React component prop types for UI development
+-   🔄 **Version Compatibility** - Types that evolve with the Promptbook ecosystem
 
 ## Usage Example
 
@@ -103,106 +104,197 @@ const promptbook: PipelineJson = compilePipeline(
 ## 📦 Exported Type Categories
 
 ### Agent and Book Types
-- `AgentBasicInformation` - Basic agent information structure
-- `AgentModelRequirements` - Model requirements for agents
-- `string_book` - Book content string type
-- `BookCommitment` - Book commitment structure
-- `CommitmentDefinition` - Commitment definition interface
-- `ParsedCommitment` - Parsed commitment structure
+
+-   `AgentBasicInformation` - Basic agent information structure (type)
+-   `AgentModelRequirements` - Model requirements for agents (type)
+-   `string_book` - Book content string type (type)
+-   `BookCommitment` - Book commitment structure (type)
+-   `CommitmentDefinition` - Commitment definition interface (type)
+-   `ParsedCommitment` - Parsed commitment structure (type)
 
 ### Component Types
-- `AvatarChipProps` - Avatar chip component props
-- `AvatarChipFromSourceProps` - Avatar chip from source props
-- `AvatarProfileProps` - Avatar profile component props
-- `AvatarProfileFromSourceProps` - Avatar profile from source props
-- `BookEditorProps` - Book editor component props
-- `ChatProps` - Chat component props
-- `LlmChatProps` - LLM chat component props
-- `ChatMessage` - Chat message structure
-- `ChatParticipant` - Chat participant information
+
+-   `AvatarChipProps` - Avatar chip component props (type)
+-   `AvatarChipFromSourceProps` - Avatar chip from source props (type)
+-   `AvatarProfileProps` - Avatar profile component props (type)
+-   `AvatarProfileFromSourceProps` - Avatar profile from source props (type)
+-   `BookEditorProps` - Book editor component props (type)
+-   `ChatProps` - Chat component props (type)
+-   `LlmChatProps` - LLM chat component props (type)
+-   `ChatMessage` - Chat message structure (type)
+-   `ChatParticipant` - Chat participant information (type)
 
 ### Collection and Pipeline Types
-- `PipelineCollection` - Pipeline collection interface
-- `PipelineJson` - Complete pipeline JSON structure
-- `PipelineString` - Pipeline string format
-- `PipelineInterface` - Pipeline interface definition
-- `TaskJson` - Task JSON structure
-- `PromptTaskJson` - Prompt task structure
-- `ScriptTaskJson` - Script task structure
-- `SimpleTaskJson` - Simple task structure
-- `DialogTaskJson` - Dialog task structure
-- `CommonTaskJson` - Common task properties
+
+-   `PipelineCollection` - Pipeline collection interface (type)
+-   `PipelineJson` - Complete pipeline JSON structure (type)
+-   `PipelineString` - Pipeline string format (type)
+-   `PipelineInterface` - Pipeline interface definition (type)
+-   `TaskJson` - Task JSON structure (type)
+-   `PromptTaskJson` - Prompt task structure (type)
+-   `ScriptTaskJson` - Script task structure (type)
+-   `SimpleTaskJson` - Simple task structure (type)
+-   `DialogTaskJson` - Dialog task structure (type)
+-   `CommonTaskJson` - Common task properties (type)
 
 ### Command Types
-- `Command` - Base command interface
-- `CommandParser` - Command parser interface
-- `CommandType` - Command type enumeration
-- `CommandUsagePlace` - Command usage context
-- `BookVersionCommand` - Book version command
-- `ExpectCommand` - Expect command structure
-- `ForeachCommand` - Foreach command structure
-- `FormatCommand` - Format command structure
-- `FormfactorCommand` - Formfactor command structure
-- `KnowledgeCommand` - Knowledge command structure
-- `ModelCommand` - Model command structure
-- `ParameterCommand` - Parameter command structure
-- `PersonaCommand` - Persona command structure
-- `PostprocessCommand` - Postprocess command structure
+
+-   `Command` - Base command interface (type)
+-   `CommandParser` - Command parser interface (type)
+-   `PipelineBothCommandParser` - Pipeline both command parser (type)
+-   `PipelineHeadCommandParser` - Pipeline head command parser (type)
+-   `PipelineTaskCommandParser` - Pipeline task command parser (type)
+-   `CommandParserInput` - Command parser input (type)
+-   `CommandType` - Command type enumeration (type)
+-   `CommandUsagePlace` - Command usage context (type)
+-   `BookVersionCommand` - Book version command (type)
+-   `ExpectCommand` - Expect command structure (type)
+-   `ForeachCommand` - Foreach command structure (type)
+-   `ForeachJson` - Foreach JSON structure (type)
+-   `FormatCommand` - Format command structure (type)
+-   `FormfactorCommand` - Formfactor command structure (type)
+-   `JokerCommand` - Joker command structure (type)
+-   `KnowledgeCommand` - Knowledge command structure (type)
+-   `ModelCommand` - Model command structure (type)
+-   `ParameterCommand` - Parameter command structure (type)
+-   `PersonaCommand` - Persona command structure (type)
+-   `PostprocessCommand` - Postprocess command structure (type)
+-   `SectionCommand` - Section command structure (type)
+-   `UrlCommand` - URL command structure (type)
+-   `ActionCommand` - Action command structure (type)
+-   `InstrumentCommand` - Instrument command structure (type)
 
 ### Execution Types
-- `ExecutionTools` - Execution tools interface
-- `LlmExecutionTools` - LLM execution tools interface
-- `PipelineExecutor` - Pipeline executor interface
-- `PipelineExecutorResult` - Execution result structure
-- `ExecutionTask` - Execution task structure
-- `ExecutionReportJson` - Execution report structure
-- `PromptResult` - Prompt execution result
-- `Usage` - Usage tracking structure
-- `AvailableModel` - Available model information
+
+-   `ExecutionTools` - Execution tools interface (type)
+-   `LlmExecutionTools` - LLM execution tools interface (type)
+-   `LlmExecutionToolsConstructor` - LLM execution tools constructor (type)
+-   `PipelineExecutor` - Pipeline executor interface (type)
+-   `PipelineExecutorResult` - Execution result structure (type)
+-   `ExecutionTask` - Execution task structure (type)
+-   `PreparationTask` - Preparation task structure (type)
+-   `task_status` - Task status type (type)
+-   `AbstractTask` - Abstract task interface (type)
+-   `Task` - Task interface (type)
+-   `ExecutionReportJson` - Execution report structure (type)
+-   `ExecutionPromptReportJson` - Execution prompt report structure (type)
+-   `ExecutionReportString` - Execution report string (type)
+-   `ExecutionReportStringOptions` - Report formatting options (type)
+-   `PromptResult` - Prompt execution result (type)
+-   `CompletionPromptResult` - Completion prompt result (type)
+-   `ChatPromptResult` - Chat prompt result (type)
+-   `EmbeddingPromptResult` - Embedding prompt result (type)
+-   `Usage` - Usage tracking structure (type)
+-   `UsageCounts` - Usage counts structure (type)
+-   `UncertainNumber` - Uncertain number type (type)
+-   `AvailableModel` - Available model information (type)
+-   `AbstractTaskResult` - Abstract task result (type)
+-   `EmbeddingVector` - Embedding vector type (type)
 
 ### LLM Provider Configuration Types
-- `AnthropicClaudeExecutionToolsOptions` - Anthropic Claude configuration
-- `OpenAiExecutionToolsOptions` - OpenAI configuration
-- `AzureOpenAiExecutionToolsOptions` - Azure OpenAI configuration
-- `GoogleExecutionToolsOptions` - Google configuration
-- `DeepseekExecutionToolsOptions` - Deepseek configuration
-- `OllamaExecutionToolsOptions` - Ollama configuration
-- `VercelExecutionToolsOptions` - Vercel configuration
+
+-   `AnthropicClaudeExecutionToolsOptions` - Anthropic Claude configuration (type)
+-   `AnthropicClaudeExecutionToolsNonProxiedOptions` - Anthropic Claude non-proxied options (type)
+-   `AnthropicClaudeExecutionToolsProxiedOptions` - Anthropic Claude proxied options (type)
+-   `OpenAiExecutionToolsOptions` - OpenAI configuration (type)
+-   `OpenAiAssistantExecutionToolsOptions` - OpenAI Assistant configuration (type)
+-   `OpenAiCompatibleExecutionToolsOptions` - OpenAI Compatible configuration (type)
+-   `OpenAiCompatibleExecutionToolsNonProxiedOptions` - OpenAI Compatible non-proxied options (type)
+-   `OpenAiCompatibleExecutionToolsProxiedOptions` - OpenAI Compatible proxied options (type)
+-   `AzureOpenAiExecutionToolsOptions` - Azure OpenAI configuration (type)
+-   `GoogleExecutionToolsOptions` - Google configuration (type)
+-   `DeepseekExecutionToolsOptions` - Deepseek configuration (type)
+-   `OllamaExecutionToolsOptions` - Ollama configuration (type)
+-   `VercelExecutionToolsOptions` - Vercel configuration (type)
+-   `VercelProvider` - Vercel provider type (type)
 
 ### Parameter and Data Types
-- `ParameterJson` - Parameter definition structure
-- `InputParameterJson` - Input parameter structure
-- `OutputParameterJson` - Output parameter structure
-- `Parameters` - Parameter collection type
-- `Expectations` - Expectation validation structure
-- `PersonaJson` - Persona definition structure
-- `KnowledgeSourceJson` - Knowledge source structure
+
+-   `ParameterJson` - Parameter definition structure (type)
+-   `InputParameterJson` - Input parameter structure (type)
+-   `IntermediateParameterJson` - Intermediate parameter structure (type)
+-   `OutputParameterJson` - Output parameter structure (type)
+-   `CommonParameterJson` - Common parameter properties (type)
+-   `Parameters` - Parameter collection type (type)
+-   `InputParameters` - Input parameters type (type)
+-   `Expectations` - Expectation validation structure (type)
+-   `ExpectationUnit` - Expectation unit type (type)
+-   `ExpectationAmount` - Expectation amount type (type)
+-   `PersonaJson` - Persona definition structure (type)
+-   `PersonaPreparedJson` - Prepared persona structure (type)
+-   `KnowledgeSourceJson` - Knowledge source structure (type)
+-   `KnowledgeSourcePreparedJson` - Prepared knowledge source structure (type)
+-   `KnowledgePiecePreparedJson` - Prepared knowledge piece structure (type)
 
 ### Utility and Helper Types
-- `string_prompt` - Prompt string type
-- `string_template` - Template string type
-- `string_parameter_name` - Parameter name type
-- `string_model_name` - Model name type
-- `string_url` - URL string type
-- `string_filename` - Filename string type
-- `number_tokens` - Token count type
-- `number_usd` - USD amount type
-- `ModelVariant` - Model variant enumeration
-- `ScriptLanguage` - Script language enumeration
-- `TaskType` - Task type enumeration
+
+-   `string_prompt` - Prompt string type (type)
+-   `string_template` - Template string type (type)
+-   `string_text_prompt` - Text prompt string type (type)
+-   `string_chat_prompt` - Chat prompt string type (type)
+-   `string_system_message` - System message string type (type)
+-   `string_completion_prompt` - Completion prompt string type (type)
+-   `string_parameter_name` - Parameter name type (type)
+-   `string_parameter_value` - Parameter value type (type)
+-   `string_reserved_parameter_name` - Reserved parameter name type (type)
+-   `ReservedParameters` - Reserved parameters type (type)
+-   `string_model_name` - Model name type (type)
+-   `string_url` - URL string type (type)
+-   `string_filename` - Filename string type (type)
+-   `string_absolute_filename` - Absolute filename type (type)
+-   `string_relative_filename` - Relative filename type (type)
+-   `string_dirname` - Directory name type (type)
+-   `string_absolute_dirname` - Absolute directory name type (type)
+-   `string_relative_dirname` - Relative directory name type (type)
+-   `number_tokens` - Token count type (type)
+-   `number_usd` - USD amount type (type)
+-   `ModelVariant` - Model variant enumeration (type)
+-   `ScriptLanguage` - Script language enumeration (type)
+-   `TaskType` - Task type enumeration (type)
+-   `SectionType` - Section type enumeration (type)
+-   `ModelRequirements` - Model requirements type (type)
+-   `CompletionModelRequirements` - Completion model requirements (type)
+-   `ChatModelRequirements` - Chat model requirements (type)
+-   `EmbeddingModelRequirements` - Embedding model requirements (type)
 
 ### Remote Server Types
-- `RemoteServerOptions` - Remote server configuration
-- `RemoteClientOptions` - Remote client configuration
-- `Identification` - User identification structure
+
+-   `RemoteServerOptions` - Remote server configuration (type)
+-   `AnonymousRemoteServerOptions` - Anonymous remote server options (type)
+-   `ApplicationRemoteServerOptions` - Application remote server options (type)
+-   `ApplicationRemoteServerClientOptions` - Application remote server client options (type)
+-   `RemoteClientOptions` - Remote client configuration (type)
+-   `Identification` - User identification structure (type)
+-   `ApplicationModeIdentification` - Application mode identification (type)
+-   `AnonymousModeIdentification` - Anonymous mode identification (type)
+-   `LoginRequest` - Login request structure (type)
+-   `LoginResponse` - Login response structure (type)
+-   `RemoteServer` - Remote server interface (type)
 
 ### Storage and Scraper Types
-- `PromptbookStorage` - Storage interface
-- `Scraper` - Scraper interface
-- `ScraperConstructor` - Scraper constructor type
-- `Converter` - Content converter interface
 
-_Note: `@promptbook/types` does not export brand-specific types like `OpenAiExecutionToolsOptions`, `ClaudeExecutionToolsOptions`, `LangchainExecutionToolsOptions`,... etc._
+-   `PromptbookStorage` - Storage interface (type)
+-   `FileCacheStorageOptions` - File cache storage options (type)
+-   `IndexedDbStorageOptions` - IndexedDB storage options (type)
+-   `Scraper` - Scraper interface (type)
+-   `ScraperConstructor` - Scraper constructor type (type)
+-   `ScraperSourceHandler` - Scraper source handler (type)
+-   `ScraperIntermediateSource` - Scraper intermediate source (type)
+-   `ScraperAndConverterMetadata` - Scraper and converter metadata (type)
+-   `Converter` - Content converter interface (type)
+
+### Additional Types
+
+-   `Prompt` - Prompt interface (type)
+-   `CompletionPrompt` - Completion prompt interface (type)
+-   `ChatPrompt` - Chat prompt interface (type)
+-   `EmbeddingPrompt` - Embedding prompt interface (type)
+-   `NonEmptyArray` - Non-empty array type (type)
+-   `NonEmptyReadonlyArray` - Non-empty readonly array type (type)
+-   `IntermediateFilesStrategy` - Intermediate files strategy (type)
+-   `string_promptbook_version` - Promptbook version string type (type)
+
+> 💡 This package provides TypeScript types for promptbook applications. For runtime functionality, see [@promptbook/core](#-packages) or install all packages with `npm i ptbk`
 
 
 ---

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

@@ -18,6 +18,10 @@ import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import { renderMarkdown } from '../book-components/Chat/utils/renderMarkdown';
 import { isMarkdownContent } from '../book-components/Chat/utils/renderMarkdown';
+import { ArrowIcon } from '../book-components/icons/ArrowIcon';
+import { ResetIcon } from '../book-components/icons/ResetIcon';
+import { SendIcon } from '../book-components/icons/SendIcon';
+import { TemplateIcon } from '../book-components/icons/TemplateIcon';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { AvatarChipProps };
 export { AvatarChip };
@@ -38,3 +42,7 @@ export type { ChatMessage };
 export type { ChatParticipant };
 export { renderMarkdown };
 export { isMarkdownContent };
+export { ArrowIcon };
+export { ResetIcon };
+export { SendIcon };
+export { TemplateIcon };

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

@@ -1,9 +1,4 @@
 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
  *

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

@@ -23,10 +23,16 @@ export type ChatProps = {
      * Called when user sends a message
      *
      * Note: You must handle the message yourself and add it to the `messages` array
+     *
+     * - When set, the send textarea and button will be shown
+     * - When undefined, the chat has no input and is read-only showing only the messages
      */
-    onMessage(messageContent: string): Promisable<void>;
+    onMessage?(messageContent: string): Promisable<void>;
     /**
-     * Optional callback, when set, button for resetting chat will be shown
+     * Optional callback
+     *
+     * - When set, button for resetting chat will be shown
+     * - When undefined, no reset button will be shown
      */
     onReset?(): Promisable<void>;
     /**
@@ -113,4 +119,24 @@ export type ChatProps = {
      * Keys should match ChatMessage.from values (e.g., 'USER', 'AGENT_{id}', etc.)
      */
     readonly participants?: ReadonlyArray<ChatParticipant>;
+    /**
+     * Optional callback for handling user feedback on messages
+     * When provided, star rating buttons (1-5 stars) will be displayed next to each message
+     *
+     * @param feedback - Object containing the feedback data
+     * @param feedback.message - The message being rated
+     * @param feedback.rating - Star rating from 1 to 5
+     * @param feedback.textRating - Optional text feedback/note from user
+     * @param feedback.chatThread - Complete chat thread as string
+     * @param feedback.expectedAnswer - Optional expected answer provided by user
+     * @param feedback.url - Current page URL where feedback was given
+     */
+    onFeedback?(feedback: {
+        message: ChatMessage;
+        rating: number;
+        textRating: string;
+        chatThread: string;
+        expectedAnswer: string | null;
+        url: string;
+    }): Promisable<void>;
 };

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

@@ -0,0 +1,8 @@
+/**
+ * @deprecated use `isComplete` instead
+ * @private util of `<Chat />`
+ */
+export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/icons/ArrowIcon.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shows simple arrow icon pointing up or down
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const ArrowIcon: ({ direction, size }: {
+    direction: string;
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/ResetIcon.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Shows simple reset icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const ResetIcon: () => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/SendIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple send icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const SendIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/TemplateIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple template icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const TemplateIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.101.0-0`).
+ * It follows semantic versioning (e.g., `0.101.0-2`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.101.0-1",
+    "version": "0.101.0-3",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-1"
+        "@promptbook/core": "0.101.0-3"
     }
 }