@promptbook/cli 0.59.0-25 → 0.59.0-26

package/umd/index.umd.js

@@ -147,7 +147,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.59.0-24';
+    var PROMPTBOOK_VERSION = '0.59.0-25';
 
     /**
      * Initializes testing `hello` command for Promptbook CLI utilities
@@ -188,61 +188,6 @@
      */
     var PROMPTBOOK_MAKED_BASE_FILENAME = "promptbook-library";
 
-    /**
-     * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
-     */
-    var PromptbookSyntaxError = /** @class */ (function (_super) {
-        __extends(PromptbookSyntaxError, _super);
-        function PromptbookSyntaxError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookSyntaxError';
-            Object.setPrototypeOf(_this, PromptbookSyntaxError.prototype);
-            return _this;
-        }
-        return PromptbookSyntaxError;
-    }(Error));
-
-    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-24",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
-
-    /**
-     * This error indicates errors during the execution of the promptbook
-     */
-    var PromptbookExecutionError = /** @class */ (function (_super) {
-        __extends(PromptbookExecutionError, _super);
-        function PromptbookExecutionError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookExecutionError';
-            Object.setPrototypeOf(_this, PromptbookExecutionError.prototype);
-            return _this;
-        }
-        return PromptbookExecutionError;
-    }(Error));
-
-    /**
-     * Asserts that the execution of a promptnook is successful
-     *
-     * @param executionResult - The partial result of the promptnook execution
-     * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
-     */
-    function assertsExecutionSuccessful(executionResult) {
-        var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
-        if (isSuccessful === true) {
-            return;
-        }
-        if (errors.length === 0) {
-            throw new PromptbookExecutionError("Promptnook Execution failed because of unknown reason");
-        }
-        else if (errors.length === 1) {
-            throw errors[0];
-        }
-        else {
-            throw new PromptbookExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                    Multiple errors occurred during promptnook execution\n\n                    ".concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n')), "\n                "); }));
-        }
-    }
-    /**
-     * TODO: [🧠] Can this return type be better typed than void
-     */
-
     /**
      * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
      */
@@ -257,6 +202,20 @@
         return PromptbookLogicError;
     }(Error));
 
+    /**
+     * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+     */
+    var PromptbookSyntaxError = /** @class */ (function (_super) {
+        __extends(PromptbookSyntaxError, _super);
+        function PromptbookSyntaxError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookSyntaxError';
+            Object.setPrototypeOf(_this, PromptbookSyntaxError.prototype);
+            return _this;
+        }
+        return PromptbookSyntaxError;
+    }(Error));
+
     /**
      * This error type indicates that the error should not happen and its last check before crashing with some other error
      */
@@ -310,7 +269,7 @@
      * @returns the same promptbook if it is logically valid
      * @throws {PromptbookLogicError} on logical error in the promptbook
      */
