@promptbook/node 0.85.0-0 → 0.85.0-2

package/esm/typings/src/_packages/utils.index.d.ts

@@ -47,6 +47,7 @@ import { parseKeywords } from '../utils/normalization/parseKeywords';
 import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
+import { suffixUrl } from '../utils/normalization/suffixUrl';
 import { titleToName } from '../utils/normalization/titleToName';
 import { spaceTrim } from '../utils/organization/spaceTrim';
 import { extractParameterNames } from '../utils/parameters/extractParameterNames';
@@ -128,6 +129,7 @@ export { parseKeywords };
 export { parseKeywordsFromString };
 export { removeDiacritics };
 export { searchKeywords };
+export { suffixUrl };
 export { titleToName };
 export { spaceTrim };
 export { extractParameterNames };

package/esm/typings/src/execution/FilesystemTools.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import type fs from 'fs/promises';
+import type fs from 'node:fs/promises';
 /**
  * Container for all the tools needed to manipulate with filesystem
  */

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -11,6 +11,8 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
 /**
+ * TODO: !!!!!!! CORS and security
+ * TODO: !!!!!!! Allow to pass tokem here
  * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -25,12 +25,14 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      */
     readonly port: number;
     /**
-     * Path for the Socket.io server to listen
+     * Root path of the server
      *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
+     * Note: This is useful when you reverse proxy the server without changing the path
+     *
+     * @default '/'
+     * @example '/api/promptbook/'
      */
-    readonly path: string_uri;
+    readonly rootPath: string_uri;
 } & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**

package/esm/typings/src/utils/normalization/suffixUrl.d.ts

@@ -0,0 +1,7 @@
+import type { string_url } from '../../types/typeAliases';
+/**
+ * Adds suffix to the URL
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function suffixUrl(value: URL, suffix: `/${string}`): string_url;

package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.85.0-0",
+    "version": "0.85.0-2",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.85.0-0"
+        "@promptbook/core": "0.85.0-2"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('fs/promises'), require('path'), require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('rxjs'), require('crypto'), require('waitasecond'), require('papaparse'), require('crypto-js/enc-hex'), require('crypto-js/sha256'), require('crypto-js'), require('mime-types'), require('child_process'), require('dotenv')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'fs/promises', 'path', 'spacetrim', 'prettier', 'prettier/parser-html', 'rxjs', 'crypto', 'waitasecond', 'papaparse', 'crypto-js/enc-hex', 'crypto-js/sha256', 'crypto-js', 'mime-types', 'child_process', 'dotenv'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-node"] = {}, global.colors, global.promises, global.path, global.spaceTrim, global.prettier, global.parserHtml, global.rxjs, global.crypto, global.waitasecond, global.papaparse, global.hexEncoder, global.sha256, global.cryptoJs, global.mimeTypes, global.child_process, global.dotenv));
-})(this, (function (exports, colors, promises, path, spaceTrim, prettier, parserHtml, rxjs, crypto, waitasecond, papaparse, hexEncoder, sha256, cryptoJs, mimeTypes, child_process, dotenv) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('node:fs/promises'), require('node:path'), require('spacetrim'), require('prettier'), require('prettier/parser-html'), require('rxjs'), require('crypto'), require('waitasecond'), require('papaparse'), require('crypto-js/enc-hex'), require('crypto-js/sha256'), require('crypto-js'), require('mime-types'), require('node:child_process'), require('dotenv')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'node:fs/promises', 'node:path', 'spacetrim', 'prettier', 'prettier/parser-html', 'rxjs', 'crypto', 'waitasecond', 'papaparse', 'crypto-js/enc-hex', 'crypto-js/sha256', 'crypto-js', 'mime-types', 'node:child_process', 'dotenv'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-node"] = {}, global.colors, global.promises, global.node_path, global.spaceTrim, global.prettier, global.parserHtml, global.rxjs, global.crypto, global.waitasecond, global.papaparse, global.hexEncoder, global.sha256, global.cryptoJs, global.mimeTypes, global.node_child_process, global.dotenv));
+})(this, (function (exports, colors, promises, node_path, spaceTrim, prettier, parserHtml, rxjs, crypto, waitasecond, papaparse, hexEncoder, sha256, cryptoJs, mimeTypes, node_child_process, dotenv) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -45,7 +45,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.84.0';
+    var PROMPTBOOK_ENGINE_VERSION = '0.85.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2061,9 +2061,9 @@
     function createTask(options) {
         var taskType = options.taskType, taskProcessCallback = options.taskProcessCallback;
         var taskId = "".concat(taskType.toLowerCase(), "-").concat($randomToken(256 /* <- TODO: !!! To global config */));
