@promptbook/node 0.59.0-25 → 0.59.0-27

package/{umd/typings/src/conversion/validation/validatePromptbookJson.d.ts → esm/typings/src/conversion/validation/validatePromptbook.d.ts}

@@ -13,7 +13,7 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * @returns the same promptbook if it is logically valid
  * @throws {PromptbookLogicError} on logical error in the promptbook
  */
-export declare function validatePromptbookJson(promptbook: PromptbookJson): PromptbookJson;
+export declare function validatePromptbook(promptbook: PromptbookJson): PromptbookJson;
 /**
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
@@ -23,5 +23,5 @@ export declare function validatePromptbookJson(promptbook: PromptbookJson): Prom
  *     >  * 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 {
  */

package/esm/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -9,4 +9,4 @@ import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): Promise<SimplePromptbookLibrary>;
+export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): SimplePromptbookLibrary;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.59.0-25",
+    "version": "0.59.0-27",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -49,7 +49,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.59.0-25"
+        "@promptbook/core": "0.59.0-27"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -152,7 +152,7 @@
         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:[]}];
+    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-26",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
@@ -260,7 +260,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) {
@@ -324,8 +324,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) {
@@ -395,7 +394,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); });
@@ -430,7 +429,7 @@
      *     >  * 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 {
      */
 
     /**
@@ -472,7 +471,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.59.0-24';
+    var PROMPTBOOK_VERSION = '0.59.0-26';
 
     /**
      * Function `addUsage` will add multiple usages into one
@@ -1013,7 +1012,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 () {
@@ -1444,7 +1443,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)];
@@ -1831,7 +1830,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) !==
@@ -1896,11 +1895,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 */
@@ -1966,9 +1961,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,
@@ -1980,7 +1973,7 @@
                             },
                         });
                         return [4 /*yield*/, executor({ content: content })];
-                    case 2:
+                    case 1:
                         result = _b.sent();
                         assertsExecutionSuccessful(result);
                         outputParameters = result.outputParameters;
@@ -2019,7 +2012,7 @@
                                         }];
                                 });
                             }); }))];
-                    case 3:
+                    case 2:
                         knowledge = _b.sent();
                         return [2 /*return*/, knowledge];
                 }
@@ -3202,9 +3195,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*/];
                     }
                 });
@@ -3348,7 +3339,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);