@promptbook/core 0.55.0 → 0.56.0-2

package/README.md

@@ -320,6 +320,7 @@ Or you can install them separately:
 -   ⭐ **[ptbk](https://www.npmjs.com/package/ptbk)** - Bundle of all packages, when you want to install everything and you don't care about the size
 -   **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
 -   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
+-   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js
 -   ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
 -   _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
 -   **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
@@ -327,7 +328,7 @@ Or you can install them separately:
 -   **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK 
 -   **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
 -   **[@promptbook/langtail](https://www.npmjs.com/package/@promptbook/langtail)** - Execution tools for Langtail API, wrapper around Langtail SDK
--   **[@promptbook/mock](https://www.npmjs.com/package/@promptbook/mock)** - Mocked execution tools for testing the library and saving the tokens
+-   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
 -   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
 -   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
@@ -512,7 +513,7 @@ There are [postprocessing functions](#postprocessing-functions) that can be used
 Executor is a simple async function that takes **input parameters** and returns **output parameters**.
 It is constructed by combining execution tools and promptbook to execute together.
 
-### 🃏 Jokers (conditions) 
+### 🃏 Jokers (conditions)
 
 Joker is a previously defined parameter that is used to bypass some parts of the pipeline.
 If the joker is present in the template, it is checked to see if it meets the requirements (without postprocessing), and if so, it is used instead of executing that prompt template. There can be multiple wildcards in a prompt template, if so they are checked in order and the first one that meets the requirements is used.

package/esm/index.es.js

@@ -1,7 +1,6 @@
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
 import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
-import { join } from 'path';
 import moment from 'moment';
 
 /*! *****************************************************************************
@@ -448,7 +447,7 @@ function union() {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.55.0-2';
+var PROMPTBOOK_VERSION = '0.56.0-1';
 
 /**
  * Parses the template and returns the list of all parameter names
@@ -3343,36 +3342,6 @@ function usageToWorktime(usage) {
     return uncertainNumber;
 }
 
-/**
- * Detects if the code is running in a browser environment in main thread (Not in a web worker)
- */
-new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
-/**
- * Detects if the code is running in a Node.js environment
- */
-var isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
-/**
- * Detects if the code is running in a web worker
- */
-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;
-}
-
 /**
  * Library of promptbooks that groups together promptbooks for an application.
  * This implementation is a very thin wrapper around the Array / Map of promptbooks.
@@ -3492,9 +3461,6 @@ function createPromptbookLibraryFromSources() {
     }
     return new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))();
 }
-/***
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
- */
 
 /**
  * Constructs Promptbook from async sources
@@ -3578,226 +3544,6 @@ function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
         isResponsibleForPrompt: isResponsibleForPrompt,
     };
 }
-/***
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
- */
-
-/**
- * Constructs Promptbook from given directory
- *
- * Note: Works only in Node.js environment because it reads the file system
- *
- * @param path - path to the directory with promptbooks
- * @param options - Misc options for the library
- * @returns PromptbookLibrary
- */
-function createPromptbookLibraryFromDirectory(path, options) {
-    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$1(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, 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, {
-                            withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
-                        })];
-                case 1:
-                    dirents = _h.sent();
-                    fileNames = dirents.filter(function (dirent) { return dirent.isFile(); }).map(function (_a) {
-                        var name = _a.name;
-                        return join(path, name);
-                    });
-                    if (!isRecursive) return [3 /*break*/, 9];
-                    _h.label = 2;
-                case 2:
-                    _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 = join(path, 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
@@ -3830,10 +3576,6 @@ function createPromptbookLibraryFromUrl(url, options) {
         });
     });
 }
-/***
- * TODO: [⚖] Compatible with remote server
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
- */
 
 /**
  * Creates PromptbookLibrary as a subset of another PromptbookLibrary
@@ -3913,9 +3655,36 @@ function createPromptbookSublibrary(library, predicate) {
         isResponsibleForPrompt: isResponsibleForPrompt,
     };
 }
-/***
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ */
+new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
+/**
+ * Detects if the code is running in a Node.js environment
  */
+var isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+/**
+ * Detects if the code is running in a web worker
+ */
+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;
+}
 
 /**
  * Just testing imports and compatibility
@@ -4245,5 +4014,5 @@ function executionReportJsonToString(executionReportJson, options) {
  * TODO: [🧠] Allow to filter out some parts of the report by options
  */
 
-export { CallbackInterfaceTools, ExecutionReportStringOptionsDefaults, ExecutionTypes, ExpectError, MultipleLlmExecutionTools, PROMPTBOOK_VERSION, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, SimplePromptInterfaceTools, SimplePromptbookLibrary, TemplateError, UnexpectedError, addUsage, assertsExecutionSuccessful, checkExpectations, createPromptbookExecutor, createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, executionReportJsonToString, isPassingExpectations, justTestFsImport, prettifyPromptbookString, promptbookJsonToString, promptbookStringToJson, usageToWorktime, validatePromptbookJson };
+export { CallbackInterfaceTools, ExecutionReportStringOptionsDefaults, ExecutionTypes, ExpectError, MultipleLlmExecutionTools, PROMPTBOOK_VERSION, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, SimplePromptInterfaceTools, SimplePromptbookLibrary, TemplateError, UnexpectedError, addUsage, assertsExecutionSuccessful, checkExpectations, createPromptbookExecutor, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, executionReportJsonToString, isPassingExpectations, justTestFsImport, prettifyPromptbookString, promptbookJsonToString, promptbookStringToJson, usageToWorktime, validatePromptbookJson };
 //# sourceMappingURL=index.es.js.map