@promptbook/types 0.105.0-1 → 0.105.0-4

package/README.md

@@ -304,19 +304,20 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 ## 📖 The Book Whitepaper
 
-For most business applications nowadays, the biggest challenge isn't about the raw capabilities of AI models. Large language models like GPT-5 or Claude-4.1 are extremely capable.
+Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
 
-The main challenge is to narrow it down, constrain it, set the proper **context, rules, knowledge, and personality**. There are a lot of tools which can do exactly this. On one side, there are no-code platforms which can launch your agent in seconds. On the other side, there are heavy frameworks like Langchain or Semantic Kernel, which can give you deep control.
+The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
 
-Promptbook takes the best from both worlds. You are defining your AI behavior by simple **books**, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
+In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
 
 <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
-**<ins>Paul Smith & Associés</ins>**<br/>
+**<ins>Paul Smith</ins>**<br/>
 <br/>
 **PERSONA** You are a company lawyer.<br/>
 Your job is to provide legal advice and support to the company and its employees.<br/>
-You are knowledgeable, professional, and detail-oriented.<br/>
+**RULE** You are knowledgeable, professional, and detail-oriented.<br/>
+TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
 
 </td></tr></table>
 
@@ -326,7 +327,9 @@ You are knowledgeable, professional, and detail-oriented.<br/>
 
 We have created a language called **Book**, which allows you to write AI agents in their native language and create your own AI persona. Book provides a guide to define all the traits and commitments.
 
-You can look at it as prompting (or writing a system message), but decorated by **commitments**.
+You can look at it as "prompting" _(or writing a system message)_, but decorated by **commitments**.
+
+**Commitments** are special syntax elements that define contracts between you and the AI agent. They are transformed by Promptbook Engine into low-level parameters like which model to use, its temperature, system message, RAG index, MCP servers, and many other parameters. For some commitments _(for example `RULE` commitment)_ Promptbook Engine can even create adversary agents and extra checks to enforce the rules.
 
 #### `Persona` commitment
 
@@ -337,8 +340,6 @@ Personas define the character of your AI persona, its role, and how it should in
 **<ins>Paul Smith & Associés</ins>**<br/>
 <br/>
 **PERSONA** You are a company lawyer.<br/>
-Your job is to provide legal advice and support to the company and its employees.<br/>
-You are knowledgeable, professional, and detail-oriented.<br/>
 
 </td></tr></table>
 
@@ -358,7 +359,7 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
 Your job is to provide legal advice and support to the company and its employees.<br/>
 You are knowledgeable, professional, and detail-oriented.<br/>
 <br/>
-**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
 **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
 
 </td></tr></table>
@@ -380,14 +381,14 @@ You are knowledgeable, professional, and detail-oriented.<br/>
 **RULE** Always ensure compliance with laws and regulations.<br/>
 **RULE** Never provide legal advice outside your area of expertise.<br/>
 **RULE** Never provide legal advice about criminal law.<br/>
-**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
 **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
 
 </td></tr></table>
 
-#### `Action` commitment
+#### `Team` commitment
 
-Action Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
+Team commitment allows you to define the team structure and advisory fellow members the AI can consult with. This allows the AI to simulate collaboration and consultation with other experts, enhancing the quality of its responses.
 
 <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
@@ -400,81 +401,36 @@ You are knowledgeable, professional, and detail-oriented.<br/>
 **RULE** Always ensure compliance with laws and regulations.<br/>
 **RULE** Never provide legal advice outside your area of expertise.<br/>
 **RULE** Never provide legal advice about criminal law.<br/>
-**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
 **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
-**ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
+TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
 
 </td></tr></table>
 
-[Read more about the language](./BLUEPRINT.md)
-
-<div style="page-break-after: always;"></div>
-
-### Where to use your AI agent in book
-
-Books can be useful in various applications and scenarios. Here are some examples:
-
-#### Chat apps:
 