-    function validatePromptbookJson(promptbook) {
+    function validatePromptbook(promptbook) {
         // TODO: [🧠] Maybe test if promptbook is a promise and make specific error case for that
         var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
         if (promptbook.promptbookUrl !== undefined) {
@@ -374,8 +333,7 @@
                     throw new PromptbookLogicError("Parameter {".concat(template.resultingParameterName, "} is defined multiple times"));
                 }
                 definedParameters.add(template.resultingParameterName);
-                if (template.executionType === 'PROMPT_TEMPLATE' &&
-                    (template.modelRequirements.modelVariant === undefined)) {
+                if (template.executionType === 'PROMPT_TEMPLATE' && template.modelRequirements.modelVariant === undefined) {
                     throw new PromptbookLogicError(spaceTrim.spaceTrim("\n\n                  You must specify MODEL VARIANT in the prompt template \"".concat(template.title, "\"\n\n                  For example:\n                  - MODEL VARIANT Chat\n                  - MODEL NAME `gpt-4-1106-preview`\n\n              ")));
                 }
                 if (template.jokers && template.jokers.length > 0) {
@@ -445,7 +403,7 @@
         var loopLimit = LOOP_LIMIT;
         var _loop_2 = function () {
             if (loopLimit-- < 0) {
-                throw new UnexpectedError('Loop limit reached during detection of circular dependencies in `validatePromptbookJson`');
+                throw new UnexpectedError('Loop limit reached during detection of circular dependencies in `validatePromptbook`');
             }
             var currentlyResovedTemplates = unresovedTemplates.filter(function (template) {
                 return template.dependentParameterNames.every(function (name) { return resovedParameters.includes(name); });
@@ -480,7 +438,48 @@
      *     >  * It checks:
      *     >  * -   it has a valid structure
      *     >  * -   ...
-     *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
+     *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
+     */
+
+    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-25",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
+
+    /**
+     * This error indicates errors during the execution of the promptbook
+     */
+    var PromptbookExecutionError = /** @class */ (function (_super) {
+        __extends(PromptbookExecutionError, _super);
+        function PromptbookExecutionError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookExecutionError';
+            Object.setPrototypeOf(_this, PromptbookExecutionError.prototype);
+            return _this;
+        }
+        return PromptbookExecutionError;
+    }(Error));
+
+    /**
+     * Asserts that the execution of a promptnook is successful
+     *
+     * @param executionResult - The partial result of the promptnook execution
+     * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
+     */
+    function assertsExecutionSuccessful(executionResult) {
+        var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
+        if (isSuccessful === true) {
+            return;
+        }
+        if (errors.length === 0) {
+            throw new PromptbookExecutionError("Promptnook Execution failed because of unknown reason");
+        }
+        else if (errors.length === 1) {
+            throw errors[0];
+        }
+        else {
+            throw new PromptbookExecutionError(spaceTrim.spaceTrim(function (block) { return "\n                    Multiple errors occurred during promptnook execution\n\n                    ".concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n')), "\n                "); }));
+        }
+    }
+    /**
+     * TODO: [🧠] Can this return type be better typed than void
      */
 
     /**
@@ -1058,7 +1057,7 @@
         var _this = this;
         var promptbook = options.promptbook, tools = options.tools, _a = options.settings, settings = _a === void 0 ? {} : _a;
         var _b = settings.maxExecutionAttempts, maxExecutionAttempts = _b === void 0 ? 3 : _b;
-        validatePromptbookJson(promptbook);
+        validatePromptbook(promptbook);
         var promptbookExecutor = function (inputParameters, onProgress) { return __awaiter(_this, void 0, void 0, function () {
             function executeSingleTemplate(currentTemplate) {
                 return __awaiter(this, void 0, void 0, function () {
@@ -1489,7 +1488,7 @@
                                             return template.dependentParameterNames.every(function (name) { return resovedParameters_1.includes(name); });
                                         });
                                         if (!(!currentTemplate && resolving_1.length === 0)) return [3 /*break*/, 1];
-                                        throw new UnexpectedError(spaceTrim.spaceTrim("\n                            Can not resolve some parameters\n\n                            Note: This should be catched during validatePromptbookJson\n                        "));
+                                        throw new UnexpectedError(spaceTrim.spaceTrim("\n                            Can not resolve some parameters\n\n                            Note: This should be catched during validatePromptbook\n                        "));
                                     case 1:
                                         if (!!currentTemplate) return [3 /*break*/, 3];
                                         /* [5] */ return [4 /*yield*/, Promise.race(resolving_1)];
@@ -1876,7 +1875,7 @@
                     if (promptbook.promptbookUrl === undefined) {
                         throw new PromptbookReferenceError(spaceTrim.spaceTrim("\n                        Promptbook with name \"".concat(promptbook.title, "\" does not have defined URL\n\n                        Note: Promptbooks without URLs are called anonymous promptbooks\n                              They can be used as standalone promptbooks, but they cannot be referenced by other promptbooks\n                              And also they cannot be used in the promptbook library\n\n                    ")));
                     }
-                    validatePromptbookJson(promptbook);
+                    validatePromptbook(promptbook);
                     // Note: [🦄]
                     if (this.library.has(promptbook.promptbookUrl) &&
                         promptbookJsonToString(promptbook) !==
@@ -1941,11 +1940,7 @@
         for (var _i = 0; _i < arguments.length; _i++) {
             promptbooks[_i] = arguments[_i];
         }
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))()];
-            });
-        });
+        return new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))();
     }
 
     /* tslint:disable */
@@ -2011,9 +2006,7 @@
                 switch (_b.label) {
                     case 0:
                         content = options.content, llmTools = options.llmTools, _a = options.isVerbose, isVerbose = _a === void 0 ? false : _a;
-                        return [4 /*yield*/, createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookLibrary), false))];
-                    case 1:
-                        library = _b.sent();
+                        library = createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookLibrary), false));
                         promptbook = library.getPromptbookByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md');
                         executor = createPromptbookExecutor({
                             promptbook: promptbook,
@@ -2025,7 +2018,7 @@
                             },
                         });
                         return [4 /*yield*/, executor({ content: content })];
