@promptbook/node 0.71.0-13 → 0.71.0-15

package/esm/index.es.js

@@ -1,5 +1,5 @@
 import colors from 'colors';
-import { stat, access, constants, readFile, readdir, writeFile, mkdir, unlink } from 'fs/promises';
+import { readFile, stat, access, constants, readdir, writeFile, mkdir, unlink } from 'fs/promises';
 import { join, basename, dirname } from 'path';
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
 import { format } from 'prettier';
@@ -17,7 +17,7 @@ import { spawn } from 'child_process';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.71.0-12';
+var PROMPTBOOK_VERSION = '0.71.0-14';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -4930,39 +4930,45 @@ function sourceContentToName(sourceContent) {
  */
 
 /**
- * Detects if the code is running in a Node.js environment
+ * Convert file extension to mime type
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ * @private within the repository
+ */
+function extensionToMimeType(value) {
+    return lookup(value) || 'application/octet-stream';
+}
+
+/**
+ * Get the file extension from a file name
  *
- * @public exported from `@promptbook/utils`
+ * @private within the repository
  */
-var $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+function getFileExtension(value) {
+    var match = value.match(/\.([0-9a-z]+)(?:[?#]|$)/i);
+    return match ? match[1].toLowerCase() : null;
+}
 
 /**
  * Checks if the file exists
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
  * @private within the repository
  */
-function $isFileExisting(filename) {
+function isFileExisting(filename, fs) {
     return __awaiter(this, void 0, void 0, function () {
         var isReadAccessAllowed, isFile;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    if (!$isRunningInNode()) {
-                        throw new EnvironmentMismatchError('Function `$isFileExisting` works only in Node environment.js');
-                    }
-                    return [4 /*yield*/, access(filename, constants.R_OK)
-                            .then(function () { return true; })
-                            .catch(function () { return false; })];
+                case 0: return [4 /*yield*/, fs
+                        .access(filename, fs.constants.R_OK)
+                        .then(function () { return true; })
+                        .catch(function () { return false; })];
                 case 1:
                     isReadAccessAllowed = _a.sent();
                     if (!isReadAccessAllowed) {
                         return [2 /*return*/, false];
                     }
-                    return [4 /*yield*/, stat(filename)
+                    return [4 /*yield*/, fs
+                            .stat(filename)
                             .then(function (fileStat) { return fileStat.isFile(); })
                             .catch(function () { return false; })];
                 case 2:
@@ -4973,30 +4979,11 @@ function $isFileExisting(filename) {
     });
 }
 /**
- * Note: [🟢 !!!!!! After fix makeKnowledgeSourceHandler] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
  * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
  * TODO: [🖇] What about symlinks?
  */
 
-/**
- * Convert file extension to mime type
- *
- * @private within the repository
- */
-function extensionToMimeType(value) {
-    return lookup(value) || 'application/octet-stream';
-}
-
-/**
- * Get the file extension from a file name
- *
- * @private within the repository
- */
-function getFileExtension(value) {
-    var match = value.match(/\.([0-9a-z]+)(?:[?#]|$)/i);
-    return match ? match[1].toLowerCase() : null;
-}
-
 /**
  * Tests if given string is valid URL.
  *
@@ -5028,7 +5015,7 @@ function isValidFilePath(filename) {
  *
  * @private for scraper utilities
  */
-function makeKnowledgeSourceHandler(knowledgeSource, options) {
+function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
     var _a;
     return __awaiter(this, void 0, void 0, function () {
         var sourceContent, name, _b, _c, rootDirname, _d, 
@@ -5097,8 +5084,9 @@ function makeKnowledgeSourceHandler(knowledgeSource, options) {
                         }];
                 case 2:
                     if (!(isValidFilePath(sourceContent) || /\.[a-z]{1,10}$/i.exec(sourceContent))) return [3 /*break*/, 4];
-                    if (!$isRunningInNode()) {
-                        throw new EnvironmentMismatchError('Importing knowledge source file works only in Node.js environment');
+                    if (tools.fs === undefined) {
+                        throw new EnvironmentMismatchError('Can not import file knowledge without filesystem tools');
+                        //          <- TODO: [🧠] What is the best error type here`
                     }
                     if (rootDirname === null) {
                         throw new EnvironmentMismatchError('Can not import file knowledge in non-file pipeline');
@@ -5107,7 +5095,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, options) {
                     filename_1 = join(rootDirname, sourceContent).split('\\').join('/');
                     fileExtension = getFileExtension(filename_1);
                     mimeType_1 = extensionToMimeType(fileExtension || '');
-                    return [4 /*yield*/, $isFileExisting(filename_1)];
+                    return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
                 case 3:
                     if (!(_e.sent())) {
                         throw new NotFoundError(spaceTrim$1(function (block) { return "\n                          Can not make source handler for file which does not exist:\n\n                          File:\n                          ".concat(block(filename_1), "\n                      "); }));
@@ -5123,7 +5111,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, options) {
                                     var content;
                                     return __generator(this, function (_a) {
                                         switch (_a.label) {
-                                            case 0: return [4 /*yield*/, readFile(filename_1)];
+                                            case 0: return [4 /*yield*/, tools.fs.readFile(filename_1)];
                                             case 1:
                                                 content = _a.sent();
                                                 return [2 /*return*/, new Blob([
@@ -5177,9 +5165,6 @@ function makeKnowledgeSourceHandler(knowledgeSource, options) {
         });
     });
 }
-/**
- * TODO: !!!!!!! Maybe constrain to @promptbook/node bundle
- */
 
 /**
  * Prepares the knowle
@@ -5203,7 +5188,7 @@ function prepareKnowledgePieces(knowledgeSources, tools, options) {
                                 switch (_d.label) {
                                     case 0:
                                         partialPieces = null;
-                                        return [4 /*yield*/, makeKnowledgeSourceHandler(knowledgeSource, { rootDirname: rootDirname, isVerbose: isVerbose })];
+                                        return [4 /*yield*/, makeKnowledgeSourceHandler(knowledgeSource, tools, { rootDirname: rootDirname, isVerbose: isVerbose })];
                                     case 1:
                                         sourceHandler = _d.sent();
                                         _d.label = 2;
@@ -8204,6 +8189,15 @@ function pipelineStringToJson(pipelineString, tools, options) {
  * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
  */
 
+/**
+ * Detects if the code is running in a Node.js environment
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+var $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+
 /**
  * @@@
  *
@@ -8432,7 +8426,29 @@ function $provideLlmToolsFromEnv(options) {
  * TODO: [🥃] Allow `ptbk make` without llm tools
  * TODO: This should be maybe not under `_common` but under `utils`
  * TODO: [®] DRY Register logic
- * TODO: [🍂] Maybe make llm = $provideLlmToolsFromEnv() without problem with bundle contaminated by only `@promptbook/node` and `@promptbook/cli` stuff
+ */
+
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/node`
+ */
+function $provideFilesystemForNode(options) {
+    if (!$isRunningInNode()) {
+        throw new EnvironmentMismatchError('Function `$provideFilesystemForNode` works only in Node.js environment');
+    }
+    var _a = (options || {}).isVerbose, isVerbose = _a === void 0 ? IS_VERBOSE : _a;
+    TODO_USE(isVerbose);
+    return {
+        stat: stat,
+        access: access,
+        constants: constants,
+        readFile: readFile,
+        readdir: readdir,
+    };
+}
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */
 
 /**
@@ -8947,7 +8963,7 @@ var JavascriptExecutionTools = JavascriptEvalExecutionTools;
  */
 function $provideExecutionToolsForNode(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var llm, tools;
+        var fs, llm, tools;
         var _a;
         return __generator(this, function (_b) {
             switch (_b.label) {
@@ -8955,11 +8971,13 @@ function $provideExecutionToolsForNode(options) {
                     if (!$isRunningInNode()) {
                         throw new EnvironmentMismatchError('Function `$getExecutionToolsForNode` works only in Node.js environment');
                     }
+                    fs = $provideFilesystemForNode();
                     llm = $provideLlmToolsFromEnv(options);
                     _a = {
-                        llm: llm
+                        llm: llm,
+                        fs: fs
                     };
-                    return [4 /*yield*/, $provideScrapersForNode({ llm: llm }, options)];
+                    return [4 /*yield*/, $provideScrapersForNode({ fs: fs, llm: llm }, options)];
                 case 1:
                     tools = (_a.scrapers = _b.sent(),
                         _a.script = [new JavascriptExecutionTools(options)],
@@ -8976,28 +8994,24 @@ function $provideExecutionToolsForNode(options) {
 /**
  * Checks if the directory exists
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
  * @private within the repository
  */
-function $isDirectoryExisting(directoryPath) {
+function isDirectoryExisting(directoryPath, fs) {
     return __awaiter(this, void 0, void 0, function () {
         var isReadAccessAllowed, isDirectory;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    if (!$isRunningInNode()) {
-                        throw new EnvironmentMismatchError('Function `$isDirectoryExisting` works only in Node environment.js');
-                    }
-                    return [4 /*yield*/, access(directoryPath, constants.R_OK)
-                            .then(function () { return true; })
-                            .catch(function () { return false; })];
+                case 0: return [4 /*yield*/, fs
+                        .access(directoryPath, fs.constants.R_OK)
+                        .then(function () { return true; })
+                        .catch(function () { return false; })];
                 case 1:
                     isReadAccessAllowed = _a.sent();
                     if (!isReadAccessAllowed) {
                         return [2 /*return*/, false];
                     }
-                    return [4 /*yield*/, stat(directoryPath)
+                    return [4 /*yield*/, fs
+                            .stat(directoryPath)
                             .then(function (fileStat) { return fileStat.isDirectory(); })
                             .catch(function () { return false; })];
                 case 2:
@@ -9008,7 +9022,7 @@ function $isDirectoryExisting(directoryPath) {
     });
 }
 /**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
  * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
  * TODO: [🧠][📂] "directory" vs "folder"
  * TODO: [🖇] What about symlinks?
@@ -9017,30 +9031,24 @@ function $isDirectoryExisting(directoryPath) {
 /**
  * Reads all files in the directory
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
  * @private internal function of `createCollectionFromDirectory`
  */
-function $listAllFiles(path, isRecursive) {
+function listAllFiles(path, isRecursive, fs) {
     return __awaiter(this, void 0, void 0, function () {
         var dirents, fileNames, _a, _b, dirent, subPath, _c, _d, _e, _f, e_1_1;
         var e_1, _g;
         return __generator(this, function (_h) {
             switch (_h.label) {
-                case 0:
-                    if (!$isRunningInNode()) {
-                        throw new EnvironmentMismatchError('Function `$listAllFiles` works only in Node environment.js');
-                    }
-                    return [4 /*yield*/, $isDirectoryExisting(path)];
+                case 0: return [4 /*yield*/, isDirectoryExisting(path, fs)];
                 case 1:
                     if (!(_h.sent())) {
                         throw new Error("Directory \"".concat(path, "\" does not exist or is not readable"));
                         //           <- TODO: Use some custom error class
                     }
-                    return [4 /*yield*/, readdir(path, {
+                    return [4 /*yield*/, fs.readdir(path, {
                             withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
                         })];
                 case 2:
@@ -9064,7 +9072,7 @@ function $listAllFiles(path, isRecursive) {
                     _d = (_c = fileNames.push).apply;
                     _e = [fileNames];
                     _f = [[]];
-                    return [4 /*yield*/, $listAllFiles(subPath, isRecursive)];
+                    return [4 /*yield*/, listAllFiles(subPath, isRecursive, fs)];
                 case 5:
                     _d.apply(_c, _e.concat([__spreadArray.apply(void 0, _f.concat([__read.apply(void 0, [(_h.sent()).map(function (filename) { return filename; })]), false]))]));
                     _h.label = 6;
@@ -9089,7 +9097,7 @@ function $listAllFiles(path, isRecursive) {
 }
 /**
  * TODO: [😶] Unite floder listing
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
  * TODO: [🖇] What about symlinks?
  */
 
@@ -9198,17 +9206,18 @@ function createCollectionFromDirectory(path, tools, options) {
         return __generator(this, function (_f) {
             switch (_f.label) {
                 case 0:
-                    if (!$isRunningInNode()) {
-                        throw new Error('Function `createCollectionFromDirectory` can only be run in Node.js environment because it reads the file system.');
-                    }
                     if (!(tools === undefined)) return [3 /*break*/, 2];
                     return [4 /*yield*/, $provideExecutionToolsForNode()];
                 case 1:
                     tools = _f.sent();
                     _f.label = 2;
                 case 2:
+                    if (tools === undefined || tools.fs === undefined) {
+                        throw new EnvironmentMismatchError('Can not create collection without filesystem tools');
+                        //          <- TODO: [🧠] What is the best error type here`
+                    }
                     makedLibraryFilePath = join(path, "".concat(PIPELINE_COLLECTION_BASE_FILENAME, ".json"));
-                    return [4 /*yield*/, $isFileExisting(makedLibraryFilePath)];
+                    return [4 /*yield*/, isFileExisting(makedLibraryFilePath, tools.fs)];
                 case 3:
                     if (!(_f.sent())) {
                         console.info(colors.yellow("Tip: Prebuild your pipeline collection (file with supposed prebuild ".concat(makedLibraryFilePath, " not found) with CLI util \"ptbk make\" to speed up the collection creation.")));
@@ -9228,7 +9237,7 @@ function createCollectionFromDirectory(path, tools, options) {
                                     if (isVerbose) {
                                         console.info(colors.cyan("Creating pipeline collection from path ".concat(path.split('\\').join('/'))));
                                     }
-                                    return [4 /*yield*/, $listAllFiles(path, isRecursive)];
+                                    return [4 /*yield*/, listAllFiles(path, isRecursive, tools.fs)];
                                 case 1:
                                     fileNames = _b.sent();
                                     // Note: First load all .ptbk.json and then .ptbk.md files
@@ -9376,8 +9385,8 @@ function createCollectionFromDirectory(path, tools, options) {
     });
 }
 /**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
  */
 
 /**
@@ -9455,7 +9464,8 @@ function nameToSubfolderPath(name) {
  * @public exported from `@promptbook/node`
  */
 var FileCacheStorage = /** @class */ (function () {
-    function FileCacheStorage(options) {
+    function FileCacheStorage(tools, options) {
+        this.tools = tools;
         this.options = options;
         if (!$isRunningInNode()) {
             throw new EnvironmentMismatchError("FileCacheStorage works only in Node.js environment");
@@ -9481,7 +9491,7 @@ var FileCacheStorage = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         filename = this.getFilenameForKey(key);
-                        return [4 /*yield*/, $isFileExisting(filename)];
+                        return [4 /*yield*/, isFileExisting(filename, this.tools.fs)];
                     case 1:
                         if (!(_a.sent())) {
                             return [2 /*return*/, null];
@@ -9747,5 +9757,5 @@ function $execCommands(_a) {
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */
 
-export { $execCommand, $execCommands, $provideExecutionToolsForNode, $provideLlmToolsConfigurationFromEnv, $provideLlmToolsFromEnv, $provideScrapersForNode, FileCacheStorage, PROMPTBOOK_VERSION, createCollectionFromDirectory };
+export { $execCommand, $execCommands, $provideExecutionToolsForNode, $provideFilesystemForNode, $provideLlmToolsConfigurationFromEnv, $provideLlmToolsFromEnv, $provideScrapersForNode, FileCacheStorage, PROMPTBOOK_VERSION, createCollectionFromDirectory };
 //# sourceMappingURL=index.es.js.map