-Create your own chat shopping assistant and place it in your eShop.
-You will be able to answer customer questions, help them find products, and provide personalized recommendations. Everything is tightly controlled by the book you have written.
 
-#### Reply Agent:
+### Promptbook Ecosystem
 
-Create your own AI agent, which will look at your emails and reply to them. It can even create drafts for you to review before sending.
+!!!@@@
 
-#### Coding Agent:
-
-Do you love Vibecoding, but the AI code is not always aligned with your coding style and architecture, rules, security, etc.? Create your own coding agent to help enforce your specific coding standards and practices.
-
-This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
-
-They will work the same as you are used to, but with your specific rules written in book.
-
-#### Internal Expertise
-
-Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
-
-You can avoid struggle with choosing the best model, its settings like temperature, max tokens, etc., by writing a book agent and using it as your AI expertise.
-
-Doesn't matter if you do automations, data analysis, customer support, sentiment analysis, classification, or any other task. Your AI agent will be tailored to your specific needs and requirements.
-
-Even works in no-code platforms!
-
-<div style="page-break-after: always;"></div>
+#### Promptbook Server
 
-### How to create your AI agent in book
+!!!@@@
 
-Now you want to use it. There are several ways how to write your first book:
+#### Promptbook Engine
 
-#### From scratch with help from Paul
+!!!@@@
 
-We have written ai asistant in book who can help you with writing your first book.
 
-#### Your AI twin
 
-Copy your own behavior, personality, and knowledge into book and create your AI twin. It can help you with your work, personal life, or any other task.
 
-#### AI persona workpool
 
