@promptbook/core 0.48.0 → 0.49.0

package/umd/index.umd.js

@@ -1,12 +1,13 @@
 (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, global.prettier, global.parserHtml));
+})(this, (function (exports, spaceTrim, prettier, parserHtml) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
+    var parserHtml__default = /*#__PURE__*/_interopDefaultLegacy(parserHtml);
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -445,7 +446,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.48.0-1';
+    var PROMPTBOOK_VERSION = '0.48.1-0';
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -495,6 +496,38 @@
         return variables;
     }
 
+    /**
+     * Prettify the html code
+     *
+     * @param content raw html code
+     * @returns formatted html code
+     */
+    function prettifyMarkdown(content) {
+        try {
+            return prettier.format(content, {
+                parser: 'markdown',
+                plugins: [parserHtml__default["default"]],
+                // TODO: DRY - make some import or auto-copy of .prettierrc
+                endOfLine: 'lf',
+                tabWidth: 4,
+                singleQuote: true,
+                trailingComma: 'all',
+                arrowParens: 'always',
+                printWidth: 120,
+                htmlWhitespaceSensitivity: 'ignore',
+                jsxBracketSameLine: false,
+                bracketSpacing: true,
+            });
+        }
+        catch (error) {
+            console.error('There was an error with prettifying the markdown, using the original as the fallback', {
+                error: error,
+                html: content,
+            });
+            return content;
+        }
+    }
+
     /**
      * Removes emojis from a string and fix whitespaces
      *
@@ -587,6 +620,20 @@
      * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
      */
 
+    /**
+     * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+     */
+    var PromptbookLogicError = /** @class */ (function (_super) {
+        __extends(PromptbookLogicError, _super);
+        function PromptbookLogicError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookLogicError';
+            Object.setPrototypeOf(_this, PromptbookLogicError.prototype);
+            return _this;
+        }
+        return PromptbookLogicError;
+    }(Error));
+
     /**
      * This error indicates errors during the execution of the promptbook
      */
@@ -1755,28 +1802,191 @@
      * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
      */
 
