@promptbook/types 0.100.0-8 → 0.100.0

package/README.md

@@ -10,14 +10,18 @@ Write AI applications using plain human language across multiple models and plat
 [![NPM Version of ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
 [![Quality of package ![Promptbook logo - cube with letters P and B](./design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
 [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
-[![Build Status](https://github.com/webgptorg/promptbook/actions/workflows/ci.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions)
-[![Coverage Status](https://coveralls.io/repos/github/webgptorg/promptbook/badge.svg?branch=main)](https://coveralls.io/github/webgptorg/promptbook?branch=main)
+[![🧪 Test Books](https://github.com/webgptorg/promptbook/actions/workflows/test-books.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions/workflows/test-books.yml)
+[![🧪 Test build](https://github.com/webgptorg/promptbook/actions/workflows/test-build.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions/workflows/test-build.yml)
+[![🧪 Lint](https://github.com/webgptorg/promptbook/actions/workflows/test-lint.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions/workflows/test-lint.yml)
+[![🧪 Spell check](https://github.com/webgptorg/promptbook/actions/workflows/test-spell-check.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions/workflows/test-spell-check.yml)
+[![🧪 Test types](https://github.com/webgptorg/promptbook/actions/workflows/test-types.yml/badge.svg)](https://github.com/webgptorg/promptbook/actions/workflows/test-types.yml)
 [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
 
 
 
 ## 🌟 New Features
 
+-   🚀 **GPT-5 Support** - Now includes OpenAI's most advanced language model with unprecedented reasoning capabilities and 200K context window
 -   💡 VS Code support for `.book` files with syntax highlighting and IntelliSense
 -   🐳 Official Docker image (`hejny/promptbook`) for seamless containerized usage
 -   🔥 Native support for OpenAI `o3-mini`, GPT-4 and other leading LLMs
@@ -25,10 +29,6 @@ Write AI applications using plain human language across multiple models and plat
 
 
 
-<blockquote style="color: #ff8811">
-    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
-</blockquote>
-
 ## 📦 Package `@promptbook/types`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -85,8 +85,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
-
-
 It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines – and it's going to change everything!
 
 The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
@@ -212,8 +210,6 @@ Join our growing community of developers and users:
 
 _A concise, Markdown-based DSL for crafting AI workflows and automations._
 
-
-
 ### Introduction
 
 Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
@@ -263,8 +259,6 @@ Personas can have access to different knowledge, tools and actions. They can als
 
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
-
-
 ### **3. How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -339,6 +333,7 @@ Or you can install them separately:
 -   **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
 -   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
+-   **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
 -   ⭐ **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 -   🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
 
@@ -364,8 +359,6 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-
-
 ### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)

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

@@ -0,0 +1,50 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { $randomColor } from '../utils/color/$randomColor';
+import { Color } from '../utils/color/Color';
+import { CSS_COLORS } from '../utils/color/css-colors';
+import type { ColorTransformer } from '../utils/color/operators/ColorTransformer';
+import { darken } from '../utils/color/operators/darken';
+import { furthest } from '../utils/color/operators/furthest';
+import { textColor } from '../utils/color/operators/furthest';
+import { grayscale } from '../utils/color/operators/grayscale';
+import { lighten } from '../utils/color/operators/lighten';
+import { mixWithColor } from '../utils/color/operators/mixWithColor';
+import { nearest } from '../utils/color/operators/nearest';
+import { negative } from '../utils/color/operators/negative';
+import { negativeLightness } from '../utils/color/operators/negativeLightness';
+import { withAlpha } from '../utils/color/operators/withAlpha';
+import { areColorsEqual } from '../utils/color/utils/areColorsEqual';
+import { colorDistance } from '../utils/color/utils/colorDistance';
+import { colorDistanceSquared } from '../utils/color/utils/colorDistance';
+import { colorHue } from '../utils/color/utils/colorHue';
+import { colorHueDistance } from '../utils/color/utils/colorHueDistance';
+import { colorLuminance } from '../utils/color/utils/colorLuminance';
+import { colorSatulightion } from '../utils/color/utils/colorSatulightion';
+import { colorSaturation } from '../utils/color/utils/colorSaturation';
+import { colorToDataUrl } from '../utils/color/utils/colorToDataUrl';
+import { mixColors } from '../utils/color/utils/mixColors';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { $randomColor };
+export { Color };
+export { CSS_COLORS };
+export type { ColorTransformer };
+export { darken };
+export { furthest };
+export { textColor };
+export { grayscale };
+export { lighten };
+export { mixWithColor };
+export { nearest };
+export { negative };
+export { negativeLightness };
+export { withAlpha };
+export { areColorsEqual };
+export { colorDistance };
+export { colorDistanceSquared };
+export { colorHue };
+export { colorHueDistance };
+export { colorLuminance };
+export { colorSatulightion };
+export { colorSaturation };
+export { colorToDataUrl };
+export { mixColors };

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

@@ -0,0 +1,36 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChip';
+import { AvatarChip } from '../book-components/AvatarProfile/AvatarChip/AvatarChip';
+import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
+import { AvatarChipFromSource } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
+import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
+import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
+import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
+import { BookEditor } from '../book-components/BookEditor/BookEditor';
+import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
+import { Chat } from '../book-components/Chat/Chat/Chat';
+import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
+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';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export type { AvatarChipProps };
+export { AvatarChip };
+export type { AvatarChipFromSourceProps };
+export { AvatarChipFromSource };
+export type { AvatarProfileProps };
+export { AvatarProfile };
+export type { AvatarProfileFromSourceProps };
+export { AvatarProfileFromSource };
+export type { BookEditorProps };
+export { BookEditor };
+export { DEFAULT_BOOK_FONT_CLASS };
+export { Chat };
+export type { ChatProps };
+export { LlmChat };
+export type { LlmChatProps };
+export type { ChatMessage };
+export type { ChatParticipant };

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

@@ -1,4 +1,16 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { parseAgentSource } from '../book-2.0/agent-source/parseAgentSource';
+import { isValidBook } from '../book-2.0/agent-source/string_book';
+import { validateBook } from '../book-2.0/agent-source/string_book';
+import { DEFAULT_BOOK } from '../book-2.0/agent-source/string_book';
+import { createEmptyAgentModelRequirements } from '../book-2.0/commitments/_base/createEmptyAgentModelRequirements';
+import { createBasicAgentModelRequirements } from '../book-2.0/commitments/_base/createEmptyAgentModelRequirements';
+import { NotYetImplementedCommitmentDefinition } from '../book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition';
+import { createAgentModelRequirements } from '../book-2.0/commitments/_misc/createAgentModelRequirements';
+import { getCommitmentDefinition } from '../book-2.0/commitments/index';
+import { getAllCommitmentDefinitions } from '../book-2.0/commitments/index';
+import { getAllCommitmentTypes } from '../book-2.0/commitments/index';
+import { isCommitmentSupported } from '../book-2.0/commitments/index';
 import { collectionToJson } from '../collection/collectionToJson';
 import { createCollectionFromJson } from '../collection/constructors/createCollectionFromJson';
 import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
@@ -34,8 +46,11 @@ import { DEFAULT_CSV_SETTINGS } from '../config';
 import { DEFAULT_IS_VERBOSE } from '../config';
 import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
+import { DEFAULT_TASK_SIMULATED_DURATION_MS } from '../config';
 import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
 import { DEFAULT_MAX_REQUESTS_PER_MINUTE } from '../config';
+import { API_REQUEST_TIMEOUT } from '../config';
+import { PROMPTBOOK_LOGO_URL } from '../config';
 import { MODEL_TRUST_LEVELS } from '../constants';
 import { MODEL_ORDERS } from '../constants';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
@@ -148,6 +163,18 @@ import { SectionTypes } from '../types/SectionType';
 import { TaskTypes } from '../types/TaskType';
 import { REMOTE_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { parseAgentSource };
+export { isValidBook };
+export { validateBook };
+export { DEFAULT_BOOK };
+export { createEmptyAgentModelRequirements };
+export { createBasicAgentModelRequirements };
+export { NotYetImplementedCommitmentDefinition };
+export { createAgentModelRequirements };
+export { getCommitmentDefinition };
+export { getAllCommitmentDefinitions };
+export { getAllCommitmentTypes };
+export { isCommitmentSupported };
 export { collectionToJson };
 export { createCollectionFromJson };
 export { createCollectionFromPromise };
@@ -183,8 +210,11 @@ export { DEFAULT_CSV_SETTINGS };
 export { DEFAULT_IS_VERBOSE };
 export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
+export { DEFAULT_TASK_SIMULATED_DURATION_MS };
 export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
 export { DEFAULT_MAX_REQUESTS_PER_MINUTE };
+export { API_REQUEST_TIMEOUT };
+export { PROMPTBOOK_LOGO_URL };
 export { MODEL_TRUST_LEVELS };
 export { MODEL_ORDERS };
 export { ORDER_OF_PIPELINE_JSON };

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

@@ -1,3 +1,19 @@
+import type { AgentBasicInformation } from '../book-2.0/agent-source/parseAgentSource';
+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 { AgentModelRequirements } from '../book-2.0/commitments/_misc/AgentModelRequirements';
+import type { AgentSourceParseResult } from '../book-2.0/commitments/_misc/AgentSourceParseResult';
+import type { ParsedCommitment } from '../book-2.0/commitments/_misc/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 { ChatProps } from '../book-components/Chat/Chat/ChatProps';
+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 type { PipelineCollection } from '../collection/PipelineCollection';
 import type { Command } from '../commands/_common/types/Command';
 import type { CommandParser } from '../commands/_common/types/CommandParser';
@@ -177,6 +193,7 @@ import type { InputParameters } from '../types/typeAliases';
 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_persona_description } from '../types/typeAliases';
 import type { string_model_description } from '../types/typeAliases';
 import type { string_knowledge_source_content } from '../types/typeAliases';
@@ -282,6 +299,7 @@ import type { number_gigabytes } from '../types/typeAliases';
 import type { number_terabytes } from '../types/typeAliases';
 import type { Registered } from '../utils/$Register';
 import type { Registration } from '../utils/$Register';
+import type { ColorTransformer } from '../utils/color/operators/ColorTransformer';
 import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
 import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
 import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
@@ -301,7 +319,24 @@ import type { really_any } from '../utils/organization/really_any';
 import type { TODO_any } from '../utils/organization/TODO_any';
 import type { CheckSerializableAsJsonOptions } from '../utils/serialization/checkSerializableAsJson';
 import type { ExportJsonOptions } from '../utils/serialization/exportJson';
+import type { ITakeChain } from '../utils/take/interfaces/ITakeChain';
 import type { string_promptbook_version } from '../version';
+export type { AgentBasicInformation };
+export type { string_book };
+export type { BookCommitment };
+export type { CommitmentDefinition };
+export type { AgentModelRequirements };
+export type { AgentSourceParseResult };
+export type { ParsedCommitment };
+export type { AvatarChipProps };
+export type { AvatarChipFromSourceProps };
+export type { AvatarProfileProps };
+export type { AvatarProfileFromSourceProps };
+export type { BookEditorProps };
+export type { ChatProps };
+export type { LlmChatProps };
+export type { ChatMessage };
+export type { ChatParticipant };
 export type { PipelineCollection };
 export type { Command };
 export type { CommandParser };
@@ -481,6 +516,7 @@ export type { InputParameters };
 export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };
+export type { string_agent_name };
 export type { string_persona_description };
 export type { string_model_description };
 export type { string_knowledge_source_content };
@@ -586,6 +622,7 @@ export type { number_gigabytes };
 export type { number_terabytes };
 export type { Registered };
 export type { Registration };
+export type { ColorTransformer };
 export type { PipelineEditableSerialized };
 export type { ExecCommandOptions };
 export type { ExecCommandOptionsAdvanced };
@@ -605,4 +642,5 @@ export type { really_any };
 export type { TODO_any };
 export type { CheckSerializableAsJsonOptions };
 export type { ExportJsonOptions };
+export type { ITakeChain };
 export type { string_promptbook_version };

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

@@ -0,0 +1,30 @@
+import type { string_agent_name } from '../../types/typeAliases';
+import type { string_url_image } from '../../types/typeAliases';
+import type { string_book } from './string_book';
+export interface AgentBasicInformation {
+    /**
+     * Name of the agent
+     * This is the first line of the agent source
+     */
+    agentName: string_agent_name | null;
+    /**
+     * Optional description of the agent
+     * This is the line starting with "PERSONA"
+     */
+    personaDescription: string | null;
+    /**
+     * Optional profile image URL
+     * This is the line starting with "META IMAGE"
+     */
+    profileImageUrl: string_url_image;
+}
+/**
+ * Parses basic information from agent source
+ *
+ * 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 parseAgentSource(agentSource: string_book): AgentBasicInformation;

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

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

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

@@ -0,0 +1,26 @@
+/**
+ * Branded type for books
+ */
+export type string_book = string & {
+    readonly __type: 'book';
+};
+/**
+ * Type guard to check if a string is a valid agent source
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isValidBook(value: string): value is string_book;
+/**
+ * Validates and converts a string to agent source branded type
+ * 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
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function validateBook(source: string): string_book;
+/**
+ * Default book
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOK: string_book;

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

@@ -0,0 +1,38 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * ACTION commitment definition
+ *
+ * The ACTION commitment defines specific actions or capabilities that the agent can perform.
+ * This helps define what the agent is capable of doing and how it should approach tasks.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * ACTION Can generate code snippets and explain programming concepts
+ * ACTION Able to analyze data and provide insights
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
+    constructor();
+    /**
+     * Short one-line description of ACTION.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for ACTION commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the ACTION commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ActionCommitment: ActionCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,39 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * FORMAT commitment definition
+ *
+ * The FORMAT commitment defines the specific output structure and formatting
+ * that the agent should use in its responses. This includes data formats,
+ * response templates, and structural requirements.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * FORMAT Always respond in JSON format with 'status' and 'data' fields
+ * FORMAT Use markdown formatting for all code blocks
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
+    constructor();
+    /**
+     * Short one-line description of FORMAT.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for FORMAT commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the FORMAT commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const FormatCommitment: FormatCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,45 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * KNOWLEDGE commitment definition
+ *
+ * The KNOWLEDGE commitment adds specific knowledge, facts, or context to the agent
+ * using RAG (Retrieval-Augmented Generation) approach for external sources.
+ *
+ * Supports both direct text knowledge and external sources like PDFs.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * KNOWLEDGE The company was founded in 2020 and specializes in AI-powered solutions
+ * KNOWLEDGE https://example.com/company-handbook.pdf
+ * KNOWLEDGE https://example.com/product-documentation.pdf
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition<'KNOWLEDGE'> {
+    constructor();
+    /**
+     * Short one-line description of KNOWLEDGE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for KNOWLEDGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Check if content is a URL
+     */
+    private isUrl;
+}
+/**
+ * Singleton instance of the KNOWLEDGE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const KnowledgeCommitment: KnowledgeCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,44 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * META IMAGE commitment definition
+ *
+ * The META IMAGE commitment sets the agent's avatar/profile image URL.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META IMAGE https://example.com/avatar.jpg
+ * META IMAGE /assets/agent-avatar.png
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition<'META IMAGE'> {
+    constructor();
+    /**
+     * Short one-line description of META IMAGE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for META IMAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the profile image URL from the content
+     * This is used by the parsing logic
+     */
+    extractProfileImageUrl(content: string): string | null;
+}
+/**
+ * Singleton instance of the META IMAGE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MetaImageCommitment: MetaImageCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,56 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * META LINK commitment definition
+ *
+ * The `META LINK` commitment represents the link to the person from whom the agent is created.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic for profile display.
+ *
+ * Example usage in agent source:
+ *
+ * ```
+ * META LINK https://twitter.com/username
+ * META LINK https://linkedin.com/in/profile
+ * META LINK https://github.com/username
+ * ```
+ *
+ * Multiple `META LINK` commitments can be used when there are multiple sources:
+ *
+ * ```book
+ * META LINK https://twitter.com/username
+ * META LINK https://linkedin.com/in/profile
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition<'META LINK'> {
+    constructor();
+    /**
+     * Short one-line description of META LINK.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for META LINK commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the profile link URL from the content
+     * This is used by the parsing logic
+     */
+    extractProfileLinkUrl(content: string): string | null;
+    /**
+     * Validates if the provided content is a valid URL
+     */
+    isValidUrl(content: string): boolean;
+}
+/**
+ * Singleton instance of the META LINK commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MetaLinkCommitment: MetaLinkCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,39 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * MODEL commitment definition
+ *
+ * The MODEL commitment specifies which AI model to use and can also set
+ * model-specific parameters like temperature, topP, and topK.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * MODEL gpt-4
+ * MODEL claude-3-opus temperature=0.3
+ * MODEL gpt-3.5-turbo temperature=0.8 topP=0.9
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
+    constructor();
+    /**
+     * Short one-line description of MODEL.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for MODEL commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the MODEL commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ModelCommitment: ModelCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */