@promptbook/core 0.52.0-9 → 0.52.0

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('moment')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'prettier', 'prettier/parser-html', 'moment'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spaceTrim, global.prettier, global.parserHtml, global.moment));
-})(this, (function (exports, spaceTrim, prettier, parserHtml, moment) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('path'), require('moment')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'prettier', 'prettier/parser-html', 'path', 'moment'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spaceTrim, global.prettier, global.parserHtml, global.path, global.moment));
+})(this, (function (exports, spaceTrim, prettier, parserHtml, path, moment) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -454,7 +454,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.52.0-8';
+    var PROMPTBOOK_VERSION = '0.52.0-33';
 
     /**
      * Parses the template and returns the list of all parameter names
@@ -1831,6 +1831,9 @@
                 postprocessing = undefined;
             }
             dependentParameterNames = union(dependentParameterNames, extractParametersFromPromptTemplate(__assign(__assign({}, section), { description: description_1, executionType: executionType, content: content })));
+            if (templateModelRequirements.modelVariant === undefined) {
+                templateModelRequirements.modelVariant = 'CHAT';
+            }
             promptbookJson.promptTemplates.push({
                 name: titleToName(section.title),
                 title: section.title,
@@ -2176,6 +2179,7 @@
      * @throws {PromptbookLogicError} on logical error in the promptbook
      */
     function validatePromptbookJson(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) {
             if (!isValidUrl(promptbook.promptbookUrl)) {
@@ -2183,6 +2187,16 @@
                 throw new PromptbookLogicError("Invalid promptbook URL \"".concat(promptbook.promptbookUrl, "\""));
             }
         }
+        // TODO: [🧠] Maybe do here some propper JSON-schema / ZOD checking
+        if (!Array.isArray(promptbook.parameters)) {
+            // TODO: [🧠] what is the correct error tp throw - maybe PromptbookSchemaError
+            throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n                Promptbook is valid JSON but with wrong structure\n\n                promptbook.parameters expected to be an array, but got ".concat(typeof promptbook.parameters, "\n            ")));
+        }
+        // TODO: [🧠] Maybe do here some propper JSON-schema / ZOD checking
+        if (!Array.isArray(promptbook.promptTemplates)) {
+            // TODO: [🧠] what is the correct error tp throw - maybe PromptbookSchemaError
+            throw new PromptbookSyntaxError(spaceTrim.spaceTrim("\n              Promptbook is valid JSON but with wrong structure\n\n              promptbook.promptTemplates expected to be an array, but got ".concat(typeof promptbook.promptTemplates, "\n          ")));
+        }
         var _loop_1 = function (parameter) {
             if (parameter.isInput && parameter.isOutput) {
                 throw new PromptbookLogicError("Parameter {".concat(parameter.name, "} can not be both input and output"));
@@ -2229,9 +2243,8 @@
                 }
                 definedParameters.add(template.resultingParameterName);
                 if (template.executionType === 'PROMPT_TEMPLATE' &&
-                    (template.modelRequirements.modelVariant === undefined ||
-                        template.modelRequirements.modelName === undefined)) {
-                    throw new PromptbookLogicError(spaceTrim.spaceTrim("\n\n                  You must specify MODEL VARIANT and MODEL NAME in the prompt template \"".concat(template.title, "\"\n\n                  For example:\n                  - MODEL VARIANT Chat\n                  - MODEL NAME `gpt-4-1106-preview`\n\n              ")));
+                    (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) {
                     if (!template.expectFormat &&
@@ -2532,7 +2545,7 @@
                                     title: currentTemplate.title,
                                     promptbookUrl: "".concat(promptbook.promptbookUrl
                                         ? promptbook.promptbookUrl
-                                        : 'anonymous' /* <- [🧠][🈴] How to deal with anonymous PROMPTBOOKs, do here some auto-url like SHA-256 based ad-hoc identifier? */, "#").concat(currentTemplate.name),
+                                        : 'anonymous' /* <- TODO: [🧠] How to deal with anonymous PROMPTBOOKs, do here some auto-url like SHA-256 based ad-hoc identifier? */, "#").concat(currentTemplate.name),
                                     parameters: parametersToPass,
                                     content: replaceParameters(currentTemplate.content, parametersToPass) /* <- [2] */,
                                     modelRequirements: currentTemplate.modelRequirements,
@@ -3162,6 +3175,20 @@
         return SimplePromptInterfaceTools;
     }());
 
+    /**
+     * This error indicates that the promptbook library cannot be propperly loaded
+     */
+    var PromptbookLibraryError = /** @class */ (function (_super) {
+        __extends(PromptbookLibraryError, _super);
+        function PromptbookLibraryError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookLibraryError';
+            Object.setPrototypeOf(_this, PromptbookLibraryError.prototype);
+            return _this;
+        }
+        return PromptbookLibraryError;
+    }(Error));
+
     /**
      * Detects if the code is running in a browser environment in main thread (Not in a web worker)
      */
@@ -3175,6 +3202,23 @@
      */
     new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
 
+    /**
+     * Returns the same value that is passed as argument.
+     * No side effects.
+     *
+     * Note: It can be usefull for leveling indentation
+     *
+     * @param value any values
+     * @returns the same values
+     */
+    function just(value) {
+        if (value === undefined) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            return undefined;
+        }
+        return value;
+    }
+
     /**
      * This error indicates that promptbook not found in the library
      */
@@ -3232,6 +3276,12 @@
                         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);