-                    case 2:
+                    case 1:
                         result = _b.sent();
                         assertsExecutionSuccessful(result);
                         outputParameters = result.outputParameters;
@@ -2064,7 +2057,7 @@
                                         }];
                                 });
                             }); }))];
-                    case 3:
+                    case 2:
                         knowledge = _b.sent();
                         return [2 /*return*/, knowledge];
                 }
@@ -3234,9 +3227,7 @@
                             return [4 /*yield*/, promptbookSourcesPromiseOrFactory];
                         case 1:
                             promptbookSources = _a.sent();
-                            return [4 /*yield*/, createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookSources), false))];
-                        case 2:
-                            library = _a.sent();
+                            library = createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookSources), false));
                             return [2 /*return*/];
                     }
                 });
@@ -3380,7 +3371,7 @@
                                                                 if (!isCrashOnError) {
                                                                     // Note: Validate promptbook to check if it is logically correct to not crash on invalid promptbooks
                                                                     //       But be handled in current try-catch block
-                                                                    validatePromptbookJson(promptbook);
+                                                                    validatePromptbook(promptbook);
                                                                 }
                                                                 // Note: [🦄] Promptbook with same url uniqueness will be checked automatically in SimplePromptbookLibrary
                                                                 promptbooks.push(promptbook);
