@promptbook/core 0.53.0 → 0.54.1

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,5 +1,6 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 /**
@@ -32,7 +33,7 @@ export type ExecutionReportJson = {
     /**
      * Description of the promptbook which was executed
      */
-    readonly description?: string;
+    readonly description?: string_markdown_text;
     /**
      * Sequence of prompt templates in order which were executed
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.53.0",
+    "version": "0.54.1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -454,7 +454,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.52.0';
+    var PROMPTBOOK_VERSION = '0.54.0';
 
     /**
      * Parses the template and returns the list of all parameter names
@@ -1777,7 +1777,7 @@
      * @returns Promptbook in string format (.ptbk.md)
      */
     function promptbookJsonToString(promptbookJson) {
-        var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e;
+        var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
         var title = promptbookJson.title, promptbookUrl = promptbookJson.promptbookUrl, promptbookVersion = promptbookJson.promptbookVersion, description = promptbookJson.description, parameters = promptbookJson.parameters, promptTemplates = promptbookJson.promptTemplates;
         var promptbookString = "# ".concat(title);
         if (description) {
@@ -1792,24 +1792,37 @@
         commands.push("PROMPTBOOK VERSION ".concat(promptbookVersion));
         promptbookString = prettifyMarkdown(promptbookString);
         try {
-            for (var parameters_1 = __values(parameters), parameters_1_1 = parameters_1.next(); !parameters_1_1.done; parameters_1_1 = parameters_1.next()) {
-                var parameter = parameters_1_1.value;
-                var isInput = parameter.isInput, isOutput = parameter.isOutput;
-                if (isInput) {
-                    commands.push("INPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
-                }
-                else if (isOutput) {
-                    commands.push("OUTPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
-                }
+            for (var _g = __values(parameters.filter(function (_a) {
+                var isInput = _a.isInput;
+                return isInput;
+            })), _h = _g.next(); !_h.done; _h = _g.next()) {
+                var parameter = _h.value;
+                commands.push("INPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (parameters_1_1 && !parameters_1_1.done && (_a = parameters_1.return)) _a.call(parameters_1);
+                if (_h && !_h.done && (_a = _g.return)) _a.call(_g);
             }
             finally { if (e_1) throw e_1.error; }
         }
+        try {
+            for (var _j = __values(parameters.filter(function (_a) {
+                var isOutput = _a.isOutput;
+                return isOutput;
+            })), _k = _j.next(); !_k.done; _k = _j.next()) {
+                var parameter = _k.value;
+                commands.push("OUTPUT PARAMETER ".concat(promptTemplateParameterJsonToString(parameter)));
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_k && !_k.done && (_b = _j.return)) _b.call(_j);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
         promptbookString += '\n\n';
         promptbookString += commands.map(function (command) { return "- ".concat(command); }).join('\n');
         try {
@@ -1859,38 +1872,38 @@
                 }
                 if (jokers) {
                     try {
-                        for (var jokers_1 = (e_3 = void 0, __values(jokers)), jokers_1_1 = jokers_1.next(); !jokers_1_1.done; jokers_1_1 = jokers_1.next()) {
+                        for (var jokers_1 = (e_4 = void 0, __values(jokers)), jokers_1_1 = jokers_1.next(); !jokers_1_1.done; jokers_1_1 = jokers_1.next()) {
                             var joker = jokers_1_1.value;
                             commands_1.push("JOKER {".concat(joker, "}"));
                         }
                     }
-                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
                     finally {
                         try {
-                            if (jokers_1_1 && !jokers_1_1.done && (_c = jokers_1.return)) _c.call(jokers_1);
+                            if (jokers_1_1 && !jokers_1_1.done && (_d = jokers_1.return)) _d.call(jokers_1);
                         }
-                        finally { if (e_3) throw e_3.error; }
+                        finally { if (e_4) throw e_4.error; }
                     }
                 } /* not else */
                 if (postprocessing) {
                     try {
-                        for (var postprocessing_1 = (e_4 = void 0, __values(postprocessing)), postprocessing_1_1 = postprocessing_1.next(); !postprocessing_1_1.done; postprocessing_1_1 = postprocessing_1.next()) {
+                        for (var postprocessing_1 = (e_5 = void 0, __values(postprocessing)), postprocessing_1_1 = postprocessing_1.next(); !postprocessing_1_1.done; postprocessing_1_1 = postprocessing_1.next()) {
                             var postprocessingFunctionName = postprocessing_1_1.value;
                             commands_1.push("POSTPROCESSING `".concat(postprocessingFunctionName, "`"));
                         }
                     }
-                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                    catch (e_5_1) { e_5 = { error: e_5_1 }; }
                     finally {
                         try {
-                            if (postprocessing_1_1 && !postprocessing_1_1.done && (_d = postprocessing_1.return)) _d.call(postprocessing_1);
+                            if (postprocessing_1_1 && !postprocessing_1_1.done && (_e = postprocessing_1.return)) _e.call(postprocessing_1);
                         }
-                        finally { if (e_4) throw e_4.error; }
+                        finally { if (e_5) throw e_5.error; }
                     }
                 } /* not else */
                 if (expectations) {
                     try {
-                        for (var _f = (e_5 = void 0, __values(Object.entries(expectations))), _g = _f.next(); !_g.done; _g = _f.next()) {
-                            var _h = __read(_g.value, 2), unit = _h[0], _j = _h[1], min = _j.min, max = _j.max;
+                        for (var _l = (e_6 = void 0, __values(Object.entries(expectations))), _m = _l.next(); !_m.done; _m = _l.next()) {
+                            var _o = __read(_m.value, 2), unit = _o[0], _p = _o[1], min = _p.min, max = _p.max;
                             if (min === max) {
                                 commands_1.push("EXPECT EXACTLY ".concat(min, " ").concat(capitalize(unit + (min > 1 ? 's' : ''))));
                             }
@@ -1904,12 +1917,12 @@
                             }
                         }
                     }
-                    catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                    catch (e_6_1) { e_6 = { error: e_6_1 }; }
                     finally {
                         try {
-                            if (_g && !_g.done && (_e = _f.return)) _e.call(_f);
+                            if (_m && !_m.done && (_f = _l.return)) _f.call(_l);
                         }
-                        finally { if (e_5) throw e_5.error; }
+                        finally { if (e_6) throw e_6.error; }
                     }
                 } /* not else */
                 if (expectFormat) {
@@ -1932,12 +1945,12 @@
                 promptbookString += "`-> {".concat(resultingParameterName, "}`"); // <- TODO: !!! If the parameter here has description, add it and use promptTemplateParameterJsonToString
             }
         }
-        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
         finally {
             try {
-                if (promptTemplates_1_1 && !promptTemplates_1_1.done && (_b = promptTemplates_1.return)) _b.call(promptTemplates_1);
+                if (promptTemplates_1_1 && !promptTemplates_1_1.done && (_c = promptTemplates_1.return)) _c.call(promptTemplates_1);
             }
-            finally { if (e_2) throw e_2.error; }
+            finally { if (e_3) throw e_3.error; }
         }
         return promptbookString;
     }
@@ -2182,6 +2195,23 @@
      *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
      */
 
+    /**
+     * This error occurs when some expectation is not met in the execution of the pipeline
+     *
+     * @private Always catched and rethrown as `PromptbookExecutionError`
+     * Note: This is a kindof subtype of PromptbookExecutionError
+     */
+    var ExpectError = /** @class */ (function (_super) {
+        __extends(ExpectError, _super);
+        function ExpectError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'ExpectError';
+            Object.setPrototypeOf(_this, ExpectError.prototype);
+            return _this;
+        }
+        return ExpectError;
+    }(Error));
+
     /**
      * This error indicates errors during the execution of the promptbook
      */
@@ -2196,6 +2226,64 @@
         return PromptbookExecutionError;
     }(Error));
 
+    /**
+     * This error indicates that the promptbook library cannot be propperly loaded
+     */
+    var PromptbookLibraryError = /** @class */ (function (_super) {
+        __extends(PromptbookLibraryError, _super);
+        function PromptbookLibraryError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookLibraryError';
+            Object.setPrototypeOf(_this, PromptbookLibraryError.prototype);
+            return _this;
+        }
+        return PromptbookLibraryError;
+    }(Error));
+
+    /**
+     * This error indicates that promptbook not found in the library
+     */
+    var PromptbookNotFoundError = /** @class */ (function (_super) {
+        __extends(PromptbookNotFoundError, _super);
+        function PromptbookNotFoundError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookNotFoundError';
+            Object.setPrototypeOf(_this, PromptbookNotFoundError.prototype);
+            return _this;
+        }
+        return PromptbookNotFoundError;
+    }(Error));
+
+    /**
+     * This error indicates errors in referencing promptbooks between each other
+     */
+    var PromptbookReferenceError = /** @class */ (function (_super) {
+        __extends(PromptbookReferenceError, _super);
+        function PromptbookReferenceError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookReferenceError';
+            Object.setPrototypeOf(_this, PromptbookReferenceError.prototype);
+            return _this;
+        }
+        return PromptbookReferenceError;
+    }(Error));
+
+    /**
+     * This error occurs during the parameter replacement in the template
+     *
+     * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
+     */
+    var TemplateError = /** @class */ (function (_super) {
+        __extends(TemplateError, _super);
+        function TemplateError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'TemplateError';
+            Object.setPrototypeOf(_this, TemplateError.prototype);
+            return _this;
+        }
+        return TemplateError;
+    }(Error));
+
     /**
      * Asserts that the execution of a promptnook is successful
      *
@@ -2221,23 +2309,6 @@
      * TODO: [🧠] Can this return type be better typed than void
      */
 
