@promptbook/documents 0.103.0-42 → 0.103.0-44

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**
 
 
 
@@ -119,7 +115,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>
@@ -141,7 +137,7 @@ 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>
@@ -161,7 +157,7 @@ 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/>
 
@@ -212,14 +208,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.
@@ -339,8 +331,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).
@@ -417,8 +407,6 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-
-
 ### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)

package/esm/index.es.js

@@ -19,14 +19,14 @@ import { parse, unparse } from 'papaparse';
  * @generated
  * @see https://github.com/webgptorg/book
  */
-const BOOK_LANGUAGE_VERSION = '1.0.0';
+const BOOK_LANGUAGE_VERSION = '2.0.0';
 /**
  * The version of the Promptbook engine
  *
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-42';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-44';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -707,6 +707,23 @@ class Color {
  * TODO: Maybe connect with textures
  */
 
+/**
+ * Makes color transformer which returns a grayscale version of the color
+ *
+ * @param amount from 0 to 1
+ *
+ * @public exported from `@promptbook/color`
+ */
+function grayscale(amount) {
+    return ({ red, green, blue, alpha }) => {
+        const average = (red + green + blue) / 3;
+        red = Math.round(average * amount + red * (1 - amount));
+        green = Math.round(average * amount + green * (1 - amount));
+        blue = Math.round(average * amount + blue * (1 - amount));
+        return Color.fromValues(red, green, blue, alpha);
+    };
+}
+
 /**
  * Converts HSL values to RGB values
  *
@@ -822,102 +839,6 @@ function lighten(amount) {
  * TODO: Maybe implement by mix+hsl
  */
 
-/**
- * Calculates distance between two colors
- *
- * @param color1 first color
- * @param color2 second color
- *
- * Note: This function is inefficient. Use colorDistanceSquared instead if possible.
- *
- * @public exported from `@promptbook/color`
- */
-/**
- * Calculates distance between two colors without square root
- *
- * @param color1 first color
- * @param color2 second color
- *
- * @public exported from `@promptbook/color`
- */
-function colorDistanceSquared(color1, color2) {
-    const rmean = (color1.red + color2.red) / 2;
-    const r = color1.red - color2.red;
-    const g = color1.green - color2.green;
-    const b = color1.blue - color2.blue;
-    const weightR = 2 + rmean / 256;
-    const weightG = 4.0;
-    const weightB = 2 + (255 - rmean) / 256;
-    const distance = weightR * r * r + weightG * g * g + weightB * b * b;
-    return distance;
-}
-
-/**
- * Makes color transformer which finds the nearest color from the given list
- *
- * @param colors array of colors to choose from
- *
- * @public exported from `@promptbook/color`
- */
-function nearest(...colors) {
-    return (color) => {
-        const distances = colors.map((c) => colorDistanceSquared(c, color));
-        const minDistance = Math.min(...distances);
-        const minIndex = distances.indexOf(minDistance);
-        const nearestColor = colors[minIndex];
-        return nearestColor;
-    };
-}
-
-/**
- * Color transformer which returns the negative color
- *
- * @public exported from `@promptbook/color`
- */
-function negative(color) {
-    const r = 255 - color.red;
-    const g = 255 - color.green;
-    const b = 255 - color.blue;
-    return Color.fromValues(r, g, b, color.alpha);
-}
-
-/**
- * Makes color transformer which finds the furthest color from the given list
- *
- * @param colors array of colors to choose from
- *
- * @public exported from `@promptbook/color`
- */
-function furthest(...colors) {
-    return (color) => {
-        const furthestColor = negative(nearest(...colors.map(negative))(color));
-        return furthestColor;
-    };
-}
-/**
- * Makes color transformer which finds the best text color (black or white) for the given background color
- *
- * @public exported from `@promptbook/color`
- */
-furthest(Color.get('white'), Color.from('black'));
-
-/**
- * Makes color transformer which returns a grayscale version of the color
- *
- * @param amount from 0 to 1
- *
- * @public exported from `@promptbook/color`
- */
-function grayscale(amount) {
-    return ({ red, green, blue, alpha }) => {
-        const average = (red + green + blue) / 3;
-        red = Math.round(average * amount + red * (1 - amount));
-        green = Math.round(average * amount + green * (1 - amount));
-        blue = Math.round(average * amount + blue * (1 - amount));
-        return Color.fromValues(red, green, blue, alpha);
-    };
-}
-
 /**
  * Makes color transformer which saturate the given color
  *
@@ -3200,6 +3121,7 @@ function createPipelineCollectionFromJson(...promptbooks) {
 /**
  * Generates random token
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
  *
  * @private internal helper function
@@ -3209,6 +3131,7 @@ function $randomToken(randomness) {
     return randomBytes(randomness).toString('hex');
 }
 /**
+ * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
  */
 
