@promptbook/core 0.47.0 → 0.48.0-0

package/umd/index.umd.js

@@ -1,8 +1,12 @@
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('moment')) :
     typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'prettier', 'prettier/parser-html', 'moment'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spacetrim));
-})(this, (function (exports, spacetrim) { 'use strict';
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spaceTrim));
+})(this, (function (exports, spaceTrim) { 'use strict';
+
+    function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+    var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -130,7 +134,7 @@
      * @returns {string} The input string with all comments removed.
      */
     function removeContentComments(content) {
-        return spacetrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
+        return spaceTrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
     }
 
     /**
@@ -139,7 +143,7 @@
     var UnexpectedError = /** @class */ (function (_super) {
         __extends(UnexpectedError, _super);
         function UnexpectedError(message) {
-            var _this = _super.call(this, spacetrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the promptbook library\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the promptbook library\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
             _this.name = 'UnexpectedError';
             Object.setPrototypeOf(_this, UnexpectedError.prototype);
             return _this;
@@ -535,11 +539,10 @@
         var letters = defaultDiacriticsRemovalMap[i].letters;
         // tslint:disable-next-line: prefer-for-of
         for (var j = 0; j < letters.length; j++) {
-            DIACRITIC_VARIANTS_LETTERS[letters[j]] =
-                defaultDiacriticsRemovalMap[i].base;
+            DIACRITIC_VARIANTS_LETTERS[letters[j]] = defaultDiacriticsRemovalMap[i].base;
         }
     }
-    // <- TODO: !!!! Put to maker function
+    // <- TODO: [🍓] Put to maker function to save execution time if not needed
     /*
       @see https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript
        Licensed under the Apache License, Version 2.0 (the "License");
@@ -847,7 +850,7 @@
         return codeBlocks[0];
     }
     /***
-     * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+     * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
      */
 
     /**
@@ -1094,7 +1097,7 @@
                             }
                             if (parent_1.parent === null /* <- Note: We are in root */) {
                                 // [🌻]
-                                throw new Error(spacetrim.spaceTrim("\n                                The file has an invalid structure.\n                                The markdown file must have exactly one top-level section.\n                            "));
+                                throw new Error(spaceTrim.spaceTrim("\n                                The file has an invalid structure.\n                                The markdown file must have exactly one top-level section.\n                            "));
                             }
                             parent_1 = parent_1.parent;
                         }
@@ -1128,7 +1131,7 @@
         return {
             level: level,
             title: title,
-            content: spacetrim.spaceTrim(contentLines.join('\n')),
+            content: spaceTrim.spaceTrim(contentLines.join('\n')),
             sections: sections.map(parsingMarkdownStructureToMarkdownStructure),
         };
     }
@@ -1136,7 +1139,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.47.0-0';
+    var PROMPTBOOK_VERSION = '0.47.0';
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -1181,7 +1184,7 @@
             if (!(error instanceof Error)) {
                 throw error;
             }
-            throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.name), ": ").concat(block(error.message), "\n                "); }));
+            throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.name), ": ").concat(block(error.message), "\n                "); }));
         }
         return variables;
     }
@@ -1246,15 +1249,15 @@
             type.startsWith('PROMPTBOOKURL') ||
             type.startsWith('HTTPS')) {
             if (!(listItemParts.length === 2 || (listItemParts.length === 1 && type.startsWith('HTTPS')))) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                        Invalid PROMPTBOOK_URL command:\n\n                        - ".concat(listItem, "\n                    ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                        Invalid PROMPTBOOK_URL command:\n\n                        - ".concat(listItem, "\n                    ")));
             }
             var promptbookUrlString = listItemParts.pop();
             var promptbookUrl = new URL(promptbookUrlString);
             if (promptbookUrl.protocol !== 'https:') {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                        Invalid PROMPTBOOK_URL command:\n\n                        - ".concat(listItem, "\n\n                        Protocol must be HTTPS\n                    ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                        Invalid PROMPTBOOK_URL command:\n\n                        - ".concat(listItem, "\n\n                        Protocol must be HTTPS\n                    ")));
             }
             if (promptbookUrl.hash !== '') {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                        Invalid PROMPTBOOK_URL command:\n\n                        - ".concat(listItem, "\n\n                        URL must not contain hash\n                        Hash is used for identification of the prompt template in the pipeline\n                    ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                        Invalid PROMPTBOOK_URL command:\n\n                        - ".concat(listItem, "\n\n                        URL must not contain hash\n                        Hash is used for identification of the prompt template in the pipeline\n                    ")));
             }
             return {
                 type: 'PROMPTBOOK_URL',
@@ -1263,7 +1266,7 @@
         }
         else if (type.startsWith('PROMPTBOOK_VERSION') || type.startsWith('PTBK_VERSION')) {
             if (listItemParts.length !== 2) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                        Invalid PROMPTBOOK_VERSION command:\n\n                        - ".concat(listItem, "\n                    ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                        Invalid PROMPTBOOK_VERSION command:\n\n                        - ".concat(listItem, "\n                    ")));
             }
             var promptbookVersion = listItemParts.pop();
             // TODO: Validate version
