@promptbook/types 0.103.0-0 → 0.103.0-10

package/README.md

@@ -1,8 +1,10 @@
 <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
-# ✨ Promptbook: AI apps in plain Language
+# ✨ Promptbook: AI Agents
+
+Turn your company's scattered knowledge into AI ready Books
+
 
-Write AI applications using plain human language across multiple models and platforms.
 
 
 
@@ -304,19 +306,130 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 
 
-## 🤍 The Book Abstract
+## 📖 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.
+
+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.
+
+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.
+
+
+<img
+    alt="Paul Smith & Associés Book"
+    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
+/>
+
+<div style="page-break-after: always;"></div>
+
+### Aspects of great AI agent
+
+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**.
+
+#### `Persona` commitment
+
+Personas define the character of your AI persona, its role, and how it should interact with users. It sets the tone and style of communication.
+
+
+<img
+    alt="Paul Smith & Associés Book"
+    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.&width=800&height=450&nonce=0"
+/>
+
+#### `Knowledge` commitment
+
+Knowledge Commitment allows you to provide specific information, facts, or context that the AI should be aware of when responding.
+
+This can include domain-specific knowledge, company policies, or any other relevant information.
+
+Promptbook Engine will automatically enforce this knowledge during interactions. When the knowledge is short enough, it will be included in the prompt. When it is too long, it will be stored in vector databases and RAG retrieved when needed. But you don't need to care about it.
+
+
+<img
+    alt="Paul Smith & Associés Book"
+    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
+/>
+
+#### `Rule` commitment
+
+Rules will enforce specific behaviors or constraints on the AI's responses. This can include ethical guidelines, communication styles, or any other rules you want the AI to follow.
+
+Depending on rule strictness, Promptbook will either propagate it to the prompt or use other techniques, like adversary agent, to enforce it.
+
+
+<img
+    alt="Paul Smith & Associés Book"
+    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx&width=800&height=450&nonce=0"
+/>
+
+#### `Action` 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.
+
+
+<img
+    alt="Paul Smith & Associés Book"
+    src="https://promptbook.studio/embed/book-preview.png?book=Paul%20Smith%20%26%20Associ%C3%A9s%0A%20%20%20%20%20%20%7C%20PERSONA%20You%20are%20a%20company%20lawyer.%0A%20%20%20%20%20%20%7C%20Your%20job%20is%20to%20provide%20legal%20advice%20and%20support%20to%20the%20company%20and%20its%20employees.%0A%20%20%20%20%20%20%7C%20You%20are%20knowledgeable%2C%20professional%2C%20and%20detail-oriented.%0A%20%20%20%20%20%20%7C%20RULE%20Always%20ensure%20compliance%20with%20laws%20and%20regulations.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20outside%20your%20area%20of%20expertise.%0A%20%20%20%20%20%20%7C%20RULE%20Never%20provide%20legal%20advice%20about%20criminal%20law.%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20%20https%3A%2F%2Fcompany.com%2Fcompany-policies.pdf%0A%20%20%20%20%20%20%7C%20KNOWLEDGE%20https%3A%2F%2Fcompany.com%2Finternal-documents%2Femployee-handbook.docx%0A%20%20%20%20%20%20%7C%20ACTION%20When%20a%20user%20asks%20about%20an%20issue%20that%20could%20be%20treated%20as%20a%20crime%2C%20notify%20legal%40company.com.&width=800&height=450&nonce=0"
+/>
+
+[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:
+
+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.
 
-**It's time for a paradigm shift! The future of software is written in plain English, French, or Latin.**
+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.
 
-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**!
+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.
 
-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!
+Even works in no-code platforms!
 
-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.
+<div style="page-break-after: always;"></div>
 
-This shift will happen whether we're ready or not. Our mission is to make it excellent, not just good.
+### How to create your AI agent in book
 
-**Join us in this journey!**
+Now you want to use it. There are several ways how to write your first book:
+
+#### 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.
 
 
 
@@ -431,80 +544,7 @@ Join our growing community of developers and users:
 
 
 
-## 📘 Book Language Blueprint
-
-_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.
-
-### Example
-
-```book
-# 🌟 My First Book
-
--   BOOK VERSION 1.0.0
--   URL https://promptbook.studio/hello.book
--   INPUT PARAMETER {topic}
--   OUTPUT PARAMETER {article}
-
-# Write an Article
-
--   PERSONA Jane, marketing specialist with prior experience in tech and AI writing
--   KNOWLEDGE https://wikipedia.org/
--   KNOWLEDGE ./journalist-ethics.pdf
--   EXPECT MIN 1 Sentence
--   EXPECT MAX 5 Pages
-
-> Write an article about {topic}
-
-→ {article}
-```
-
-Each part of the book defines one of three circles:
 
-### **1. What:** Workflows, Tasks and Parameters
-
-What work needs to be done. Each book defines a [workflow _(scenario or pipeline)_](https://github.com/webgptorg/promptbook/discussions/88), which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
-
-**Related commands:**
-
--   [PARAMETER](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PARAMETER.md)
-
-### **2. Who:** Personas
-
-Who does the work. Each task is performed by a persona. A persona is a description of your virtual employee. It is a higher abstraction than the model, tokens, temperature, top-k, top-p and other model parameters.
-
-You can describe what you want in human language like `Jane, creative writer with a sense of sharp humour` instead of `gpt-4-2024-13-31, temperature 1.2, top-k 40, STOP token ".\n",...`.
-
-Personas can have access to different knowledge, tools and actions. They can also consult their work with other personas or user, if allowed.
-
-**Related commands:**
-
--   [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.
-
-**Related commands:**
-
--   [KNOWLEDGE](https://github.com/webgptorg/promptbook/blob/main/documents/commands/KNOWLEDGE.md) of documents, websites, and other resources
--   [INSTRUMENT](https://github.com/webgptorg/promptbook/blob/main/documents/commands/INSTRUMENT.md) for real-time data like time, location, weather, stock prices, searching the internet, calculations, etc.
--   [ACTION](https://github.com/webgptorg/promptbook/blob/main/documents/commands/ACTION.md) for actions like sending emails, creating files, ending a workflow, etc.
-
-### General Principles
-
-Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
-
-The file has a `.book` extension and uses UTF-8 encoding without BOM.
-
-Books have two variants: flat — just a prompt without structure, and full — with tasks, commands, and prompts.
-
-As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
-
-But unlike programming languages, it is designed to be understandable by non-programmers and non-technical people.
 
 
 
@@ -584,6 +624,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/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts

@@ -1,4 +1,5 @@
 import type { AgentBasicInformation } from '../../../book-2.0/agent-source/AgentBasicInformation';
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
 import type { string_css_class } from '../../../types/typeAliases';
 /**
  * Props of `AvatarProfile`
@@ -10,6 +11,10 @@ export type AvatarProfileProps = {
      * Agent to be shown
      */
     readonly agent: AgentBasicInformation;
+    /**
+     * The source of the agent, which will be displayed in the BookEditor.
+     */
+    readonly agentSource: string_book;
     /**
      * Optional CSS class name which will be added to root <div> element
      */

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="react" />
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+type AvatarProfileTooltipProps = {
+    agentSource: string_book;
+    position: {
+        top: number;
+        left: number;
+    };
+};
+/**
+ *
+ * @private internal subcomponent of `<Chat>` component
+ */
+export declare const AvatarProfileTooltip: import("react").ForwardRefExoticComponent<AvatarProfileTooltipProps & import("react").RefAttributes<HTMLDivElement>>;
+export {};

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

@@ -8,6 +8,10 @@ import type { string_knowledge_source_content } from '../../types/typeAliases';
  * @public exported from `@promptbook/components`
  */
 export type BookEditorProps = {
+    /**
+     * The source of the agent to be displayed in the editor.
+     */
+    readonly agentSource?: string_book;
     /**
      * Additional CSS classes to apply to the editor container.
      */
@@ -16,11 +20,6 @@ export type BookEditorProps = {
      * Optional CSS style which will be added to root <div/> element
      */
     readonly style?: CSSProperties;
-    /**
-     * CSS className for a font (e.g. from next/font) to style the editor text.
-     * If omitted, defaults to system serif fonts.
-     */
-    readonly fontClassName?: string;
     /**
      * The book which is being edited.
      */
@@ -46,6 +45,12 @@ export type BookEditorProps = {
      * By default, the footer is hidden.
      */
     readonly isFooterShown?: boolean;
+    /**
+     * If true, the editor is in read-only mode
+     *
+     * @default false
+     */
+    readonly isReadonly?: boolean;
 };
 /**
  * Renders a book editor

package/esm/typings/src/book-components/BookEditor/BookEditorMonaco.d.ts

@@ -0,0 +1,5 @@
+import type { BookEditorProps } from './BookEditor';
+/**
+ * @private Internal component used by `BookEditor`
+ */
+export declare function BookEditorMonaco(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/BookEditor/config.d.ts

@@ -3,6 +3,7 @@
  * In Next.js environments, you can override this by importing the font directly
  *
  * @public exported from `@promptbook/components`
+ * @deprecated !!! Remove
  */
 export declare const DEFAULT_BOOK_FONT_CLASS: any;
 /**

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

@@ -1,5 +1,6 @@
 import type { id, string_color, string_person_fullname, string_url_image } from '../../../types/typeAliases';
 import { Color } from '../../../utils/color/Color';
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
 /**
  * A participant in the chat
  *
@@ -26,6 +27,10 @@ export type ChatParticipant = {
      * Color associated with the participant
      */
     color?: string_color | Color;
+    /**
+     * Agent source for avatar profile
+     */
+    agentSource?: string_book;
 };
 /**
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`

package/esm/typings/src/book-components/_common/Modal/Modal.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+/**
+ *
+ * @private internal subcomponent of `<Chat>` component
+ */
+export declare function Modal({ children, onClose, className, }: {
+    children: ReactNode;
+    onClose: () => void;
+    className?: string;
+}): import("react").ReactPortal;
+/**
+ * TODO: !!!! Use this also for feedback modal in Chat component -Make modals DRY
+ */

package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts

@@ -4,4 +4,4 @@ import type { string_css_class } from '../../../types/typeAliases';
  *
  * @private within the `@promptbook/components`
  */
-export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;
+export declare function classNames(...classes: Array<string_css_class | undefined | false | null | 0>): string_css_class;

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

@@ -35,7 +35,7 @@ export declare const ADMIN_GITHUB_NAME: string_name;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
+export declare const CLAIM = "Turn your company's scattered knowledge into AI ready books";
 /**
  * Color of the Promptbook
  *

package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts

@@ -16,5 +16,6 @@ export type InjectCssModuleIntoShadowRootOptions = {
  *
  * @public exported from `@promptbook/components`
  *         <- TODO: [🧠] Make `@promptbook/components-utils`
+ * @deprecated This was used for BookEditor shadow DOM support, which is no longer needed
  */
 export declare function injectCssModuleIntoShadowRoot(options: InjectCssModuleIntoShadowRootOptions): void;

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.102.0`).
+ * It follows semantic versioning (e.g., `0.103.0-9`).
  *
  * @generated
  */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@promptbook/types",
-    "version": "0.103.0-0",
-    "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
+    "version": "0.103.0-10",
+    "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
     "repository": {
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-0"
+        "@promptbook/core": "0.103.0-10"
     }
 }

package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts

@@ -1,5 +0,0 @@
-import type { BookEditorProps } from './BookEditor';
-/**
- * @private util of `<BookEditor />`
- */
-export declare function BookEditorInner(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;