+                    // Note: [🦄]
+                    if (this.library.has(promptbook.promptbookUrl) &&
+                        promptbookJsonToString(promptbook) !==
+                            promptbookJsonToString(this.library.get(promptbook.promptbookUrl))) {
+                        throw new PromptbookReferenceError(spaceTrim.spaceTrim("\n                        Promptbook with URL \"".concat(promptbook.promptbookUrl, "\" is already in the library\n\n                        Note: Promptbooks with the same URL are not allowed\n                        Note: Automatically check whether the promptbooks are the same BUT they are DIFFERENT\n\n                    ")));
+                    }
                     this.library.set(promptbook.promptbookUrl, promptbook);
                 }
             }
@@ -3258,6 +3308,9 @@
             var _this = this;
             var promptbook = this.library.get(url);
             if (!promptbook) {
+                if (this.listPromptbooks().length === 0) {
+                    throw new PromptbookNotFoundError(spaceTrim.spaceTrim("\n                            Promptbook with url \"".concat(url, "\" not found\n\n                            No promptbooks available\n                        ")));
+                }
                 throw new PromptbookNotFoundError(spaceTrim.spaceTrim(function (block) { return "\n                        Promptbook with url \"".concat(url, "\" not found\n\n                        Available promptbooks:\n                        ").concat(block(_this.listPromptbooks()
                     .map(function (promptbookUrl) { return "- ".concat(promptbookUrl); })
                     .join('\n')), "\n\n                    "); }));
@@ -3330,11 +3383,11 @@
      * 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`
      *
      * @param promptbookSourcesPromiseOrFactory
      * @returns PromptbookLibrary
-     *
-     * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+     * @private Just internal tool for other constructor functions
      */
     function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
         var library;
@@ -3407,37 +3460,252 @@
      * Constructs Promptbook from given directory
      *
      * Note: Works only in Node.js environment because it reads the file system
-     * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
-     *       SO during the construction syntax and logic sources IS NOT validated
      *
      * @param path - path to the directory with promptbooks
      * @param options - Misc options for the library
      * @returns PromptbookLibrary
      */
     function createPromptbookLibraryFromDirectory(path, options) {
-        var _this = this;
-        if (!isRunningInNode()) {
-            throw new Error('Function `createPromptbookLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
-        }
-        var _a = (options || {}).isRecursive, isRecursive = _a === void 0 ? true : _a;
-        return createPromptbookLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
-            var readdir, readdirResult;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, import('fs/promises')];
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashOnError, library;
+            var _this = this;
+            return __generator(this, function (_f) {
+                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.');
+                        }
+                        _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 () {
+                            var fsPromises, readFile, fileNames, promptbooks, _loop_1, fileNames_1, fileNames_1_1, fileName, e_1_1;
+                            var e_1, _a;
+                            return __generator(this, function (_b) {
+                                switch (_b.label) {
+                                    case 0:
+                                        if (isVerbose) {
+                                            console.info("Creating promptbook library from path ".concat(path));
+                                        }
+                                        fsPromises = require(just('fs/promises') /* <- Note: [1] */);
+                                        readFile = fsPromises.readFile;
+                                        return [4 /*yield*/, listAllFiles(path, isRecursive)];
+                                    case 1:
+                                        fileNames = _b.sent();
+                                        if (isVerbose) {
+                                            console.info('createPromptbookLibraryFromDirectory', { path: path, isRecursive: isRecursive, fileNames: fileNames });
+                                        }
+                                        promptbooks = [];
+                                        _loop_1 = function (fileName) {
+                                            var promptbook, promptbookString, _c, _d, error_1, wrappedErrorMessage;
+                                            return __generator(this, function (_e) {
+                                                switch (_e.label) {
+                                                    case 0:
+                                                        _e.trys.push([0, 6, , 7]);
+                                                        promptbook = null;
+                                                        if (!fileName.endsWith('.ptbk.md')) return [3 /*break*/, 2];
+                                                        return [4 /*yield*/, readFile(fileName, 'utf8')];
+                                                    case 1:
+                                                        promptbookString = (_e.sent());
+                                                        promptbook = promptbookStringToJson(promptbookString);
+                                                        return [3 /*break*/, 5];
+                                                    case 2:
+                                                        if (!fileName.endsWith('.ptbk.json')) return [3 /*break*/, 4];
+                                                        if (isVerbose) {
+                                                            console.info("Loading ".concat(fileName));
+                                                        }
+                                                        _d = (_c = JSON).parse;
+                                                        return [4 /*yield*/, readFile(fileName, 'utf8')];
+                                                    case 3:
+                                                        // TODO: Handle non-valid JSON files
+                                                        promptbook = _d.apply(_c, [_e.sent()]);
+                                                        return [3 /*break*/, 5];
+                                                    case 4:
+                                                        if (isVerbose) {
+                                                            console.info("Skipping file ".concat(fileName));
+                                                        }
+                                                        _e.label = 5;
+                                                    case 5:
+                                                        // ---
+                                                        if (promptbook !== null) {
+                                                            if (!promptbook.promptbookUrl) {
+                                                                if (isVerbose) {
+                                                                    console.info("Not loading ".concat(fileName, " - missing URL"));
+                                                                }
+                                                            }
+                                                            else {
+                                                                if (isVerbose) {
+                                                                    console.info("Loading ".concat(fileName));
+                                                                }
+                                                                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);
+                                                                }
+                                                                // Note: [🦄] Promptbook with same url uniqueness will be checked automatically in SimplePromptbookLibrary
+                                                                promptbooks.push(promptbook);
+                                                            }
+                                                        }
+                                                        return [3 /*break*/, 7];
+                                                    case 6:
+                                                        error_1 = _e.sent();
+                                                        if (!(error_1 instanceof Error)) {
+                                                            throw error_1;
+                                                        }
+                                                        wrappedErrorMessage = spaceTrim__default["default"](function (block) { return "\n                        Error during loading promptbook from file ".concat(fileName.split('\\').join('/'), ":\n\n                        ").concat(block(error_1.message), "\n\n                    "); });
+                                                        if (isCrashOnError) {
+                                                            throw new PromptbookLibraryError(wrappedErrorMessage);
+                                                        }
+                                                        console.error(wrappedErrorMessage);
+                                                        return [3 /*break*/, 7];
+                                                    case 7: return [2 /*return*/];
+                                                }
+                                            });
+                                        };
+                                        _b.label = 2;
+                                    case 2:
+                                        _b.trys.push([2, 7, 8, 9]);
+                                        fileNames_1 = __values(fileNames), fileNames_1_1 = fileNames_1.next();
+                                        _b.label = 3;
+                                    case 3:
+                                        if (!!fileNames_1_1.done) return [3 /*break*/, 6];
+                                        fileName = fileNames_1_1.value;
+                                        return [5 /*yield**/, _loop_1(fileName)];
+                                    case 4:
+                                        _b.sent();
+                                        _b.label = 5;
+                                    case 5:
+                                        fileNames_1_1 = fileNames_1.next();
+                                        return [3 /*break*/, 3];
+                                    case 6: return [3 /*break*/, 9];
+                                    case 7:
+                                        e_1_1 = _b.sent();
+                                        e_1 = { error: e_1_1 };
+                                        return [3 /*break*/, 9];
+                                    case 8:
+                                        try {
+                                            if (fileNames_1_1 && !fileNames_1_1.done && (_a = fileNames_1.return)) _a.call(fileNames_1);
+                                        }
+                                        finally { if (e_1) throw e_1.error; }
+                                        return [7 /*endfinally*/];
+                                    case 9: return [2 /*return*/, promptbooks];
+                                }
+                            });
+                        }); });
+                        if (!(isLazyLoaded === false)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, library.listPromptbooks()];
+                    case 1:
+                        _f.sent();
+                        _f.label = 2;
+                    case 2: return [2 /*return*/, library];
+                }
+            });
+        });
+    }
+    /**
+     * Reads all files in the directory
+     *
+     * @param path
+     * @param isRecursive
+     * @returns List of all files in the directory
+     * @private internal function for `createPromptbookLibraryFromDirectory`
+     */
+    function listAllFiles(path$1, isRecursive) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fsPromises, readdir, dirents, fileNames, _a, _b, dirent, subPath, _c, _d, _e, _f, e_2_1;
+            var e_2, _g;
+            return __generator(this, function (_h) {
+                switch (_h.label) {
+                    case 0:
+                        fsPromises = require(just('fs/promises') /* <- Note: [1] */);
+                        readdir = fsPromises.readdir;
+                        return [4 /*yield*/, readdir(path$1, {
+                                withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
+                            })];
                     case 1:
-                        readdir = (_a.sent()).readdir;
-                        return [4 /*yield*/, readdir(path)];
+                        dirents = _h.sent();
+                        fileNames = dirents.filter(function (dirent) { return dirent.isFile(); }).map(function (_a) {
+                            var name = _a.name;
+                            return path.join(path$1, name);
+                        });
+                        if (!isRecursive) return [3 /*break*/, 9];
+                        _h.label = 2;
                     case 2:
-                        readdirResult = _a.sent();
-                        // TODO: !!! Implement
-                        console.info('createPromptbookLibraryFromDirectory', { path: path, isRecursive: isRecursive, readdirResult: readdirResult });
-                        throw new Error('Not implemented yet');
+                        _h.trys.push([2, 7, 8, 9]);
+                        _a = __values(dirents.filter(function (dirent) { return dirent.isDirectory(); })), _b = _a.next();
+                        _h.label = 3;
+                    case 3:
+                        if (!!_b.done) return [3 /*break*/, 6];
+                        dirent = _b.value;
+                        subPath = path.join(path$1, dirent.name);
+                        _d = (_c = fileNames.push).apply;
+                        _e = [fileNames];
+                        _f = [[]];
+                        return [4 /*yield*/, listAllFiles(subPath, isRecursive)];
+                    case 4:
+                        _d.apply(_c, _e.concat([__spreadArray.apply(void 0, _f.concat([__read.apply(void 0, [(_h.sent())]), false]))]));
+                        _h.label = 5;
+                    case 5:
+                        _b = _a.next();
+                        return [3 /*break*/, 3];
+                    case 6: return [3 /*break*/, 9];
+                    case 7:
+                        e_2_1 = _h.sent();
+                        e_2 = { error: e_2_1 };
+                        return [3 /*break*/, 9];
+                    case 8:
+                        try {
+                            if (_b && !_b.done && (_g = _a.return)) _g.call(_a);
+                        }
+                        finally { if (e_2) throw e_2.error; }
+                        return [7 /*endfinally*/];
+                    case 9: return [2 /*return*/, fileNames];
                 }
             });