@@ -1278,7 +1281,7 @@
             type.startsWith('SIMPLE_TEMPLATE')) {
             var executionTypes = ExecutionTypes.filter(function (executionType) { return type.includes(executionType); });
             if (executionTypes.length !== 1) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                        Unknown execution type in command:\n\n                        - ".concat(listItem, "\n\n                        Supported execution types are:\n                        ").concat(block(ExecutionTypes.join(', ')), "\n                    "); }));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                        Unknown execution type in command:\n\n                        - ".concat(listItem, "\n\n                        Supported execution types are:\n                        ").concat(block(ExecutionTypes.join(', ')), "\n                    "); }));
             }
             return {
                 type: 'EXECUTE',
@@ -1303,7 +1306,7 @@
                     };
                 }
                 else {
-                    throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                            Unknown model variant in command:\n\n                            - ".concat(listItem, "\n\n                            Supported variants are:\n                            ").concat(block(['CHAT', 'COMPLETION'].join(', ')), "\n                        "); }));
+                    throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                            Unknown model variant in command:\n\n                            - ".concat(listItem, "\n\n                            Supported variants are:\n                            ").concat(block(['CHAT', 'COMPLETION'].join(', ')), "\n                        "); }));
                 }
             }
             if (type.startsWith('MODEL_NAME')) {
@@ -1314,7 +1317,7 @@
                 };
             }
             else {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                          Unknown model key in command:\n\n                          - ".concat(listItem, "\n\n                          Supported model keys are:\n                          ").concat(block(['variant', 'name'].join(', ')), "\n\n                          Example:\n\n                          - MODEL VARIANT Chat\n                          - MODEL NAME gpt-4\n                    "); }));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                          Unknown model key in command:\n\n                          - ".concat(listItem, "\n\n                          Supported model keys are:\n                          ").concat(block(['variant', 'name'].join(', ')), "\n\n                          Example:\n\n                          - MODEL VARIANT Chat\n                          - MODEL NAME gpt-4\n                    "); }));
             }
         }
         else if (type.startsWith('PARAM') ||
@@ -1324,12 +1327,12 @@
             listItem.startsWith('> {') /* <- Note: This is a bit hack to parse return parameters defined at the end of each section */) {
             var parametersMatch = listItem.match(/\{(?<parameterName>[a-z0-9_]+)\}[^\S\r\n]*(?<parameterDescription>.*)$/im);
             if (!parametersMatch || !parametersMatch.groups || !parametersMatch.groups.parameterName) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                        Invalid parameter in command:\n\n                        - ".concat(listItem, "\n                    ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                        Invalid parameter in command:\n\n                        - ".concat(listItem, "\n                    ")));
             }
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             var _b = parametersMatch.groups, parameterName = _b.parameterName, parameterDescription = _b.parameterDescription;
             if (parameterDescription && parameterDescription.match(/\{(?<parameterName>[a-z0-9_]+)\}/im)) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                        Parameter {".concat(parameterName, "} can not contain another parameter in description:\n\n                        - ").concat(listItem, "\n                    ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                        Parameter {".concat(parameterName, "} can not contain another parameter in description:\n\n                        - ").concat(listItem, "\n                    ")));
             }
             var isInput = type.startsWith('INPUT');
             var isOutput = type.startsWith('OUTPUT');
