@promptbook/node 0.103.0-8 → 0.103.0

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,18 +23,10 @@ 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**
 
 
 
-<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/node`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -59,48 +51,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`
 
@@ -120,11 +118,15 @@ The main challenge is to narrow it down, constrain it, set the proper **context,
 
 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/>
 
-<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"
-/>
+</td></tr></table>
 
 <div style="page-break-after: always;"></div>
 
@@ -138,11 +140,15 @@ You can look at it as prompting (or writing a system message), but decorated by
 
 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>
 
-<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"
-/>
+**<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
 
@@ -152,11 +158,18 @@ This can include domain-specific knowledge, company policies, or any other relev
 
 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/>
 
-<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"
-/>
+</td></tr></table>
 
 #### `Rule` commitment
 
@@ -164,21 +177,42 @@ Rules will enforce specific behaviors or constraints on the AI's responses. This
 
 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>
 
-<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"
-/>
+**<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/>
 
-<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"
-/>
+</td></tr></table>
 
 [Read more about the language](./BLUEPRINT.md)
 
@@ -225,14 +259,10 @@ Now you want to use it. There are several ways how to write your first book:
 
 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.
@@ -352,8 +382,6 @@ 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).
@@ -430,8 +458,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)