@promptbook/remote-server 0.89.0-5 → 0.89.0-7

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-5';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-7';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -156,6 +158,7 @@ const DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹‍♂️]
  */
 const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
 // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
+// TODO: !!!!!! Just .promptbook dir, hardocode others
 /**
  * Where to store the temporary downloads
  *
@@ -207,9 +210,22 @@ const IS_PIPELINE_LOGIC_VALIDATED = just(
 true);
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
  */
 
+/**
+ * AuthenticationError is thrown from login function which is dependency of remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+class AuthenticationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'AuthenticationError';
+        Object.setPrototypeOf(this, AuthenticationError.prototype);
+    }
+}
+
 /**
  * Generates random token
  *
@@ -543,6 +559,7 @@ const COMMON_JAVASCRIPT_ERRORS = {
     TypeError,
     URIError,
     AggregateError,
+    AuthenticationError,
     /*
   Note: Not widely supported
   > InternalError,
@@ -578,6 +595,10 @@ function serializeError(error) {
 
                     Cannot serialize error with name "${name}"
 
+                    Authors of Promptbook probably forgot to add this error into the list of errors:
+                    https://github.com/webgptorg/promptbook/blob/main/src/errors/0-index.ts
+
+
                     ${block(stack || message)}
 
                 `));
@@ -6711,11 +6732,12 @@ async function $provideScriptingForNode(options) {
  * @public exported from `@promptbook/remote-server`
  */
 function startRemoteServer(options) {
-    const { port, collection, createLlmExecutionTools, isAnonymousModeAllowed, isApplicationModeAllowed, isVerbose = DEFAULT_IS_VERBOSE, } = {
+    const { port, collection, createLlmExecutionTools, isAnonymousModeAllowed, isApplicationModeAllowed, isVerbose = DEFAULT_IS_VERBOSE, login, } = {
         isAnonymousModeAllowed: false,
         isApplicationModeAllowed: false,
         collection: null,
         createLlmExecutionTools: null,
+        login: null,
         ...options,
     };
     // <- TODO: [🦪] Some helper type to be able to use discriminant union types with destructuring
@@ -6782,9 +6804,38 @@ 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`
+                },
+            ],
+        },
+        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));
     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')) {
@@ -6821,9 +6872,12 @@ function startRemoteServer(options) {
 
                     ## Paths
 
-                    ${block(app._router.stack
-            .map(({ route }) => (route === null || route === void 0 ? void 0 : route.path) || null)
-            .filter((path) => path !== null)
+                    ${block([
+            ...app._router.stack
+                .map(({ route }) => (route === null || route === void 0 ? void 0 : route.path) || null)
+                .filter((path) => path !== null),
+            '/api-docs',
+        ]
             .map((path) => `- ${path}`)
             .join('\n'))}
 
@@ -6841,8 +6895,81 @@ function startRemoteServer(options) {
                     https://github.com/webgptorg/promptbook
                 `));
     });
-    // TODO: !!!!!! Add login route
-    app.get(`${rootPath}/books`, async (request, response) => {
+    /**
+     * @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) => {
+        if (!isApplicationModeAllowed || login === null) {
+            response.status(400).send('Application mode is not allowed');
+            return;
+        }
+        try {
+            const username = request.body.username;
+            const password = request.body.password;
+            const appId = request.body.appId;
+            const identification = await login({ username, password, appId });
+            response.status(201).send({ identification });
+            return;
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            if (error instanceof AuthenticationError) {
+                response.status(401).send({ error: serializeError(error) });
+            }
+            console.warn(`Login function thrown different error than AuthenticationError`, {
+                error,
+                serializedError: serializeError(error),
+            });
+            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) => {
         if (collection === null) {
             response.status(500).send('No collection available');
             return;
@@ -6852,7 +6979,30 @@ function startRemoteServer(options) {
         response.send(pipelines);
     });
     // TODO: [🧠] Is it secure / good idea to expose source codes of hosted books
-    app.get(`${rootPath}/books/*`, async (request, response) => {
+    /**
+     * @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) => {
         try {
             if (collection === null) {
                 response.status(500).send('No collection nor books available');
@@ -6906,10 +7056,26 @@ function startRemoteServer(options) {
             };
         }
     }
-    app.get(`${rootPath}/executions`, async (request, response) => {
+    /**
+     * @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) => {
         response.send(runningExecutionTasks.map((runningExecutionTask) => exportExecutionTask(runningExecutionTask, false)));
     });
-    app.get(`${rootPath}/executions/last`, async (request, response) => {
+    app.get([`/executions/last`, `${rootPath}/executions/last`], async (request, response) => {
         // TODO: [🤬] Filter only for user
         if (runningExecutionTasks.length === 0) {
             response.status(404).send('No execution tasks found');
@@ -6918,7 +7084,7 @@ function startRemoteServer(options) {
         const lastExecutionTask = runningExecutionTasks[runningExecutionTasks.length - 1];
         response.send(exportExecutionTask(lastExecutionTask, true));
     });
-    app.get(`${rootPath}/executions/:taskId`, async (request, response) => {
+    app.get([`/executions/:taskId`, `${rootPath}/executions/:taskId`], async (request, response) => {
         const { taskId } = request.params;
         // TODO: [🤬] Filter only for user
         const executionTask = runningExecutionTasks.find((executionTask) => executionTask.taskId === taskId);
@@ -6930,7 +7096,36 @@ function startRemoteServer(options) {
         }
         response.send(exportExecutionTask(executionTask, true));
     });
-    app.post(`${rootPath}/executions/new`, async (request, response) => {
+    /**
+     * @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) => {
         try {
             const { inputParameters, identification /* <- [🤬] */ } = request.body;
             const pipelineUrl = request.body.pipelineUrl || request.body.book;