-        var resultSubject = new rxjs.BehaviorSubject({});
+        var partialResultSubject = new rxjs.BehaviorSubject({});
         var finalResultPromise = /* not await */ taskProcessCallback(function (newOngoingResult) {
-            resultSubject.next(newOngoingResult);
+            partialResultSubject.next(newOngoingResult);
         });
         function asPromise(options) {
             return __awaiter(this, void 0, void 0, function () {
@@ -2088,7 +2088,7 @@
             taskId: taskId,
             asPromise: asPromise,
             asObservable: function () {
-                return rxjs.concat(resultSubject.asObservable(), rxjs.from(asPromise({
+                return rxjs.concat(partialResultSubject.asObservable(), rxjs.from(asPromise({
                     isCrashedOnError: true,
                 })));
             },
@@ -5596,7 +5596,7 @@
             value = value.replace(/\.html$/, '');
         }
         else if (isValidFilePath(value)) {
-            value = path.basename(value);
+            value = node_path.basename(value);
             // Note: Keeping extension in the name
         }
         value = value.split('/').join('-');
@@ -5702,9 +5702,9 @@
                         }
                         basename = url.split('/').pop() || titleToName(url);
                         hash = sha256__default["default"](hexEncoder__default["default"].parse(url)).toString( /* hex */);
-                        rootDirname_1 = path.join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
-                        filepath = path.join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".").concat(mimeTypeToExtension(mimeType))], false));
-                        return [4 /*yield*/, tools.fs.mkdir(path.dirname(path.join(rootDirname_1, filepath)), { recursive: true })];
+                        rootDirname_1 = node_path.join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
+                        filepath = node_path.join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".").concat(mimeTypeToExtension(mimeType))], false));
+                        return [4 /*yield*/, tools.fs.mkdir(node_path.dirname(node_path.join(rootDirname_1, filepath)), { recursive: true })];
                     case 2:
                         _h.sent();
                         _g = (_f = Buffer).from;
@@ -5714,7 +5714,7 @@
                         if (fileContent.length > DEFAULT_MAX_FILE_SIZE /* <- TODO: Allow to pass different value to remote server */) {
                             throw new LimitReachedError("File is too large (".concat(Math.round(fileContent.length / 1024 / 1024), "MB). Maximum allowed size is ").concat(Math.round(DEFAULT_MAX_FILE_SIZE / 1024 / 1024), "MB."));
                         }
-                        return [4 /*yield*/, tools.fs.writeFile(path.join(rootDirname_1, filepath), fileContent)];
+                        return [4 /*yield*/, tools.fs.writeFile(node_path.join(rootDirname_1, filepath), fileContent)];
                     case 4:
                         _h.sent();
                         // TODO: [💵] Check the file security
@@ -5730,7 +5730,7 @@
                             throw new EnvironmentMismatchError('Can not import file knowledge in non-file pipeline');
                             //          <- TODO: [🧠] What is the best error type here`
                         }
-                        filename_1 = path.join(rootDirname, knowledgeSourceContent).split('\\').join('/');
+                        filename_1 = node_path.join(rootDirname, knowledgeSourceContent).split('\\').join('/');
                         fileExtension = getFileExtension(filename_1);
                         mimeType = extensionToMimeType(fileExtension || '');
                         return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
