@promptbook/node 0.59.0-24 → 0.59.0-26

package/esm/index.es.js

@@ -1,4 +1,5 @@
-import { readFile, readdir } from 'fs/promises';
+import colors from 'colors';
+import { access, constants, readFile, readdir } from 'fs/promises';
 import { join } from 'path';
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
 import { format } from 'prettier';
@@ -123,6 +124,15 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
+/**
+ * The maximum number of iterations for a loops
+ */
+var LOOP_LIMIT = 1000;
+/**
+ * The name of the builded promptbook library made by CLI `promptbook make` and for lookup in `createLibraryFromDirectory`
+ */
+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
  */
@@ -137,7 +147,7 @@ var PromptbookSyntaxError = /** @class */ (function (_super) {
     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-23",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:[]}];
+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
@@ -178,11 +188,6 @@ function assertsExecutionSuccessful(executionResult) {
  * TODO: [🧠] Can this return type be better typed than void
  */
 
-/**
- * The maximum number of iterations for a loops
- */
-var LOOP_LIMIT = 1000;
-
 /**
  * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
  */
@@ -250,7 +255,7 @@ function isValidUrl(url) {
  * @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) {
@@ -314,8 +319,7 @@ function validatePromptbookJson(promptbook) {
                 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("\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) {
@@ -385,7 +389,7 @@ function validatePromptbookJson(promptbook) {
     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); });
@@ -420,7 +424,7 @@ function validatePromptbookJson(promptbook) {
  *     >  * 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 {
  */
 
 /**
@@ -462,7 +466,7 @@ function isValidJsonString(value /* <-[👨‍⚖️] */) {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.59.0-23';
+var PROMPTBOOK_VERSION = '0.59.0-25';
 
 /**
  * Function `addUsage` will add multiple usages into one
@@ -1003,7 +1007,7 @@ function createPromptbookExecutor(options) {
     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 () {
@@ -1434,7 +1438,7 @@ function createPromptbookExecutor(options) {
                                         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("\n                            Can not resolve some parameters\n\n                            Note: This should be catched during validatePromptbookJson\n                        "));
+                                    throw new UnexpectedError(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)];
@@ -1821,7 +1825,7 @@ var SimplePromptbookLibrary = /** @class */ (function () {
                 if (promptbook.promptbookUrl === undefined) {
                     throw new PromptbookReferenceError(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) !==
@@ -1886,11 +1890,7 @@ function createLibraryFromJson() {
     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 */
@@ -1956,9 +1956,7 @@ function prepareKnowledgeFromMarkdown(options) {
             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,
@@ -1970,7 +1968,7 @@ function prepareKnowledgeFromMarkdown(options) {
                         },
                     });
                     return [4 /*yield*/, executor({ content: content })];
-                case 2:
+                case 1:
                     result = _b.sent();
                     assertsExecutionSuccessful(result);
                     outputParameters = result.outputParameters;
@@ -2009,7 +2007,7 @@ function prepareKnowledgeFromMarkdown(options) {
                                     }];
                             });
                         }); }))];
-                case 3:
+                case 2:
                     knowledge = _b.sent();
                     return [2 /*return*/, knowledge];
             }
@@ -3192,9 +3190,7 @@ function createLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
                         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*/];
                 }
             });
@@ -3254,7 +3250,7 @@ function createLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
  */
 function createLibraryFromDirectory(path, options) {
     return __awaiter(this, void 0, void 0, function () {
-        var _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashOnError, library;
+        var makedLibraryFilePath, makedLibraryFileExists, _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashOnError, library;
         var _this = this;
         return __generator(this, function (_f) {
             switch (_f.label) {
@@ -3262,6 +3258,19 @@ function createLibraryFromDirectory(path, options) {
                     if (!isRunningInNode()) {
                         throw new Error('Function `createLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
                     }
+                    makedLibraryFilePath = join(path, "".concat(PROMPTBOOK_MAKED_BASE_FILENAME, ".json"));
+                    return [4 /*yield*/, access(makedLibraryFilePath, constants.R_OK)
+                            .then(function () { return true; })
+                            .catch(function () { return false; })];
+                case 1:
+                    makedLibraryFileExists = _f.sent();
+                    if (!makedLibraryFileExists) {
+                        console.info(colors.yellow("Tip: Prebuild your promptbook library (file with supposed prebuild ".concat(makedLibraryFilePath, " not found) with CLI util \"promptbook make\" to speed up the library creation.")));
+                    }
+                    else {
+                        colors.green("Using your prebuild promptbook library ".concat(makedLibraryFilePath));
+                        // TODO: !!!!! Implement;
+                    }
                     _a = options || {}, _b = _a.isRecursive, isRecursive = _b === void 0 ? true : _b, _c = _a.isVerbose, isVerbose = _c === void 0 ? false : _c, _d = _a.isLazyLoaded, isLazyLoaded = _d === void 0 ? false : _d, _e = _a.isCrashOnError, isCrashOnError = _e === void 0 ? true : _e;
                     library = createLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
                         var fileNames, promptbooks, _loop_1, fileNames_1, fileNames_1_1, fileName, e_1_1;
@@ -3325,7 +3334,7 @@ function createLibraryFromDirectory(path, options) {
                                                             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);
@@ -3377,12 +3386,12 @@ function createLibraryFromDirectory(path, options) {
                             }
                         });
                     }); });
-                    if (!(isLazyLoaded === false)) return [3 /*break*/, 2];
+                    if (!(isLazyLoaded === false)) return [3 /*break*/, 3];
                     return [4 /*yield*/, library.listPromptbooks()];
-                case 1:
+                case 2:
                     _f.sent();
-                    _f.label = 2;
-                case 2: return [2 /*return*/, library];
+                    _f.label = 3;
+                case 3: return [2 /*return*/, library];
             }
         });
     });