@promptbook/node 0.82.0 → 0.83.0

package/umd/index.umd.js

@@ -45,7 +45,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.82.0-3';
+    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
@@ -5307,15 +5307,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
@@ -5464,19 +5464,19 @@
     function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var _b, fetch, sourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
+            var _b, fetch, knowledgeSourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
             return __generator(this, function (_f) {
                 switch (_f.label) {
                     case 0:
                         _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
-                        sourceContent = knowledgeSource.sourceContent;
+                        knowledgeSourceContent = knowledgeSource.knowledgeSourceContent;
                         name = knowledgeSource.name;
                         _c = options || {}, _d = _c.rootDirname, rootDirname = _d === void 0 ? null : _d, _c.isVerbose;
                         if (!name) {
-                            name = sourceContentToName(sourceContent);
+                            name = knowledgeSourceContentToName(knowledgeSourceContent);
                         }
-                        if (!isValidUrl(sourceContent)) return [3 /*break*/, 2];
-                        url = sourceContent;
+                        if (!isValidUrl(knowledgeSourceContent)) return [3 /*break*/, 2];
+                        url = knowledgeSourceContent;
                         return [4 /*yield*/, fetch(url)];
                     case 1:
                         response_1 = _f.sent();
@@ -5522,7 +5522,7 @@
                                 },
                             }];
                     case 2:
-                        if (!isValidFilePath(sourceContent)) return [3 /*break*/, 4];
+                        if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 4];
                         if (tools.fs === undefined) {
                             throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
                             //          <- TODO: [🧠] What is the best error type here`
@@ -5531,13 +5531,13 @@
                             throw new EnvironmentMismatchError('Can not import file knowledge in non-file pipeline');
                             //          <- TODO: [🧠] What is the best error type here`
                         }
-                        filename_1 = path.join(rootDirname, sourceContent).split('\\').join('/');
+                        filename_1 = path.join(rootDirname, knowledgeSourceContent).split('\\').join('/');
                         fileExtension = getFileExtension(filename_1);
                         mimeType = extensionToMimeType(fileExtension || '');
                         return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
                     case 3:
                         if (!(_f.sent())) {
-                            throw new NotFoundError(spaceTrim__default["default"](function (block) { return "\n                          Can not make source handler for file which does not exist:\n\n                          File:\n                          ".concat(block(sourceContent), "\n\n                          Full file path:\n                          ").concat(block(filename_1), "\n                      "); }));
+                            throw new NotFoundError(spaceTrim__default["default"](function (block) { return "\n                          Can not make source handler for file which does not exist:\n\n                          File:\n                          ".concat(block(knowledgeSourceContent), "\n\n                          Full file path:\n                          ").concat(block(filename_1), "\n                      "); }));
                         }
                         // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
                         return [2 /*return*/, {
@@ -5588,7 +5588,7 @@
                             url: null,
                             mimeType: 'text/markdown',
                             asText: function () {
-                                return knowledgeSource.sourceContent;
+                                return knowledgeSource.knowledgeSourceContent;
                             },
                             asJson: function () {
                                 throw new UnexpectedError('Did not expect that `markdownScraper` would need to get the content `asJson`');
@@ -5650,7 +5650,7 @@
                                                                 partialPieces = __spreadArray([], __read(partialPiecesUnchecked), false);
                                                                 return [2 /*return*/, "break"];
                                                             }
-                                                            console.warn(spaceTrim__default["default"](function (block) { return "\n                        Cannot scrape knowledge from source despite the scraper `".concat(scraper.metadata.className, "` supports the mime type \"").concat(sourceHandler.mimeType, "\".\n\n                        The source:\n                        ").concat(block(knowledgeSource.sourceContent
+                                                            console.warn(spaceTrim__default["default"](function (block) { return "\n                        Cannot scrape knowledge from source despite the scraper `".concat(scraper.metadata.className, "` supports the mime type \"").concat(sourceHandler.mimeType, "\".\n\n                        The source:\n                        ").concat(block(knowledgeSource.knowledgeSourceContent
                                                                 .split('\n')
                                                                 .map(function (line) { return "> ".concat(line); })
                                                                 .join('\n')), "\n\n                        ").concat(block($registeredScrapersMessage(scrapers)), "\n\n\n                    "); }));
@@ -5688,7 +5688,7 @@
                                             return [7 /*endfinally*/];
                                         case 9:
                                             if (partialPieces === null) {
-                                                throw new KnowledgeScrapeError(spaceTrim__default["default"](function (block) { return "\n                        Cannot scrape knowledge\n\n                        The source:\n                        > ".concat(block(knowledgeSource.sourceContent
+                                                throw new KnowledgeScrapeError(spaceTrim__default["default"](function (block) { return "\n                        Cannot scrape knowledge\n\n                        The source:\n                        > ".concat(block(knowledgeSource.knowledgeSourceContent
                                                     .split('\n')
                                                     .map(function (line) { return "> ".concat(line); })
                                                     .join('\n')), "\n\n                        No scraper found for the mime type \"").concat(sourceHandler.mimeType, "\"\n\n                        ").concat(block($registeredScrapersMessage(scrapers)), "\n\n\n                    "); }));
@@ -5959,7 +5959,7 @@
      * Parses the knowledge command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var knowledgeCommandParser = {
         /**
@@ -5995,23 +5995,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,
             };
         },
         /**
@@ -6020,10 +6022,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,
             });
         },
         /**
@@ -6051,7 +6053,7 @@
      * Parses the section command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var sectionCommandParser = {
         /**
@@ -6182,7 +6184,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;
@@ -6327,7 +6329,7 @@
      * Parses the BOOK_VERSION command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var bookVersionCommandParser = {
         /**
@@ -6482,7 +6484,7 @@
      * Parses the expect command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var expectCommandParser = {
         /**
@@ -6814,7 +6816,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 = {
         /**
@@ -6968,7 +6970,7 @@
      * Parses the format command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var formatCommandParser = {
         /**
@@ -7265,7 +7267,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 = {
         /**
@@ -7354,7 +7356,7 @@
      * Parses the joker command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var jokerCommandParser = {
         /**
@@ -7431,7 +7433,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 = {
         /**
@@ -7575,7 +7578,7 @@
      * Parses the parameter command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var parameterCommandParser = {
         /**
@@ -7680,7 +7683,7 @@
      * Parses the persona command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var personaCommandParser = {
         /**
@@ -7815,7 +7818,7 @@
      * Parses the postprocess command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var postprocessCommandParser = {
         /**
@@ -7893,7 +7896,7 @@
      * Parses the url command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var urlCommandParser = {
         /**
@@ -7994,7 +7997,7 @@
      * Parses the action command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var actionCommandParser = {
         /**
@@ -8060,7 +8063,7 @@
      * Parses the instrument command
      *
      * @see `documentationUrl` for more details
-     * @private within the commands folder
+     * @public exported from `@promptbook/editable`
      */
     var instrumentCommandParser = {
         /**
@@ -8125,7 +8128,7 @@
     /**
      * All available command parsers
      *
-     * @private internal index of `parseCommand`
+     * @public exported from `@promptbook/editable`
      */
     var COMMANDS = [
         sectionCommandParser,
@@ -8156,7 +8159,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; });
@@ -8192,7 +8195,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')) {