@promptbook/types weekly downloads statistics

🐙 Promptbook: Invisible AI Agents

Create persistent AI agents that turn your company's scattered knowledge into action - powered by the Agents Server

Promptbook](https://www.npmjs.com/package/promptbook) Promptbook](https://packagequality.com/#?package=promptbook)

🚀 Quick deploy

Run the standalone VPS installer _(for example on DigitalOcean)_ only on a fresh server. Interactive mode asks for the installation values:

Non-interactive mode takes defaults from command-line options. Use --env live, --env preview, --env production, or --env lts to pick the installed environment; the default is preview. When --openai-api-key is provided with the default OpenAI Codex runner, the installer installs and configures Codex automatically; other runner authentication can be configured later from the UI or SSH:

⚠ Warning: This is a pre-release version of the library. It is not yet ready for production use. Please look at latest stable release.

📦 Package @promptbook/types

• Promptbooks are divided into several packages, all are published from single monorepo. • This package @promptbook/types is one part of the promptbook ecosystem.

To install this package, run:

Comprehensive TypeScript type definitions for all Promptbook entities, enabling type-safe development and excellent IDE support throughout the Promptbook ecosystem.

🎯 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

📦 Exported Type Categories

Agent and Book Types

• 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 (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 (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 (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…

Description from the npm listing.