@promptbook/remote-server 0.85.0-9 → 0.85.0

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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.85.0-9",
+    "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/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.85.0-9"
+        "@promptbook/core": "0.85.0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -28,7 +28,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.85.0-8';
+    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
@@ -1488,57 +1488,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 URL.
      *
@@ -1581,16 +1530,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;
     }
     /**
@@ -7014,6 +6966,46 @@
                 }
             });
         }); });
+        // TODO: [🧠] Is it secure / good idea to expose source codes of hosted books
+        app.get("".concat(rootPath, "/books/*"), function (request, response) { return __awaiter(_this, void 0, void 0, function () {
+            var pipelines, fullUrl, pipelineUrl, pipeline, source, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 3, , 4]);
+                        if (collection === null) {
+                            response.status(500).send('No collection nor books available');
+                            return [2 /*return*/];
+                        }
+                        return [4 /*yield*/, collection.listPipelines()];
+                    case 1:
+                        pipelines = _a.sent();
+                        fullUrl = request.protocol + '://' + request.get('host') + request.originalUrl;
+                        pipelineUrl = pipelines.find(function (pipelineUrl) { return pipelineUrl.endsWith(request.originalUrl); }) || fullUrl;
+                        return [4 /*yield*/, collection.getPipelineByUrl(pipelineUrl)];
+                    case 2:
+                        pipeline = _a.sent();
+                        source = pipeline.sources[0];
+                        if (source === undefined || source.type !== 'BOOK') {
+                            throw new Error('Pipeline source is not a book');
+                        }
+                        response
+                            .type('text/markdown')
+                            .send(source.content);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _a.sent();
+                        if (!(error_1 instanceof Error)) {
+                            throw error_1;
+                        }
+                        response
+                            .status(404)
+                            .send({ error: serializeError(error_1) });
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        }); });
         app.get("".concat(rootPath, "/executions"), function (request, response) { return __awaiter(_this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 response.send(runningExecutionTasks);
@@ -7026,7 +7018,9 @@
                 taskId = request.params.taskId;
                 execution = runningExecutionTasks.find(function (executionTask) { return executionTask.taskId === taskId; });
                 if (execution === undefined) {
-                    response.status(404).send("Execution \"".concat(taskId, "\" not found"));
+                    response
+                        .status(404)
+                        .send("Execution \"".concat(taskId, "\" not found"));
                     return [2 /*return*/];
                 }
                 response.send(execution.currentValue);
@@ -7034,7 +7028,7 @@
             });
         }); });
         app.post("".concat(rootPath, "/executions/new"), function (request, response) { return __awaiter(_this, void 0, void 0, function () {
-            var _a, inputParameters, identification, pipelineUrl, pipeline, tools, pipelineExecutor, executionTask, error_1;
+            var _a, inputParameters, identification, pipelineUrl, pipeline, tools, pipelineExecutor, executionTask, error_2;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -7062,11 +7056,11 @@
                         response.send(executionTask);
                         return [3 /*break*/, 5];
                     case 4:
-                        error_1 = _b.sent();
-                        if (!(error_1 instanceof Error)) {
-                            throw error_1;
+                        error_2 = _b.sent();
+                        if (!(error_2 instanceof Error)) {
+                            throw error_2;
                         }
-                        response.status(400).send({ error: serializeError(error_1) });
+                        response.status(400).send({ error: serializeError(error_2) });
                         return [3 /*break*/, 5];
                     case 5: return [2 /*return*/];
                 }
@@ -7087,7 +7081,7 @@
             }
             // -----------
             socket.on('prompt-request', function (request) { return __awaiter(_this, void 0, void 0, function () {
-                var identification, prompt, tools, llm, _a, promptResult, _b, error_2;
+                var identification, prompt, tools, llm, _a, promptResult, _b, error_3;
                 return __generator(this, function (_c) {
                     switch (_c.label) {
                         case 0:
@@ -7156,11 +7150,11 @@
                             socket.emit('prompt-response', { promptResult: promptResult } /* <- Note: [🤛] */);
                             return [3 /*break*/, 15];
                         case 13:
-                            error_2 = _c.sent();
-                            if (!(error_2 instanceof Error)) {
-                                throw error_2;
+                            error_3 = _c.sent();
+                            if (!(error_3 instanceof Error)) {
+                                throw error_3;
                             }
-                            socket.emit('error', serializeError(error_2) /* <- Note: [🤛] */);
+                            socket.emit('error', serializeError(error_3) /* <- Note: [🤛] */);
                             return [3 /*break*/, 15];
                         case 14:
                             socket.disconnect();
@@ -7172,7 +7166,7 @@
             // -----------
             // TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
             socket.on('listModels-request', function (request) { return __awaiter(_this, void 0, void 0, function () {
-                var identification, tools, llm, models, error_3;
+                var identification, tools, llm, models, error_4;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -7193,11 +7187,11 @@
                             socket.emit('listModels-response', { models: models } /* <- Note: [🤛] */);
                             return [3 /*break*/, 6];
                         case 4:
-                            error_3 = _a.sent();
-                            if (!(error_3 instanceof Error)) {
-                                throw error_3;
+                            error_4 = _a.sent();
+                            if (!(error_4 instanceof Error)) {
+                                throw error_4;
                             }
-                            socket.emit('error', serializeError(error_3));
+                            socket.emit('error', serializeError(error_4));
                             return [3 /*break*/, 6];
                         case 5:
                             socket.disconnect();
@@ -7209,7 +7203,7 @@
             // -----------
             // TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
             socket.on('preparePipeline-request', function (request) { return __awaiter(_this, void 0, void 0, function () {
-                var identification, pipeline, tools, preparedPipeline, error_4;
+                var identification, pipeline, tools, preparedPipeline, error_5;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -7229,11 +7223,11 @@
                             socket.emit('preparePipeline-response', { preparedPipeline: preparedPipeline } /* <- Note: [🤛] */);
                             return [3 /*break*/, 6];
                         case 4:
-                            error_4 = _a.sent();
-                            if (!(error_4 instanceof Error)) {
-                                throw error_4;
+                            error_5 = _a.sent();
+                            if (!(error_5 instanceof Error)) {
+                                throw error_5;
                             }
-                            socket.emit('error', serializeError(error_4));
+                            socket.emit('error', serializeError(error_5));
                             return [3 /*break*/, 6];
                         case 5:
                             socket.disconnect();