@promptbook/node 0.85.0-8 → 0.85.0

package/esm/typings/src/cli/cli-commands/about.d.ts

@@ -8,7 +8,6 @@ import type { Command as Program } from 'commander';
  */
 export declare function $initializeAboutCommand(program: Program): void;
 /**
- * TODO: !!! Test this in `deno`
  * TODO: [🗽] Unite branding and make single place for it
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
  *
- * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book.md` file is located
  *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
@@ -51,13 +51,13 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
  *
  * Note: Works only in Node.js environment because it reads the file system
  *
- * @param path - path to the directory with pipelines
+ * @param rootPath - path to the directory with pipelines
  * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
  * @param options - Options for the collection creation
  * @returns PipelineCollection
  * @public exported from `@promptbook/node`
  */
-export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed

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

@@ -11,8 +11,7 @@ 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: !! Add CORS and security - probbably via `helmet`
  * 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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.85.0-8",
+    "version": "0.85.0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -42,12 +42,12 @@
     "bugs": {
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
-    "homepage": "https://www.npmjs.com/package/@promptbook/core",
+    "homepage": "https://ptbk.io/",
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.85.0-8"
+        "@promptbook/core": "0.85.0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -45,7 +45,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.85.0-7';
+    var PROMPTBOOK_ENGINE_VERSION = '0.85.0-16';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1152,57 +1152,6 @@
         return true;
     }
 
-    /**
-     * Checks if an URL is reserved for private networks or localhost.
-     *
-     * Note: There are two simmilar functions:
-     * - `isUrlOnPrivateNetwork` which tests full URL
-     * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    function isHostnameOnPrivateNetwork(hostname) {
-        if (hostname === 'example.com' ||
-            hostname === 'localhost' ||
-            hostname.endsWith('.localhost') ||
-            hostname.endsWith('.local') ||
-            hostname.endsWith('.test') ||
-            hostname === '127.0.0.1' ||
-            hostname === '::1') {
-            return true;
-        }
-        if (hostname.includes(':')) {
-            // IPv6
-            var ipParts = hostname.split(':');
-            return ipParts[0] === 'fc00' || ipParts[0] === 'fd00' || ipParts[0] === 'fe80';
-        }
-        else {
-            // IPv4
-            var ipParts = hostname.split('.').map(function (part) { return Number.parseInt(part, 10); });
-            return (ipParts[0] === 10 ||
-                (ipParts[0] === 172 && ipParts[1] >= 16 && ipParts[1] <= 31) ||
-                (ipParts[0] === 192 && ipParts[1] === 168));
-        }
-    }
-
-    /**
-     * Checks if an IP address or hostname is reserved for private networks or localhost.
-     *
-     * Note: There are two simmilar functions:
-     * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
-     * - `isHostnameOnPrivateNetwork` which tests just hostname
-     *
-     * @param {string} ipAddress - The IP address to check.
-     * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
-     * @public exported from `@promptbook/utils`
-     */
-    function isUrlOnPrivateNetwork(url) {
-        if (typeof url === 'string') {
-            url = new URL(url);
-        }
-        return isHostnameOnPrivateNetwork(url.hostname);
-    }
-
     /**
      * Tests if given string is valid pipeline URL URL.
      *
@@ -1216,16 +1165,19 @@
         if (!isValidUrl(url)) {
             return false;
         }
-        if (!url.startsWith('https://')) {
+        if (!url.startsWith('https://') && !url.startsWith('http://') /* <- Note: [👣] */) {
             return false;
         }
         if (url.includes('#')) {
             // TODO: [🐠]
             return false;
         }
