@promptbook/node 0.89.0-9 → 0.92.0-10

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

@@ -0,0 +1,581 @@
+/**
+ * @private !!!! Decide how to expose this
+ */
+export declare const openapiJson: {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description: string;
+    };
+    paths: {
+        '/': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'text/markdown': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/login': {
+            post: {
+                summary: string;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    username: {
+                                        type: string;
+                                    };
+                                    password: {
+                                        type: string;
+                                    };
+                                    appId: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '201': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        isSuccess: {
+                                            type: string;
+                                        };
+                                        message: {
+                                            type: string;
+                                        };
+                                        error: {
+                                            type: string;
+                                        };
+                                        identification: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '400': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '401': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        isSuccess: {
+                                            type: string;
+                                            enum: boolean[];
+                                        };
+                                        message: {
+                                            type: string;
+                                        };
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/books': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '500': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/books/{bookId}': {
+            get: {
+                summary: string;
+                description: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                    description: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'text/markdown': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                    '404': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '500': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                        properties: {
+                                            nonce: {
+                                                type: string;
+                                            };
+                                            taskId: {
+                                                type: string;
+                                            };
+                                            taskType: {
+                                                type: string;
+                                            };
+                                            status: {
+                                                type: string;
+                                            };
+                                            createdAt: {
+                                                type: string;
+                                                format: string;
+                                            };
+                                            updatedAt: {
+                                                type: string;
+                                                format: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions/last': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        nonce: {
+                                            type: string;
+                                        };
+                                        taskId: {
+                                            type: string;
+                                        };
+                                        taskType: {
+                                            type: string;
+                                        };
+                                        status: {
+                                            type: string;
+                                        };
+                                        errors: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        warnings: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        createdAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        updatedAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        currentValue: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '404': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions/{taskId}': {
+            get: {
+                summary: string;
+                description: string;
+                parameters: {
+                    in: string;
+                    name: string;
+                    required: boolean;
+                    schema: {
+                        type: string;
+                    };
+                    description: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        nonce: {
+                                            type: string;
+                                        };
+                                        taskId: {
+                                            type: string;
+                                        };
+                                        taskType: {
+                                            type: string;
+                                        };
+                                        status: {
+                                            type: string;
+                                        };
+                                        errors: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        warnings: {
+                                            type: string;
+                                            items: {
+                                                type: string;
+                                            };
+                                        };
+                                        createdAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        updatedAt: {
+                                            type: string;
+                                            format: string;
+                                        };
+                                        currentValue: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '404': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/executions/new': {
+            post: {
+                summary: string;
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    pipelineUrl: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    book: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    inputParameters: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    identification: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                    '400': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    '404': {
+                        description: string;
+                        content: {
+                            'text/plain': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/api-docs': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/swagger': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/openapi': {
+            get: {
+                summary: string;
+                description: string;
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        schemas: {
+            Error: {
+                type: string;
+                properties: {
+                    error: {
+                        type: string;
+                    };
+                };
+            };
+            ExecutionTaskSummary: {
+                type: string;
+                properties: {
+                    nonce: {
+                        type: string;
+                    };
+                    taskId: {
+                        type: string;
+                    };
+                    taskType: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                    };
+                    createdAt: {
+                        type: string;
+                        format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                };
+            };
+            ExecutionTaskFull: {
+                type: string;
+                properties: {
+                    nonce: {
+                        type: string;
+                    };
+                    taskId: {
+                        type: string;
+                    };
+                    taskType: {
+                        type: string;
+                    };
+                    status: {
+                        type: string;
+                    };
+                    errors: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    warnings: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    createdAt: {
+                        type: string;
+                        format: string;
+                    };
+                    updatedAt: {
+                        type: string;
+                        format: string;
+                    };
+                    currentValue: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+    tags: {
+        name: string;
+        description: string;
+    }[];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/remote-server/socket-types/_subtypes/Identification.d.ts

@@ -1,4 +1,5 @@
 import type { LlmToolsConfiguration } from '../../../llm-providers/_common/register/LlmToolsConfiguration';
+import type { string_ip_address } from '../../../types/typeAliases';
 import type { string_user_id } from '../../../types/typeAliases';
 import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteServerOptions';
 /**
@@ -7,7 +8,12 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type Identification<TCustomOptions> = ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification;
+export type Identification<TCustomOptions> = (ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification) & {
+    /**
+     * Identifier of the IP address of the client
+     */
+    readonly ipAddress?: string_ip_address;
+};
 /**
  * Application mode is situation when you run known and well-defined books with your own api keys
  *

package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts

@@ -0,0 +1,11 @@
+import type { string_promptbook_token } from '../../../types/typeAliases';
+import type { really_unknown } from '../../../utils/organization/really_unknown';
+import type { ApplicationModeIdentification } from './Identification';
+/**
+ * Convert identification to Promptbook token
+ *
+ * @param identification
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function identificationToPromptbookToken(identification: ApplicationModeIdentification<really_unknown>): string_promptbook_token;

package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts

@@ -0,0 +1,10 @@
+import type { string_promptbook_token } from '../../../types/typeAliases';
+import type { ApplicationModeIdentification } from './Identification';
+/**
+ * Convert Promptbook token to identification
+ *
+ * @param promptbookToken
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function promptbookTokenToIdentification(promptbookToken: string_promptbook_token): ApplicationModeIdentification<undefined>;

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -11,8 +11,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
- * TODO: !! Add CORS and security - probbably via `helmet`
- * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch
+ * 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'`

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

@@ -3,12 +3,14 @@ import type { Promisable } from 'type-fest';
 import type { PipelineCollection } from '../../collection/PipelineCollection';
 import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_app_id } from '../../types/typeAliases';
 import type { string_email } from '../../types/typeAliases';
 import type { string_password } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
 import type { string_user_id } from '../../types/typeAliases';
+import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
 import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
  * @@@
@@ -29,14 +31,18 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      */
     readonly port: number;
     /**
-     * Root path of the server
+     * Creates execution tools the client
      *
-     * Note: This is useful when you reverse proxy the server without changing the path
+     * This is relevant also in anonymous mode in oposition to `createLlmExecutionTools`
      *
-     * @default '/'
-     * @example '/api/promptbook/'
-     */
-    readonly rootPath?: string_uri;
+     * Note: You can provide only some tools and leave the rest to the default ones also llm tools are created by `createLlmExecutionTools`
+     * Note: This is useful when you want to provide some custom restrictions for example:
+     * - Limit access to certain websites for some users
+     * - Bind user-interface tools to email agent
+     * - Allow / block script execution
+     * - And many more
+     */
+    createExecutionTools?(options: Identification<TCustomOptions>): Promisable<Partial<Omit<ExecutionTools, 'llm'>>>;
 } & ((AnonymousRemoteServerOptions & {
     readonly isApplicationModeAllowed?: false;
 }) | ({
@@ -74,7 +80,7 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(options: ApplicationRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+    createLlmExecutionTools(options: ApplicationModeIdentification<TCustomOptions>): Promisable<LlmExecutionTools>;
 };
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
@@ -96,7 +102,7 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
      *
      * Note: This is passed for example to `createLlmExecutionTools`
      */
-    readonly userToken?: string_user_id;
+    readonly userToken?: string_token;
     /**
      * Additional arbitrary options to identify the client or to pass custom metadata
      */