@promptbook/documents 0.92.0-23 → 0.92.0-24

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -4,8 +4,6 @@ import type { Prompt } from '../types/Prompt';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
- *
- * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/SimplePipelineCollection.d.ts

@@ -14,7 +14,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
     /**
      * 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

package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { FormfactorCommand } from './FormfactorCommand';
 /**
  * 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`

package/esm/typings/src/config.d.ts

@@ -69,19 +69,23 @@ export declare const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = "result";
  */
 export declare const DEFAULT_MAX_FILE_SIZE: number;
 /**
- * @@@
+ * 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`
  */
 export declare const BIG_DATASET_TRESHOLD = 50;
 /**
- * @@@
+ * Placeholder text used to represent a placeholder value of failed operation
  *
  * @public exported from `@promptbook/core`
  */
-export declare const FAILED_VALUE_PLACEHOLDER = "!";
+export declare 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`
  */

package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts

@@ -32,32 +32,32 @@ export type FormatSubvalueParser<TValue extends string, TSettings extends empty_
  */
 export type FormatSubvalueParserMapValuesOptions<TValue extends string, TSettings extends empty_object> = {
     /**
-     * @@@
+     * The input string value to parse for subvalues
      */
     readonly value: TValue;
     /**
-     * @@@
+     * The name of the output parameter where the processed value will be stored
      */
     readonly outputParameterName: string_parameter_name;
     /**
-     * @@@
+     * Format-specific settings that control how subvalues are parsed or processed
      */
     readonly settings: TSettings;
     /**
-     * @@@
+     * Callback function that processes each subvalue and returns the transformed value
      *
-     * @param subvalues @@@
+     * @param subvalues Object containing the extracted subvalues
      * @param index Current index of the subvalue which is being mapped
      * @param length Full length of the subvalues
-     * @param number @@@
-     * @returns @@@
+     * @param number Total number of subvalues to process
+     * @returns Transformed value after processing
      */
     mapCallback(subvalues: Parameters, index: number, length: number): Promisable<TValue>;
     /**
-     * @@@
+     * Progress callback that receives partial results during processing
      *
-     * @param partialResultString @@@
-     * @returns @@@
+     * @param partialResultString The current partial result as processing progresses
+     * @returns Promise or void to continue execution
      */
     onProgress(partialResultString: TValue): Promisable<void>;
 };

package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts

@@ -1,11 +1,12 @@
 /**
- * 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`
  */
 export declare const BoilerplateFormfactorDefinition: {
     readonly name: "BOILERPLATE";
-    readonly description: "@@@";
+    readonly description: "A template structure for creating new formfactors, providing the base architecture and interfaces that should be implemented.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];

package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts

@@ -1,5 +1,6 @@
 import type { FormfactorDefinition } from './FormfactorDefinition';
 /**
- * @@@
+ * A type alias representing the name of a formfactor, used for type checking and validation
+ * in the formfactor registry and selection processes
  */
 export type string_formfactor_name = FormfactorDefinition['name'];

package/esm/typings/src/formfactors/index.d.ts

@@ -71,7 +71,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     readonly name: "SHEETS";
     readonly aliasNames: readonly ["SHEETS", "SHEET"];
-    readonly description: "@@@";
+    readonly description: "A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts

@@ -1,12 +1,13 @@
 /**
- * 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`
  */
 export declare const SheetsFormfactorDefinition: {
     readonly name: "SHEETS";
     readonly aliasNames: readonly ["SHEETS", "SHEET"];
-    readonly description: "@@@";
+    readonly description: "A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -13,7 +13,7 @@ export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTo
 /**
  * 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
  */

package/esm/typings/src/utils/environment/$getGlobalScope.d.ts

@@ -1,6 +1,7 @@
 import type { really_any } from '../organization/really_any';
 /**
- * @@@
+ * 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
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.92.0-23",
+    "version": "0.92.0-24",
     "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/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-23"
+        "@promptbook/core": "0.92.0-24"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @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
@@ -103,11 +103,20 @@
      */
     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: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
     /**
      * The maximum number of iterations for a loops
@@ -2131,7 +2140,7 @@
         /**
          * 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
@@ -3250,7 +3259,8 @@
      */
 
     /**
-     * @@@
+     * 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
      *
@@ -4341,6 +4351,15 @@
                         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(papaparse.unparse(mappedData, { ...settings, ...MANDATORY_CSV_SETTINGS }));
                         }
                     }
@@ -5349,7 +5368,7 @@
                         `));
                     if (length > BIG_DATASET_TRESHOLD) {
                         console.error(highLevelError);
-                        return '~';
+                        return FAILED_VALUE_PLACEHOLDER;
                     }
                     throw highLevelError;
                 }
@@ -5380,7 +5399,7 @@
                               ${block(pipelineIdentification)}
                               Subparameter index: ${index}
                           `));
-                        return '~';
+                        return FAILED_VALUE_PLACEHOLDER;
                     }
                     throw error;
                 }