@promptbook/remote-client 0.82.0-3 → 0.83.0

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.82.0-2';
+    var PROMPTBOOK_ENGINE_VERSION = '0.82.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
@@ -622,8 +622,7 @@
             var socket, preparedPipeline;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0:
-                        return [4 /*yield*/, createRemoteClient(options)];
+                    case 0: return [4 /*yield*/, createRemoteClient(options)];
                     case 1:
                         socket = _a.sent();
                         socket.emit('preparePipeline-request', {
@@ -643,7 +642,7 @@
                     case 2:
                         preparedPipeline = _a.sent();
                         socket.disconnect();
-                        // TODO: !!!!!!  do $exportJson
+                        // TODO: [🧠] Maybe do $exportJson
                         return [2 /*return*/, preparedPipeline];
                 }
             });
@@ -1091,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
@@ -1113,7 +1112,7 @@
      * Parses the knowledge command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var knowledgeCommandParser = {
         /**
@@ -1149,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,
             };
         },
         /**
@@ -1174,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,
             });
         },
         /**
@@ -1205,7 +1206,7 @@
      * Parses the section command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var sectionCommandParser = {
         /**
@@ -1336,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;
@@ -1523,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 = {
         /**
@@ -1678,7 +1679,7 @@
      * Parses the expect command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var expectCommandParser = {
         /**
@@ -2619,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 = {
         /**
@@ -2773,7 +2774,7 @@
      * Parses the format command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var formatCommandParser = {
         /**
@@ -3070,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 = {
         /**
@@ -3159,7 +3160,7 @@
      * Parses the joker command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var jokerCommandParser = {
         /**
@@ -3236,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 = {
         /**
@@ -3380,7 +3382,7 @@
      * Parses the parameter command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var parameterCommandParser = {
         /**
@@ -3485,7 +3487,7 @@
      * Parses the persona command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var personaCommandParser = {
         /**
@@ -3620,7 +3622,7 @@
      * Parses the postprocess command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var postprocessCommandParser = {
         /**
@@ -3778,7 +3780,7 @@
      * Parses the url command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var urlCommandParser = {
         /**
@@ -3879,7 +3881,7 @@
      * Parses the action command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var actionCommandParser = {
         /**
@@ -3945,7 +3947,7 @@
      * Parses the instrument command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var instrumentCommandParser = {
         /**
@@ -4010,7 +4012,7 @@
     /**
      * All available command parsers
      *
-     * @private internal index of `parseCommand`
+     * @public exported from `@promptbook/editable`
      */
     var COMMANDS = [
         sectionCommandParser,
@@ -4041,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; });
@@ -4077,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')) {