@promptbook/types 0.101.0-0 → 0.101.0-2

package/README.md

@@ -47,7 +47,34 @@ npm i ptbk
 npm i -D @promptbook/types
 ```
 
-This package is useful when you want to explicitly define types in your code.
+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.
+
+## 🎯 Purpose and Motivation
+
+This package centralizes all TypeScript type definitions used throughout the Promptbook ecosystem. It enables developers to write type-safe code when working with promptbooks, pipelines, LLM providers, and other Promptbook components, providing excellent IntelliSense and compile-time error checking.
+
+## 🔧 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
+
+## ✨ 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
+
+## Usage Example
 
 ```typescript
 import type { PipelineJson } from '@promptbook/types';
@@ -73,6 +100,108 @@ 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
+
+### 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
+
+### 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
+
+### 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
+
+### 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
+
+### 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
+
+### 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
+
+### 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
+
+### Remote Server Types
+- `RemoteServerOptions` - Remote server configuration
+- `RemoteClientOptions` - Remote client configuration
+- `Identification` - User identification structure
+
+### 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._
 
 

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

@@ -16,6 +16,12 @@ import { LlmChat } from '../book-components/Chat/LlmChat/LlmChat';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
 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 };
@@ -34,3 +40,9 @@ export { LlmChat };
 export type { LlmChatProps };
 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>;
     /**

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/Chat/examples/ChatMarkdownDemo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Demo component showing Chat with markdown rendering capabilities
+ *
+ * This example demonstrates various markdown features supported by the Chat component:
+ * - Headers
+ * - Bold and italic text
+ * - Code blocks and inline code
+ * - Lists (ordered and unordered)
+ * - Links
+ * - Blockquotes
+ * - Tables
+ * - Strikethrough text
+ *
+ * @private temporary for testing purposes
+ */
+export declare function ChatMarkdownDemo(): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,21 @@
+import type { string_html, string_markdown } from '../../../types/typeAliases';
+/**
+ * Convert markdown content to HTML for display in chat messages
+ *
+ * @param markdown - The markdown content to convert
+ * @returns HTML string ready for rendering
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
+ */
+export declare function renderMarkdown(markdown: string_markdown): string_html;
+/**
+ * Check if content appears to be markdown (contains markdown syntax)
+ *
+ * @param content - Content to check
+ * @returns true if content appears to contain markdown syntax
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
+ */
+export declare function isMarkdownContent(content: string): boolean;

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

@@ -0,0 +1 @@
+export {};

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/utils/markdown/escapeMarkdownBlock.d.ts

@@ -3,6 +3,8 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

package/esm/typings/src/utils/markdown/humanizeAiText.d.ts

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Function `humanizeAiText` will remove traces of AI text generation artifacts
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want more control, look for other functions for example `humanizeAiTextEmdashed` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

package/esm/typings/src/utils/markdown/humanizeAiTextEllipsis.d.ts

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change ellipsis character to three dots `…` -> `...`
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

package/esm/typings/src/utils/markdown/humanizeAiTextEmdashed.d.ts

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change em-dashes to regular dashes `—` -> `-`
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

package/esm/typings/src/utils/markdown/humanizeAiTextQuotes.d.ts

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change smart quotes to regular quotes
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

package/esm/typings/src/utils/markdown/humanizeAiTextWhitespace.d.ts

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change unprintable hard spaces to regular spaces
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts

@@ -7,3 +7,11 @@ import type { string_html } from '../../types/typeAliases';
  * @private withing the package because of HUGE size of prettier dependency
  */
 export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;
+/**
+ * Async version of prettifyMarkdown using dynamic imports
+ *
+ * @param content raw html code
+ * @returns formatted html code
+ * @private withing the package because of HUGE size of prettier dependency
+ */
+export declare function prettifyMarkdownAsync<TContent extends string_html>(content: TContent): Promise<TContent>;

package/esm/typings/src/utils/markdown/promptbookifyAiText.d.ts

@@ -6,6 +6,7 @@ import { string_markdown } from '../../types/typeAliases';
  */
 export declare function promptbookifyAiText(text: string_markdown): string_markdown;
 /**
+ * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
  * TODO: [🅾️]!!! Use this across the project where AI text is involved
  * TODO: [🧠][✌️] Make some Promptbook-native token system
  */

package/esm/typings/src/utils/normalization/capitalize.d.ts

@@ -1,6 +1,8 @@
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function capitalize(word: string): string;

package/esm/typings/src/utils/normalization/decapitalize.d.ts

@@ -1,5 +1,7 @@
 /**
- * Makes first letter of a string uppercase
+ * Makes first letter of a string lowercase
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -9,6 +9,8 @@ export type string_SCREAMING_CASE = string;
 /**
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to SCREAMING_CASE format.
  * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'

package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -8,6 +8,8 @@ export type string_snake_case = string;
 /**
  * Normalizes a text string to snake_case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to snake_case format.
  * @returns The normalized text in snake_case format.
  * @example 'hello_world'

package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts

@@ -1,6 +1,8 @@
 /**
  * Take every whitespace (space, new line, tab) and replace it with a single space
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function normalizeWhitespaces(sentence: string): string;

package/esm/typings/src/utils/normalization/removeDiacritics.d.ts

@@ -1,6 +1,8 @@
 /**
  * Removes diacritic marks (accents) from characters in a string.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param input The string containing diacritics to be normalized.
  * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/parseNumber.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function parseNumber will parse number from string
  *
+ * Note: [🔂] This function is idempotent.
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
  * Note: it also works only with decimal numbers
  *

package/esm/typings/src/utils/removeEmojis.d.ts

@@ -1,6 +1,8 @@
 /**
  * Removes emojis from a string and fix whitespaces
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text with emojis
  * @returns text without emojis
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/removeQuotes.d.ts

@@ -1,6 +1,7 @@
 /**
  * Removes quotes from a string
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
  * Note: There are two similar functions:

package/esm/typings/src/utils/serialization/deepClone.d.ts

@@ -2,6 +2,7 @@ import type { WritableDeep } from 'type-fest';
 /**
  * Creates a deep clone of the given object
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
  *
  * @param objectValue The object to clone.

package/esm/typings/src/utils/trimCodeBlock.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *

package/esm/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -3,6 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: Dataurl are considered perfectly valid.
  * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL

package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -3,6 +3,8 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidUuid(value: really_unknown): value is string_uuid;

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.100.4-0`).
+ * It follows semantic versioning (e.g., `0.101.0-1`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.101.0-0",
+    "version": "0.101.0-2",
     "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-0"
+        "@promptbook/core": "0.101.0-2"
     }
 }