@promptbook/node 0.59.0-21 → 0.59.0-24

package/esm/index.es.js

@@ -137,7 +137,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-20",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-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:[]}];
 
 /**
  * This error indicates errors during the execution of the promptbook
@@ -462,7 +462,7 @@ function isValidJsonString(value /* <-[👨‍⚖️] */) {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.59.0-20';
+var PROMPTBOOK_VERSION = '0.59.0-23';
 
 /**
  * Function `addUsage` will add multiple usages into one
@@ -1795,6 +1795,7 @@ var PromptbookReferenceError = /** @class */ (function (_super) {
  * Library of promptbooks that groups together promptbooks for an application.
  * This implementation is a very thin wrapper around the Array / Map of promptbooks.
  *
+ * @private use `createLibraryFromJson` instead
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 var SimplePromptbookLibrary = /** @class */ (function () {
@@ -1803,8 +1804,9 @@ var SimplePromptbookLibrary = /** @class */ (function () {
      *
      * @param promptbooks !!!
      *
+     * @private Use instead `createLibraryFromJson`
      * Note: During the construction logic of all promptbooks are validated
-     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
      */
     function SimplePromptbookLibrary() {
         var e_1, _a;
@@ -1873,68 +1875,23 @@ var SimplePromptbookLibrary = /** @class */ (function () {
 /**
  * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
  *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
  * Note: During the construction syntax and logic of all sources are validated
  *
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-function createPromptbookLibraryFromSources() {
-    var promptbookSources = [];
+function createLibraryFromJson() {
+    var promptbooks = [];
     for (var _i = 0; _i < arguments.length; _i++) {
-        promptbookSources[_i] = arguments[_i];
+        promptbooks[_i] = arguments[_i];
     }
     return __awaiter(this, void 0, void 0, function () {
-        var promptbooks, promptbookSources_1, promptbookSources_1_1, source, promptbook, e_1_1;
-        var e_1, _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    promptbooks = new Array();
-                    _b.label = 1;
-                case 1:
-                    _b.trys.push([1, 8, 9, 10]);
-                    promptbookSources_1 = __values(promptbookSources), promptbookSources_1_1 = promptbookSources_1.next();
-                    _b.label = 2;
-                case 2:
-                    if (!!promptbookSources_1_1.done) return [3 /*break*/, 7];
-                    source = promptbookSources_1_1.value;
-                    promptbook = void 0;
-                    if (!(typeof source === 'string')) return [3 /*break*/, 4];
-                    return [4 /*yield*/, promptbookStringToJson(source)];
-                case 3:
-                    // Note: When directly creating from string, no need to validate the source
-                    //       The validation is performed always before execution
-                    promptbook = _b.sent();
-                    return [3 /*break*/, 5];
-                case 4:
-                    promptbook = source;
-                    _b.label = 5;
-                case 5:
-                    promptbooks.push(promptbook);
-                    _b.label = 6;
-                case 6:
-                    promptbookSources_1_1 = promptbookSources_1.next();
-                    return [3 /*break*/, 2];
-                case 7: return [3 /*break*/, 10];
-                case 8:
-                    e_1_1 = _b.sent();
-                    e_1 = { error: e_1_1 };
-                    return [3 /*break*/, 10];
-                case 9:
-                    try {
-                        if (promptbookSources_1_1 && !promptbookSources_1_1.done && (_a = promptbookSources_1.return)) _a.call(promptbookSources_1);
-                    }
-                    finally { if (e_1) throw e_1.error; }
-                    return [7 /*endfinally*/];
-                case 10: return [2 /*return*/, new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))()];
-            }
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))()];
         });
     });
 }
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */
 
 /* tslint:disable */
 function normalizeToKebabCase(sentence) {
@@ -1999,7 +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*/, createPromptbookLibraryFromSources.apply(void 0, __spreadArray([], __read(promptbookLibrary), false))];
+                    return [4 /*yield*/, createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookLibrary), false))];
                 case 1:
                     library = _b.sent();
                     promptbook = library.getPromptbookByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md');
@@ -3208,19 +3165,19 @@ new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined'
  * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       `createLibraryFromUrl` or `createLibraryFromDirectory`
  *       Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
  *
- * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
+ * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
  * @deprecated Do not use, it will became internal tool for other constructor functions
  */
-function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
+function createLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
     var library;
     function forSources() {
         return __awaiter(this, void 0, void 0, function () {
@@ -3235,7 +3192,7 @@ function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
                         return [4 /*yield*/, promptbookSourcesPromiseOrFactory];
                     case 1:
                         promptbookSources = _a.sent();
-                        return [4 /*yield*/, createPromptbookLibraryFromSources.apply(void 0, __spreadArray([], __read(promptbookSources), false))];
+                        return [4 /*yield*/, createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookSources), false))];
                     case 2:
                         library = _a.sent();
                         return [2 /*return*/];
@@ -3285,9 +3242,6 @@ function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
         isResponsibleForPrompt: isResponsibleForPrompt,
     };
 }
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */
 
 /**
  * Constructs Promptbook from given directory
@@ -3298,7 +3252,7 @@ function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-function createPromptbookLibraryFromDirectory(path, options) {
+function createLibraryFromDirectory(path, options) {
     return __awaiter(this, void 0, void 0, function () {
         var _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashOnError, library;
         var _this = this;
@@ -3306,10 +3260,10 @@ function createPromptbookLibraryFromDirectory(path, options) {
             switch (_f.label) {
                 case 0:
                     if (!isRunningInNode()) {
-                        throw new Error('Function `createPromptbookLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
+                        throw new Error('Function `createLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
                     }
                     _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 = createPromptbookLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
+                    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;
                         var e_1, _a;
                         return __generator(this, function (_b) {
@@ -3322,7 +3276,7 @@ function createPromptbookLibraryFromDirectory(path, options) {
                                 case 1:
                                     fileNames = _b.sent();
                                     if (isVerbose) {
-                                        console.info('createPromptbookLibraryFromDirectory', { path: path, isRecursive: isRecursive, fileNames: fileNames });
+                                        console.info('createLibraryFromDirectory', { path: path, isRecursive: isRecursive, fileNames: fileNames });
                                     }
                                     promptbooks = [];
                                     _loop_1 = function (fileName) {
@@ -3439,7 +3393,7 @@ function createPromptbookLibraryFromDirectory(path, options) {
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
- * @private internal function for `createPromptbookLibraryFromDirectory`
+ * @private internal function for `createLibraryFromDirectory`
  */
 function listAllFiles(path, isRecursive) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3496,5 +3450,5 @@ function listAllFiles(path, isRecursive) {
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
  */
 
-export { PROMPTBOOK_VERSION, createPromptbookLibraryFromDirectory };
+export { PROMPTBOOK_VERSION, createLibraryFromDirectory };
 //# sourceMappingURL=index.es.js.map