@promptbook/remote-server 0.89.0-29 → 0.89.0-30

package/esm/typings/src/_packages/types.index.d.ts

@@ -107,6 +107,11 @@ import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { paths } from '../remote-server/openapi-types';
+import type { webhooks } from '../remote-server/openapi-types';
+import type { components } from '../remote-server/openapi-types';
+import type { $defs } from '../remote-server/openapi-types';
+import type { operations } from '../remote-server/openapi-types';
 import type { RemoteServer } from '../remote-server/RemoteServer';
 import type { Identification } from '../remote-server/socket-types/_subtypes/Identification';
 import type { ApplicationModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
@@ -397,6 +402,11 @@ export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
 export type { PrepareAndScrapeOptions };
+export type { paths };
+export type { webhooks };
+export type { components };
+export type { $defs };
+export type { operations };
 export type { RemoteServer };
 export type { Identification };
 export type { ApplicationModeIdentification };

package/esm/typings/src/remote-server/openapi-types.d.ts

@@ -0,0 +1,284 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export type paths = {
+    readonly "/": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * Get server details
+         * @description Returns details about the Promptbook server.
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description Server details in markdown format. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/login": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        readonly get?: never;
+        readonly put?: never;
+        /**
+         * Login to the server
+         * @description Login to the server and get identification.
+         */
+        readonly post: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody: {
+                readonly content: {
+                    readonly "application/json": {
+                        readonly username?: string;
+                        readonly password?: string;
+                        readonly appId?: string;
+                    };
+                };
+            };
+            readonly responses: {
+                /** @description Successful login */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": {
+                            readonly identification?: Record<string, never>;
+                        };
+                    };
+                };
+            };
+        };
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/books": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * List all books
+         * @description Returns a list of all available books in the collection.
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description A list of books. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": readonly string[];
+                    };
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly [path: `/books/${string}`]: {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * Get book content
+         * @description Returns the content of a specific book.
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path: {
+                    /** @description The ID of the book to retrieve. */
+                    readonly bookId: string;
+                };
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description The content of the book. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "text/markdown": string;
+                    };
+                };
+                /** @description Book not found. */
+                readonly 404: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/executions": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        /**
+         * List all executions
+         * @description Returns a list of all running execution tasks.
+         */
+        readonly get: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody?: never;
+            readonly responses: {
+                /** @description A list of execution tasks. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": readonly Record<string, never>[];
+                    };
+                };
+            };
+        };
+        readonly put?: never;
+        readonly post?: never;
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+    readonly "/executions/new": {
+        readonly parameters: {
+            readonly query?: never;
+            readonly header?: never;
+            readonly path?: never;
+            readonly cookie?: never;
+        };
+        readonly get?: never;
+        readonly put?: never;
+        /**
+         * Start a new execution
+         * @description Starts a new execution task for a given pipeline.
+         */
+        readonly post: {
+            readonly parameters: {
+                readonly query?: never;
+                readonly header?: never;
+                readonly path?: never;
+                readonly cookie?: never;
+            };
+            readonly requestBody: {
+                readonly content: {
+                    readonly "application/json": {
+                        readonly pipelineUrl?: string;
+                        readonly inputParameters?: Record<string, never>;
+                        readonly identification?: Record<string, never>;
+                    };
+                };
+            };
+            readonly responses: {
+                /** @description The newly created execution task. */
+                readonly 200: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content: {
+                        readonly "application/json": Record<string, never>;
+                    };
+                };
+                /** @description Invalid input. */
+                readonly 400: {
+                    headers: {
+                        readonly [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        readonly delete?: never;
+        readonly options?: never;
+        readonly head?: never;
+        readonly patch?: never;
+        readonly trace?: never;
+    };
+};
+export type webhooks = Record<string, never>;
+export type components = {
+    schemas: never;
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+};
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.89.0-29",
+    "version": "0.89.0-30",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.89.0-29"
+        "@promptbook/core": "0.89.0-30"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -48,7 +48,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-29';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-30';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -6793,15 +6793,15 @@
      * 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
+    // 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)',
+            title: 'Promptbook Remote Server API (!!!! From TS)',
             version: '1.0.0',
             description: 'API documentation for the Promptbook Remote Server',
         },
@@ -7059,17 +7059,14 @@
             response.setHeader('X-Powered-By', 'Promptbook engine');
             next();
         });
-        // TODO: !!! Expose openapiJson to consumer and also allow to add new routes
+        // 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;
+            ignorePaths(path) {
+                return path.startsWith('/api-docs') || path.startsWith('/swagger') || path.startsWith('/openapi');
             },
-            // TODO: !!! Validate both
-            validateRequests: false,
-            validateResponses: false, // false by default
+            validateRequests: true,
+            validateResponses: true,
         }));
         app.use([`/api-docs`, `/swagger`], swaggerUi__default["default"].serve, swaggerUi__default["default"].setup(openapiJson, {
         // customCss: '.swagger-ui .topbar { display: none }',
@@ -7079,10 +7076,6 @@
         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
@@ -7246,7 +7239,7 @@
             }
         }
         app.get(`/executions`, async (request, response) => {
-            response.send(runningExecutionTasks.map((runningExecutionTask) => exportExecutionTask(runningExecutionTask, false)));
+            response.send(runningExecutionTasks.map((runningExecutionTask) => exportExecutionTask(runningExecutionTask, false)) /* <- TODO: satisfies paths['/executions']['get']['responses']['200']['content']['application/json'] */);
         });
         app.get(`/executions/last`, async (request, response) => {
             // TODO: [🤬] Filter only for user
@@ -7272,7 +7265,9 @@
         app.post(`/executions/new`, async (request, response) => {
             try {
                 const { inputParameters, identification /* <- [🤬] */ } = request.body;
-                const pipelineUrl = request.body.pipelineUrl || request.body.book;
+                const pipelineUrl = request.body
+                    .pipelineUrl /* <- TODO: as paths['/executions/new']['post']['requestBody']['content']['application/json'] */ ||
+                    request.body.book;
                 // TODO: [🧠] Check `pipelineUrl` and `inputParameters` here or it should be responsibility of `collection.getPipelineByUrl` and `pipelineExecutor`
                 const pipeline = await (collection === null || collection === void 0 ? void 0 : collection.getPipelineByUrl(pipelineUrl));
                 if (pipeline === undefined) {
@@ -7286,7 +7281,7 @@
                 await waitasecond.forTime(10);
                 // <- Note: Wait for a while to wait for quick responses or sudden but asynchronous errors
                 // <- TODO: Put this into configuration
-                response.send(executionTask);
+                response.send(executionTask /* <- TODO: satisfies paths['/executions/new']['post']['responses']['200']['content']['application/json'] */);
                 /*/
                 executionTask.asObservable().subscribe({
                     next(partialResult) {