+    /**
+     * Converts promptbook in JSON format to string format
+     *
+     * @param promptbookJson Promptbook in JSON format (.ptbk.json)
+     * @returns Promptbook in string format (.ptbk.md)
+     */
     function promptbookJsonToString(promptbookJson) {
-        return spaceTrim__default["default"](function (block) { return "\n\n            # ".concat(block(promptbookJson.title), "\n\n        "); });
+        var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e;
+        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) {
+            promptbookString += '\n\n';
+            promptbookString += description;
+        }
+        // TODO:> const commands: Array<Command>
+        var commands = [];
+        if (promptbookUrl) {
+            commands.push("PROMPTBOOK URL ".concat(promptbookUrl));
+        }
+        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)));
+                }
+            }
+        }
+        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);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        promptbookString += '\n\n';
+        promptbookString += commands.map(function (command) { return "- ".concat(command); }).join('\n');
+        try {
+            for (var promptTemplates_1 = __values(promptTemplates), promptTemplates_1_1 = promptTemplates_1.next(); !promptTemplates_1_1.done; promptTemplates_1_1 = promptTemplates_1.next()) {
+                var promptTemplate = promptTemplates_1_1.value;
+                var 
+                /* Note: Not using:> name, */
+                title_1 = promptTemplate.title, description_1 = promptTemplate.description, 
+                /* Note: dependentParameterNames, */
+                jokers = promptTemplate.jokers, executionType = promptTemplate.executionType, content = promptTemplate.content, postprocessing = promptTemplate.postprocessing, expectations = promptTemplate.expectations, expectFormat = promptTemplate.expectFormat, resultingParameterName = promptTemplate.resultingParameterName;
+                promptbookString += '\n\n';
+                promptbookString += "## ".concat(title_1);
+                if (description_1) {
+                    promptbookString += '\n\n';
+                    promptbookString += description_1;
+                }
+                // TODO:> const commands: Array<Command>
+                var commands_1 = [];
+                var contentLanguage = 'text';
+                if (executionType === 'PROMPT_TEMPLATE') {
+                    var modelRequirements = promptTemplate.modelRequirements;
+                    var modelName = modelRequirements.modelName, modelVariant = modelRequirements.modelVariant;
+                    commands_1.push("EXECUTE PROMPT TEMPLATE");
+                    if (modelVariant) {
+                        commands_1.push("MODEL VARIANT ".concat(capitalize(modelVariant)));
+                    }
+                    if (modelName) {
+                        commands_1.push("MODEL NAME `".concat(modelName, "`"));
+                    }
+                }
+                else if (executionType === 'SIMPLE_TEMPLATE') {
+                    commands_1.push("SIMPLE TEMPLATE");
+                    // Note: Nothing special here
+                }
+                else if (executionType === 'SCRIPT') {
+                    commands_1.push("EXECUTE SCRIPT");
+                    if (promptTemplate.contentLanguage) {
+                        contentLanguage = promptTemplate.contentLanguage;
+                    }
+                    else {
+                        contentLanguage = '';
+                    }
+                }
+                else if (executionType === 'PROMPT_DIALOG') {
+                    commands_1.push("PROMPT DIALOG");
+                    // Note: Nothing special here
+                }
+                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()) {
+                            var joker = jokers_1_1.value;
+                            commands_1.push("JOKER {".concat(joker, "}"));
+                        }
+                    }
+                    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                    finally {
+                        try {
+                            if (jokers_1_1 && !jokers_1_1.done && (_c = jokers_1.return)) _c.call(jokers_1);
+                        }
+                        finally { if (e_3) throw e_3.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()) {
+                            var postprocessingFunctionName = postprocessing_1_1.value;
+                            commands_1.push("POSTPROCESSING `".concat(postprocessingFunctionName, "`"));
+                        }
+                    }
+                    catch (e_4_1) { e_4 = { error: e_4_1 }; }
+                    finally {
+                        try {
+                            if (postprocessing_1_1 && !postprocessing_1_1.done && (_d = postprocessing_1.return)) _d.call(postprocessing_1);
+                        }
+                        finally { if (e_4) throw e_4.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;
+                            if (min === max) {
+                                commands_1.push("EXPECT EXACTLY ".concat(min, " ").concat(capitalize(unit + (min > 1 ? 's' : ''))));
+                            }
+                            else {
+                                if (min !== undefined) {
+                                    commands_1.push("EXPECT MIN ".concat(min, " ").concat(capitalize(unit + (min > 1 ? 's' : ''))));
+                                } /* not else */
+                                if (max !== undefined) {
+                                    commands_1.push("EXPECT MAX ".concat(max, " ").concat(capitalize(unit + (max > 1 ? 's' : ''))));
+                                }
+                            }
+                        }
+                    }
+                    catch (e_5_1) { e_5 = { error: e_5_1 }; }
+                    finally {
+                        try {
+                            if (_g && !_g.done && (_e = _f.return)) _e.call(_f);
+                        }
+                        finally { if (e_5) throw e_5.error; }
+                    }
+                } /* not else */
+                if (expectFormat) {
+                    if (expectFormat === 'JSON') {
+                        // TODO: @deprecated remove
+                        commands_1.push("EXPECT JSON");
+                    }
+                } /* not else */
+                promptbookString += '\n\n';
+                promptbookString += commands_1.map(function (command) { return "- ".concat(command); }).join('\n');
+                promptbookString += '\n\n';
+                promptbookString += '```' + contentLanguage;
+                promptbookString += '\n';
+                promptbookString += spaceTrim__default["default"](content);
+                //                   <- TODO: !!! Escape
+                //                   <- TODO: [🧠] Some clear strategy how to spaceTrim the blocks
+                promptbookString += '\n';
+                promptbookString += '```';
+                promptbookString += '\n\n';
+                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 }; }
+        finally {
+            try {
+                if (promptTemplates_1_1 && !promptTemplates_1_1.done && (_b = promptTemplates_1.return)) _b.call(promptTemplates_1);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+        return promptbookString;
     }
     /**
-     * TODO: !!!!! Implement
-     * TODO: !!!!! Annotate and warn
-     * TODO: !!!!! Test + test together with promptbookStringToJson
+     * @private internal util of promptbookJsonToString
      */
-
+    function promptTemplateParameterJsonToString(promptTemplateParameterJson) {
+        var name = promptTemplateParameterJson.name, description = promptTemplateParameterJson.description;
+        var parameterString = "{".concat(name, "}");
+        if (description) {
+            parameterString = "".concat(parameterString, " ").concat(description);
+        }
+        return parameterString;
+    }
     /**
-     * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+     * TODO: Escape all
      */
-    var PromptbookLogicError = /** @class */ (function (_super) {
-        __extends(PromptbookLogicError, _super);
-        function PromptbookLogicError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookLogicError';
-            Object.setPrototypeOf(_this, PromptbookLogicError.prototype);
-            return _this;
-        }
-        return PromptbookLogicError;
-    }(Error));
 
     /**
      * Tests if given string is valid URL.
@@ -1804,7 +2014,7 @@
     }
 
     /**
-     * Validates PromptbookJson if it is logically valid.
+     * Validates PromptbookJson if it is logically valid
      *
      * It checks:
      * -   if it has correct parameters dependency
@@ -1814,6 +2024,7 @@
      * -   if it is meaningful
      *
      * @param promptbook valid or invalid PromptbookJson
+     * @returns the same promptbook if it is logically valid
      * @throws {PromptbookLogicError} on logical error in the promptbook
      */
     function validatePromptbookJson(promptbook) {
@@ -1965,6 +2176,7 @@
         while (unresovedTemplates.length > 0) {
             _loop_2();
         }
+        return promptbook;
     }
     /**
      * TODO: [🧠] Work with promptbookVersion