@promptbook/remote-client 0.82.0 → 0.84.0-0

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/remote-client`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

package/esm/index.es.js

@@ -19,7 +19,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @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
@@ -1086,15 +1086,15 @@ function normalizeToKebabCase(text) {
 /**
  * Creates unique name for the source
  *
- * @private within the repository
+ * @public exported from `@promptbook/editable`
  */
-function sourceContentToName(sourceContent) {
-    var hash = SHA256(hexEncoder.parse(JSON.stringify(sourceContent)))
+function knowledgeSourceContentToName(knowledgeSourceContent) {
+    var hash = SHA256(hexEncoder.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
@@ -1108,7 +1108,7 @@ function sourceContentToName(sourceContent) {
  * Parses the knowledge command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var knowledgeCommandParser = {
     /**
@@ -1144,23 +1144,25 @@ var knowledgeCommandParser = {
      */
     parse: function (input) {
         var args = input.args;
-        var sourceContent = spaceTrim$1(args[0] || '');
-        if (sourceContent === '') {
+        var knowledgeSourceContent = spaceTrim$1(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,
         };
     },
     /**
@@ -1169,10 +1171,10 @@ var knowledgeCommandParser = {
      * 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,
         });
     },
     /**
@@ -1200,7 +1202,7 @@ var knowledgeCommandParser = {
  * Parses the section command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var sectionCommandParser = {
     /**
@@ -1331,7 +1333,7 @@ var sectionCommandParser = {
         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;
@@ -1518,7 +1520,7 @@ function isValidPromptbookVersion(version) {
  * Parses the BOOK_VERSION command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var bookVersionCommandParser = {
     /**
@@ -1673,7 +1675,7 @@ function parseNumber(value) {
  * Parses the expect command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var expectCommandParser = {
     /**
@@ -2614,7 +2616,7 @@ function validateParameterName(parameterName) {
  * 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 = {
     /**
@@ -2768,7 +2770,7 @@ var foreachCommandParser = {
  * Parses the format command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var formatCommandParser = {
     /**
@@ -3065,7 +3067,7 @@ var FORMFACTOR_DEFINITIONS = [
  * 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 = {
     /**
@@ -3154,7 +3156,7 @@ var formfactorCommandParser = {
  * Parses the joker command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var jokerCommandParser = {
     /**
@@ -3231,7 +3233,8 @@ var MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'EMBEDDING' /* <- TODO [🏳] */ /*
  * 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 = {
     /**
@@ -3375,7 +3378,7 @@ var modelCommandParser = {
  * Parses the parameter command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var parameterCommandParser = {
     /**
@@ -3480,7 +3483,7 @@ var parameterCommandParser = {
  * Parses the persona command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var personaCommandParser = {
     /**
@@ -3615,7 +3618,7 @@ function isValidJavascriptName(javascriptName) {
  * Parses the postprocess command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var postprocessCommandParser = {
     /**
@@ -3773,7 +3776,7 @@ function isValidPipelineUrl(url) {
  * Parses the url command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var urlCommandParser = {
     /**
@@ -3874,7 +3877,7 @@ var urlCommandParser = {
  * Parses the action command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var actionCommandParser = {
     /**
@@ -3940,7 +3943,7 @@ var actionCommandParser = {
  * Parses the instrument command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var instrumentCommandParser = {
     /**
@@ -4005,7 +4008,7 @@ var instrumentCommandParser = {
 /**
  * All available command parsers
  *
- * @private internal index of `parseCommand`
+ * @public exported from `@promptbook/editable`
  */
 var COMMANDS = [
     sectionCommandParser,
@@ -4036,7 +4039,7 @@ var COMMANDS = [
  * @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; });
@@ -4072,7 +4075,7 @@ function removeMarkdownFormatting(str) {
  * @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')) {
@@ -4533,6 +4536,55 @@ function validatePipelineString(pipelineString) {
 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(content.replace(/<!--(.*?)-->/gs, ''));
+}
+
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+function isFlatPipeline(pipelineString) {
+    pipelineString = removeMarkdownComments(pipelineString);
+    pipelineString = spaceTrim$1(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$1(pipelineStringLines.join('\n'));
+    pipelineString = validatePipelineString(spaceTrim$1(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
  *
@@ -4834,17 +4886,6 @@ function flattenMarkdown(markdown) {
  *       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(content.replace(/<!--(.*?)-->/gs, ''));
-}
-
 /**
  * @@@
  *
@@ -5102,26 +5143,9 @@ function parsePipeline(pipelineString) {
     pipelineString = removeMarkdownComments(pipelineString);
     pipelineString = 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(pipelineStringLines.join('\n'));
-        pipelineString = validatePipelineString(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>}');