@promptbook/cli 0.86.0-13 → 0.86.0-15

package/esm/index.es.js

@@ -8,6 +8,7 @@ import hexEncoder from 'crypto-js/enc-hex';
 import sha256 from 'crypto-js/sha256';
 import * as dotenv from 'dotenv';
 import { spawn } from 'child_process';
+import JSZip from 'jszip';
 import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
 import { BehaviorSubject } from 'rxjs';
@@ -43,7 +44,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.86.0-13';
+var PROMPTBOOK_ENGINE_VERSION = '0.86.0-15';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -549,6 +550,7 @@ function $initializeHelloCommand(program) {
     var _this = this;
     var helloCommand = program.command('hello');
     helloCommand.description(spaceTrim("\n            Just command for testing\n        "));
+    helloCommand.alias('hi');
     helloCommand.argument('[name]', 'Your name', 'Paul');
     helloCommand.option('-g, --greeting <greeting>', "Greeting", 'Hello');
     helloCommand.action(function (name, _a) {
@@ -2922,6 +2924,8 @@ function $initializeListModelsCommand(program) {
     var _this = this;
     var listModelsCommand = program.command('list-models');
     listModelsCommand.description(spaceTrim("\n            List all available and configured LLM models\n        "));
+    listModelsCommand.alias('models');
+    listModelsCommand.alias('llm');
     listModelsCommand.action(function () { return __awaiter(_this, void 0, void 0, function () {
         var llm;
         return __generator(this, function (_a) {
@@ -3607,6 +3611,7 @@ function $initializeListScrapersCommand(program) {
     var _this = this;
     var listModelsCommand = program.command('list-scrapers');
     listModelsCommand.description(spaceTrim("\n            List all available and configured scrapers and executables\n        "));
+    listModelsCommand.alias('scrapers');
     listModelsCommand.action(function () { return __awaiter(_this, void 0, void 0, function () {
         var scrapers, executables;
         return __generator(this, function (_a) {
@@ -3798,7 +3803,7 @@ function capitalize(word) {
  * Converts promptbook in JSON format to string format
  *
  * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
- * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @param pipelineJson Promptbook in JSON format (.bookc)
  * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`
  */
@@ -10744,7 +10749,7 @@ function flattenMarkdown(markdown) {
  * Note: This function acts as compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
- * @returns {Promptbook} compiled in JSON format (.book.json)
+ * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
@@ -11212,7 +11217,7 @@ function parsePipeline(pipelineString) {
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.book.json)
+ * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
@@ -12006,7 +12011,7 @@ function createCollectionFromDirectory(rootPath, tools, options) {
                     }
                     madeLibraryFilePath = join(rootPath, "".concat(DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME
                     // <- TODO: [🦒] Allow to override (pass different value into the function)
-                    , ".json"));
+                    , ".bookc"));
                     return [4 /*yield*/, isFileExisting(madeLibraryFilePath, tools.fs)];
                 case 3:
                     if (!(_f.sent())) ;
@@ -12028,13 +12033,13 @@ function createCollectionFromDirectory(rootPath, tools, options) {
                                     return [4 /*yield*/, listAllFiles(rootPath, isRecursive, tools.fs)];
                                 case 1:
                                     fileNames = _b.sent();
-                                    // Note: First load all `.book.json` and then `.book` / `.book` files
-                                    //       `.book.json` can be prepared so it is faster to load
+                                    // Note: First load compiled `.bookc` files and then source `.book` files
+                                    //       `.bookc` are already compiled and can be used faster
                                     fileNames.sort(function (a, b) {
-                                        if (a.endsWith('.json') && (b.endsWith('.book') || b.endsWith('.book'))) {
+                                        if ((a.endsWith('.bookc') || a.endsWith('.book.json')) && (b.endsWith('.book') || b.endsWith('.book.md'))) {
                                             return -1;
                                         }
-                                        if ((a.endsWith('.book') || a.endsWith('.book')) && b.endsWith('.json')) {
+                                        if ((a.endsWith('.book') || a.endsWith('.book.md')) && (b.endsWith('.bookc') || b.endsWith('.book.json'))) {
                                             return 1;
                                         }
                                         return 0;
@@ -12051,7 +12056,7 @@ function createCollectionFromDirectory(rootPath, tools, options) {
                                                 case 1:
                                                     _f.trys.push([1, 8, , 9]);
                                                     pipeline = null;
-                                                    if (!(fileName.endsWith('.book') || fileName.endsWith('.book'))) return [3 /*break*/, 4];
+                                                    if (!(fileName.endsWith('.book') || fileName.endsWith('.book.md'))) return [3 /*break*/, 4];
                                                     _c = validatePipelineString;
                                                     return [4 /*yield*/, readFile(fileName, 'utf-8')];
                                                 case 2:
@@ -12064,7 +12069,7 @@ function createCollectionFromDirectory(rootPath, tools, options) {
                                                     pipeline = __assign(__assign({}, pipeline), { sourceFile: sourceFile });
                                                     return [3 /*break*/, 7];
                                                 case 4:
-                                                    if (!fileName.endsWith('.book.json')) return [3 /*break*/, 6];
+                                                    if (!(fileName.endsWith('.bookc') || fileName.endsWith('.book.json'))) return [3 /*break*/, 6];
                                                     _e = (_d = JSON).parse;
                                                     return [4 /*yield*/, readFile(fileName, 'utf-8')];
                                                 case 5:
@@ -12269,13 +12274,16 @@ function $initializeMakeCommand(program) {
     var _this = this;
     var makeCommand = program.command('make');
     makeCommand.description(spaceTrim("\n            Makes a new pipeline collection in given folder\n        "));
+    makeCommand.alias('compile');
+    makeCommand.alias('prepare');
+    makeCommand.alias('build');
     // TODO: [🧅] DRY command arguments
     makeCommand.argument('[path]', 
     // <- TODO: [🧟‍♂️] Unite path to promptbook collection argument
     'Path to promptbook collection directory', DEFAULT_BOOKS_DIRNAME);
     makeCommand.option('--project-name', "Name of the project for whom collection is", 'Untitled Promptbook project');
     makeCommand.option('--root-url <url>', "Root URL of all pipelines to make", undefined);
-    makeCommand.option('-f, --format <format>', spaceTrim("\n            Output format of builded collection \"javascript\", \"typescript\" or \"json\"\n\n            Note: You can use multiple formats separated by comma\n        "), 'javascript' /* <- Note: [🏳‍🌈] */);
+    makeCommand.option('-f, --format <format>', spaceTrim("\n            Output format of builded collection \"bookc\", \"javascript\", \"typescript\" or \"json\"\n\n            Note: You can use multiple formats separated by comma\n        "), 'bookc' /* <- Note: [🏳‍🌈] */);
     makeCommand.option('--no-validation', "Do not validate logic of pipelines in collection", true);
     makeCommand.option('--validation', "Types of validations separated by comma (options \"logic\",\"imports\")", 'logic,imports');
     makeCommand.option('-r, --reload', "Call LLM models even if same prompt with result is in the cache", false);
@@ -12285,7 +12293,7 @@ function $initializeMakeCommand(program) {
     makeCommand.action(function (path, _a) {
         var projectName = _a.projectName, rootUrl = _a.rootUrl, format = _a.format, functionName = _a.functionName, validation = _a.validation, isCacheReloaded = _a.reload, isVerbose = _a.verbose, output = _a.output;
         return __awaiter(_this, void 0, void 0, function () {
-            var formats, validations, prepareAndScrapeOptions, fs, llm, executables, tools, collection, pipelinesUrls, validations_1, validations_1_1, validation_1, pipelinesUrls_1, pipelinesUrls_1_1, pipelineUrl, pipeline, e_1_1, e_2_1, collectionJson, collectionJsonString, collectionJsonItems, saveFile;
+            var formats, validations, prepareAndScrapeOptions, fs, llm, executables, tools, collection, pipelinesUrls, validations_1, validations_1_1, validation_1, pipelinesUrls_1, pipelinesUrls_1_1, pipelineUrl, pipeline, e_1_1, e_2_1, collectionJson, collectionJsonString, collectionJsonItems, saveFile, bookcBundle;
             var _b, e_2, _c, e_1, _d;
             var _this = this;
             return __generator(this, function (_e) {
@@ -12421,7 +12429,7 @@ function $initializeMakeCommand(program) {
                             return spaceTrim(collectionJsonString.substring(1, collectionJsonString.length - 1));
                         })();
                         saveFile = function (extension, content) { return __awaiter(_this, void 0, void 0, function () {
-                            var filename;
+                            var filename, data;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
@@ -12434,36 +12442,55 @@ function $initializeMakeCommand(program) {
                                         return [4 /*yield*/, mkdir(dirname(filename), { recursive: true })];
                                     case 1:
                                         _a.sent();
+                                        if (!(typeof content === 'string')) return [3 /*break*/, 3];
                                         return [4 /*yield*/, writeFile(filename, content, 'utf-8')];
                                     case 2:
                                         _a.sent();
+                                        return [3 /*break*/, 6];
+                                    case 3: return [4 /*yield*/, content.generateAsync({ type: 'nodebuffer', streamFiles: true })];
+                                    case 4:
+                                        data = _a.sent();
+                                        return [4 /*yield*/, writeFile(filename, data)];
+                                    case 5:
+                                        _a.sent();
+                                        _a.label = 6;
+                                    case 6:
                                         // Note: Log despite of verbose mode
                                         console.info(colors.green("Made ".concat(filename.split('\\').join('/'))));
                                         return [2 /*return*/];
                                 }
                             });
                         }); };
-                        if (!formats.includes('json')) return [3 /*break*/, 22];
-                        formats = formats.filter(function (format) { return format !== 'json'; });
-                        return [4 /*yield*/, saveFile('json', collectionJsonString)];
+                        if (!formats.includes('bookc')) return [3 /*break*/, 22];
+                        formats = formats.filter(function (format) { return format !== 'bookc'; });
+                        bookcBundle = new JSZip();
+                        bookcBundle.file('index.book.json', collectionJsonString);
+                        return [4 /*yield*/, saveFile('bookc', bookcBundle)];
                     case 21:
                         _e.sent();
                         _e.label = 22;
                     case 22:
-                        if (!(formats.includes('javascript') || formats.includes('js'))) return [3 /*break*/, 24];
-                        formats = formats.filter(function (format) { return format !== 'javascript' && format !== 'js'; });
-                        return [4 /*yield*/, saveFile('js', spaceTrim(function (block) { return "\n                            // ".concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n\n                            import { createCollectionFromJson } from '@promptbook/core';\n\n                            /**\n                             * Pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @generated\n                             * @private internal cache for `").concat(functionName, "`\n                             */\n                            let pipelineCollection = null;\n\n\n                            /**\n                             * Get pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @generated\n                             * @returns {PipelineCollection} Library of promptbooks for ").concat(projectName, "\n                             */\n                            export function ").concat(functionName, "(){\n                                if(pipelineCollection===null){\n                                    pipelineCollection = createCollectionFromJson(\n                                        ").concat(block(collectionJsonItems), "\n                                    );\n                                }\n\n                                return pipelineCollection;\n                            }\n                        "); }))];
+                        if (!formats.includes('json')) return [3 /*break*/, 24];
+                        formats = formats.filter(function (format) { return format !== 'json'; });
+                        return [4 /*yield*/, saveFile('json', collectionJsonString)];
                     case 23:
-                        (_e.sent()) + '\n';
+                        _e.sent();
                         _e.label = 24;
                     case 24:
-                        if (!(formats.includes('typescript') || formats.includes('ts'))) return [3 /*break*/, 26];
-                        formats = formats.filter(function (format) { return format !== 'typescript' && format !== 'ts'; });
-                        return [4 /*yield*/, saveFile('ts', spaceTrim(function (block) { return "\n                            // ".concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n\n                            import { createCollectionFromJson } from '@promptbook/core';\n                            import type { PipelineCollection } from '@promptbook/types';\n\n                            /**\n                             * Pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @private internal cache for `").concat(functionName, "`\n                             * @generated\n                             */\n                            let pipelineCollection: null | PipelineCollection = null;\n\n\n                            /**\n                             * Get pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @generated\n                             * @returns {PipelineCollection} Library of promptbooks for ").concat(projectName, "\n                             */\n                            export function ").concat(functionName, "(): PipelineCollection{\n                                if(pipelineCollection===null){\n\n                                    // TODO: !!6 Use book string literal notation\n                                    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n                                    pipelineCollection = (createCollectionFromJson as (..._: any) => PipelineCollection)(\n                                        ").concat(block(collectionJsonItems), "\n                                    );\n                                }\n\n                                return pipelineCollection;\n                            }\n                        "); }) + '\n')];
+                        if (!(formats.includes('javascript') || formats.includes('js'))) return [3 /*break*/, 26];
+                        formats = formats.filter(function (format) { return format !== 'javascript' && format !== 'js'; });
+                        return [4 /*yield*/, saveFile('js', spaceTrim(function (block) { return "\n                            // ".concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n\n                            import { createCollectionFromJson } from '@promptbook/core';\n\n                            /**\n                             * Pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @generated\n                             * @private internal cache for `").concat(functionName, "`\n                             */\n                            let pipelineCollection = null;\n\n\n                            /**\n                             * Get pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @generated\n                             * @returns {PipelineCollection} Library of promptbooks for ").concat(projectName, "\n                             */\n                            export function ").concat(functionName, "(){\n                                if(pipelineCollection===null){\n                                    pipelineCollection = createCollectionFromJson(\n                                        ").concat(block(collectionJsonItems), "\n                                    );\n                                }\n\n                                return pipelineCollection;\n                            }\n                        "); }))];
                     case 25:
-                        _e.sent();
+                        (_e.sent()) + '\n';
                         _e.label = 26;
                     case 26:
+                        if (!(formats.includes('typescript') || formats.includes('ts'))) return [3 /*break*/, 28];
+                        formats = formats.filter(function (format) { return format !== 'typescript' && format !== 'ts'; });
+                        return [4 /*yield*/, saveFile('ts', spaceTrim(function (block) { return "\n                            // ".concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n\n                            import { createCollectionFromJson } from '@promptbook/core';\n                            import type { PipelineCollection } from '@promptbook/types';\n\n                            /**\n                             * Pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @private internal cache for `").concat(functionName, "`\n                             * @generated\n                             */\n                            let pipelineCollection: null | PipelineCollection = null;\n\n\n                            /**\n                             * Get pipeline collection for ").concat(projectName, "\n                             *\n                             * ").concat(block(GENERATOR_WARNING_BY_PROMPTBOOK_CLI), "\n                             *\n                             * @generated\n                             * @returns {PipelineCollection} Library of promptbooks for ").concat(projectName, "\n                             */\n                            export function ").concat(functionName, "(): PipelineCollection{\n                                if(pipelineCollection===null){\n\n                                    // TODO: !!6 Use book string literal notation\n                                    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n                                    pipelineCollection = (createCollectionFromJson as (..._: any) => PipelineCollection)(\n                                        ").concat(block(collectionJsonItems), "\n                                    );\n                                }\n\n                                return pipelineCollection;\n                            }\n                        "); }) + '\n')];
+                    case 27:
+                        _e.sent();
+                        _e.label = 28;
+                    case 28:
                         if (formats.length > 0) {
                             console.warn(colors.yellow("Format ".concat(formats.join(' and '), " is not supported")));
                         }
@@ -13266,6 +13293,7 @@ function $initializeRunCommand(program) {
     var _this = this;
     var runCommand = program.command('run', { isDefault: true });
     runCommand.description(spaceTrim("\n            Runs a pipeline\n        "));
+    runCommand.alias('execute');
     // TODO: [🧅] DRY command arguments
     runCommand.argument('[pipelineSource]', 'Path to book file OR URL to book file, if not provided it will be asked');
     runCommand.option('-r, --reload', "Call LLM models even if same prompt with result is in the cache", false);
@@ -13281,6 +13309,10 @@ function $initializeRunCommand(program) {
             switch (_m.label) {
                 case 0:
                     isCacheReloaded = options.reload, isInteractive = options.interactive, isFormfactorUsed = options.formfactor, json = options.json, isVerbose = options.verbose, saveReport = options.saveReport;
+                    if (pipelineSource.includes('-') && normalizeToKebabCase(pipelineSource) === pipelineSource) {
+                        console.error(colors.red("\"\"".concat(pipelineSource, "\" is not a valid command or book. See 'ptbk --help'.")));
+                        return [2 /*return*/, process.exit(1)];
+                    }
                     if (saveReport && !saveReport.endsWith('.json') && !saveReport.endsWith('.md')) {
                         console.error(colors.red("Report file must be .json or .md"));
                         return [2 /*return*/, process.exit(1)];
@@ -14072,6 +14104,7 @@ function $initializeStartServerCommand(program) {
     startServerCommand.option('-r, --reload', "Call LLM models even if same prompt with result is in the cache", false);
     startServerCommand.option('-v, --verbose', "Is output verbose", false);
     startServerCommand.description(spaceTrim("\n            Starts a remote server to execute books\n        "));
+    startServerCommand.alias('server');
     startServerCommand.action(function (path, _a) {
         var portRaw = _a.port, rawUrl = _a.url, isAnonymousModeAllowed = _a.allowAnonymous, isCacheReloaded = _a.reload, isVerbose = _a.verbose;
         return __awaiter(_this, void 0, void 0, function () {
@@ -14169,7 +14202,7 @@ function $initializeStartServerCommand(program) {
 function $initializeTestCommand(program) {
     var _this = this;
     var testCommand = program.command('test');
-    testCommand.description(spaceTrim("\n            Iterates over `.book.md` and `.book.json` and checks if they are parsable and logically valid\n      "));
+    testCommand.description(spaceTrim("\n            Iterates over `.book.md` and `.bookc` and checks if they are parsable and logically valid\n      "));
     testCommand.argument('<filesGlob>', 
     // <- TODO: [🧟‍♂️] Unite path to promptbook collection argument
     'Pipelines to test as glob pattern');
@@ -14234,7 +14267,7 @@ function $initializeTestCommand(program) {
                         }
                         _g.label = 10;
                     case 10:
-                        if (!filename.endsWith('.book.json')) return [3 /*break*/, 12];
+                        if (!filename.endsWith('.bookc')) return [3 /*break*/, 12];
                         _d = (_c = JSON).parse;
                         return [4 /*yield*/, readFile(filename, 'utf-8')];
                     case 11: