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

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('express'), require('http'), require('socket.io'), require('spacetrim'), 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', '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.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, 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('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';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -10,6 +10,8 @@
     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 swaggerUi__default = /*#__PURE__*/_interopDefaultLegacy(swaggerUi);
     var parserHtml__default = /*#__PURE__*/_interopDefaultLegacy(parserHtml);
     var hexEncoder__default = /*#__PURE__*/_interopDefaultLegacy(hexEncoder);
     var sha256__default = /*#__PURE__*/_interopDefaultLegacy(sha256);
@@ -28,7 +30,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-2';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-20';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -82,6 +84,7 @@
      * @public exported from `@promptbook/core`
      */
     const CLAIM = `It's time for a paradigm shift. The future of software in plain English, French or Latin`;
+    //            <- TODO: [🐊] Pick the best claim
     /**
      * When the title is not provided, the default title is used
      *
@@ -114,6 +117,7 @@
         infinity: '(infinity; ∞)',
         negativeInfinity: '(negative infinity; -∞)',
         unserializable: '(unserializable value)',
+        circular: '(circular JSON)',
     };
     /**
      * Small number limit
@@ -153,6 +157,7 @@
      */
     const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
     // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
+    // TODO: Just `.promptbook` in config, hardcode subfolders like `download-cache` or `execution-cache`
     /**
      * Where to store the temporary downloads
      *
@@ -204,9 +209,138 @@
     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
      */
 
+    /**
+     * Make error report URL for the given error
+     *
+     * @private private within the repository
+     */
+    function getErrorReportUrl(error) {
+        const report = {
+            title: `🐜 Error report from ${NAME}`,
+            body: spaceTrim__default["default"]((block) => `
+
+
+            \`${error.name || 'Error'}\` has occurred in the [${NAME}], please look into it @${ADMIN_GITHUB_NAME}.
+
+            \`\`\`
+            ${block(error.message || '(no error message)')}
+            \`\`\`
+
+
+            ## More info:
+
+            - **Promptbook engine version:** ${PROMPTBOOK_ENGINE_VERSION}
+            - **Book language version:** ${BOOK_LANGUAGE_VERSION}
+            - **Time:** ${new Date().toISOString()}
+
+            <details>
+            <summary>Stack trace:</summary>
+
+            ## Stack trace:
+
+            \`\`\`stacktrace
+            ${block(error.stack || '(empty)')}
+            \`\`\`
+            </details>
+
+        `),
+        };
+        const reportUrl = new URL(`https://github.com/webgptorg/promptbook/issues/new`);
+        reportUrl.searchParams.set('labels', 'bug');
+        reportUrl.searchParams.set('assignees', ADMIN_GITHUB_NAME);
+        reportUrl.searchParams.set('title', report.title);
+        reportUrl.searchParams.set('body', report.body);
+        return reportUrl;
+    }
+
+    /**
+     * This error type indicates that the error should not happen and its last check before crashing with some other error
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class UnexpectedError extends Error {
+        constructor(message) {
+            super(spaceTrim.spaceTrim((block) => `
+                    ${block(message)}
+
+                    Note: This error should not happen.
+                    It's probbably a bug in the pipeline collection
+
+                    Please report issue:
+                    ${block(getErrorReportUrl(new Error(message)).href)}
+
+                    Or contact us on ${ADMIN_EMAIL}
+
+                `));
+            this.name = 'UnexpectedError';
+            Object.setPrototypeOf(this, UnexpectedError.prototype);
+        }
+    }
+
+    /**
+     * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class WrappedError extends Error {
+        constructor(whatWasThrown) {
+            const tag = `[🤮]`;
+            console.error(tag, whatWasThrown);
+            super(spaceTrim.spaceTrim(`
+                Non-Error object was thrown
+
+                Note: Look for ${tag} in the console for more details
+                Please report issue on ${ADMIN_EMAIL}
+            `));
+            this.name = 'WrappedError';
+            Object.setPrototypeOf(this, WrappedError.prototype);
+        }
+    }
+
+    /**
+     * Helper used in catch blocks to assert that the error is an instance of `Error`
+     *
+     * @param whatWasThrown Any object that was thrown
+     * @returns Nothing if the error is an instance of `Error`
+     * @throws `WrappedError` or `UnexpectedError` if the error is not standard
+     *
+     * @private within the repository
+     */
+    function assertsError(whatWasThrown) {
+        // Case 1: Handle error which was rethrown as `WrappedError`
+        if (whatWasThrown instanceof WrappedError) {
+            const wrappedError = whatWasThrown;
+            throw wrappedError;
+        }
+        // Case 2: Handle unexpected errors
+        if (whatWasThrown instanceof UnexpectedError) {
+            const unexpectedError = whatWasThrown;
+            throw unexpectedError;
+        }
+        // Case 3: Handle standard errors - keep them up to consumer
+        if (whatWasThrown instanceof Error) {
+            return;
+        }
+        // Case 4: Handle non-standard errors - wrap them into `WrappedError` and throw
+        throw new WrappedError(whatWasThrown);
+    }
+
+    /**
+     * 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
      *
@@ -238,7 +372,7 @@
         }
     }
     /**
-     * TODO: !!!!!! Add id to all errors
+     * TODO: [🧠][🌂] Add id to all errors
      */
 
     /**
@@ -436,70 +570,15 @@
     }
 
     /**
-     * Make error report URL for the given error
-     *
-     * @private private within the repository
-     */
-    function getErrorReportUrl(error) {
-        const report = {
-            title: `🐜 Error report from ${NAME}`,
-            body: spaceTrim__default["default"]((block) => `
-
-
-            \`${error.name || 'Error'}\` has occurred in the [${NAME}], please look into it @${ADMIN_GITHUB_NAME}.
-
-            \`\`\`
-            ${block(error.message || '(no error message)')}
-            \`\`\`
-
-
-            ## More info:
-
-            - **Promptbook engine version:** ${PROMPTBOOK_ENGINE_VERSION}
-            - **Book language version:** ${BOOK_LANGUAGE_VERSION}
-            - **Time:** ${new Date().toISOString()}
-
-            <details>
-            <summary>Stack trace:</summary>
-
-            ## Stack trace:
-
-            \`\`\`stacktrace
-            ${block(error.stack || '(empty)')}
-            \`\`\`
-            </details>
-
-        `),
-        };
-        const reportUrl = new URL(`https://github.com/webgptorg/promptbook/issues/new`);
-        reportUrl.searchParams.set('labels', 'bug');
-        reportUrl.searchParams.set('assignees', ADMIN_GITHUB_NAME);
-        reportUrl.searchParams.set('title', report.title);
-        reportUrl.searchParams.set('body', report.body);
-        return reportUrl;
-    }
-
-    /**
-     * This error type indicates that the error should not happen and its last check before crashing with some other error
+     * Error thrown when a fetch request fails
      *
      * @public exported from `@promptbook/core`
      */
-    class UnexpectedError extends Error {
+    class PromptbookFetchError extends Error {
         constructor(message) {
-            super(spaceTrim.spaceTrim((block) => `
-                    ${block(message)}
-
-                    Note: This error should not happen.
-                    It's probbably a bug in the pipeline collection
-
-                    Please report issue:
-                    ${block(getErrorReportUrl(new Error(message)).href)}
-
-                    Or contact us on ${ADMIN_EMAIL}
-
-                `));
-            this.name = 'UnexpectedError';
-            Object.setPrototypeOf(this, UnexpectedError.prototype);
+            super(message);
+            this.name = 'PromptbookFetchError';
+            Object.setPrototypeOf(this, PromptbookFetchError.prototype);
         }
     }
 
@@ -523,7 +602,10 @@
         PipelineExecutionError,
         PipelineLogicError,
         PipelineUrlError,
+        AuthenticationError,
+        PromptbookFetchError,
         UnexpectedError,
+        WrappedError,
         // TODO: [🪑]> VersionMismatchError,
     };
     /**
@@ -575,6 +657,10 @@
 
                     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)}
 
                 `));
@@ -778,9 +864,7 @@
             return result.trim();
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             return null;
         }
     }
@@ -858,9 +942,7 @@
             return result.trim() + toExec;
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             return null;
         }
     }
@@ -891,9 +973,7 @@
             throw new Error(`Can not locate app ${appName} on Windows.`);
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             return null;
         }
     }
@@ -1131,9 +1211,7 @@
                     JSON.stringify(value); // <- TODO: [0]
                 }
                 catch (error) {
-                    if (!(error instanceof Error)) {
-                        throw error;
-                    }
+                    assertsError(error);
                     throw new UnexpectedError(spaceTrim__default["default"]((block) => `
                             \`${name}\` is not serializable
 
@@ -1741,9 +1819,7 @@
             return true;
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             if (error.message.includes('Unexpected token')) {
                 return false;
             }
@@ -1881,8 +1957,8 @@
                     updatedAt = new Date();
                     errors.push(...executionResult.errors);
                     warnings.push(...executionResult.warnings);
-                    // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
-                    // TODO: [🧠] !!! errors, warning, isSuccessful  are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
+                    // <- TODO: [🌂] Only unique errors and warnings should be added (or filtered)
+                    // TODO: [🧠] !! errors, warning, isSuccessful  are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
                     //            Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
                     //            And delete `ExecutionTask.currentValue.preparedPipeline`
                     assertsTaskSuccessful(executionResult);
@@ -1892,6 +1968,7 @@
                     partialResultSubject.next(executionResult);
                 }
                 catch (error) {
+                    assertsError(error);
                     status = 'ERROR';
                     errors.push(error);
                     partialResultSubject.error(error);
@@ -2702,14 +2779,15 @@
                     }
                 }
                 catch (error) {
-                    if (!(error instanceof Error) || error instanceof UnexpectedError) {
+                    assertsError(error);
+                    if (error instanceof UnexpectedError) {
                         throw error;
                     }
                     errors.push({ llmExecutionTools, error });
                 }
             }
             if (errors.length === 1) {
-                throw errors[0];
+                throw errors[0].error;
             }
             else if (errors.length > 1) {
                 throw new PipelineExecutionError(
@@ -3543,17 +3621,22 @@
     /**
      * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
      *
-     * @private as default `fetch` function used in Promptbook scrapers
+     * @public exported from `@promptbook/core`
      */
-    const scraperFetch = async (url, init) => {
+    const promptbookFetch = async (urlOrRequest, init) => {
         try {
-            return await fetch(url, init);
+            return await fetch(urlOrRequest, init);
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
+            assertsError(error);
+            let url;
+            if (typeof urlOrRequest === 'string') {
+                url = urlOrRequest;
             }
-            throw new KnowledgeScrapeError(spaceTrim__default["default"]((block) => `
+            else if (urlOrRequest instanceof Request) {
+                url = urlOrRequest.url;
+            }
+            throw new PromptbookFetchError(spaceTrim__default["default"]((block) => `
                     Can not fetch "${url}"
 
                     Fetch error:
@@ -3574,7 +3657,7 @@
     async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
         // console.log('!! makeKnowledgeSourceHandler', knowledgeSource);
         var _a;
-        const { fetch = scraperFetch } = tools;
+        const { fetch = promptbookFetch } = tools;
         const { knowledgeSourceContent } = knowledgeSource;
         let { name } = knowledgeSource;
         const { rootDirname = null, 
@@ -3776,9 +3859,7 @@
                 knowledgePreparedUnflatten[index] = pieces;
             }
             catch (error) {
-                if (!(error instanceof Error)) {
-                    throw error;
-                }
+                assertsError(error);
                 console.warn(error);
                 // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             }
@@ -4070,13 +4151,19 @@
                 return value.toISOString();
             }
             else {
-                return JSON.stringify(value);
+                try {
+                    return JSON.stringify(value);
+                }
+                catch (error) {
+                    if (error instanceof TypeError && error.message.includes('circular structure')) {
+                        return VALUE_STRINGS.circular;
+                    }
+                    throw error;
+                }
             }
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             console.error(error);
             return VALUE_STRINGS.unserializable;
         }
@@ -4133,9 +4220,7 @@
                 }
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             throw new ParseError(spaceTrim.spaceTrim((block) => `
                     Can not extract variables from the script
                     ${block(error.stack || error.message)}
@@ -5017,9 +5102,7 @@
                                     break scripts;
                                 }
                                 catch (error) {
-                                    if (!(error instanceof Error)) {
-                                        throw error;
-                                    }
+                                    assertsError(error);
                                     if (error instanceof UnexpectedError) {
                                         throw error;
                                     }
@@ -5089,9 +5172,7 @@
                                 break scripts;
                             }
                             catch (error) {
-                                if (!(error instanceof Error)) {
-                                    throw error;
-                                }
+                                assertsError(error);
                                 if (error instanceof UnexpectedError) {
                                     throw error;
                                 }
@@ -5712,9 +5793,7 @@
             await Promise.all(resolving);
         }
         catch (error /* <- Note: [3] */) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             // Note: No need to rethrow UnexpectedError
             // if (error instanceof UnexpectedError) {
             // Note: Count usage, [🧠] Maybe put to separate function executionReportJsonToUsage + DRY [🤹‍♂️]
@@ -6616,9 +6695,7 @@
                 }
             }
             catch (error) {
-                if (!(error instanceof Error)) {
-                    throw error;
-                }
+                assertsError(error);
                 if (error instanceof ReferenceError) {
                     const undefinedName = error.message.split(' ')[0];
                     /*
@@ -6708,11 +6785,12 @@
      * @public exported from `@promptbook/remote-server`
      */
     function startRemoteServer(options) {
-        const { port, collection, createLlmExecutionTools, isAnonymousModeAllowed, isApplicationModeAllowed, isVerbose = DEFAULT_IS_VERBOSE, } = {
+        const { port, collection, createLlmExecutionTools, createExecutionTools, 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
@@ -6755,6 +6833,7 @@
                 // Note: Application mode
                 const { appId, userId, customOptions } = identification;
                 llm = await createLlmExecutionTools({
+                    isAnonymous: false,
                     appId,
                     userId,
                     customOptions,
@@ -6763,13 +6842,20 @@
             else {
                 throw new PipelineExecutionError(`You must provide either llmToolsConfiguration or non-anonymous mode must be propperly configured`);
             }
-            const fs = $provideFilesystemForNode();
-            const executables = await $provideExecutablesForNode();
+            const customExecutionTools = createExecutionTools ? await createExecutionTools(identification) : {};
+            const fs = customExecutionTools.fs || $provideFilesystemForNode();
+            const executables = customExecutionTools.executables || (await $provideExecutablesForNode());
+            const scrapers = customExecutionTools.scrapers || (await $provideScrapersForNode({ fs, llm, executables }));
+            const script = customExecutionTools.script || (await $provideScriptingForNode({}));
+            const fetch = customExecutionTools.fetch || promptbookFetch;
+            const userInterface = customExecutionTools.userInterface || undefined;
             const tools = {
                 llm,
                 fs,
-                scrapers: await $provideScrapersForNode({ fs, llm, executables }),
-                script: await $provideScriptingForNode({}),
+                scrapers,
+                script,
+                fetch,
+                userInterface,
             };
             return tools;
         }
@@ -6779,9 +6865,38 @@
             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__default["default"](swaggerOptions);
+        app.use([`/api-docs`, `${rootPath}/api-docs`], swaggerUi__default["default"].serve, swaggerUi__default["default"].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')) {
@@ -6818,9 +6933,12 @@
 
                     ## 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'))}
 
@@ -6838,8 +6956,94 @@
                     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 { isSuccess, error, message, identification } = await login({
+                    username,
+                    password,
+                    appId,
+                    rawRequest: request,
+                    rawResponse: response,
+                });
+                response.status(201).send({
+                    isSuccess,
+                    message,
+                    error: error ? serializeError(error) : undefined,
+                    identification,
+                });
+                return;
+            }
+            catch (error) {
+                assertsError(error);
+                if (error instanceof AuthenticationError) {
+                    response.status(401).send({
+                        isSuccess: false,
+                        message: error.message,
+                        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;
@@ -6849,7 +7053,30 @@
             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');
@@ -6868,9 +7095,7 @@
                     .send(source.content);
             }
             catch (error) {
-                if (!(error instanceof Error)) {
-                    throw error;
-                }
+                assertsError(error);
                 response
                     .status(404)
                     .send({ error: serializeError(error) });
@@ -6903,10 +7128,26 @@
                 };
             }
         }
-        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');
@@ -6915,7 +7156,7 @@
             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);
@@ -6927,7 +7168,36 @@
             }
             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;
@@ -6964,12 +7234,16 @@
                 */
             }
             catch (error) {
-                if (!(error instanceof Error)) {
-                    throw error;
-                }
+                assertsError(error);
                 response.status(400).send({ error: serializeError(error) });
             }
         });
+        /**
+         * Catch-all handler for unmatched routes
+         */
+        app.use((request, response) => {
+            response.status(404).send(`URL "${request.originalUrl}" was not found on Promptbook server.`);
+        });
         const httpServer = http__default["default"].createServer(app);
         const server = new socket_io.Server(httpServer, {
             path: socketioPath,
@@ -7030,9 +7304,7 @@
                     socket.emit('prompt-response', { promptResult } /* <- Note: [🤛] */);
                 }
                 catch (error) {
-                    if (!(error instanceof Error)) {
-                        throw error;
-                    }
+                    assertsError(error);
                     socket.emit('error', serializeError(error) /* <- Note: [🤛] */);
                 }
                 finally {
@@ -7054,9 +7326,7 @@
                     socket.emit('listModels-response', { models } /* <- Note: [🤛] */);
                 }
                 catch (error) {
-                    if (!(error instanceof Error)) {
-                        throw error;
-                    }
+                    assertsError(error);
                     socket.emit('error', serializeError(error));
                 }
                 finally {
@@ -7077,9 +7347,7 @@
                     socket.emit('preparePipeline-response', { preparedPipeline } /* <- Note: [🤛] */);
                 }
                 catch (error) {
-                    if (!(error instanceof Error)) {
-                        throw error;
-                    }
+                    assertsError(error);
                     socket.emit('error', serializeError(error));
                     // <- TODO: [🚋] There is a problem with the remote server handling errors and sending them back to the client
                 }
@@ -7104,6 +7372,15 @@
         }
         let isDestroyed = false;
         return {
+            get httpServer() {
+                return httpServer;
+            },
+            get expressApp() {
+                return app;
+            },
+            get socketIoServer() {
+                return server;
+            },
             get isDestroyed() {
                 return isDestroyed;
             },
@@ -7119,7 +7396,6 @@
     }
     /**
      * TODO: !! Add CORS and security - probbably via `helmet`
-     * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch
      * TODO: Split this file into multiple functions - handler for each request
      * TODO: Maybe use `$exportJson`
      * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`