@@ -1347,11 +1350,11 @@
         }
         else if (type.startsWith('JOKER')) {
             if (listItemParts.length !== 2) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                Invalid JOKER command:\n\n                - ".concat(listItem, "\n            ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                Invalid JOKER command:\n\n                - ".concat(listItem, "\n            ")));
             }
             var parametersMatch = (listItemParts.pop() || '').match(/^\{(?<parameterName>[a-z0-9_]+)\}$/im);
             if (!parametersMatch || !parametersMatch.groups || !parametersMatch.groups.parameterName) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                      Invalid parameter in command:\n\n                      - ".concat(listItem, "\n                  ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                      Invalid parameter in command:\n\n                      - ".concat(listItem, "\n                  ")));
             }
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             var parameterName = parametersMatch.groups.parameterName;
@@ -1362,7 +1365,7 @@
         }
         else if (type.startsWith('POSTPROCESS') || type.startsWith('POST_PROCESS')) {
             if (listItemParts.length !== 2) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                Invalid POSTPROCESSING command:\n\n                - ".concat(listItem, "\n            ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                Invalid POSTPROCESSING command:\n\n                - ".concat(listItem, "\n            ")));
             }
             var functionName = listItemParts.pop();
             return {
@@ -1442,7 +1445,7 @@
                 if (!(error instanceof Error)) {
                     throw error;
                 }
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                  Invalid EXPECT command; ".concat(error.message, ":\n\n                  - ").concat(listItem, "\n              ")));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                  Invalid EXPECT command; ".concat(error.message, ":\n\n                  - ").concat(listItem, "\n              ")));
             }
             /*
         } else if (type.startsWith('__________________')) {
@@ -1450,7 +1453,7 @@
         */
         }
         else {
-            throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                    Unknown command:\n\n                    - ".concat(listItem, "\n\n                    Supported commands are:\n                    - PROMPTBOOK_URL <url>\n                    - PROMPTBOOK_VERSION <version>\n                    - EXECUTE PROMPT TEMPLATE\n                    - EXECUTE SIMPLE TEMPLATE\n                    -         SIMPLE TEMPLATE\n                    - EXECUTE SCRIPT\n                    - EXECUTE PROMPT_DIALOG'\n                    -         PROMPT_DIALOG'\n                    - MODEL NAME <name>\n                    - MODEL VARIANT <\"Chat\"|\"Completion\">\n                    - INPUT  PARAM {<name>} <description>\n                    - OUTPUT PARAM {<name>} <description>\n                    - POSTPROCESS `{functionName}`\n                    - JOKER {<name>}\n                    - EXPECT JSON\n                    - EXPECT <\"Exactly\"|\"Min\"|\"Max\"> <number> <\"Chars\"|\"Words\"|\"Sentences\"|\"Paragraphs\"|\"Pages\">\n\n                ")));
+            throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                    Unknown command:\n\n                    - ".concat(listItem, "\n\n                    Supported commands are:\n                    - PROMPTBOOK_URL <url>\n                    - PROMPTBOOK_VERSION <version>\n                    - EXECUTE PROMPT TEMPLATE\n                    - EXECUTE SIMPLE TEMPLATE\n                    -         SIMPLE TEMPLATE\n                    - EXECUTE SCRIPT\n                    - EXECUTE PROMPT_DIALOG'\n                    -         PROMPT_DIALOG'\n                    - MODEL NAME <name>\n                    - MODEL VARIANT <\"Chat\"|\"Completion\">\n                    - INPUT  PARAM {<name>} <description>\n                    - OUTPUT PARAM {<name>} <description>\n                    - POSTPROCESS `{functionName}`\n                    - JOKER {<name>}\n                    - EXPECT JSON\n                    - EXPECT <\"Exactly\"|\"Min\"|\"Max\"> <number> <\"Chars\"|\"Words\"|\"Sentences\"|\"Paragraphs\"|\"Pages\">\n\n                ")));
         }
     }
 