+        /*
+        Note: [👣][🧠] Is it secure to allow pipeline URLs on private and unsecured networks?
         if (isUrlOnPrivateNetwork(url)) {
             return false;
         }
+        */
         return true;
     }
     /**
@@ -2060,18 +2012,16 @@
      */
     function createTask(options) {
         var taskType = options.taskType, taskProcessCallback = options.taskProcessCallback;
-        var taskId = "".concat(taskType.toLowerCase().substring(0, 4), "-").concat($randomToken(8 /* <- TODO: !!! To global config + Use Base58 to avoid simmilar char conflicts   */));
+        var taskId = "".concat(taskType.toLowerCase().substring(0, 4), "-").concat($randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */));
         var partialResultSubject = new rxjs.BehaviorSubject({});
         var finalResultPromise = /* not await */ taskProcessCallback(function (newOngoingResult) {
             partialResultSubject.next(newOngoingResult);
         });
         finalResultPromise
             .catch(function (error) {
-            // console.error('!!!!! Task failed:', error);
             partialResultSubject.error(error);
         })
             .then(function (value) {
-            // console.error('!!!!! Task finished:', value);
             if (value) {
                 try {
                     assertsTaskSuccessful(value);
@@ -2093,9 +2043,7 @@
                             return [4 /*yield*/, finalResultPromise];
                         case 1:
                             finalResult = _b.sent();
-                            console.error('!!!!! finalResult:', finalResult);
                             if (isCrashedOnError) {
-                                console.error('!!!!! isCrashedOnError:', finalResult);
                                 assertsTaskSuccessful(finalResult);
                             }
                             return [2 /*return*/, finalResult];
@@ -11309,13 +11257,13 @@
      *
      * Note: Works only in Node.js environment because it reads the file system
      *
-     * @param path - path to the directory with pipelines
+     * @param rootPath - path to the directory with pipelines
      * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
      * @param options - Options for the collection creation
      * @returns PipelineCollection
      * @public exported from `@promptbook/node`
      */
-    function createCollectionFromDirectory(path$1, tools, options) {
+    function createCollectionFromDirectory(rootPath, 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;
@@ -11332,7 +11280,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 = path.join(rootPath, "".concat(DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME
                         // <- TODO: [🦒] Allow to override (pass different value into the function)
                         , ".json"));
                         return [4 /*yield*/, isFileExisting(madeLibraryFilePath, tools.fs)];
@@ -11351,18 +11299,18 @@
                                 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(rootPath.split('\\').join('/'))));
                                         }
-                                        return [4 /*yield*/, listAllFiles(path$1, isRecursive, tools.fs)];
+                                        return [4 /*yield*/, listAllFiles(rootPath, isRecursive, tools.fs)];
                                     case 1:
                                         fileNames = _b.sent();
-                                        // Note: First load all .book.json and then .book.md files
-                                        //       .book.json can be prepared so it is faster to load
+                                        // Note: First load all `.book.json` and then `.book` / `.book.md` files
+                                        //       `.book.json` can be prepared so it is faster to load
                                         fileNames.sort(function (a, b) {
-                                            if (a.endsWith('.json') && b.endsWith('.md')) {
+                                            if (a.endsWith('.json') && (b.endsWith('.book') || b.endsWith('.book.md'))) {
                                                 return -1;
                                             }
-                                            if (a.endsWith('.md') && b.endsWith('.json')) {
+                                            if ((a.endsWith('.book') || a.endsWith('.book.md')) && b.endsWith('.json')) {
                                                 return 1;
                                             }
                                             return 0;
@@ -11379,7 +11327,7 @@
                                                     case 1:
                                                         _f.trys.push([1, 8, , 9]);
                                                         pipeline = null;
-                                                        if (!fileName.endsWith('.book.md')) return [3 /*break*/, 4];
+                                                        if (!(fileName.endsWith('.book') || fileName.endsWith('.book.md'))) return [3 /*break*/, 4];
                                                         _c = validatePipelineString;
                                                         return [4 /*yield*/, promises.readFile(fileName, 'utf-8')];
                                                     case 2:
@@ -11411,7 +11359,8 @@
                                                         if (pipeline !== null) {
                                                             if (rootUrl !== undefined) {
                                                                 if (pipeline.pipelineUrl === undefined) {
-                                                                    pipelineUrl = rootUrl + '/' + fileName.split('\\').join('/');
+                                                                    pipelineUrl = rootUrl + '/' + path.relative(rootPath, fileName).split('\\').join('/');
+                                                                    // console.log({ pipelineUrl, rootPath, rootUrl, fileName });
                                                                     if (isVerbose) {
                                                                         console.info(colors__default["default"].yellow("Implicitly set pipeline URL to ".concat(pipelineUrl, " from ").concat(fileName
                                                                             .split('\\')