@@ -9726,7 +9726,7 @@
                 console.info(colors__default["default"].yellow(cwd) + ' ' + colors__default["default"].green(command) + ' ' + colors__default["default"].blue(args.join(' ')));
             }
             try {
-                var commandProcess = child_process.spawn(command, args, { cwd: cwd, shell: true });
+                var commandProcess = node_child_process.spawn(command, args, { cwd: cwd, shell: true });
                 if (isVerbose) {
                     commandProcess.on('message', function (message) {
                         console.info({ message: message });
@@ -9936,7 +9936,7 @@
     function locateAppOnWindows(_a) {
         var appName = _a.appName, windowsSuffix = _a.windowsSuffix;
         return __awaiter(this, void 0, void 0, function () {
-            var prefixes, prefixes_1, prefixes_1_1, prefix, path$1, e_1_1, error_1;
+            var prefixes, prefixes_1, prefixes_1_1, prefix, path, e_1_1, error_1;
             var e_1, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
@@ -9944,7 +9944,7 @@
                         _c.trys.push([0, 9, , 10]);
                         prefixes = [
                             process.env.LOCALAPPDATA,
-                            path.join(process.env.LOCALAPPDATA || '', 'Programs'),
+                            node_path.join(process.env.LOCALAPPDATA || '', 'Programs'),
                             process.env.PROGRAMFILES,
                             process.env['PROGRAMFILES(X86)'],
                         ];
@@ -9956,11 +9956,11 @@
                     case 2:
                         if (!!prefixes_1_1.done) return [3 /*break*/, 5];
                         prefix = prefixes_1_1.value;
-                        path$1 = prefix + windowsSuffix;
-                        return [4 /*yield*/, isExecutable(path$1, $provideFilesystemForNode())];
+                        path = prefix + windowsSuffix;
+                        return [4 /*yield*/, isExecutable(path, $provideFilesystemForNode())];
                     case 3:
                         if (_c.sent()) {
-                            return [2 /*return*/, path$1];
+                            return [2 /*return*/, path];
                         }
                         _c.label = 4;
                     case 4:
@@ -10356,7 +10356,7 @@
                     case 3:
                         if (!!envFilePatterns_1_1.done) return [3 /*break*/, 6];
                         pattern = envFilePatterns_1_1.value;
-                        envFilename = path.join(rootDirname, pattern);
+                        envFilename = node_path.join(rootDirname, pattern);
                         return [4 /*yield*/, isFileExisting(envFilename, $provideFilesystemForNode())];
                     case 4:
                         if (_b.sent()) {
@@ -10384,7 +10384,7 @@
                             return [3 /*break*/, 11];
                         }
                         // Note: If the directory does not exist, try the parent directory
-                        rootDirname = path.join(rootDirname, '..');
+                        rootDirname = node_path.join(rootDirname, '..');
                         _b.label = 10;
                     case 10:
                         i++;
@@ -11131,19 +11131,19 @@
      * @returns List of all files in the directory
      * @private internal function of `createCollectionFromDirectory`
      */
-    function listAllFiles(path$1, isRecursive, fs) {
+    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: return [4 /*yield*/, isDirectoryExisting(path$1, fs)];
+                    case 0: return [4 /*yield*/, isDirectoryExisting(path, fs)];
                     case 1:
                         if (!(_h.sent())) {
-                            throw new Error("Directory \"".concat(path$1, "\" does not exist or is not readable"));
+                            throw new Error("Directory \"".concat(path, "\" does not exist or is not readable"));
                             //           <- TODO: Use some custom error class
                         }
-                        return [4 /*yield*/, fs.readdir(path$1, {
+                        return [4 /*yield*/, fs.readdir(path, {
                                 withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
                             })];
                     case 2:
@@ -11152,7 +11152,7 @@
                             .filter(function (dirent) { return dirent.isFile(); })
                             .map(function (_a) {
                             var name = _a.name;
-                            return path.join(path$1, name).split('\\').join('/');
+                            return node_path.join(path, name).split('\\').join('/');
                         });
                         if (!isRecursive) return [3 /*break*/, 10];
                         _h.label = 3;
@@ -11163,7 +11163,7 @@
                     case 4:
                         if (!!_b.done) return [3 /*break*/, 7];
                         dirent = _b.value;
-                        subPath = path.join(path$1, dirent.name);
+                        subPath = node_path.join(path, dirent.name);
                         _d = (_c = fileNames.push).apply;
                         _e = [fileNames];
                         _f = [[]];
@@ -11294,7 +11294,7 @@
      * @returns PipelineCollection
      * @public exported from `@promptbook/node`
      */
-    function createCollectionFromDirectory(path$1, tools, options) {
+    function createCollectionFromDirectory(path, tools, options) {
         return __awaiter(this, void 0, void 0, function () {
             var madeLibraryFilePath, _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashedOnError, rootUrl, collection;
             var _this = this;
@@ -11311,7 +11311,7 @@
                             throw new EnvironmentMismatchError('Can not create collection without filesystem tools');
                             //          <- TODO: [🧠] What is the best error type here`
                         }
-                        madeLibraryFilePath = path.join(path$1, "".concat(DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME
+                        madeLibraryFilePath = node_path.join(path, "".concat(DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME
                         // <- TODO: [🦒] Allow to override (pass different value into the function)
                         , ".json"));
                         return [4 /*yield*/, isFileExisting(madeLibraryFilePath, tools.fs)];
@@ -11330,9 +11330,9 @@
                                 switch (_b.label) {
                                     case 0:
                                         if (isVerbose) {
-                                            console.info(colors__default["default"].cyan("Creating pipeline collection from path ".concat(path$1.split('\\').join('/'))));
+                                            console.info(colors__default["default"].cyan("Creating pipeline collection from path ".concat(path.split('\\').join('/'))));
                                         }
-                                        return [4 /*yield*/, listAllFiles(path$1, isRecursive, tools.fs)];
+                                        return [4 /*yield*/, listAllFiles(path, isRecursive, tools.fs)];
                                     case 1:
                                         fileNames = _b.sent();
                                         // Note: First load all .book.json and then .book.md files
@@ -11353,7 +11353,7 @@
                                                 switch (_f.label) {
                                                     case 0:
                                                         sourceFile = './' + fileName.split('\\').join('/');
-                                                        rootDirname = path.dirname(sourceFile).split('\\').join('/');
+                                                        rootDirname = node_path.dirname(sourceFile).split('\\').join('/');
                                                         _f.label = 1;
                                                     case 1:
                                                         _f.trys.push([1, 8, , 9]);
@@ -11547,7 +11547,7 @@
             var name = titleToName(key);
             var hash = sha256__default["default"](hexEncoder__default["default"].parse(name)).toString( /* hex */);
             //    <- TODO: [🥬] Encapsulate sha256 to some private utility function
-            return path.join.apply(void 0, __spreadArray(__spreadArray([this.options.rootFolderPath], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(name.substring(0, MAX_FILENAME_LENGTH), ".json")], false));
+            return node_path.join.apply(void 0, __spreadArray(__spreadArray([this.options.rootFolderPath], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(name.substring(0, MAX_FILENAME_LENGTH), ".json")], false));
         };
         /**
          * @@@ Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
@@ -11588,7 +11588,7 @@
                                 throw new UnexpectedError("The \"".concat(key, "\" you want to store in JSON file is not serializable as JSON"));
                             }
                             fileContent = stringifyPipelineJson(value);
-                            return [4 /*yield*/, promises.mkdir(path.dirname(filename), { recursive: true })];
+                            return [4 /*yield*/, promises.mkdir(node_path.dirname(filename), { recursive: true })];
                         case 1:
                             _a.sent(); // <- [0]
                             return [4 /*yield*/, promises.writeFile(filename, fileContent, 'utf-8')];