@@ -1486,7 +1489,7 @@
                 existingParameter.description &&
                 existingParameter.description !== parameterDescription &&
                 parameterDescription) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                        Parameter {".concat(parameterName, "} is defined multiple times with different description.\n\n                        First definition:\n                        ").concat(block(existingParameter.description || '[undefined]'), "\n\n                        Second definition:\n                        ").concat(block(parameterDescription || '[undefined]'), "\n                    "); }));
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                        Parameter {".concat(parameterName, "} is defined multiple times with different description.\n\n                        First definition:\n                        ").concat(block(existingParameter.description || '[undefined]'), "\n\n                        Second definition:\n                        ").concat(block(parameterDescription || '[undefined]'), "\n                    "); }));
             }
             if (existingParameter) {
                 if (parameterDescription) {
@@ -1507,7 +1510,7 @@
         var markdownStructure = markdownToMarkdownStructure(promptbookString);
         var markdownStructureDeepness = countMarkdownStructureDeepness(markdownStructure);
         if (markdownStructureDeepness !== 2) {
-            throw new PromptbookSyntaxError(spacetrim.spaceTrim("\n                Invalid markdown structure.\n                The markdown must have exactly 2 levels of headings (one top-level section and one section for each template).\n                Now it has ".concat(markdownStructureDeepness, " levels of headings.\n            ")));
+            throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                Invalid markdown structure.\n                The markdown must have exactly 2 levels of headings (one top-level section and one section for each template).\n                Now it has ".concat(markdownStructureDeepness, " levels of headings.\n            ")));
         }
         promptbookJson.title = markdownStructure.title;
         // TODO: [1] DRY description
@@ -1516,7 +1519,7 @@
         description = description.split(/^```.*^```/gms).join('');
         //Note: Remove lists and return statement
         description = description.split(/^(?:(?:-)|(?:\d\))|(?:`?->))\s+.*$/gm).join('');
-        description = spacetrim.spaceTrim(description);
+        description = spaceTrim.spaceTrim(description);
         if (description === '') {
             description = undefined;
         }
@@ -1631,13 +1634,13 @@
                     throw new PromptbookSyntaxError('You must specify the language of the script in the prompt template');
                 }
                 else if (!SUPPORTED_SCRIPT_LANGUAGES.includes(language)) {
-                    throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                            Script language ".concat(language, " is not supported.\n\n                            Supported languages are:\n                            ").concat(block(SUPPORTED_SCRIPT_LANGUAGES.join(', ')), "\n\n                        "); }));
+                    throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                            Script language ".concat(language, " is not supported.\n\n                            Supported languages are:\n                            ").concat(block(SUPPORTED_SCRIPT_LANGUAGES.join(', ')), "\n\n                        "); }));
                 }
             }
             var lastLine = section.content.split('\n').pop();
             var match = /^->\s*\{(?<resultingParamName>[a-z0-9_]+)\}/im.exec(lastLine);
             if (!match || match.groups === undefined || match.groups.resultingParamName === undefined) {
-                throw new PromptbookSyntaxError(spacetrim.spaceTrim(function (block) { return "\n                        Invalid template - each section must end with \"-> {...}\"\n\n                        Invalid section:\n                        ".concat(block(
+                throw new PromptbookSyntaxError(spaceTrim.spaceTrim(function (block) { return "\n                        Invalid template - each section must end with \"-> {...}\"\n\n                        Invalid section:\n                        ".concat(block(
                 // TODO: Show code of invalid sections each time + DRY
                 section.content
                     .split('\n')
@@ -1651,7 +1654,7 @@
             description_1 = description_1.split(/^```.*^```/gms).join('');
             //Note: Remove lists and return statement
             description_1 = description_1.split(/^(?:(?:-)|(?:\d\))|(?:`?->))\s+.*$/gm).join('');
-            description_1 = spacetrim.spaceTrim(description_1);
+            description_1 = spaceTrim.spaceTrim(description_1);
             if (description_1 === '') {
                 description_1 = undefined;
             }
@@ -1731,6 +1734,15 @@
      * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
      */
 
+    function promptbookJsonToString(promptbookJson) {
+        return spaceTrim__default["default"](function (block) { return "\n\n            # ".concat(block(promptbookJson.title), "\n\n        "); });
+    }
+    /**
+     * TODO: !!! Implement
+     * TODO: !!! Annotate and warn
+     * TODO: !!! Test + test together with promptbookStringToJson
+     */
+
     /**
      * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
      */
@@ -1799,12 +1811,12 @@
             if (!parameter.isInput &&
                 !parameter.isOutput &&
                 !promptbook.promptTemplates.some(function (template) { return template.dependentParameterNames.includes(parameter.name); })) {
-                throw new PromptbookLogicError(spacetrim.spaceTrim("\n                    Parameter {".concat(parameter.name, "} is created but not used\n\n                    You can declare {").concat(parameter.name, "} as output parameter by adding in the header:\n                    - OUTPUT PARAMETER `{").concat(parameter.name, "}` ").concat(parameter.description || '', "\n\n                ")));
+                throw new PromptbookLogicError(spaceTrim.spaceTrim("\n                    Parameter {".concat(parameter.name, "} is created but not used\n\n                    You can declare {").concat(parameter.name, "} as output parameter by adding in the header:\n                    - OUTPUT PARAMETER `{").concat(parameter.name, "}` ").concat(parameter.description || '', "\n\n                ")));
             }
             // Note: Testing that parameter is either input or result of some template
             if (!parameter.isInput &&
                 !promptbook.promptTemplates.some(function (template) { return template.resultingParameterName === parameter.name; })) {
-                throw new PromptbookLogicError(spacetrim.spaceTrim("\n                    Parameter {".concat(parameter.name, "} is declared but not defined\n\n                    You can do one of these:\n                    - Remove declaration of {").concat(parameter.name, "}\n                    - Add prompt template that results in -> {").concat(parameter.name, "}\n\n                ")));
+                throw new PromptbookLogicError(spaceTrim.spaceTrim("\n                    Parameter {".concat(parameter.name, "} is declared but not defined\n\n                    You can do one of these:\n                    - Remove declaration of {").concat(parameter.name, "}\n                    - Add prompt template that results in -> {").concat(parameter.name, "}\n\n                ")));
             }
         };
         try {
@@ -1839,7 +1851,7 @@
                 if (template.executionType === 'PROMPT_TEMPLATE' &&
                     (template.modelRequirements.modelVariant === undefined ||
                         template.modelRequirements.modelName === undefined)) {
-                    throw new PromptbookLogicError(spacetrim.spaceTrim("\n\n                  You must specify MODEL VARIANT and MODEL NAME in the prompt template \"".concat(template.title, "\"\n\n                  For example:\n                  - MODEL VARIANT Chat\n                  - MODEL NAME `gpt-4-1106-preview`\n\n              ")));
+                    throw new PromptbookLogicError(spaceTrim.spaceTrim("\n\n                  You must specify MODEL VARIANT and MODEL NAME in the prompt template \"".concat(template.title, "\"\n\n                  For example:\n                  - MODEL VARIANT Chat\n                  - MODEL NAME `gpt-4-1106-preview`\n\n              ")));
                 }
                 if (template.jokers && template.jokers.length > 0) {
                     if (!template.expectFormat &&
@@ -1914,7 +1926,7 @@
                 return template.dependentParameterNames.every(function (name) { return resovedParameters.includes(name); });
             });
             if (currentlyResovedTemplates.length === 0) {
-                throw new PromptbookLogicError(spacetrim.spaceTrim(function (block) { return "\n\n                        Can not resolve some parameters\n                        It may be circular dependencies\n\n                        Can not resolve:\n                        ".concat(block(unresovedTemplates
+                throw new PromptbookLogicError(spaceTrim.spaceTrim(function (block) { return "\n\n                        Can not resolve some parameters\n                        It may be circular dependencies\n\n                        Can not resolve:\n                        ".concat(block(unresovedTemplates
                     .map(function (_a) {
                     var resultingParameterName = _a.resultingParameterName, dependentParameterNames = _a.dependentParameterNames;
                     return "- {".concat(resultingParameterName, "} depends on ").concat(dependentParameterNames
@@ -2087,7 +2099,7 @@
                                                         throw errors[0];
                                                     }
                                                     else {
-                                                        throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                                                        Postprocessing in LlmExecutionTools failed ".concat(errors.length, "x\n\n                                                        ").concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n\n')), "\n                                                      "); }));
+                                                        throw new PromptbookExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                                                        Postprocessing in LlmExecutionTools failed ".concat(errors.length, "x\n\n                                                        ").concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n\n')), "\n                                                      "); }));
                                                     }
                                             }
                                         });
@@ -2171,7 +2183,7 @@
                                     throw scriptExecutionErrors[0];
                                 }
                                 else {
-                                    throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                                              Script execution failed ".concat(scriptExecutionErrors.length, " times\n\n                                              ").concat(block(scriptExecutionErrors
+                                    throw new PromptbookExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                                              Script execution failed ".concat(scriptExecutionErrors.length, " times\n\n                                              ").concat(block(scriptExecutionErrors
                                         .map(function (error) { return '- ' + error.message; })
                                         .join('\n\n')), "\n                                          "); }));
                                 }
@@ -2311,7 +2323,7 @@
                                 return [7 /*endfinally*/];
                             case 47:
                                 if (expectError !== null && attempt === maxAttempts - 1) {
-                                    throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                              LLM execution failed ".concat(maxExecutionAttempts, "x\n\n                              ---\n                              Last error ").concat((expectError === null || expectError === void 0 ? void 0 : expectError.name) || '', ":\n                              ").concat(block((expectError === null || expectError === void 0 ? void 0 : expectError.message) || ''), "\n\n                              Last result:\n                              ").concat(resultString, "\n                              ---\n                          "); }));
+                                    throw new PromptbookExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                              LLM execution failed ".concat(maxExecutionAttempts, "x\n\n                              ---\n                              Last error ").concat((expectError === null || expectError === void 0 ? void 0 : expectError.name) || '', ":\n                              ").concat(block((expectError === null || expectError === void 0 ? void 0 : expectError.message) || ''), "\n\n                              Last result:\n                              ").concat(resultString, "\n                              ---\n                          "); }));
                                 }
                                 _o.label = 48;
                             case 48:
@@ -2380,7 +2392,7 @@
                                             return template.dependentParameterNames.every(function (name) { return resovedParameters_1.includes(name); });
                                         });
                                         if (!(!currentTemplate && resolving_1.length === 0)) return [3 /*break*/, 1];
-                                        throw new UnexpectedError(spacetrim.spaceTrim("\n                            Can not resolve some parameters\n\n                            Note: This should be catched during validatePromptbookJson\n                        "));
+                                        throw new UnexpectedError(spaceTrim.spaceTrim("\n                            Can not resolve some parameters\n\n                            Note: This should be catched during validatePromptbookJson\n                        "));
                                     case 1:
                                         if (!!currentTemplate) return [3 /*break*/, 3];
                                         /* [5] */ return [4 /*yield*/, Promise.race(resolving_1)];
@@ -2480,7 +2492,7 @@
                         case 1:
                             answer = _a.sent();
                             if (this.options.isVerbose) {
-                                console.info(spacetrim.spaceTrim(function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.promptTitle), "\n                        \uD83D\uDC64 ").concat(block(answer), "\n                    "); }));
+                                console.info(spaceTrim.spaceTrim(function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.promptTitle), "\n                        \uD83D\uDC64 ").concat(block(answer), "\n                    "); }));
                             }
                             return [2 /*return*/, answer];
                     }