-Or you can pick from our library of pre-written books for various roles and tasks. You can find books for customer support, coding, marketing, sales, HR, legal, and many other roles.
 
 
 
 
 
 
-## 🚀 Get started
-
-Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
-
--   [Hello Book](https://github.com/webgptorg/hello-world)
--   [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
--   [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
-
-
-
-
 
 
 ## 💜 The Promptbook Project
@@ -490,33 +446,32 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </thead>
   <tbody>
     <tr>
-      <td><a href="https://github.com/webgptorg/book">Book language</a></td>
+      <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
       <td>
-          Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
-          <hr>
-          There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
+          Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
       </td>
     </tr>
     <tr>
-      <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
+      <td><a href="https://github.com/webgptorg/book">Book language</a></td>
       <td>
-          Promptbook engine can run applications written in Book language. It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Docker HUB</a>
+          Human-friendly, high-level language that abstracts away low-level details of AI. It allows to focus on personality, behavior, knowledge, and rules of AI agents rather than on models, parameters, and prompt engineering.
+          <hr>
+          There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
       </td>
     </tr>
     <tr>
-      <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
+      <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
       <td>
-          Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage.
+          Promptbook engine can run AI agents based on Book language.
+          It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
+          Agent Server is based on Promptbook Engine.
       </td>
     </tr>
+    
   </tbody>
 </table>
 
-Hello world examples:
 
--   [Hello world](https://github.com/webgptorg/hello-world)
--   [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
--   [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
 
 ### 🌐 Community & Social Media
 
@@ -574,6 +529,8 @@ Join our growing community of developers and users:
 
 
 
+
+
 ## 📚 Documentation
 
 See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -650,6 +607,8 @@ 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/core.index.d.ts

@@ -27,6 +27,7 @@ import { getAllCommitmentTypes } from '../commitments/index';
 import { isCommitmentSupported } from '../commitments/index';
 import type { GroupedCommitmentDefinition } from '../commitments/index';
 import { getGroupedCommitmentDefinitions } from '../commitments/index';
+import { getAllCommitmentsToolFunctions } from '../commitments/index';
 import { NAME } from '../config';
 import { ADMIN_EMAIL } from '../config';
 import { PROMPTBOOK_LEGAL_ENTITY } from '../config';
@@ -225,6 +226,7 @@ export { getAllCommitmentTypes };
 export { isCommitmentSupported };
 export type { GroupedCommitmentDefinition };
 export { getGroupedCommitmentDefinitions };
+export { getAllCommitmentsToolFunctions };
 export { NAME };
 export { ADMIN_EMAIL };
 export { PROMPTBOOK_LEGAL_ENTITY };

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

@@ -106,6 +106,7 @@ import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
 import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
 import type { string_formfactor_name } from '../formfactors/_common/string_formfactor_name';
+import type { FileImportPlugin } from '../import-plugins/FileImportPlugin';
 import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
 import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
 import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
@@ -179,6 +180,7 @@ import type { ScraperSourceHandler } from '../scrapers/_common/Scraper';
 import type { ScraperIntermediateSource } from '../scrapers/_common/ScraperIntermediateSource';
 import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { ToolFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { SearchEngine } from '../search-engines/SearchEngine';
 import type { SearchResult } from '../search-engines/SearchResult';
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
@@ -478,6 +480,7 @@ export type { CsvSettings };
 export type { AbstractFormfactorDefinition };
 export type { FormfactorDefinition };
 export type { string_formfactor_name };
+export type { FileImportPlugin };
 export type { LlmToolsConfiguration };
 export type { LlmToolsMetadata };
 export type { LlmToolsOptions };
@@ -551,6 +554,7 @@ export type { ScraperSourceHandler };
 export type { ScraperIntermediateSource };
 export type { JavascriptExecutionToolsOptions };
 export type { PostprocessingFunction };
+export type { ToolFunction };
 export type { SearchEngine };
 export type { SearchResult };
 export type { PromptbookStorage };

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

@@ -31,7 +31,7 @@ export type AgentCapability = {
     /**
      * The type of the capability
      */
-    type: 'browser' | 'search-engine' | 'knowledge';
+    type: 'browser' | 'search-engine' | 'knowledge' | 'time';
     /**
      * The label to display for this capability
      */
@@ -90,12 +90,19 @@ export type AgentBasicInformation = {
      * - @Parameter (single word parameter starting with @)
      * - {parameterName} or {parameter with multiple words} or {parameterName: description text}
      */
-    parameters: BookParameter[];
+    parameters: Array<BookParameter>;
     /**
      * Capabilities of the agent
      * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
      */
-    capabilities: AgentCapability[];
+    capabilities: Array<AgentCapability>;
+    /**
+     * List of sample conversations (question/answer pairs)
+     */
+    samples: Array<{
+        question: string | null;
+        answer: string;
+    }>;
 };
 /**
  * TODO: [🐱‍🚀] Make all properties of `AgentBasicInformation` readonly

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

@@ -32,6 +32,10 @@ export type AgentModelRequirements = {
      * List of imported agent URLs
      */
     readonly importedAgentUrls?: ReadonlyArray<string_agent_url>;
+    /**
+     * List of imported file URLs or paths
+     */
+    readonly importedFileUrls?: ReadonlyArray<string>;
     /**
      * Optional list of knowledge source links that the agent can use
      */
@@ -40,7 +44,7 @@ export type AgentModelRequirements = {
      * List of sample conversations (question/answer pairs)
      */
     readonly samples?: ReadonlyArray<{
-        question: string;
+        question: string | null;
         answer: string;
     }>;
     /**
@@ -64,6 +68,12 @@ export type AgentModelRequirements = {
      * Each commitment can store its own data here
      */
     readonly metadata?: Record<string, TODO_any>;
+    /**
+     * Notes associated with the agent
+     *
+     * Note: This does not affect agent behavior in any way
+     */
+    readonly notes?: ReadonlyArray<string>;
 };
 /**
  * TODO: [🐤] DRY `AgentModelRequirements` and `ModelRequirements`

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

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

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

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

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

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

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

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

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

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

package/esm/typings/src/commitments/USE_TIME/USE_TIME.d.ts

@@ -0,0 +1,40 @@
+import { string_javascript_name } from '../../_packages/types.index';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE TIME commitment definition
+ *
+ * The `USE TIME` commitment indicates that the agent should be able to determine the current date and time.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE TIME
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseTimeCommitmentDefinition extends BaseCommitmentDefinition<'USE TIME'> {
+    constructor();
+    /**
+     * Short one-line description of USE TIME.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE TIME commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets the `get_current_time` tool function implementation.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/USE_TIME/USE_TIME.test.d.ts

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

package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts

@@ -1,4 +1,6 @@
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import { string_javascript_name } from '../../types/typeAliases';
 import type { CommitmentDefinition } from './CommitmentDefinition';
 /**
  * Base implementation of CommitmentDefinition that provides common functionality
@@ -61,4 +63,10 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
      * but can be useful for organizing and structuring the message during processing
      */
     protected addCommentSection(requirements: AgentModelRequirements, commentTitle: string, content: string, position?: 'beginning' | 'end'): AgentModelRequirements;
+    /**
+     * Gets tool function implementations provided by this commitment
+     *
+     * When the `applyToAgentModelRequirements` adds tools to the requirements, this method should return the corresponding function definitions.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }

package/esm/typings/src/commitments/_base/CommitmentDefinition.d.ts

@@ -1,4 +1,6 @@
+import { string_javascript_name } from '../../_packages/types.index';
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
 /**
  * Definition of a commitment that can be applied to agent model requirements
  *
@@ -50,4 +52,10 @@ export type CommitmentDefinition = {
      * @returns Updated agent model requirements
      */
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Gets tool function implementations provided by this commitment
+     *
+     * When the `applyToAgentModelRequirements` adds tools to the requirements, this method should return the corresponding function definitions.
+     */
+    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 };

package/esm/typings/src/commitments/index.d.ts

@@ -1,5 +1,7 @@
 import type { BookCommitment } from './_base/BookCommitment';
 import type { CommitmentDefinition } from './_base/CommitmentDefinition';
+import { ToolFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import { string_javascript_name } from '../types/typeAliases';
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
 import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
@@ -7,8 +9,8 @@ import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
 import { FromCommitmentDefinition } from './FROM/FROM';
-import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
+import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
 import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
 import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
@@ -33,6 +35,7 @@ import { UseCommitmentDefinition } from './USE/USE';
 import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
 import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
+import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
 /**
  * Registry of all available commitment definitions
@@ -41,7 +44,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up
@@ -89,6 +92,12 @@ export type GroupedCommitmentDefinition = {
  * @public exported from `@promptbook/core`
  */
 export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
+/**
+ * Gets all function implementations provided by all commitments
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentsToolFunctions(): Record<string_javascript_name, ToolFunction>;
 /**
  * TODO: [🧠] Maybe create through standardized $register
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -63,6 +63,7 @@ export declare const PROMPTBOOK_SYNTAX_COLORS: {
     readonly SEPARATOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly CODE_BLOCK: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 };
 /**
  * Chat color of the Promptbook (in chat)

package/esm/typings/src/import-plugins/$fileImportPlugins.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * All available file import plugins
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const $fileImportPlugins: ReadonlyArray<FileImportPlugin>;

package/esm/typings/src/import-plugins/AgentFileImportPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * Plugin for importing agent books *(`.book` files)*
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const AgentFileImportPlugin: FileImportPlugin;

package/esm/typings/src/import-plugins/FileImportPlugin.d.ts

@@ -0,0 +1,24 @@
+import type { string_mime_type } from '../types/typeAliases';
+/**
+ * Type for file import plugins
+ *
+ * Each plugin handles a specific set of MIME types or file extensions.
+ */
+export type FileImportPlugin = {
+    /**
+     * Unique name of the plugin
+     */
+    readonly name: string;
+    /**
+     * Checks if the plugin can handle the given MIME type or file extension
+     */
+    canImport(mimeType: string_mime_type): boolean;
+    /**
+     * Processes the file content and returns the string to be placed in the agent book
+     *
+     * @param content - The raw content of the file
+     * @param mimeType - The MIME type of the file
+     * @returns The processed content (e.g. wrapped in code block)
+     */
+    import(content: string, mimeType: string_mime_type): string | Promise<string>;
+};

package/esm/typings/src/import-plugins/JsonFileImportPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * Plugin for importing JSON files
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const JsonFileImportPlugin: FileImportPlugin;

package/esm/typings/src/import-plugins/TextFileImportPlugin.d.ts

@@ -0,0 +1,7 @@
+import type { FileImportPlugin } from './FileImportPlugin';
+/**
+ * Plugin for importing generic text files
+ *
+ * @private [🥝] Maybe export the import plugins through some package
+ */
+export declare const TextFileImportPlugin: FileImportPlugin;

package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -4,9 +4,10 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
  * Intercepts LLM tools and counts total usage of the tools
  *
  * Note: It can take extended `LlmExecutionTools` and cache the
+ * Note: Returns full proxy of all LLM tool properties and methods
  *
  * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
- * @returns LLM tools with same functionality with added total cost counting
+ * @returns Full proxy of LLM tools with same functionality with added caching
  * @public exported from `@promptbook/core`
  */
 export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts

@@ -8,10 +8,10 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  * in real-time through an observable.
  *
  * @param llmTools - The LLM tools to be intercepted and tracked
- * @returns An augmented version of the tools that includes usage tracking capabilities
+ * @returns Full proxy of the tools with added usage tracking capabilities
  * @public exported from `@promptbook/core`
  */
-export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+export declare function countUsage<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools): TLlmTools & LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util

package/esm/typings/src/llm-providers/agent/Agent.d.ts

@@ -42,7 +42,14 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
      * Capabilities of the agent
      * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
      */
-    capabilities: AgentCapability[];
+    capabilities: Array<AgentCapability>;
+    /**
+     * List of sample conversations (question/answer pairs)
+     */
+    samples: Array<{
+        question: string | null;
+        answer: string;
+    }>;
     /**
      * Computed hash of the agent source for integrity verification
      */
@@ -63,7 +70,7 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
     /**
      * Not used in Agent, always returns empty array
      */
-    get parameters(): BookParameter[];
+    get parameters(): Array<BookParameter>;
     readonly agentSource: BehaviorSubject<string_book>;
     constructor(options: AgentOptions);
     /**

package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts

@@ -54,8 +54,10 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
     private getAgentInfo;
     /**
      * Get cached or create agent model requirements
+     *
+     * Note: [🐤] This is names `getModelRequirements` *(not `getAgentModelRequirements`)* because in future these two will be united
      */
-    protected getAgentModelRequirements(): Promise<AgentModelRequirements>;
+    getModelRequirements(): Promise<AgentModelRequirements>;
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     get profile(): ChatParticipant | undefined;

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -1,5 +1,6 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { ModelRequirements } from '../../types/ModelRequirements';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_title, string_token } from '../../types/typeAliases';
 import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
@@ -54,6 +55,10 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
          * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
          */
         readonly knowledgeSources?: ReadonlyArray<string>;
+        /**
+         * Optional list of tools to attach to the assistant
+         */
+        readonly tools?: ModelRequirements['tools'];
     }): Promise<OpenAiAssistantExecutionTools>;
     updateAssistant(options: {
         /**
@@ -72,6 +77,10 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
          * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
          */
         readonly knowledgeSources?: ReadonlyArray<string>;
+        /**
+         * Optional list of tools to attach to the assistant
+         */
+        readonly tools?: ModelRequirements['tools'];
     }): Promise<OpenAiAssistantExecutionTools>;
     /**
      * Discriminant for type guards
@@ -85,6 +94,7 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     static isOpenAiAssistantExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAssistantExecutionTools;
 }
 /**
+ * TODO: [🙎] In `OpenAiAssistantExecutionTools` Allow to create abstract assistants with `isCreatingNewAssistantsAllowed`
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -46,7 +46,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
     private callCommonModel;
 }
 /**
- * TODO: !!!! Deprecate pipeline server and all of its components
+ * TODO: [🕴] Deprecate pipeline server and all of its components
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant

package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -1,4 +1,5 @@
 import type { Promisable } from 'type-fest';
+import { TODO_any } from '../../_packages/types.index';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
@@ -15,12 +16,16 @@ export type JavascriptExecutionToolsOptions = CommonToolsOptions & {
      * Note: There are also some built-in functions available:
      *      @see ./JavascriptEvalExecutionTools.ts
      */
-    functions?: Record<string_postprocessing_function_name, PostprocessingFunction>;
+    functions?: Record<string_postprocessing_function_name, PostprocessingFunction | ToolFunction>;
 };
 /**
  * Function that can be used to postprocess the output of the LLM
  */
 export type PostprocessingFunction = ((value: string) => Promisable<string>) | Function;
+/**
+ * Function that can be used as tool for AI model
+ */
+export type ToolFunction = (args: TODO_any) => Promise<TODO_any>;
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/esm/typings/src/types/ModelRequirements.d.ts

@@ -29,12 +29,6 @@ export type CompletionModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
-    /**
-     * Tools available for the model
-     *
-     * Note: [🚉] This is fully serializable as JSON
-     */
-    readonly tools?: LlmToolDefinition[];
 };
 /**
  * Model requirements for the chat variant
@@ -60,12 +54,6 @@ export type ChatModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
-    /**
-     * Tools available for the model
-     *
-     * Note: [🚉] This is fully serializable as JSON
-     */
-    readonly tools?: LlmToolDefinition[];
 };
 /**
  * Model requirements for the image generation variant
@@ -135,6 +123,12 @@ export type CommonModelRequirements = {
      * Seed for the model
      */
     readonly seed?: number_seed;
+    /**
+     * Tools available for the model
+     *
+     * Note: [🚉] This is fully serializable as JSON
+     */
+    readonly tools?: LlmToolDefinition[];
 };
 /**
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)

package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts

@@ -1,5 +1,4 @@
-import type { ExecCommandOptions } from './ExecCommandOptions';
-import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
+import type { ExecCommandOptions, ExecCommandOptionsAdvanced } from './ExecCommandOptions';
 /**
  * Normalize options for `execCommand` and `execCommands`
  *
@@ -7,6 +6,6 @@ import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
  *
  * @private internal utility of `execCommand` and `execCommands`
  */
