@promptbook/cli 0.71.0-13 → 0.71.0-14

package/umd/index.umd.js

@@ -39,7 +39,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.71.0-12';
+    var PROMPTBOOK_VERSION = '0.71.0-13';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -5107,30 +5107,45 @@
      */
 
     /**
-     * Checks if the file exists
+     * Convert file extension to mime type
      *
-     * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
+     * @private within the repository
+     */
+    function extensionToMimeType(value) {
+        return mimeTypes.lookup(value) || 'application/octet-stream';
+    }
+
+    /**
+     * Get the file extension from a file name
      *
      * @private within the repository
      */
-    function $isFileExisting(filename) {
+    function getFileExtension(value) {
+        var match = value.match(/\.([0-9a-z]+)(?:[?#]|$)/i);
+        return match ? match[1].toLowerCase() : null;
+    }
+
+    /**
+     * Checks if the file exists
+     *
+     * @private within the repository
+     */
+    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*/, promises.access(filename, promises.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*/, promises.stat(filename)
+                        return [4 /*yield*/, fs
+                                .stat(filename)
                                 .then(function (fileStat) { return fileStat.isFile(); })
                                 .catch(function () { return false; })];
                     case 2:
@@ -5141,30 +5156,11 @@
         });
     }
     /**
-     * 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 mimeTypes.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.
      *
@@ -5196,7 +5192,7 @@
      *
      * @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, 
@@ -5265,8 +5261,9 @@
                             }];
                     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');
@@ -5275,7 +5272,7 @@
                         filename_1 = path.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__default["default"](function (block) { return "\n                          Can not make source handler for file which does not exist:\n\n                          File:\n                          ".concat(block(filename_1), "\n                      "); }));
@@ -5291,7 +5288,7 @@
                                         var content;
                                         return __generator(this, function (_a) {
                                             switch (_a.label) {
-                                                case 0: return [4 /*yield*/, promises.readFile(filename_1)];
+                                                case 0: return [4 /*yield*/, tools.fs.readFile(filename_1)];
                                                 case 1:
                                                     content = _a.sent();
                                                     return [2 /*return*/, new Blob([
@@ -5345,9 +5342,6 @@
             });
         });
     }
-    /**
-     * TODO: !!!!!!! Maybe constrain to @promptbook/node bundle
-     */
 
     /**
      * Prepares the knowle
@@ -5371,7 +5365,7 @@
                                     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;
@@ -8603,6 +8597,29 @@
      * 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: promises.stat,
+            access: promises.access,
+            constants: promises.constants,
+            readFile: promises.readFile,
+            readdir: promises.readdir,
+        };
+    }
+    /**
+     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+     */
+
     /**
      * !!!!!!
      *
@@ -9125,7 +9142,8 @@
                         }
                         llm = $provideLlmToolsFromEnv(options);
                         _a = {
-                            llm: llm
+                            llm: llm,
+                            fs: $provideFilesystemForNode()
                         };
                         return [4 /*yield*/, $provideScrapersForNode({ llm: llm }, options)];
                     case 1:
@@ -9144,28 +9162,24 @@
     /**
      * 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*/, promises.access(directoryPath, promises.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*/, promises.stat(directoryPath)
+                        return [4 /*yield*/, fs
+                                .stat(directoryPath)
                                 .then(function (fileStat) { return fileStat.isDirectory(); })
                                 .catch(function () { return false; })];
                     case 2:
@@ -9176,7 +9190,7 @@
         });
     }
     /**
-     * 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?
@@ -9185,30 +9199,24 @@
     /**
      * 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$1, isRecursive) {
+    function listAllFiles(path$1, 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$1)];
+                    case 0: return [4 /*yield*/, isDirectoryExisting(path$1, fs)];
                     case 1:
                         if (!(_h.sent())) {
                             throw new Error("Directory \"".concat(path$1, "\" does not exist or is not readable"));
                             //           <- TODO: Use some custom error class
                         }