-        }); });
+        });
     }
     /***
+     * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node
+     *       [🍓][🚯] maybe make `@promptbook/library` package
+     * TODO: Fix the dynamic import issue in Webpack (! Not working !)
+     *     > ./node_modules/@promptbook/core/esm/index.es.js
+     *     > Critical dependency: the request of a dependency is an expression
+     *
+     * Note: [1] Using require(just('fs/promises')) to allow
+     *     the `@promptbook/core` work for both Node.js and browser environments
+     */
+
+    /**
+     * Constructs Promptbook from remote Promptbase URL
+
+     * @returns PromptbookLibrary
+     */
+    function createPromptbookLibraryFromUrl(url, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, _b, isVerbose, _c, isLazyLoaded, library;
+            var _this = this;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _a = options || {}, _b = _a.isVerbose, isVerbose = _b === void 0 ? false : _b, _c = _a.isLazyLoaded, isLazyLoaded = _c === void 0 ? false : _c;
+                        library = createPromptbookLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                if (isVerbose) {
+                                    console.info("Creating promptbook library from url ".concat(url.toString()));
+                                }
+                                throw new Error('Not implemented yet');
+                            });
+                        }); });
+                        if (!(isLazyLoaded === false)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, library.listPromptbooks()];
+                    case 1:
+                        _d.sent();
+                        _d.label = 2;
+                    case 2: return [2 /*return*/, library];
+                }
+            });
+        });
+    }
+    /***
+     * TODO: [⚖] Compatible with remote server
      * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
      */
 
