@promptbook/core 0.82.0-3 → 0.83.0

package/README.md

@@ -23,10 +23,6 @@
 
 
 
-<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/core`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

package/esm/index.es.js

@@ -25,7 +25,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @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
@@ -5642,15 +5642,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
@@ -5799,19 +5799,19 @@ var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void
 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();
@@ -5857,7 +5857,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                             },
                         }];
                 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`
@@ -5866,13 +5866,13 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                         throw new EnvironmentMismatchError('Can not import file knowledge in non-file pipeline');
                         //          <- TODO: [🧠] What is the best error type here`
                     }
-                    filename_1 = join(rootDirname, sourceContent).split('\\').join('/');
+                    filename_1 = 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(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(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*/, {
@@ -5923,7 +5923,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                         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`');
@@ -5985,7 +5985,7 @@ function prepareKnowledgePieces(knowledgeSources, tools, options) {
                                                             partialPieces = __spreadArray([], __read(partialPiecesUnchecked), false);
                                                             return [2 /*return*/, "break"];
                                                         }
-                                                        console.warn(spaceTrim(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(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                    "); }));
@@ -6023,7 +6023,7 @@ function prepareKnowledgePieces(knowledgeSources, tools, options) {
                                         return [7 /*endfinally*/];
                                     case 9:
                                         if (partialPieces === null) {
-                                            throw new KnowledgeScrapeError(spaceTrim(function (block) { return "\n                        Cannot scrape knowledge\n\n                        The source:\n                        > ".concat(block(knowledgeSource.sourceContent
+                                            throw new KnowledgeScrapeError(spaceTrim(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                    "); }));
@@ -6294,7 +6294,7 @@ var SectionTypes = __spreadArray(__spreadArray([], __read(TaskTypes.map(function
  * Parses the knowledge command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var knowledgeCommandParser = {
     /**
@@ -6330,23 +6330,25 @@ var knowledgeCommandParser = {
      */
     parse: function (input) {
         var args = input.args;
-        var sourceContent = spaceTrim(args[0] || '');
-        if (sourceContent === '') {
+        var knowledgeSourceContent = spaceTrim(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,
         };
     },
     /**
@@ -6355,10 +6357,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,
         });
     },
     /**
@@ -6386,7 +6388,7 @@ var knowledgeCommandParser = {
  * Parses the section command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var sectionCommandParser = {
     /**
@@ -6517,7 +6519,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;
@@ -6662,7 +6664,7 @@ var boilerplateCommandParser = {
  * Parses the BOOK_VERSION command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var bookVersionCommandParser = {
     /**
@@ -6817,7 +6819,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 = {
     /**
@@ -7149,7 +7151,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 = {
     /**
@@ -7303,7 +7305,7 @@ var foreachCommandParser = {
  * Parses the format command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var formatCommandParser = {
     /**
@@ -7600,7 +7602,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 = {
     /**
@@ -7689,7 +7691,7 @@ var formfactorCommandParser = {
  * Parses the joker command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var jokerCommandParser = {
     /**
@@ -7766,7 +7768,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 = {
     /**
@@ -7910,7 +7913,7 @@ var modelCommandParser = {
  * Parses the parameter command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var parameterCommandParser = {
     /**
@@ -8015,7 +8018,7 @@ var parameterCommandParser = {
  * Parses the persona command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var personaCommandParser = {
     /**
@@ -8150,7 +8153,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 = {
     /**
@@ -8228,7 +8231,7 @@ var postprocessCommandParser = {
  * Parses the url command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var urlCommandParser = {
     /**
@@ -8329,7 +8332,7 @@ var urlCommandParser = {
  * Parses the action command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var actionCommandParser = {
     /**
@@ -8395,7 +8398,7 @@ var actionCommandParser = {
  * Parses the instrument command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 var instrumentCommandParser = {
     /**
@@ -8460,7 +8463,7 @@ var instrumentCommandParser = {
 /**
  * All available command parsers
  *
- * @private internal index of `parseCommand`
+ * @public exported from `@promptbook/editable`
  */
 var COMMANDS = [
     sectionCommandParser,
@@ -8491,7 +8494,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; });
@@ -8527,7 +8530,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')) {