@promptbook/core 0.55.0-1 → 0.55.0

package/esm/index.es.js

@@ -448,7 +448,7 @@ function union() {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.55.0-0';
+var PROMPTBOOK_VERSION = '0.55.0-2';
 
 /**
  * Parses the template and returns the list of all parameter names
@@ -2279,11 +2279,55 @@ var TemplateError = /** @class */ (function (_super) {
 }(Error));
 
 /**
- * Function addPromptResultUsage will add multiple usages into one
+ * Asserts that the execution of a promptnook is successful
+ *
+ * @param executionResult - The partial result of the promptnook execution
+ * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
+ */
+function assertsExecutionSuccessful(executionResult) {
+    var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
+    if (isSuccessful === true) {
+        return;
+    }
+    if (errors.length === 0) {
+        throw new PromptbookExecutionError("Promptnook Execution failed because of unknown reason");
+    }
+    else if (errors.length === 1) {
+        throw errors[0];
+    }
+    else {
+        throw new PromptbookExecutionError(spaceTrim(function (block) { return "\n                    Multiple errors occurred during promptnook execution\n\n                    ".concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n')), "\n                "); }));
+    }
+}
+/**
+ * TODO: [🧠] Can this return type be better typed than void
+ */
+
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ */
+function isValidJsonString(value) {
+    try {
+        JSON.parse(value);
+        return true;
+    }
+    catch (error) {
+        if (!(error instanceof Error)) {
+            throw error;
+        }
+        if (error.message.includes('Unexpected token')) {
+            return false;
+        }
+        return false;
+    }
+}
+
+/**
+ * Function `addUsage` will add multiple usages into one
  *
  * Note: If you provide 0 values, it returns void usage
  */
-function addPromptResultUsage() {
+function addUsage() {
     var usageItems = [];
     for (var _i = 0; _i < arguments.length; _i++) {
         usageItems[_i] = arguments[_i];
@@ -2369,50 +2413,6 @@ function addPromptResultUsage() {
     }, initialStructure);
 }
 
-/**
- * Asserts that the execution of a promptnook is successful
- *
- * @param executionResult - The partial result of the promptnook execution
- * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
- */
-function assertsExecutionSuccessful(executionResult) {
-    var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
-    if (isSuccessful === true) {
-        return;
-    }
-    if (errors.length === 0) {
-        throw new PromptbookExecutionError("Promptnook Execution failed because of unknown reason");
-    }
-    else if (errors.length === 1) {
-        throw errors[0];
-    }
-    else {
-        throw new PromptbookExecutionError(spaceTrim(function (block) { return "\n                    Multiple errors occurred during promptnook execution\n\n                    ".concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n')), "\n                "); }));
-    }
-}
-/**
- * TODO: [🧠] Can this return type be better typed than void
- */
-
-/**
- * Function isValidJsonString will tell you if the string is valid JSON or not
- */
-function isValidJsonString(value) {
-    try {
-        JSON.parse(value);
-        return true;
-    }
-    catch (error) {
-        if (!(error instanceof Error)) {
-            throw error;
-        }
-        if (error.message.includes('Unexpected token')) {
-            return false;
-        }
-        return false;
-    }
-}
-
 /**
  * Counts number of characters in the text
  */
@@ -3002,7 +3002,7 @@ function createPromptbookExecutor(options) {
                 });
             });
         }
-        var parametersToPass, executionReport, resovedParameters_1, unresovedTemplates, resolving_1, loopLimit, _loop_1, error_1, _a, _b, parameter;
+        var parametersToPass, executionReport, resovedParameters_1, unresovedTemplates, resolving_1, loopLimit, _loop_1, error_1, usage_1, _a, _b, parameter, usage;
         var e_1, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
@@ -3081,9 +3081,14 @@ function createPromptbookExecutor(options) {
                     if (!(error_1 instanceof Error)) {
                         throw error_1;
                     }
+                    usage_1 = addUsage.apply(void 0, __spreadArray([], __read(executionReport.promptExecutions.map(function (_a) {
+                        var result = _a.result;
+                        return (result === null || result === void 0 ? void 0 : result.usage) || addUsage();
+                    })), false));
                     return [2 /*return*/, {
                             isSuccessful: false,
                             errors: [error_1],
+                            usage: usage_1,
                             executionReport: executionReport,
                             outputParameters: parametersToPass,
                         }];
@@ -3105,9 +3110,14 @@ function createPromptbookExecutor(options) {
                         }
                         finally { if (e_1) throw e_1.error; }
                     }
+                    usage = addUsage.apply(void 0, __spreadArray([], __read(executionReport.promptExecutions.map(function (_a) {
+                        var result = _a.result;
+                        return (result === null || result === void 0 ? void 0 : result.usage) || addUsage();
+                    })), false));
                     return [2 /*return*/, {
                             isSuccessful: true,
                             errors: [],
+                            usage: usage,
                             executionReport: executionReport,
                             outputParameters: parametersToPass,
                         }];
@@ -3315,6 +3325,24 @@ var SimplePromptInterfaceTools = /** @class */ (function () {
     return SimplePromptInterfaceTools;
 }());
 
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of theese sources:
+ * - https://jecas.cz/doba-cteni
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ */
+function usageToWorktime(usage) {
+    var value = usage.input.wordsCount.value / (200 /* words per minute */ * 60) +
+        usage.output.wordsCount.value / (40 /* words per minute */ * 60);
+    var isUncertain = usage.input.wordsCount.isUncertain || usage.output.wordsCount.isUncertain;
+    var uncertainNumber = { value: value };
+    if (isUncertain === true) {
+        uncertainNumber.isUncertain = true;
+    }
+    return uncertainNumber;
+}
+
 /**
  * Detects if the code is running in a browser environment in main thread (Not in a web worker)
  */
@@ -4095,13 +4123,16 @@ function executionReportJsonToString(executionReportJson, options) {
             return ({
                 title: promptExecution.prompt.title,
                 from: 0,
-                to: (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price.value) || 0) /* uncertainNumber */ * (1 + taxRate),
+                to: (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price.value) || 0) /* <- TODO: look at uncertain numbers */ *
+                    (1 + taxRate),
             });
         });
         var duration = moment.duration(completedAt.diff(startedAt));
         var llmDuration = moment.duration(countWorkingDuration(timingItems) * 1000);
         var executionsWithKnownCost = executionReportJson.promptExecutions.filter(function (promptExecution) { var _a, _b; return (((_b = (_a = promptExecution.result) === null || _a === void 0 ? void 0 : _a.usage) === null || _b === void 0 ? void 0 : _b.price) || 'UNKNOWN') !== 'UNKNOWN'; });
-        var cost = executionsWithKnownCost.reduce(function (cost, promptExecution) { return cost + ((promptExecution.result.usage.price.value /* uncertainNumber */) || 0); }, 0);
+        var cost = executionsWithKnownCost.reduce(function (cost, promptExecution) {
+            return cost + (promptExecution.result.usage.price.value /* <- Look at uncertain number */ || 0);
+        }, 0);
         headerList.push("STARTED AT ".concat(moment(startedAt).format("YYYY-MM-DD HH:mm:ss")));
         headerList.push("COMPLETED AT ".concat(moment(completedAt).format("YYYY-MM-DD HH:mm:ss")));
         headerList.push("TOTAL DURATION ".concat(duration.humanize(MOMENT_ARG_THRESHOLDS)));
@@ -4214,5 +4245,5 @@ function executionReportJsonToString(executionReportJson, options) {
  * TODO: [🧠] Allow to filter out some parts of the report by options
  */
 
-export { CallbackInterfaceTools, ExecutionReportStringOptionsDefaults, ExecutionTypes, ExpectError, MultipleLlmExecutionTools, PROMPTBOOK_VERSION, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, SimplePromptInterfaceTools, SimplePromptbookLibrary, TemplateError, UnexpectedError, addPromptResultUsage, assertsExecutionSuccessful, checkExpectations, createPromptbookExecutor, createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, executionReportJsonToString, isPassingExpectations, justTestFsImport, prettifyPromptbookString, promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
+export { CallbackInterfaceTools, ExecutionReportStringOptionsDefaults, ExecutionTypes, ExpectError, MultipleLlmExecutionTools, PROMPTBOOK_VERSION, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, SimplePromptInterfaceTools, SimplePromptbookLibrary, TemplateError, UnexpectedError, addUsage, assertsExecutionSuccessful, checkExpectations, createPromptbookExecutor, createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, executionReportJsonToString, isPassingExpectations, justTestFsImport, prettifyPromptbookString, promptbookJsonToString, promptbookStringToJson, usageToWorktime, validatePromptbookJson };
 //# sourceMappingURL=index.es.js.map