@promptbook/editable 0.83.0 → 0.84.0-10

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/editable`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -267,6 +271,7 @@ Or you can install them separately:
 -   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
 -   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
 -   **[@promptbook/pdf](https://www.npmjs.com/package/@promptbook/pdf)** - Read knowledge from `.pdf` documents
+-   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/markitdown)** - Integration of [Markitdown by Microsoft](https://github.com/microsoft/markitdown)
 -   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
 -   **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
 -   **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web

package/esm/index.es.js

@@ -17,7 +17,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.82.0';
+var PROMPTBOOK_ENGINE_VERSION = '0.84.0-9';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -175,13 +175,19 @@ var NAME = "Promptbook";
  *
  * @public exported from `@promptbook/core`
  */
-var ADMIN_EMAIL = 'me@pavolhejny.com';
+var ADMIN_EMAIL = 'pavol@ptbk.io';
 /**
  * Name of the responsible person for the Promptbook on GitHub
  *
  * @public exported from `@promptbook/core`
  */
 var ADMIN_GITHUB_NAME = 'hejny';
+/**
+ * When the title is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
 // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
 /**
  * The maximum number of iterations for a loops
@@ -360,7 +366,7 @@ var boilerplateCommandParser = {
 var NotYetImplementedError = /** @class */ (function (_super) {
     __extends(NotYetImplementedError, _super);
     function NotYetImplementedError(message) {
-        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on pavol@ptbk.io\n\n                "); })) || this;
         _this.name = 'NotYetImplementedError';
         Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
         return _this;
@@ -1320,7 +1326,7 @@ function exportJson(options) {
  *
  * @private within the repository
  */
-var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+var REPLACING_NONCE = 'ptbkauk42kV2dzao34faw7FudQUHYPtW';
 /**
  * The names of the parameters that are reserved for special purposes
  *
@@ -3862,6 +3868,145 @@ function parseCommandVariant(input) {
     return null;
 }
 
+/**
+ * Function `validatePipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {PipelineString} the same string as input, but validated as valid
+ * @throws {ParseError} if the string is not a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+function validatePipelineString(pipelineString) {
+    if (isValidJsonString(pipelineString)) {
+        throw new ParseError('Expected a book, but got a JSON string');
+    }
+    // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
+    return pipelineString;
+}
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */
+
+/**
+ * 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$1(content.replace(/<!--(.*?)-->/gs, ''));
+}
+
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+function isFlatPipeline(pipelineString) {
+    pipelineString = removeMarkdownComments(pipelineString);
+    pipelineString = spaceTrim(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(pipelineStringLines.join('\n'));
+    pipelineString = validatePipelineString(spaceTrim(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
+ */
+
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+function addPipelineCommand(options) {
+    var e_1, _a;
+    var commandString = options.commandString, pipelineString = options.pipelineString;
+    var deflatedPipelineString = deflatePipeline(pipelineString);
+    var lines = deflatedPipelineString.split('\n');
+    var newLines = [];
+    var isCommandAdded = false;
+    try {
+        for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
+            var line = lines_1_1.value;
+            // Add command before second (or more) heading
+            if (!isCommandAdded && line.startsWith('##')) {
+                newLines.push("-   ".concat(commandString));
+                newLines.push('');
+                isCommandAdded = true;
+            }
+            newLines.push(line);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    if (!isCommandAdded) {
+        // Note: Only situation when this should happen is when pipeline has no tasks
+        if ((newLines[newLines.length - 1] || '').startsWith('#')) {
+            newLines.push('');
+        }
+        newLines.push("-   ".concat(commandString));
+        /*
+        TODO: [🧠] Is this error relevant:
+        throw new UnexpectedError(
+            spaceTrim(
+                (block) => `
+                    Can not add command to pipeline because there is no second heading in the pipeline
+
+                    This should never happen because pipeline is deflated before adding command
+
+                    The command to add:
+                    ${block(commandString)}
+
+                    ---
+                    The original pipeline:
+                    ${block(pipelineString)}
+
+                    ---
+                    Deflated pipeline:
+                    ${block(deflatedPipelineString)}
+
+                    ---
+                `,
+            ),
+        );
+        */
+    }
+    return spaceTrim(newLines.join('\n'));
+}
+/**
+ * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
+ * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
+ */
+
 /**
  * Function `removePipelineCommand` will remove one command from pipeline string
  *
@@ -3869,8 +4014,8 @@ function parseCommandVariant(input) {
  */
 function removePipelineCommand(options) {
     var e_1, _a;
-    var command = options.command, pipeline = options.pipeline;
-    var lines = pipeline.split('\n');
+    var command = options.command, pipelineString = options.pipelineString;
+    var lines = pipelineString.split('\n');
     // TODO: [🧽] DRY
     var currentType = 'MARKDOWN';
     var newLines = [];
@@ -3986,6 +4131,9 @@ function renamePipelineParameter(options) {
     }
     return renamedPipeline;
 }
+/**
+ * TODO: Also variant for `edit-pipeline-string`
+ */
 
 // <- TODO: Auto convert to type `import { ... } from 'type-fest';`
 /**
@@ -4048,5 +4196,5 @@ function stringifyPipelineJson(pipeline) {
  * TODO: [🍙] Make some standard order of json properties
  */
 
-export { BOOK_LANGUAGE_VERSION, COMMANDS, PROMPTBOOK_ENGINE_VERSION, actionCommandParser, bookVersionCommandParser, expectCommandParser, foreachCommandParser, formatCommandParser, formfactorCommandParser, getParserForCommand, instrumentCommandParser, jokerCommandParser, knowledgeCommandParser, knowledgeSourceContentToName, modelCommandParser, parameterCommandParser, parseCommand, personaCommandParser, postprocessCommandParser, removePipelineCommand, renamePipelineParameter, sectionCommandParser, stringifyPipelineJson, urlCommandParser };
+export { BOOK_LANGUAGE_VERSION, COMMANDS, PROMPTBOOK_ENGINE_VERSION, actionCommandParser, addPipelineCommand, bookVersionCommandParser, deflatePipeline, expectCommandParser, foreachCommandParser, formatCommandParser, formfactorCommandParser, getParserForCommand, instrumentCommandParser, isFlatPipeline, jokerCommandParser, knowledgeCommandParser, knowledgeSourceContentToName, modelCommandParser, parameterCommandParser, parseCommand, personaCommandParser, postprocessCommandParser, removePipelineCommand, renamePipelineParameter, sectionCommandParser, stringifyPipelineJson, urlCommandParser };
 //# sourceMappingURL=index.es.js.map