@promptbook/remote-server 0.89.0-4 → 0.89.0-6

package/esm/index.es.js

@@ -3,6 +3,8 @@ import express from 'express';
 import http from 'http';
 import { Server } from 'socket.io';
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
+import swaggerJsdoc from 'swagger-jsdoc';
+import swaggerUi from 'swagger-ui-express';
 import { forTime } from 'waitasecond';
 import { randomBytes } from 'crypto';
 import { spawn } from 'child_process';
@@ -31,7 +33,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.89.0-4';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-6';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -6782,9 +6784,37 @@ 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}`,
+                },
+            ],
+        },
+        apis: ['./src/remote-server/**/*.ts'], // Adjust path as needed
+    };
+    const swaggerSpec = swaggerJsdoc(swaggerOptions);
+    app.use(`${rootPath}/api-docs`, swaggerUi.serve, swaggerUi.setup(swaggerSpec));
     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) => {
         var _a;
         if ((_a = request.url) === null || _a === void 0 ? void 0 : _a.includes('socket.io')) {
@@ -6842,6 +6872,22 @@ function startRemoteServer(options) {
                 `));
     });
     // TODO: !!!!!! Add login route
+    /**
+     * @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(`${rootPath}/books`, async (request, response) => {
         if (collection === null) {
             response.status(500).send('No collection available');
@@ -6852,6 +6898,29 @@ 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(`${rootPath}/books/*`, async (request, response) => {
         try {
             if (collection === null) {
@@ -6906,6 +6975,22 @@ 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(`${rootPath}/executions`, async (request, response) => {
         response.send(runningExecutionTasks.map((runningExecutionTask) => exportExecutionTask(runningExecutionTask, false)));
     });
@@ -6930,6 +7015,35 @@ 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(`${rootPath}/executions/new`, async (request, response) => {
         try {
             const { inputParameters, identification /* <- [🤬] */ } = request.body;
@@ -7107,6 +7221,15 @@ function startRemoteServer(options) {
     }
     let isDestroyed = false;
     return {
+        get httpServer() {
+            return httpServer;
+        },
+        get expressApp() {
+            return app;
+        },
+        get socketIoServer() {
+            return server;
+        },
         get isDestroyed() {
             return isDestroyed;
         },