@promptbook/node 0.103.0-1 → 0.103.0-100

package/README.md

@@ -9,8 +9,8 @@ Turn your company's scattered knowledge into AI ready Books
 
 
 
-[![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)
+[![NPM Version of ![Promptbook logo](./design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
+[![Quality of package ![Promptbook logo](./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)
 [![🧪 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)
@@ -23,11 +23,7 @@ Turn your company's scattered knowledge into AI ready Books
 
 ## 🌟 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
--   🔍 DeepSeek integration for advanced knowledge search
+-   **Gemini 3 Support**
 
 
 
@@ -59,48 +55,54 @@ This package extends Promptbook's core functionality with Node.js-specific featu
 ## 🔧 High-Level Functionality
 
 The package provides Node.js-specific integrations and utilities:
-- **Filesystem Operations**: Read promptbooks from directories and manage file-based collections
-- **Automatic Provider Setup**: Detect and configure LLM providers from environment variables
-- **Command Execution**: Execute system commands and scripts
-- **Knowledge Scraping**: Node.js-specific scrapers for various content sources
-- **File-based Storage**: Persistent storage using the filesystem
-- **Environment Integration**: Seamless integration with Node.js environment and tooling
+
+-   **Filesystem Operations**: Read promptbooks from directories and manage file-based collections
+-   **Automatic Provider Setup**: Detect and configure LLM providers from environment variables
+-   **Command Execution**: Execute system commands and scripts
+-   **Knowledge Scraping**: Node.js-specific scrapers for various content sources
+-   **File-based Storage**: Persistent storage using the filesystem
+-   **Environment Integration**: Seamless integration with Node.js environment and tooling
 
 ## ✨ Key Features
 
-- 📁 **Directory-based Collections** - Load promptbook collections from filesystem directories
-- 🔧 **Auto-configuration** - Automatically detect and configure LLM providers from environment
-- 💾 **File Storage** - Persistent caching and storage using the filesystem
-- 🛠️ **Command Execution** - Execute system commands and scripts from promptbooks
-- 🌐 **Knowledge Scraping** - Scrape content from files, websites, and other sources
-- 🔌 **Provider Detection** - Automatically discover available LLM providers
-- 📊 **Executable Management** - Manage and execute external tools and scripts
-- 🚀 **Performance Optimization** - File-based caching for improved performance
+-   📁 **Directory-based Collections** - Load promptbook collections from filesystem directories
+-   🔧 **Auto-configuration** - Automatically detect and configure LLM providers from environment
+-   💾 **File Storage** - Persistent caching and storage using the filesystem
+-   🛠️ **Command Execution** - Execute system commands and scripts from promptbooks
+-   🌐 **Knowledge Scraping** - Scrape content from files, websites, and other sources
+-   🔌 **Provider Detection** - Automatically discover available LLM providers
+-   📊 **Executable Management** - Manage and execute external tools and scripts
+-   🚀 **Performance Optimization** - File-based caching for improved performance
 
 ## 📦 Exported Entities
 
 ### Version Information
-- `BOOK_LANGUAGE_VERSION` - Current book language version
-- `PROMPTBOOK_ENGINE_VERSION` - Current engine version
+
+-   `BOOK_LANGUAGE_VERSION` - Current book language version
+-   `PROMPTBOOK_ENGINE_VERSION` - Current engine version
 
 ### Collection Management
-- `createCollectionFromDirectory` - Create promptbook collection from filesystem directory
+
+-   `createPipelineCollectionFromDirectory` - Create promptbook collection from filesystem directory
 
 ### Provider Configuration
-- `$provideExecutablesForNode` - Provide executable tools for Node.js environment
-- `$provideExecutionToolsForNode` - Auto-configure all execution tools from environment
-- `$provideLlmToolsConfigurationFromEnv` - Create LLM tools configuration from environment variables
-- `$provideLlmToolsFromEnv` - Create LLM tools from environment variables
-- `$provideFilesystemForNode` - Provide filesystem access for Node.js
-- `$provideScrapersForNode` - Provide knowledge scrapers for Node.js environment
-- `$provideScriptingForNode` - Provide scripting capabilities for Node.js
+
+-   `$provideExecutablesForNode` - Provide executable tools for Node.js environment
+-   `$provideExecutionToolsForNode` - Auto-configure all execution tools from environment
+-   `$provideLlmToolsConfigurationFromEnv` - Create LLM tools configuration from environment variables
+-   `$provideLlmToolsFromEnv` - Create LLM tools from environment variables
+-   `$provideFilesystemForNode` - Provide filesystem access for Node.js
+-   `$provideScrapersForNode` - Provide knowledge scrapers for Node.js environment
+-   `$provideScriptingForNode` - Provide scripting capabilities for Node.js
 
 ### Storage
-- `FileCacheStorage` - File-based cache storage implementation
+
+-   `FileCacheStorage` - File-based cache storage implementation
 
 ### Command Execution
-- `$execCommand` - Execute single system command
-- `$execCommands` - Execute multiple system commands
+
+-   `$execCommand` - Execute single system command
+-   `$execCommands` - Execute multiple system commands
 
 > 💡 This package does not make sense on its own, look at [all promptbook packages](#-packages) or just install all by `npm i ptbk`
 
@@ -112,19 +114,162 @@ 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.
+
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<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>
+
+<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.
+
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<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>
+
+#### `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.
+
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<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/>
+<br/>
+**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
+
+</td></tr></table>
+
+#### `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.
+
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<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/>
+<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/internal-documents/employee-handbook.docx<br/>
+
+</td></tr></table>
+
+#### `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.
+
+<table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
+
+**<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/>
+<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/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/>
+
+</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:
 
-**It's time for a paradigm shift! The future of software is written in plain English, French, or Latin.**
+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.
 
-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**!
+#### Coding Agent:
 
-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!
+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.
 
-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.
+This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
 
-This shift will happen whether we're ready or not. Our mission is to make it excellent, not just good.
+They will work the same as you are used to, but with your specific rules written in book.
 
-**Join us in this journey!**
+#### 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>
+
+### How to create your AI agent in book
+
+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.
 
 
 
@@ -239,81 +384,6 @@ 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.
-
 
 
 ## 📚 Documentation