-    /**
-     * This error occurs when some expectation is not met in the execution of the pipeline
-     *
-     * @private Always catched and rethrown as `PromptbookExecutionError`
-     * Note: This is a kindof subtype of PromptbookExecutionError
-     */
-    var ExpectError = /** @class */ (function (_super) {
-        __extends(ExpectError, _super);
-        function ExpectError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'ExpectError';
-            Object.setPrototypeOf(_this, ExpectError.prototype);
-            return _this;
-        }
-        return ExpectError;
-    }(Error));
-
     /**
      * Function isValidJsonString will tell you if the string is valid JSON or not
      */
@@ -2388,22 +2459,6 @@
      * TODO: [💝] Unite object for expecting amount and format
      */
 
-    /**
-     * This error occurs during the parameter replacement in the template
-     *
-     * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
-     */
-    var TemplateError = /** @class */ (function (_super) {
-        __extends(TemplateError, _super);
-        function TemplateError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'TemplateError';
-            Object.setPrototypeOf(_this, TemplateError.prototype);
-            return _this;
-        }
-        return TemplateError;
-    }(Error));
-
     /**
      * Replaces parameters in template with values from parameters object
      *
@@ -3175,20 +3230,6 @@
         return SimplePromptInterfaceTools;
     }());
 
-    /**
-     * This error indicates that the promptbook library cannot be propperly loaded
-     */
-    var PromptbookLibraryError = /** @class */ (function (_super) {
-        __extends(PromptbookLibraryError, _super);
-        function PromptbookLibraryError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookLibraryError';
-            Object.setPrototypeOf(_this, PromptbookLibraryError.prototype);
-            return _this;
-        }
-        return PromptbookLibraryError;
-    }(Error));
-
     /**
      * Detects if the code is running in a browser environment in main thread (Not in a web worker)
      */
