@promptbook/node 0.92.0-27 → 0.92.0-28

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

@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
  */
 export declare const _OpenAiMetadataRegistration: Registration;
 /**
- * @@@ registration1 of default configuration for Open AI
+ * Registration of the OpenAI Assistant metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
  *
  * @public exported from `@promptbook/core`
  * @public exported from `@promptbook/wizzard`

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

@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
  */
 export declare const _OpenAiRegistration: Registration;
 /**
- * @@@ registration2
+ * Registration of the OpenAI Assistant provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
  *
  * @public exported from `@promptbook/openai`
  * @public exported from `@promptbook/wizzard`

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.92.0-26`).
+ * It follows semantic versioning (e.g., `0.92.0-27`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.92.0-27",
+    "version": "0.92.0-28",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-27"
+        "@promptbook/core": "0.92.0-28"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -46,7 +46,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-27';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-28';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2550,7 +2550,7 @@
     }
 
     /**
-     * @@@
+     * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
      *
      * @public exported from `@promptbook/core`
      */
@@ -3737,8 +3737,12 @@
      */
 
     /**
-     * @@@
+     * Executes a pipeline task with multiple attempts, including joker and retry logic. Handles different task types
+     * (prompt, script, dialog, etc.), applies postprocessing, checks expectations, and updates the execution report.
+     * Throws errors if execution fails after all attempts.
      *
+     * @param options - The options for execution, including task, parameters, pipeline, and configuration.
+     * @returns The result string of the executed task.
      * @private internal utility of `createPipelineExecutor`
      */
     async function executeAttempts(options) {
@@ -4196,8 +4200,12 @@
     }
 
     /**
-     * @@@
+     * Returns the context for a given task, typically used to provide additional information or variables
+     * required for the execution of the task within a pipeline. The context is returned as a string value
+     * that may include markdown formatting.
      *
+     * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
+     * @returns The context as a string, formatted as markdown and parameter value.
      * @private internal utility of `createPipelineExecutor`
      */
     async function getContextForTask(task) {
@@ -4205,7 +4213,7 @@
     }
 
     /**
-     * @@@
+     * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
      *
      * @private internal utility of `createPipelineExecutor`
      */
@@ -4252,9 +4260,8 @@
     }
 
     /**
-     * @@@
-     *
-     * Here is the place where RAG (retrieval-augmented generation) happens
+     * Retrieves the most relevant knowledge pieces for a given task using embedding-based similarity search.
+     * This is where retrieval-augmented generation (RAG) is performed to enhance the task with external knowledge.
      *
      * @private internal utility of `createPipelineExecutor`
      */
@@ -4473,7 +4480,8 @@
      */
 
     /**
-     * @@@
+     * Filters and returns only the output parameters from the provided pipeline execution options.
+     * Adds warnings for any expected output parameters that are missing.
      *
      * @private internal utility of `createPipelineExecutor`
      */
@@ -6777,8 +6785,6 @@
     /**
      * Parses the foreach command
      *
-     * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book` file
-     *
      * @see `documentationUrl` for more details
      * @public exported from `@promptbook/editable`
      */
@@ -7019,14 +7025,14 @@
     };
 
     /**
-     * @@@
+     * Chatbot form factor definition for conversational interfaces that interact with users in a chat-like manner.
      *
      * @public exported from `@promptbook/core`
      */
     const ChatbotFormfactorDefinition = {
         name: 'CHATBOT',
         aliasNames: ['CHAT'],
-        description: `@@@`,
+        description: `A chatbot form factor for conversational user interfaces.`,
         documentationUrl: `https://github.com/webgptorg/promptbook/discussions/174`,
         pipelineInterface: {
             inputParameters: [
@@ -7059,7 +7065,7 @@
      */
     const CompletionFormfactorDefinition = {
         name: 'COMPLETION',
-        description: `@@@`,
+        description: `Completion is formfactor that emulates completion models`,
         documentationUrl: `https://github.com/webgptorg/promptbook/discussions/@@`,
         //                                                                     <- TODO: https://github.com/webgptorg/promptbook/discussions/new?category=concepts
         //                                                                              "🔠 Completion Formfactor"
@@ -7090,7 +7096,8 @@
     };
 
     /**
-     * Generator is form of app that @@@
+     * Generator form factor represents an application that generates content or data based on user input or predefined rules.
+     * This form factor is used for apps that produce outputs, such as text, images, or other media, based on provided input.
      *
      * @public exported from `@promptbook/core`
      */
@@ -7134,13 +7141,13 @@
      */
 
     /**
-     * @@@
+     * A generic pipeline
      *
      * @public exported from `@promptbook/core`
      */
     const GenericFormfactorDefinition = {
         name: 'GENERIC',
-        description: `@@@`,
+        description: `A generic pipeline`,
         documentationUrl: `https://github.com/webgptorg/promptbook/discussions/173`,
         pipelineInterface: GENERIC_PIPELINE_INTERFACE,
     };
@@ -9606,7 +9613,8 @@
      */
 
     /**
-     * @@@
+     * Attempts to locate the specified application on a Linux system using the 'which' command.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -9673,7 +9681,8 @@
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const userhome = require('userhome');
     /**
-     * @@@
+     * Attempts to locate the specified application on a macOS system by checking standard application paths and using mdfind.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -9705,7 +9714,8 @@
      */
 
     /**
-     * @@@
+     * Attempts to locate the specified application on a Windows system by searching common installation directories.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -9776,7 +9786,8 @@
      */
 
     /**
-     * @@@
+     * Locates the LibreOffice executable on the current system by searching platform-specific paths.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -9794,7 +9805,8 @@
      */
 
     /**
-     * @@@
+     * Locates the Pandoc executable on the current system by searching platform-specific paths.
+     * Returns the path to the executable if found, or null otherwise.
      *
      * @private within the repository
      */
@@ -9812,7 +9824,7 @@
      */
 
     /**
-     * @@@
+     * Provides paths to required executables (i.e. as Pandoc and LibreOffice) for Node.js environments.
      *
      * @public exported from `@promptbook/node`
      */