-                        return [4 /*yield*/, promises.readdir(path$1, {
+                        return [4 /*yield*/, fs.readdir(path$1, {
                                 withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
                             })];
                     case 2:
@@ -9232,7 +9240,7 @@
                         _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;
@@ -9257,7 +9265,7 @@
     }
     /**
      * 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?
      */
 
@@ -9366,17 +9374,18 @@
             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 = path.join(path$1, "".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__default["default"].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.")));
@@ -9396,7 +9405,7 @@
                                         if (isVerbose) {
                                             console.info(colors__default["default"].cyan("Creating pipeline collection from path ".concat(path$1.split('\\').join('/'))));
                                         }
-                                        return [4 /*yield*/, $listAllFiles(path$1, isRecursive)];
+                                        return [4 /*yield*/, listAllFiles(path$1, isRecursive, tools.fs)];
                                     case 1:
                                         fileNames = _b.sent();
                                         // Note: First load all .ptbk.json and then .ptbk.md files
@@ -9544,8 +9553,8 @@
         });
     }
     /**
-     * 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`
      */
 
     /**
@@ -9688,7 +9697,8 @@
      * @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");
@@ -9714,7 +9724,7 @@
                     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];
@@ -9969,7 +9979,7 @@
         return cacheLlmTools(countTotalUsage(
         //        <- Note: for example here we don`t want the [🌯]
         $provideLlmToolsFromEnv()), {
-            storage: new FileCacheStorage({ rootFolderPath: path.join(process.cwd(), EXECUTIONS_CACHE_DIRNAME) }),
+            storage: new FileCacheStorage({ fs: $provideFilesystemForNode() }, { rootFolderPath: path.join(process.cwd(), EXECUTIONS_CACHE_DIRNAME) }),
             isReloaded: isCacheReloaded,
         });
     }
@@ -12756,6 +12766,7 @@
      * 1) Need to store more than serialized JSONs
      * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: !!!!
      * TODO: [🐱‍🐉][🧠] Make some smart crop
+     * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
      */
 
     /**
@@ -13013,6 +13024,10 @@
                             if (!$isRunningInNode()) {
                                 throw new KnowledgeScrapeError('Scraping .docx files is only supported in Node environment');
                             }
+                            if (this.tools.fs === undefined) {
+                                throw new EnvironmentMismatchError('Can not scrape documents without filesystem tools');
+                                //          <- TODO: [🧠] What is the best error type here`
+                            }
                             if (externalProgramsPaths.pandocPath === undefined) {
                                 throw new MissingToolsError('Pandoc is required for scraping .docx files');
                             }
@@ -13030,7 +13045,7 @@
                                 })];
                         case 1:
                             cacheFilehandler = _g.sent();
-                            return [4 /*yield*/, $isFileExisting(cacheFilehandler.filename)];
+                            return [4 /*yield*/, isFileExisting(cacheFilehandler.filename, this.tools.fs)];
                         case 2:
                             if (!!(_g.sent())) return [3 /*break*/, 5];
                             command_1 = "\"".concat(externalProgramsPaths.pandocPath, "\" -f ").concat(extension, " -t markdown \"").concat(source.filename, "\" -o \"").concat(cacheFilehandler.filename, "\"");
@@ -13039,7 +13054,7 @@
                         case 3:
                             // TODO: !!!!!! [🕊] Make execCommand standard (?node-)util of the promptbook
                             _g.sent();
-                            return [4 /*yield*/, $isFileExisting(cacheFilehandler.filename)];
+                            return [4 /*yield*/, isFileExisting(cacheFilehandler.filename, this.tools.fs)];
                         case 4:
                             // Note: [0]
                             if (!(_g.sent())) {
@@ -13165,6 +13180,10 @@
                             if (!$isRunningInNode()) {
                                 throw new KnowledgeScrapeError('Scraping .doc files is only supported in Node environment');
                             }
+                            if (this.tools.fs === undefined) {
+                                throw new EnvironmentMismatchError('Can not scrape (legacy) documents without filesystem tools');
+                                //          <- TODO: [🧠] What is the best error type here`
+                            }
                             if (externalProgramsPaths.libreOfficePath === undefined) {
                                 throw new MissingToolsError('LibreOffice is required for scraping .doc and .rtf files');
                             }
@@ -13185,7 +13204,7 @@
                             if (isVerbose) {
                                 console.info("documentScraper: Converting .".concat(extension, " -> .docx"));
                             }
-                            return [4 /*yield*/, $isFileExisting(cacheFilehandler.filename)];
+                            return [4 /*yield*/, isFileExisting(cacheFilehandler.filename, this.tools.fs)];
                         case 2:
                             if (!!(_g.sent())) return [3 /*break*/, 8];
                             documentSourceOutdirPathForLibreOffice_1 = path.join(path.dirname(cacheFilehandler.filename), 'libreoffice')
@@ -13210,7 +13229,7 @@
                             return [4 /*yield*/, promises.rmdir(documentSourceOutdirPathForLibreOffice_1)];
                         case 6:
                             _g.sent();
-                            return [4 /*yield*/, $isFileExisting(cacheFilehandler.filename)];
+                            return [4 /*yield*/, isFileExisting(cacheFilehandler.filename, this.tools.fs)];
                         case 7:
                             if (!(_g.sent())) {
                                 throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            File that was supposed to be created by LibreOffice does not exist for unknown reason\n\n                            Expected file:\n                            ".concat(block(cacheFilehandler.filename), "\n\n                            The temporary folder:\n                            ").concat(block(documentSourceOutdirPathForLibreOffice_1), "\n\n                            Command:\n                            > ").concat(block(command_1), "\n\n                        "); }));
@@ -13290,7 +13309,6 @@
      * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
      */
 
-    // <- TODO: !!!!!!! Are theese changed to import type { ... } from ... correctly
     /**
      * @@@
      *