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

package/esm/index.es.js

@@ -3,7 +3,7 @@ import express from 'express';
 import http from 'http';
 import { Server } from 'socket.io';
 import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
-import swaggerJsdoc from 'swagger-jsdoc';
+import * as OpenApiValidator from 'express-openapi-validator';
 import swaggerUi from 'swagger-ui-express';
 import { forTime } from 'waitasecond';
 import { randomBytes } from 'crypto';
@@ -33,7 +33,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @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
@@ -6778,6 +6778,198 @@ async function $provideScriptingForNode(options) {
  * 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.
  *
@@ -6796,22 +6988,6 @@ function startRemoteServer(options) {
         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) {
@@ -6868,39 +7044,34 @@ function startRemoteServer(options) {
         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.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(swaggerOptions);
-    app.use([`/api-docs`, `${rootPath}/api-docs`], swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+        // TODO: !!! Validate both
+        validateRequests: false,
+        validateResponses: false, // false by default
+    }));
+    app.use([`/api-docs`, `/swagger`], swaggerUi.serve, swaggerUi.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;
@@ -6919,8 +7090,6 @@ function startRemoteServer(options) {
                     ## 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'}
@@ -6959,38 +7128,7 @@ function startRemoteServer(options) {
                     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;
@@ -7030,23 +7168,7 @@ function startRemoteServer(options) {
             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;
@@ -7056,30 +7178,7 @@ function startRemoteServer(options) {
         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');
@@ -7131,26 +7230,10 @@ function startRemoteServer(options) {
             };
         }
     }
-    /**
-     * @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');
@@ -7159,7 +7242,7 @@ function startRemoteServer(options) {
         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);
@@ -7171,36 +7254,7 @@ function startRemoteServer(options) {
         }
         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;
@@ -7249,11 +7303,12 @@ function startRemoteServer(options) {
     });
     const httpServer = http.createServer(app);
     const server = new 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) => {
@@ -7398,7 +7453,7 @@ function startRemoteServer(options) {
     };
 }
 /**
- * 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'`