@promptbook/remote-server 0.89.0-20 → 0.89.0-28

package/umd/index.umd.js

@@ -1,16 +1,34 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('express'), require('http'), require('socket.io'), require('spacetrim'), require('swagger-jsdoc'), require('swagger-ui-express'), require('waitasecond'), require('crypto'), require('child_process'), require('fs/promises'), require('path'), require('rxjs'), require('prettier'), require('prettier/parser-html'), require('crypto-js/enc-hex'), require('crypto-js/sha256'), require('crypto-js'), require('mime-types'), require('papaparse')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'express', 'http', 'socket.io', 'spacetrim', 'swagger-jsdoc', 'swagger-ui-express', 'waitasecond', 'crypto', 'child_process', 'fs/promises', 'path', 'rxjs', 'prettier', 'prettier/parser-html', 'crypto-js/enc-hex', 'crypto-js/sha256', 'crypto-js', 'mime-types', 'papaparse'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-remote-server"] = {}, global.colors, global.express, global.http, global.socket_io, global.spaceTrim, global.swaggerJsdoc, global.swaggerUi, global.waitasecond, global.crypto, global.child_process, global.promises, global.path, global.rxjs, global.prettier, global.parserHtml, global.hexEncoder, global.sha256, global.cryptoJs, global.mimeTypes, global.papaparse));
-})(this, (function (exports, colors, express, http, socket_io, spaceTrim, swaggerJsdoc, swaggerUi, waitasecond, crypto, child_process, promises, path, rxjs, prettier, parserHtml, hexEncoder, sha256, cryptoJs, mimeTypes, papaparse) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('express'), require('http'), require('socket.io'), require('spacetrim'), require('express-openapi-validator'), require('swagger-ui-express'), require('waitasecond'), require('crypto'), require('child_process'), require('fs/promises'), require('path'), require('rxjs'), require('prettier'), require('prettier/parser-html'), require('crypto-js/enc-hex'), require('crypto-js/sha256'), require('crypto-js'), require('mime-types'), require('papaparse')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'express', 'http', 'socket.io', 'spacetrim', 'express-openapi-validator', 'swagger-ui-express', 'waitasecond', 'crypto', 'child_process', 'fs/promises', 'path', 'rxjs', 'prettier', 'prettier/parser-html', 'crypto-js/enc-hex', 'crypto-js/sha256', 'crypto-js', 'mime-types', 'papaparse'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-remote-server"] = {}, global.colors, global.express, global.http, global.socket_io, global.spaceTrim, global.OpenApiValidator, global.swaggerUi, global.waitasecond, global.crypto, global.child_process, global.promises, global.path, global.rxjs, global.prettier, global.parserHtml, global.hexEncoder, global.sha256, global.cryptoJs, global.mimeTypes, global.papaparse));
+})(this, (function (exports, colors, express, http, socket_io, spaceTrim, OpenApiValidator, swaggerUi, waitasecond, crypto, child_process, promises, path, rxjs, prettier, parserHtml, hexEncoder, sha256, cryptoJs, mimeTypes, papaparse) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
+    function _interopNamespace(e) {
+        if (e && e.__esModule) return e;
+        var n = Object.create(null);
+        if (e) {
+            Object.keys(e).forEach(function (k) {
+                if (k !== 'default') {
+                    var d = Object.getOwnPropertyDescriptor(e, k);
+                    Object.defineProperty(n, k, d.get ? d : {
+                        enumerable: true,
+                        get: function () { return e[k]; }
+                    });
+                }
+            });
+        }
+        n["default"] = e;
+        return Object.freeze(n);
+    }
+
     var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
     var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
     var http__default = /*#__PURE__*/_interopDefaultLegacy(http);
     var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
-    var swaggerJsdoc__default = /*#__PURE__*/_interopDefaultLegacy(swaggerJsdoc);
+    var OpenApiValidator__namespace = /*#__PURE__*/_interopNamespace(OpenApiValidator);
     var swaggerUi__default = /*#__PURE__*/_interopDefaultLegacy(swaggerUi);
     var parserHtml__default = /*#__PURE__*/_interopDefaultLegacy(parserHtml);
     var hexEncoder__default = /*#__PURE__*/_interopDefaultLegacy(hexEncoder);
@@ -30,7 +48,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-20';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-28';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -6775,6 +6793,198 @@
      * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
      */
 
+    // TODO: !!! List running services from REMOTE_SERVER_URLS
+    // TODO: !!! Import directly from YML
+    /**
+     * @private !!!! Decide how to expose this
+     */
+    const openapiJson = {
+        openapi: '3.0.0',
+        info: {
+            title: 'Promptbook Remote Server API (!!! From TS)',
+            version: '1.0.0',
+            description: 'API documentation for the Promptbook Remote Server',
+        },
+        paths: {
+            '/': {
+                get: {
+                    summary: 'Get server details',
+                    description: 'Returns details about the Promptbook server.',
+                    responses: {
+                        '200': {
+                            description: 'Server details in markdown format.',
+                        },
+                    },
+                },
+            },
+            '/login': {
+                post: {
+                    summary: 'Login to the server',
+                    description: 'Login to the server and get identification.',
+                    requestBody: {
+                        required: true,
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: 'object',
+                                    properties: {
+                                        username: {
+                                            type: 'string',
+                                        },
+                                        password: {
+                                            type: 'string',
+                                        },
+                                        appId: {
+                                            type: 'string',
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                    responses: {
+                        '200': {
+                            description: 'Successful login',
+                            content: {
+                                'application/json': {
+                                    schema: {
+                                        type: 'object',
+                                        properties: {
+                                            identification: {
+                                                type: 'object',
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            '/books': {
+                get: {
+                    summary: 'List all books',
+                    description: 'Returns a list of all available books in the collection.',
+                    responses: {
+                        '200': {
+                            description: 'A list of books.',
+                            content: {
+                                'application/json': {
+                                    schema: {
+                                        type: 'array',
+                                        items: {
+                                            type: 'string',
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            '/books/{bookId}': {
+                get: {
+                    summary: 'Get book content',
+                    description: 'Returns the content of a specific book.',
+                    parameters: [
+                        {
+                            in: 'path',
+                            name: 'bookId',
+                            required: true,
+                            schema: {
+                                type: 'string',
+                            },
+                            description: 'The ID of the book to retrieve.',
+                        },
+                    ],
+                    responses: {
+                        '200': {
+                            description: 'The content of the book.',
+                            content: {
+                                'text/markdown': {
+                                    schema: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                        '404': {
+                            description: 'Book not found.',
+                        },
+                    },
+                },
+            },
+            '/executions': {
+                get: {
+                    summary: 'List all executions',
+                    description: 'Returns a list of all running execution tasks.',
+                    responses: {
+                        '200': {
+                            description: 'A list of execution tasks.',
+                            content: {
+                                'application/json': {
+                                    schema: {
+                                        type: 'array',
+                                        items: {
+                                            type: 'object',
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            '/executions/new': {
+                post: {
+                    summary: 'Start a new execution',
+                    description: 'Starts a new execution task for a given pipeline.',
+                    requestBody: {
+                        required: true,
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: 'object',
+                                    properties: {
+                                        pipelineUrl: {
+                                            type: 'string',
+                                        },
+                                        inputParameters: {
+                                            type: 'object',
+                                        },
+                                        identification: {
+                                            type: 'object',
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                    responses: {
+                        '200': {
+                            description: 'The newly created execution task.',
+                            content: {
+                                'application/json': {
+                                    schema: {
+                                        type: 'object',
+                                    },
+                                },
+                            },
+                        },
+                        '400': {
+                            description: 'Invalid input.',
+                        },
+                    },
+                },
+            },
+        },
+        components: {},
+        tags: [],
+    };
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
      *
@@ -6793,22 +7003,6 @@
             login: null,
             ...options,
         };
-        // <- TODO: [🦪] Some helper type to be able to use discriminant union types with destructuring
-        let { rootPath = '/' } = options;
-        if (!rootPath.startsWith('/')) {
-            rootPath = `/${rootPath}`;
-        } /* not else */
-        if (rootPath.endsWith('/')) {
-            rootPath = rootPath.slice(0, -1);
-        } /* not else */
-        if (rootPath === '/') {
-            rootPath = '';
-        }
-        const socketioPath = '/' +
-            `${rootPath}/socket.io`
-                .split('/')
-                .filter((part) => part !== '')
-                .join('/');
         const startupDate = new Date();
         async function getExecutionToolsFromIdentification(identification) {
             if (identification === null || identification === undefined) {
@@ -6865,39 +7059,34 @@
             response.setHeader('X-Powered-By', 'Promptbook engine');
             next();
         });
-        const swaggerOptions = {
-            definition: {
-                openapi: '3.0.0',
-                info: {
-                    title: 'Promptbook Remote Server API',
-                    version: '1.0.0',
-                    description: 'API documentation for the Promptbook Remote Server',
-                },
-                servers: [
-                    {
-                        url: `http://localhost:${port}${rootPath}`,
-                        // <- TODO: !!!!! Probbably: Pass `remoteServerUrl` instead of `port` and `rootPath`
-                    },
-                ],
+        // TODO: !!! Expose openapiJson to consumer and also allow to add new routes
+        app.use(OpenApiValidator__namespace.middleware({
+            apiSpec: openapiJson,
+            // TODO: !!! Adjust
+            ignorePaths(...args) {
+                console.warn(`!!! Ignoring paths`, ...args);
+                return true;
             },
-            apis: ['./src/remote-server/**/*.ts'], // Adjust path as needed
-        };
-        const swaggerSpec = swaggerJsdoc__default["default"](swaggerOptions);
-        app.use([`/api-docs`, `${rootPath}/api-docs`], swaggerUi__default["default"].serve, swaggerUi__default["default"].setup(swaggerSpec));
+            // TODO: !!! Validate both
+            validateRequests: false,
+            validateResponses: false, // false by default
+        }));
+        app.use([`/api-docs`, `/swagger`], swaggerUi__default["default"].serve, swaggerUi__default["default"].setup(openapiJson, {
+        // customCss: '.swagger-ui .topbar { display: none }',
+        // customSiteTitle: 'BRJ API',
+        // customfavIcon: 'https://brj.app/favicon.ico',
+        }));
+        app.get(`/openapi`, (request, response) => {
+            response.json(openapiJson);
+        });
+        // TODO: !!! Remove:
+        app.get(`/xxx`, (request, response) => {
+            response.json(openapiJson);
+        });
         const runningExecutionTasks = [];
         // <- TODO: [🤬] Identify the users
         // TODO: [🧠] Do here some garbage collection of finished tasks
-        /**
-         * @swagger
-         * /:
-         *   get:
-         *     summary: Get server details
-         *     description: Returns details about the Promptbook server.
-         *     responses:
-         *       200:
-         *         description: Server details in markdown format.
-         */
-        app.get(['/', rootPath], async (request, response) => {
+        app.get('/', async (request, response) => {
             var _a;
             if ((_a = request.url) === null || _a === void 0 ? void 0 : _a.includes('socket.io')) {
                 return;
@@ -6916,8 +7105,6 @@
                     ## Details
 
                     **Server port:** ${port}
-                    **Server root path:** ${rootPath}
-                    **Socket.io path:** ${socketioPath}
                     **Startup date:** ${startupDate.toISOString()}
                     **Anonymouse mode:** ${isAnonymousModeAllowed ? 'enabled' : 'disabled'}
                     **Application mode:** ${isApplicationModeAllowed ? 'enabled' : 'disabled'}
@@ -6956,38 +7143,7 @@
                     https://github.com/webgptorg/promptbook
                 `));
         });
-        /**
-         * @swagger
-         *
-         * /login:
-         *  post:
-         *   summary: Login to the server
-         *   description: Login to the server and get identification.
-         *   requestBody:
-         *    required: true
-         *    content:
-         *     application/json:
-         *      schema:
-         *       type: object
-         *       properties:
-         *        username:
-         *         type: string
-         *        password:
-         *         type: string
-         *        appId:
-         *         type: string
-         *   responses:
-         *    200:
-         *     description: Successful login
-         *     content:
-         *      application/json:
-         *       schema:
-         *        type: object
-         *        properties:
-         *         identification:
-         *          type: object
-         */
-        app.post([`/login`, `${rootPath}/login`], async (request, response) => {
+        app.post(`/login`, async (request, response) => {
             if (!isApplicationModeAllowed || login === null) {
                 response.status(400).send('Application mode is not allowed');
                 return;
@@ -7027,23 +7183,7 @@
                 response.status(400).send({ error: serializeError(error) });
             }
         });
-        /**
-         * @swagger
-         * /books:
-         *   get:
-         *     summary: List all books
-         *     description: Returns a list of all available books in the collection.
-         *     responses:
-         *       200:
-         *         description: A list of books.
-         *         content:
-         *           application/json:
-         *             schema:
-         *               type: array
-         *               items:
-         *                 type: string
-         */
-        app.get([`/books`, `${rootPath}/books`], async (request, response) => {
+        app.get(`/books`, async (request, response) => {
             if (collection === null) {
                 response.status(500).send('No collection available');
                 return;
@@ -7053,30 +7193,7 @@
             response.send(pipelines);
         });
         // TODO: [🧠] Is it secure / good idea to expose source codes of hosted books
-        /**
-         * @swagger
-         * /books/{bookId}:
-         *   get:
-         *     summary: Get book content
-         *     description: Returns the content of a specific book.
-         *     parameters:
-         *       - in: path
-         *         name: bookId
-         *         required: true
-         *         schema:
-         *           type: string
-         *         description: The ID of the book to retrieve.
-         *     responses:
-         *       200:
-         *         description: The content of the book.
-         *         content:
-         *           text/markdown:
-         *             schema:
-         *               type: string
-         *       404:
-         *         description: Book not found.
-         */
-        app.get([`/books/*`, `${rootPath}/books/*`], async (request, response) => {
+        app.get(`/books/*`, async (request, response) => {
             try {
                 if (collection === null) {
                     response.status(500).send('No collection nor books available');
@@ -7128,26 +7245,10 @@
                 };
             }
         }
-        /**
-         * @swagger
-         * /executions:
-         *   get:
-         *     summary: List all executions
-         *     description: Returns a list of all running execution tasks.
-         *     responses:
-         *       200:
-         *         description: A list of execution tasks.
-         *         content:
-         *           application/json:
-         *             schema:
-         *               type: array
-         *               items:
-         *                 type: object
-         */
-        app.get([`/executions`, `${rootPath}/executions`], async (request, response) => {
+        app.get(`/executions`, async (request, response) => {
             response.send(runningExecutionTasks.map((runningExecutionTask) => exportExecutionTask(runningExecutionTask, false)));
         });
-        app.get([`/executions/last`, `${rootPath}/executions/last`], async (request, response) => {
+        app.get(`/executions/last`, async (request, response) => {
             // TODO: [🤬] Filter only for user
             if (runningExecutionTasks.length === 0) {
                 response.status(404).send('No execution tasks found');
@@ -7156,7 +7257,7 @@
             const lastExecutionTask = runningExecutionTasks[runningExecutionTasks.length - 1];
             response.send(exportExecutionTask(lastExecutionTask, true));
         });
-        app.get([`/executions/:taskId`, `${rootPath}/executions/:taskId`], async (request, response) => {
+        app.get(`/executions/:taskId`, async (request, response) => {
             const { taskId } = request.params;
             // TODO: [🤬] Filter only for user
             const executionTask = runningExecutionTasks.find((executionTask) => executionTask.taskId === taskId);
@@ -7168,36 +7269,7 @@
             }
             response.send(exportExecutionTask(executionTask, true));
         });
-        /**
-         * @swagger
-         * /executions/new:
-         *   post:
-         *     summary: Start a new execution
-         *     description: Starts a new execution task for a given pipeline.
-         *     requestBody:
-         *       required: true
-         *       content:
-         *         application/json:
-         *           schema:
-         *             type: object
-         *             properties:
-         *               pipelineUrl:
-         *                 type: string
-         *               inputParameters:
-         *                 type: object
-         *               identification:
-         *                 type: object
-         *     responses:
-         *       200:
-         *         description: The newly created execution task.
-         *         content:
-         *           application/json:
-         *             schema:
-         *               type: object
-         *       400:
-         *         description: Invalid input.
-         */
-        app.post([`/executions/new`, `${rootPath}/executions/new`], async (request, response) => {
+        app.post(`/executions/new`, async (request, response) => {
             try {
                 const { inputParameters, identification /* <- [🤬] */ } = request.body;
                 const pipelineUrl = request.body.pipelineUrl || request.body.book;
@@ -7246,11 +7318,12 @@
         });
         const httpServer = http__default["default"].createServer(app);
         const server = new socket_io.Server(httpServer, {
-            path: socketioPath,
-            transports: [/*'websocket', <- TODO: [🌬] Make websocket transport work */ 'polling'],
+            path: '/socket.io',
+            transports: ['polling', 'websocket' /*, <- TODO: [🌬] Allow to pass `transports`, add 'webtransport' */],
             cors: {
                 origin: '*',
                 methods: ['GET', 'POST'],
+                // <- TODO: [🌡] Allow to pass
             },
         });
         server.on('connection', (socket) => {
@@ -7395,7 +7468,7 @@
         };
     }
     /**
-     * TODO: !! Add CORS and security - probbably via `helmet`
+     * TODO: [🌡] Add CORS and security - probbably via `helmet`
      * TODO: Split this file into multiple functions - handler for each request
      * TODO: Maybe use `$exportJson`
      * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`