@@ -3219,34 +3260,6 @@
         return value;
     }
 
-    /**
-     * This error indicates that promptbook not found in the library
-     */
-    var PromptbookNotFoundError = /** @class */ (function (_super) {
-        __extends(PromptbookNotFoundError, _super);
-        function PromptbookNotFoundError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookNotFoundError';
-            Object.setPrototypeOf(_this, PromptbookNotFoundError.prototype);
-            return _this;
-        }
-        return PromptbookNotFoundError;
-    }(Error));
-
-    /**
-     * This error indicates errors in referencing promptbooks between each other
-     */
-    var PromptbookReferenceError = /** @class */ (function (_super) {
-        __extends(PromptbookReferenceError, _super);
-        function PromptbookReferenceError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookReferenceError';
-            Object.setPrototypeOf(_this, PromptbookReferenceError.prototype);
-            return _this;
-        }
-        return PromptbookReferenceError;
-    }(Error));
-
     /**
      * Library of promptbooks that groups together promptbooks for an application.
      * This implementation is a very thin wrapper around the Array / Map of promptbooks.
@@ -4119,10 +4132,19 @@
     exports.CallbackInterfaceTools = CallbackInterfaceTools;
     exports.ExecutionReportStringOptionsDefaults = ExecutionReportStringOptionsDefaults;
     exports.ExecutionTypes = ExecutionTypes;
+    exports.ExpectError = ExpectError;
     exports.MultipleLlmExecutionTools = MultipleLlmExecutionTools;
     exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;
+    exports.PromptbookExecutionError = PromptbookExecutionError;
+    exports.PromptbookLibraryError = PromptbookLibraryError;
+    exports.PromptbookLogicError = PromptbookLogicError;
+    exports.PromptbookNotFoundError = PromptbookNotFoundError;
+    exports.PromptbookReferenceError = PromptbookReferenceError;
+    exports.PromptbookSyntaxError = PromptbookSyntaxError;
     exports.SimplePromptInterfaceTools = SimplePromptInterfaceTools;
     exports.SimplePromptbookLibrary = SimplePromptbookLibrary;
+    exports.TemplateError = TemplateError;
+    exports.UnexpectedError = UnexpectedError;
     exports.assertsExecutionSuccessful = assertsExecutionSuccessful;
     exports.checkExpectations = checkExpectations;
     exports.createPromptbookExecutor = createPromptbookExecutor;