-export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose' | 'env'> & {
     humanReadableCommand: string;
 };

package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts

@@ -5,7 +5,7 @@ type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends
 /**
  * Simple options for `execCommand`
  */
-export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose' | 'env'>;
 /**
  * Advanced options for `execCommand`
  */
@@ -38,6 +38,12 @@ export type ExecCommandOptionsAdvanced = {
      * @default false
      */
     readonly isVerbose?: boolean;
+    /**
+     * Environment variables to pass to the command
+     *
+     * Note: These will be merged with process.env
+     */
+    readonly env?: Record<string, string>;
 };
 export {};
 /**

package/esm/typings/src/utils/organization/keepImported.d.ts

@@ -0,0 +1,9 @@
+import { chococake } from './really_any';
+/**
+ * Just says that the dependency is imported, not used but should be kept
+ *
+ * @param dependenciesToKeep any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepImported(...dependenciesToKeep: ReadonlyArray<chococake>): void;

package/esm/typings/src/utils/organization/keepTypeImported.d.ts

@@ -2,7 +2,6 @@
  * Just says that the type is used but `organize-imports-cli` does not recognize it.
  * [🤛] This is a workaround for the issue.
  *
- * @param value any values
  * @returns void
  * @private within the repository
  */

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.105.0-1",
+    "version": "0.105.0-4",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.105.0-1"
+        "@promptbook/core": "0.105.0-4"
     }
 }