@@ -3327,6 +3250,22 @@ class CollectionError extends Error {
     }
 }
 
+/**
+ * This error indicates error from the database
+ *
+ * @public exported from `@promptbook/core`
+ */
+class DatabaseError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'DatabaseError';
+        Object.setPrototypeOf(this, DatabaseError.prototype);
+    }
+}
+/**
+ * TODO: !!!! Explain that NotFoundError (!!! and other specific errors) has priority over DatabaseError in some contexts
+ */
+
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
@@ -3430,6 +3369,7 @@ const PROMPTBOOK_ERRORS = {
     UnexpectedError,
     WrappedError,
     NotAllowed,
+    DatabaseError,
     // TODO: [🪑]> VersionMismatchError,
 };
 /**
@@ -4266,6 +4206,7 @@ function joinLlmExecutionTools(title, ...llmExecutionTools) {
     return new MultipleLlmExecutionTools(title || 'Multiple LLM Providers joined by `joinLlmExecutionTools`', ...llmExecutionTools);
 }
 /**
+ * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */
 
@@ -4282,6 +4223,7 @@ function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
     return llmTools;
 }
 /**
+ * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */
 
@@ -5857,18 +5799,6 @@ function templateParameters(template, parameters) {
     return replacedTemplates;
 }
 
-/**
- * Logs an LLM call with the given report.
- *
- * @private internal utility of `createPipelineExecutor`
- */
-function logLlmCall(logLlmCall, report) {
-    logLlmCall({
-        modelName: 'model' /* <- TODO: How to get model name from the report */,
-        report,
-    });
-}
-
 /**
  * Extracts all code blocks from markdown.
  *
@@ -6214,7 +6144,7 @@ function validatePromptResult(options) {
  */
 async function executeAttempts(options) {
     const { jokerParameterNames, priority, maxAttempts, // <- Note: [💂]
-    preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, onProgress, logLlmCall: logLlmCall$1, } = options;
+    preparedContent, parameters, task, preparedPipeline, tools, $executionReport, pipelineIdentification, maxExecutionAttempts, onProgress, logLlmCall, } = options;
     const $ongoingTaskResult = {
         $result: null,
         $resultString: null,
@@ -6476,8 +6406,11 @@ async function executeAttempts(options) {
                         : serializeError($ongoingTaskResult.$expectError),
                 };
                 $executionReport.promptExecutions.push(executionPromptReport);
-                if (logLlmCall$1) {
-                    logLlmCall(logLlmCall$1, executionPromptReport);
+                if (logLlmCall) {
+                    logLlmCall({
+                        modelName: 'model' /* <- TODO: How to get model name from the report */,
+                        report: executionPromptReport,
+                    });
                 }
             }
         }
@@ -6751,7 +6684,7 @@ async function getKnowledgeForTask(options) {
             },
             content: task.content,
             parameters,
-        };
+        }; /* <- Note: [🤛] */
         const taskEmbeddingResult = await llmTools.callEmbeddingModel(taskEmbeddingPrompt);
         const knowledgePiecesWithRelevance = preparedPipeline.knowledgePieces.map((knowledgePiece) => {
             const { index } = knowledgePiece;