@promptbook/remote-client 0.82.0 → 0.84.0-0

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.82.0-3';
+    var PROMPTBOOK_ENGINE_VERSION = '0.83.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1090,15 +1090,15 @@
     /**
      * Creates unique name for the source
      *
-     * @private within the repository
+     * @public exported from `@promptbook/editable`
      */
-    function sourceContentToName(sourceContent) {
-        var hash = cryptoJs.SHA256(hexEncoder__default["default"].parse(JSON.stringify(sourceContent)))
+    function knowledgeSourceContentToName(knowledgeSourceContent) {
+        var hash = cryptoJs.SHA256(hexEncoder__default["default"].parse(JSON.stringify(knowledgeSourceContent)))
             //    <- TODO: [🥬] Encapsulate sha256 to some private utility function
             .toString( /* hex */)
             .substring(0, 20);
         //    <- TODO: [🥬] Make some system for hashes and ids of promptbook
-        var semanticName = normalizeToKebabCase(sourceContent.substring(0, 20));
+        var semanticName = normalizeToKebabCase(knowledgeSourceContent.substring(0, 20));
         var pieces = ['source', semanticName, hash].filter(function (piece) { return piece !== ''; });
         var name = pieces.join('-').split('--').join('-');
         // <- TODO: Use MAX_FILENAME_LENGTH
@@ -1112,7 +1112,7 @@
      * Parses the knowledge command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var knowledgeCommandParser = {
         /**
@@ -1148,23 +1148,25 @@
          */
         parse: function (input) {
             var args = input.args;
-            var sourceContent = spaceTrim__default["default"](args[0] || '');
-            if (sourceContent === '') {
+            var knowledgeSourceContent = spaceTrim__default["default"](args[0] || '');
+            if (knowledgeSourceContent === '') {
                 throw new ParseError("Source is not defined");
             }
             // TODO: [main] !!4 Following checks should be applied every link in the `sourceContent`
-            if (sourceContent.startsWith('http://')) {
+            if (knowledgeSourceContent.startsWith('http://')) {
                 throw new ParseError("Source is not secure");
             }
-            if (!(isValidFilePath(sourceContent) || isValidUrl(sourceContent))) {
+            if (!(isValidFilePath(knowledgeSourceContent) || isValidUrl(knowledgeSourceContent))) {
                 throw new ParseError("Source not valid");
             }
-            if (sourceContent.startsWith('../') || sourceContent.startsWith('/') || /^[A-Z]:[\\/]+/i.test(sourceContent)) {
+            if (knowledgeSourceContent.startsWith('../') ||
+                knowledgeSourceContent.startsWith('/') ||
+                /^[A-Z]:[\\/]+/i.test(knowledgeSourceContent)) {
                 throw new ParseError("Source cannot be outside of the .book.md folder");
             }
             return {
                 type: 'KNOWLEDGE',
-                sourceContent: sourceContent,
+                knowledgeSourceContent: knowledgeSourceContent,
             };
         },
         /**
@@ -1173,10 +1175,10 @@
          * Note: `$` is used to indicate that this function mutates given `pipelineJson`
          */
         $applyToPipelineJson: function (command, $pipelineJson) {
-            var sourceContent = command.sourceContent;
+            var knowledgeSourceContent = command.knowledgeSourceContent;
             $pipelineJson.knowledgeSources.push({
-                name: sourceContentToName(sourceContent),
-                sourceContent: sourceContent,
+                name: knowledgeSourceContentToName(knowledgeSourceContent),
+                knowledgeSourceContent: knowledgeSourceContent,
             });
         },
         /**
@@ -1204,7 +1206,7 @@
      * Parses the section command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var sectionCommandParser = {
         /**
@@ -1335,7 +1337,7 @@
             if (command.taskType === 'KNOWLEDGE') {
                 knowledgeCommandParser.$applyToPipelineJson({
                     type: 'KNOWLEDGE',
-                    sourceContent: $taskJson.content, // <- TODO: [🐝][main] !!3 Work with KNOWLEDGE which not referring to the source file or website, but its content itself
+                    knowledgeSourceContent: $taskJson.content, // <- TODO: [🐝][main] !!3 Work with KNOWLEDGE which not referring to the source file or website, but its content itself
                 }, $pipelineJson);
                 $taskJson.isTask = false;
                 return;
@@ -1522,7 +1524,7 @@
      * Parses the BOOK_VERSION command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var bookVersionCommandParser = {
         /**
@@ -1677,7 +1679,7 @@
      * Parses the expect command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var expectCommandParser = {
         /**
@@ -2618,7 +2620,7 @@
      * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var foreachCommandParser = {
         /**
@@ -2772,7 +2774,7 @@
      * Parses the format command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var formatCommandParser = {
         /**
@@ -3069,7 +3071,7 @@
      * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book.md` file
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var formfactorCommandParser = {
         /**
@@ -3158,7 +3160,7 @@
      * Parses the joker command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var jokerCommandParser = {
         /**
@@ -3235,7 +3237,8 @@
      * Parses the model command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
+     * @public exported from `@promptbook/editable`
      */
     var modelCommandParser = {
         /**
@@ -3379,7 +3382,7 @@
      * Parses the parameter command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var parameterCommandParser = {
         /**
@@ -3484,7 +3487,7 @@
      * Parses the persona command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var personaCommandParser = {
         /**
@@ -3619,7 +3622,7 @@
      * Parses the postprocess command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var postprocessCommandParser = {
         /**
@@ -3777,7 +3780,7 @@
      * Parses the url command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var urlCommandParser = {
         /**
@@ -3878,7 +3881,7 @@
      * Parses the action command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var actionCommandParser = {
         /**
@@ -3944,7 +3947,7 @@
      * Parses the instrument command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var instrumentCommandParser = {
         /**
@@ -4009,7 +4012,7 @@
     /**
      * All available command parsers
      *
-     * @private internal index of `parseCommand`
+     * @public exported from `@promptbook/editable`
      */
     var COMMANDS = [
         sectionCommandParser,
@@ -4040,7 +4043,7 @@
      * @returns the parser for the command
      * @throws {UnexpectedError} if the parser is not found
      *
-     * @private within the compilePipeline
+     * @public exported from `@promptbook/editable`
      */
     function getParserForCommand(command) {
         var commandParser = COMMANDS.find(function (commandParser) { return commandParser.name === command.type; });
@@ -4076,7 +4079,7 @@
      * @returns parsed command object
      * @throws {ParseError} if the command is invalid
      *
-     * @private within the compilePipeline
+     * @public exported from `@promptbook/editable`
      */
     function parseCommand(raw, usagePlace) {
         if (raw.includes('\n') || raw.includes('\r')) {
@@ -4537,6 +4540,55 @@
     var SUPPORTED_SCRIPT_LANGUAGES = ['javascript', 'typescript', 'python'];
     //          <- TODO: [🏥] DRY
 
+    /**
+     * Removes Markdown (or HTML) comments
+     *
+     * @param {string} content - The string to remove comments from.
+     * @returns {string} The input string with all comments removed.
+     * @public exported from `@promptbook/markdown-utils`
+     */
+    function removeMarkdownComments(content) {
+        return spaceTrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
+    }
+
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/editable`
+     */
+    function isFlatPipeline(pipelineString) {
+        pipelineString = removeMarkdownComments(pipelineString);
+        pipelineString = spaceTrim__default["default"](pipelineString);
+        var isMarkdownBeginningWithHeadline = pipelineString.startsWith('# ');
+        var isLastLineReturnStatement = pipelineString.split('\n').pop().split('`').join('').startsWith('->');
+        // TODO: Also (double)check
+        // > const usedCommands
+        // > const isBlocksUsed
+        // > const returnStatementCount
+        var isFlat = !isMarkdownBeginningWithHeadline && isLastLineReturnStatement;
+        return isFlat;
+    }
+
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/editable`
+     */
+    function deflatePipeline(pipelineString) {
+        if (!isFlatPipeline(pipelineString)) {
+            return pipelineString;
+        }
+        var pipelineStringLines = pipelineString.split('\n');
+        var returnStatement = pipelineStringLines.pop();
+        var prompt = spaceTrim__default["default"](pipelineStringLines.join('\n'));
+        pipelineString = validatePipelineString(spaceTrim__default["default"](function (block) { return "\n                # ".concat(DEFAULT_BOOK_TITLE, "\n\n                ## Prompt\n\n                ```\n                ").concat(block(prompt), "\n                ```\n\n                ").concat(returnStatement, "\n            "); }));
+        // <- TODO: Maybe use book` notation
+        return pipelineString;
+    }
+    /**
+     * TODO: Unit test
+     */
+
     /**
      * Utility function to extract all list items from markdown
      *
@@ -4838,17 +4890,6 @@
      *       NOW we are working just with markdown string and its good enough
      */
 
-    /**
-     * Removes Markdown (or HTML) comments
-     *
-     * @param {string} content - The string to remove comments from.
-     * @returns {string} The input string with all comments removed.
-     * @public exported from `@promptbook/markdown-utils`
-     */
-    function removeMarkdownComments(content) {
-        return spaceTrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
-    }
-
     /**
      * @@@
      *
@@ -5106,26 +5147,9 @@
         pipelineString = removeMarkdownComments(pipelineString);
         pipelineString = spaceTrim.spaceTrim(pipelineString);
         // <- TODO: [😧] `spaceTrim` should preserve discriminated type *(or at lease `PipelineString`)*
+        pipelineString = deflatePipeline(pipelineString);
         // ==============
-        // Note: 1️⃣◽2️⃣ Process flat pipeline
-        var isMarkdownBeginningWithHeadline = pipelineString.startsWith('# ');
-        var isLastLineReturnStatement = pipelineString.split('\n').pop().split('`').join('').startsWith('->');
-        // TODO: Also (double)check
-        // > const usedCommands
-        // > const isBlocksUsed
-        // > const returnStatementCount
-        var isFlatPipeline = !isMarkdownBeginningWithHeadline && isLastLineReturnStatement;
-        // console.log({ isMarkdownBeginningWithHeadline, isLastLineReturnStatement, isFlatPipeline });
-        if (isFlatPipeline) {
-            var pipelineStringLines = pipelineString.split('\n');
-            var returnStatement_1 = pipelineStringLines.pop();
-            var prompt_1 = spaceTrim.spaceTrim(pipelineStringLines.join('\n'));
-            pipelineString = validatePipelineString(spaceTrim.spaceTrim(function (block) { return "\n                    # ".concat(DEFAULT_BOOK_TITLE, "\n\n                    ## Prompt\n\n                    ```\n                    ").concat(block(prompt_1), "\n                    ```\n\n                    ").concat(returnStatement_1, "\n                "); }));
-            // <- TODO: Maybe use book` notation
-            // console.log(pipelineString);
-        }
-        // ==============
-        // Note: 1️⃣◽3️⃣ Parse the markdown
+        // Note: 1️⃣◽2️⃣ Parse the markdown
         pipelineString = flattenMarkdown(pipelineString) /* <- Note: [🥞] */;
         pipelineString = pipelineString.replaceAll(/`\{(?<parameterName>[a-z0-9_]+)\}`/gi, '{$<parameterName>}');
         pipelineString = pipelineString.replaceAll(/`->\s+\{(?<parameterName>[a-z0-9_]+)\}`/gi, '-> {$<parameterName>}');