@promptbook/editable 0.83.0 → 0.84.0-0

package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts

@@ -0,0 +1,7 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function isFlatPipeline(pipelineString: PipelineString): boolean;

package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts

@@ -24,3 +24,6 @@ type RenameParameterOptions = {
  */
 export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};
+/**
+ * TODO: Also variant for `edit-pipeline-string`
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.83.0",
+    "version": "0.84.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.83.0"
+        "@promptbook/core": "0.84.0-0"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.82.0';
+    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
@@ -188,6 +188,12 @@
      * @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
@@ -3868,6 +3874,145 @@
         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.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
+    }
+
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/editable`
+     */
+    function isFlatPipeline(pipelineString) {
+        pipelineString = removeMarkdownComments(pipelineString);
+        pipelineString = spaceTrim__default["default"](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__default["default"](pipelineStringLines.join('\n'));
+        pipelineString = validatePipelineString(spaceTrim__default["default"](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__default["default"](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
      *
@@ -3875,8 +4020,8 @@
      */
     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 = [];
@@ -3992,6 +4137,9 @@
         }
         return renamedPipeline;
     }
+    /**
+     * TODO: Also variant for `edit-pipeline-string`
+     */
 
     // <- TODO: Auto convert to type `import { ... } from 'type-fest';`
     /**
@@ -4058,13 +4206,16 @@
     exports.COMMANDS = COMMANDS;
     exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
     exports.actionCommandParser = actionCommandParser;
+    exports.addPipelineCommand = addPipelineCommand;
     exports.bookVersionCommandParser = bookVersionCommandParser;
+    exports.deflatePipeline = deflatePipeline;
     exports.expectCommandParser = expectCommandParser;
     exports.foreachCommandParser = foreachCommandParser;
     exports.formatCommandParser = formatCommandParser;
     exports.formfactorCommandParser = formfactorCommandParser;
     exports.getParserForCommand = getParserForCommand;
     exports.instrumentCommandParser = instrumentCommandParser;
+    exports.isFlatPipeline = isFlatPipeline;
     exports.jokerCommandParser = jokerCommandParser;
     exports.knowledgeCommandParser = knowledgeCommandParser;
     exports.knowledgeSourceContentToName = knowledgeSourceContentToName;