@@ -2507,9 +2519,9 @@
             return __awaiter(this, void 0, void 0, function () {
                 var answer;
                 return __generator(this, function (_a) {
-                    answer = window.prompt(spacetrim.spaceTrim(function (block) { return "\n                    ".concat(block(options.promptTitle), "\n\n                    ").concat(block(options.promptMessage), "\n                "); }));
+                    answer = window.prompt(spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(options.promptTitle), "\n\n                    ").concat(block(options.promptMessage), "\n                "); }));
                     if (this.options.isVerbose) {
-                        console.info(spacetrim.spaceTrim(function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.promptTitle), "\n                        \uD83D\uDC64 ").concat(block(answer || '🚫 User cancelled prompt'), "\n                    "); }));
+                        console.info(spaceTrim.spaceTrim(function (block) { return "\n                        \uD83D\uDCD6 ".concat(block(options.promptTitle), "\n                        \uD83D\uDC64 ").concat(block(answer || '🚫 User cancelled prompt'), "\n                    "); }));
                     }
                     if (answer === null) {
                         throw new PromptbookExecutionError('User cancelled prompt');
@@ -2556,7 +2568,8 @@
      * @see https://github.com/webgptorg/promptbook#promptbook-library
      */
     var SimplePromptbookLibrary = /** @class */ (function () {
-        /**!!!
+        /**
+         * Constructs a promptbook library from promptbooks
          *
          * @param promptbooks !!!
          *
@@ -2574,7 +2587,7 @@
                 for (var promptbooks_1 = __values(promptbooks), promptbooks_1_1 = promptbooks_1.next(); !promptbooks_1_1.done; promptbooks_1_1 = promptbooks_1.next()) {
                     var promptbook = promptbooks_1_1.value;
                     if (promptbook.promptbookUrl === undefined) {
-                        throw new PromptbookReferenceError(spacetrim.spaceTrim("\n                        Promptbook with name \"".concat(promptbook.title, "\" does not have defined URL\n\n                        Note: Promptbooks without URLs are called anonymous promptbooks\n                              They can be used as standalone promptbooks, but they cannot be referenced by other promptbooks\n                              And also they cannot be used in the promptbook library\n\n                    ")));
+                        throw new PromptbookReferenceError(spaceTrim.spaceTrim("\n                        Promptbook with name \"".concat(promptbook.title, "\" does not have defined URL\n\n                        Note: Promptbooks without URLs are called anonymous promptbooks\n                              They can be used as standalone promptbooks, but they cannot be referenced by other promptbooks\n                              And also they cannot be used in the promptbook library\n\n                    ")));
                     }
                     validatePromptbookJson(promptbook);
                     this.library.set(promptbook.promptbookUrl, promptbook);
@@ -2603,7 +2616,7 @@
             var _this = this;
             var promptbook = this.library.get(url);
             if (!promptbook) {
-                throw new PromptbookNotFoundError(spacetrim.spaceTrim(function (block) { return "\n                        Promptbook with url \"".concat(url, "\" not found\n\n                        Available promptbooks:\n                        ").concat(block(_this.listPromptbooks()
+                throw new PromptbookNotFoundError(spaceTrim.spaceTrim(function (block) { return "\n                        Promptbook with url \"".concat(url, "\" not found\n\n                        Available promptbooks:\n                        ").concat(block(_this.listPromptbooks()
                     .map(function (promptbookUrl) { return "- ".concat(promptbookUrl); })
                     .join('\n')), "\n\n                    "); }));
             }
@@ -2618,6 +2631,15 @@
         return SimplePromptbookLibrary;
     }());
 
+    /**
+     * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
+     *
+     * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
+     * Note: During the construction syntax and logic of all sources are validated
+     *
+     * @param promptbookSources
+     * @returns PromptbookLibrary
+     */
     function createPromptbookLibraryFromSources() {
         var e_1, _a;
         var promptbookSources = [];
@@ -2649,20 +2671,29 @@
         }
         return new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))();
     }