@@ -3523,6 +3791,31 @@
      * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
      */
 
+    /**
+     * Just testing imports and compatibility
+     */
+    function justTestFsImport() {
+        return __awaiter(this, void 0, void 0, function () {
+            var files;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!isRunningInNode()) {
+                            throw new Error('Function `testFiles` can only be run in Node.js environment because it reads the file system.');
+                        }
+                        return [4 /*yield*/, require(just('glob-promise'))('/**/*')];
+                    case 1:
+                        files = _a.sent();
+                        console.info('testFiles', { files: files });
+                        return [2 /*return*/];
+                }
+            });
+        });
+    }
+    /**
+     * TODO: !!! Remove this file
+     */
+
     /**
      * Format either small or big number
      *
@@ -3543,23 +3836,6 @@
         return value.toString();
     }
 
-    /**
-     * Returns the same value that is passed as argument.
-     * No side effects.
-     *
-     * Note: It can be usefull for leveling indentation
-     *
-     * @param value any values
-     * @returns the same values
-     */
-    function just(value) {
-        if (value === undefined) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            return undefined;
-        }
-        return value;
-    }
-
     /**
      * Create a markdown table from a 2D array of strings
      *
@@ -3851,11 +4127,12 @@
     exports.checkExpectations = checkExpectations;
     exports.createPromptbookExecutor = createPromptbookExecutor;
     exports.createPromptbookLibraryFromDirectory = createPromptbookLibraryFromDirectory;
-    exports.createPromptbookLibraryFromPromise = createPromptbookLibraryFromPromise;
     exports.createPromptbookLibraryFromSources = createPromptbookLibraryFromSources;
+    exports.createPromptbookLibraryFromUrl = createPromptbookLibraryFromUrl;
     exports.createPromptbookSublibrary = createPromptbookSublibrary;
     exports.executionReportJsonToString = executionReportJsonToString;
     exports.isPassingExpectations = isPassingExpectations;
+    exports.justTestFsImport = justTestFsImport;
     exports.prettifyPromptbookString = prettifyPromptbookString;
     exports.promptbookJsonToString = promptbookJsonToString;
     exports.promptbookStringToJson = promptbookStringToJson;