@promptbook/core 0.92.0-23 → 0.92.0-24

package/esm/index.es.js

@@ -27,7 +27,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.92.0-23';
+const PROMPTBOOK_ENGINE_VERSION = '0.92.0-24';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -275,20 +275,23 @@ const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = 'result';
  */
 const DEFAULT_MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
 /**
- * @@@
+ * Threshold value that determines when a dataset is considered "big"
+ * and may require special handling or optimizations
+ *
+ * For example, when error occurs in one item of the big dataset, it will not fail the whole pipeline
  *
  * @public exported from `@promptbook/core`
  */
 const BIG_DATASET_TRESHOLD = 50;
 /**
- * @@@
+ * Placeholder text used to represent a placeholder value of failed operation
  *
  * @public exported from `@promptbook/core`
  */
-const FAILED_VALUE_PLACEHOLDER = '!';
-// <- TODO: !!!! Use
+const FAILED_VALUE_PLACEHOLDER = '!?';
 /**
- * @@@
+ * Placeholder text used to represent operations or values that are still in progress
+ * or awaiting completion in UI displays and logging
  *
  * @public exported from `@promptbook/core`
  */
@@ -1628,7 +1631,7 @@ class SimplePipelineCollection {
     /**
      * Constructs a pipeline collection from pipelines
      *
-     * @param pipelines @@@
+     * @param pipelines Array of pipeline JSON objects to include in the collection
      *
      * Note: During the construction logic of all pipelines are validated
      * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
@@ -2878,6 +2881,15 @@ const CsvFormatParser = {
                     mappedData.push(mappedRow);
                     if (onProgress) {
                         // Note: Report the CSV with all rows mapped so far
+                        /*
+                        !!!!
+                         // Report progress with updated value
+                            const progressData = mappedData.map((row, i) =>
+                              i > index ? { ...row, [outputParameterName]: PENDING_VALUE_PLACEHOLDER } : row,
+                          );
+
+
+                        */
                         await onProgress(unparse(mappedData, { ...settings, ...MANDATORY_CSV_SETTINGS }));
                     }
                 }
@@ -4397,7 +4409,7 @@ async function executeFormatSubvalues(options) {
                         `));
                 if (length > BIG_DATASET_TRESHOLD) {
                     console.error(highLevelError);
-                    return '~';
+                    return FAILED_VALUE_PLACEHOLDER;
                 }
                 throw highLevelError;
             }
@@ -4428,7 +4440,7 @@ async function executeFormatSubvalues(options) {
                               ${block(pipelineIdentification)}
                               Subparameter index: ${index}
                           `));
-                    return '~';
+                    return FAILED_VALUE_PLACEHOLDER;
                 }
                 throw error;
             }
@@ -5267,7 +5279,8 @@ async function preparePersona(personaDescription, tools, options) {
  */
 
 /**
- * @@@
+ * Safely retrieves the global scope object (window in browser, global in Node.js)
+ * regardless of the JavaScript environment in which the code is running
  *
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
  *
@@ -7440,14 +7453,15 @@ const MatcherFormfactorDefinition = {
 };
 
 /**
- * Sheets is form of app that @@@
+ * Sheets is form of app that processes tabular data in CSV format, allowing transformation
+ * and analysis of structured data through AI-powered operations
  *
  * @public exported from `@promptbook/core`
  */
 const SheetsFormfactorDefinition = {
     name: 'SHEETS',
     aliasNames: ['SHEETS', 'SHEET'],
-    description: `@@@`,
+    description: `A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data`,
     documentationUrl: `https://github.com/webgptorg/promptbook/discussions/176`,
     pipelineInterface: {
         inputParameters: [
@@ -7523,7 +7537,7 @@ const FORMFACTOR_DEFINITIONS = [
 /**
  * Parses the formfactor command
  *
- * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book` file
+ * Note: This command is used as a formfactor for new commands and defines the app type format - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`
@@ -7545,7 +7559,7 @@ const formfactorCommandParser = {
     /**
      * Description of the FORMFACTOR command
      */
-    description: `@@`,
+    description: `Specifies the application type and interface requirements that this promptbook should conform to`,
     /**
      * Link to documentation
      */
@@ -10208,22 +10222,23 @@ function usageToHuman(usage) {
  */
 
 /**
- * Boilerplate is form of app that @@@
+ * Boilerplate is form of app that serves as a template structure for creating other formfactors
+ * and should not be used directly in production.
  *
  * @public exported from `@promptbook/core`
  */
 const BoilerplateFormfactorDefinition = {
     name: 'BOILERPLATE',
-    description: `@@@`,
+    description: `A template structure for creating new formfactors, providing the base architecture and interfaces that should be implemented.`,
     documentationUrl: `https://github.com/webgptorg/promptbook/discussions/@@`,
     //                                                                     <- TODO: https://github.com/webgptorg/promptbook/discussions/new?category=concepts
     //                                                                              "🔠 Boilerplate Formfactor"
     pipelineInterface: {
         inputParameters: [
-        /* @@@ */
+        /* <- Example input parameters should be defined here */
         ],
         outputParameters: [
-        /* @@@ */
+        /* <- Example output parameters should be defined here */
         ],
     },
 };
@@ -10706,9 +10721,9 @@ function cacheLlmTools(llmTools, options = {}) {
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- *            @@@ write discussion about this and storages
- *            @@@ write how to combine multiple interceptors
+ * TODO: [👷‍♂️] Comprehensive manual about construction of llmTools
+ *            Detailed explanation about caching strategies and appropriate storage selection for different use cases
+ *            Examples of how to combine multiple interceptors for advanced caching, logging, and usage tracking
  */
 
 /**