+    /***
+     * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+     */
+
     /**
-     * Constructs Promptbook from any sources
+     * Constructs Promptbook from async sources
+     * It can be one of the following:
+     * - Promise of array of PromptbookJson or PromptbookString
+     * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
      *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+     * Note: This is useful as internal tool for other constructor functions like
+     *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+     *       Consider using those functions instead of this one
+     *
+     * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
+     *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
      *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
+     *
+     * @param promptbookSourcesPromiseOrFactory
      * @returns PromptbookLibrary
+     *
+     * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
      */
-    /***
-     * TODO: !!! Annotate all + all to README and samples
-     */
-
     function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
         var library;
         function forSources() {
@@ -2727,9 +2758,18 @@
         };
     }
     /***
-     * TODO: !!! Annotate all + all to README and samples
+     * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
      */
 
+    /**
+     * Creates PromptbookLibrary as a subset of another PromptbookLibrary
+     *
+     * Note: You can use any type of library as a parent library - local, remote, etc.
+     * Note: This is just a thin wrapper / proxy around the parent library
+     *
+     * @param promptbookSources
+     * @returns PromptbookLibrary
+     */
     function createPromptbookSublibrary(library, predicate) {
         function listPromptbooks() {
             return __awaiter(this, void 0, void 0, function () {
@@ -2754,7 +2794,7 @@
                         case 0:
                             if (!!predicate(url)) return [3 /*break*/, 2];
                             _a = PromptbookNotFoundError.bind;
-                            return [4 /*yield*/, spacetrim.spaceTrim(function (block) { return __awaiter(_this, void 0, void 0, function () {
+                            return [4 /*yield*/, spaceTrim.spaceTrim(function (block) { return __awaiter(_this, void 0, void 0, function () {
                                     var _a, _b, _c, _d, _e, _f;
                                     return __generator(this, function (_g) {
                                         switch (_g.label) {
@@ -2800,7 +2840,7 @@
         };
     }
     /***
-     * TODO: !!! Annotate all + all to README and samples
+     * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
      */
 
     exports.CallbackInterfaceTools = CallbackInterfaceTools;
@@ -2812,6 +2852,7 @@
     exports.createPromptbookLibraryFromPromise = createPromptbookLibraryFromPromise;
     exports.createPromptbookLibraryFromSources = createPromptbookLibraryFromSources;
     exports.createPromptbookSublibrary = createPromptbookSublibrary;
+    exports.promptbookJsonToString = promptbookJsonToString;
     exports.promptbookStringToJson = promptbookStringToJson;
     exports.validatePromptbookJson = validatePromptbookJson;