@promptbook/documents 0.89.0-15 → 0.89.0-17

package/esm/index.es.js

@@ -28,7 +28,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.89.0-15';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-17';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -91,6 +91,7 @@ const ADMIN_EMAIL = 'pavol@ptbk.io';
  * @public exported from `@promptbook/core`
  */
 const ADMIN_GITHUB_NAME = 'hejny';
+//            <- TODO: [🐊] Pick the best claim
 /**
  * When the title is not provided, the default title is used
  *
@@ -163,7 +164,7 @@ const DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹‍♂️]
  */
 const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
 // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
-// TODO: !!!!!! Just .promptbook dir, hardocode others
+// TODO: Just `.promptbook` in config, hardcode subfolders like `download-cache` or `execution-cache`
 /**
  * Where to store the temporary downloads
  *
@@ -1080,44 +1081,42 @@ class WrappedError extends Error {
     constructor(whatWasThrown) {
         const tag = `[🤮]`;
         console.error(tag, whatWasThrown);
-        super(spaceTrim((block) => `
-                    ${ /* Fixing tests !!!  block(valueToString(whatWasThrown)) */block(`non-Error object was thrown`)}
-
-                    Note: Look for ${tag} in the console for more details
-                    !!! Note: \`WrappedError\` indicates that somewhere in the code non-Error object was thrown and it was wrapped
+        super(spaceTrim(`
+                Non-Error object was thrown
 
-                    Please report issue on ${ADMIN_EMAIL}
-
-                `));
+                Note: Look for ${tag} in the console for more details
+                Please report issue on ${ADMIN_EMAIL}
+            `));
         this.name = 'WrappedError';
         Object.setPrototypeOf(this, WrappedError.prototype);
     }
 }
 
 /**
- * !!!@@@
+ * Helper used in catch blocks to assert that the error is an instance of `Error`
  *
- * @param whatWasThrown !!!@@@
- * @returns !!!@@@
+ * @param whatWasThrown Any object that was thrown
+ * @returns Nothing if the error is an instance of `Error`
+ * @throws `WrappedError` or `UnexpectedError` if the error is not standard
  *
  * @private within the repository
  */
 function assertsError(whatWasThrown) {
-    // Case 1: !!!@@@
+    // Case 1: Handle error which was rethrown as `WrappedError`
     if (whatWasThrown instanceof WrappedError) {
         const wrappedError = whatWasThrown;
         throw wrappedError;
     }
-    // Case 2: !!!@@@
+    // Case 2: Handle unexpected errors
     if (whatWasThrown instanceof UnexpectedError) {
         const unexpectedError = whatWasThrown;
         throw unexpectedError;
     }
-    // Case 3: !!!@@@
+    // Case 3: Handle standard errors - keep them up to consumer
     if (whatWasThrown instanceof Error) {
         return;
     }
-    // Case 4: !!!@@@
+    // Case 4: Handle non-standard errors - wrap them into `WrappedError` and throw
     throw new WrappedError(whatWasThrown);
 }
 
@@ -2256,7 +2255,7 @@ class PipelineExecutionError extends Error {
     }
 }
 /**
- * TODO: !!!!!! Add id to all errors
+ * TODO: [🧠][🌂] Add id to all errors
  */
 
 /**
@@ -2609,8 +2608,8 @@ function createTask(options) {
                 updatedAt = new Date();
                 errors.push(...executionResult.errors);
                 warnings.push(...executionResult.warnings);
-                // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
-                // TODO: [🧠] !!! errors, warning, isSuccessful  are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
+                // <- TODO: [🌂] Only unique errors and warnings should be added (or filtered)
+                // TODO: [🧠] !! errors, warning, isSuccessful  are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
                 //            Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
                 //            And delete `ExecutionTask.currentValue.preparedPipeline`
                 assertsTaskSuccessful(executionResult);