@@ -3545,21 +3536,84 @@
         helloCommand.action(function (path$1, _a) {
             var projectName = _a.projectName, format = _a.format, validation = _a.validation;
             return __awaiter(_this, void 0, void 0, function () {
-                var library, libraryJson, libraryJsonString, saveFile;
+                var formats, validations, library, validations_1, validations_1_1, validation_1, _b, _c, promptbookUrl, promptbook, e_1_1, e_2_1, libraryJson, libraryJsonString, saveFile;
+                var e_2, _d, e_1, _e;
                 var _this = this;
-                return __generator(this, function (_b) {
-                    switch (_b.label) {
+                return __generator(this, function (_f) {
+                    switch (_f.label) {
                         case 0:
                             console.info('!!!', { projectName: projectName, path: path$1, format: format, validation: validation });
+                            formats = (format || '')
+                                .split(',')
+                                .map(function (_) { return _.trim(); })
+                                .filter(function (_) { return _ !== ''; });
+                            validations = (validation || '')
+                                .split(',')
+                                .map(function (_) { return _.trim(); })
+                                .filter(function (_) { return _ !== ''; });
                             return [4 /*yield*/, createLibraryFromDirectory(path$1, {
                                     isVerbose: true,
                                     isRecursive: true,
                                 })];
                         case 1:
-                            library = _b.sent();
-                            return [4 /*yield*/, libraryToJson(library)];
+                            library = _f.sent();
+                            _f.label = 2;
                         case 2:
-                            libraryJson = _b.sent();
+                            _f.trys.push([2, 14, 15, 16]);
+                            validations_1 = __values(validations), validations_1_1 = validations_1.next();
+                            _f.label = 3;
+                        case 3:
+                            if (!!validations_1_1.done) return [3 /*break*/, 13];
+                            validation_1 = validations_1_1.value;
+                            _f.label = 4;
+                        case 4:
+                            _f.trys.push([4, 10, 11, 12]);
+                            e_1 = void 0;
+                            return [4 /*yield*/, library.listPromptbooks()];
+                        case 5:
+                            _b = (__values.apply(void 0, [_f.sent()])), _c = _b.next();
+                            _f.label = 6;
+                        case 6:
+                            if (!!_c.done) return [3 /*break*/, 9];
+                            promptbookUrl = _c.value;
+                            return [4 /*yield*/, library.getPromptbookByUrl(promptbookUrl)];
+                        case 7:
+                            promptbook = _f.sent();
+                            if (validation_1 === 'logic') {
+                                validatePromptbook(promptbook);
+                            }
+                            _f.label = 8;
+                        case 8:
+                            _c = _b.next();
+                            return [3 /*break*/, 6];
+                        case 9: return [3 /*break*/, 12];
+                        case 10:
+                            e_1_1 = _f.sent();
+                            e_1 = { error: e_1_1 };
+                            return [3 /*break*/, 12];
+                        case 11:
+                            try {
+                                if (_c && !_c.done && (_e = _b.return)) _e.call(_b);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                            return [7 /*endfinally*/];
+                        case 12:
+                            validations_1_1 = validations_1.next();
+                            return [3 /*break*/, 3];
+                        case 13: return [3 /*break*/, 16];
+                        case 14:
+                            e_2_1 = _f.sent();
+                            e_2 = { error: e_2_1 };
+                            return [3 /*break*/, 16];
+                        case 15:
+                            try {
+                                if (validations_1_1 && !validations_1_1.done && (_d = validations_1.return)) _d.call(validations_1);
+                            }
+                            finally { if (e_2) throw e_2.error; }
+                            return [7 /*endfinally*/];
+                        case 16: return [4 /*yield*/, libraryToJson(library)];
+                        case 17:
+                            libraryJson = _f.sent();
                             libraryJsonString = JSON.stringify(libraryJson);
                             saveFile = function (extension, content) { return __awaiter(_this, void 0, void 0, function () {
                                 var filePath;
@@ -3575,25 +3629,25 @@
                                     }
                                 });
                             }); };
-                            if (!format.includes('json')) return [3 /*break*/, 4];
+                            if (!formats.includes('json')) return [3 /*break*/, 19];
                             return [4 /*yield*/, saveFile('json', libraryJsonString + '\n')];
-                        case 3:
-                            _b.sent();
-                            _b.label = 4;
-                        case 4:
-                            if (format.includes('javascript')) {
+                        case 18:
+                            _f.sent();
+                            _f.label = 19;
+                        case 19:
+                            if (formats.includes('javascript')) {
                                 // TODO: !!!!;
                                 // TODO: !!! DRY javascript and typescript
-                                format.push('javascript');
+                                formats.push('javascript');
                             }
-                            if (!format.includes('typescript')) return [3 /*break*/, 6];
+                            if (!formats.includes('typescript')) return [3 /*break*/, 21];
                             // TODO: !!!!!!!! Javascript json
-                            return [4 /*yield*/, saveFile('ts', spaceTrim__default["default"]("\n                        import type { PromptbookLibrary, SimplePromptbookLibrary } from '@promptbook/types';\n                        import type { PromptbookLibrary } from '@promptbook/core';\n\n                        /**\n                         * Promptbook library for ".concat(projectName, "\n                         *\n                         * @private internal cache for `getPromptbookLibrary`\n                         */\n                        let promptbookLibrary: null | SimplePromptbookLibrary = null;\n\n\n                        /**\n                         *  Get promptbook library for ").concat(projectName, "\n                         *\n                         *  @returns {PromptbookLibrary} Library of promptbooks for ").concat(projectName, "\n                         *  @generated by `@promptbook/cli`\n                         */\n                        export function getPromptbookLibrary(): PromptbookLibrary{\n                            if(promptbookLibrary===null){\n                                promptbookLibrary = createLibraryFromJson(...").concat(libraryJsonString, ");\n                            }\n\n                            return promptbookLibrary;\n                        }\n                    ") + '\n'))];
-                        case 5:
+                            return [4 /*yield*/, saveFile('ts', spaceTrim__default["default"]("\n                        import type { PromptbookLibrary, SimplePromptbookLibrary } from '@promptbook/types';\n                        import type { createLibraryFromJson } from '@promptbook/core';\n\n                        /**\n                         * Promptbook library for ".concat(projectName, "\n                         *\n                         * @private internal cache for `getPromptbookLibrary`\n                         */\n                        let promptbookLibrary: null | SimplePromptbookLibrary = null;\n\n\n                        /**\n                         *  Get promptbook library for ").concat(projectName, "\n                         *\n                         *  @returns {PromptbookLibrary} Library of promptbooks for ").concat(projectName, "\n                         *  @generated by `@promptbook/cli`\n                         */\n                        export function getPromptbookLibrary(): PromptbookLibrary{\n                            if(promptbookLibrary===null){\n                                promptbookLibrary = createLibraryFromJson(").concat(libraryJsonString.substring(1, libraryJsonString.length - 2), ");\n                            }\n\n                            return promptbookLibrary;\n                        }\n                    ") + '\n'))];
+                        case 20:
                             // TODO: !!!!!!!! Javascript json
-                            _b.sent();
-                            _b.label = 6;
-                        case 6:
+                            _f.sent();
+                            _f.label = 21;
+                        case 21:
                             process.exit(0);
                             return [2 /*return*/];
                     }