@promptbook/wizard 0.95.0

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/_common/PromptbookServer_Error.d.ts

@@ -0,0 +1,7 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
+/**
+ * This is sent from server to client when error occurs and stops the process
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_Error = ErrorJson;

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

@@ -0,0 +1,59 @@
+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';
+/**
+ * Identification of client for Socket.io remote server
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+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
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type ApplicationModeIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
+    /**
+     * Application mode
+     */
+    readonly isAnonymous: false;
+};
+/**
+ * Anonymous mode is when you run arbitrary user books without api keys from user
+ *
+ * Note: This is useful in situations when the LLM provider does not allow to call the API requests from the client side
+ *       It is kind of a proxy mode
+ *
+ * @public exported from `@promptbook/remote-server`
+ * @public exported from `@promptbook/remote-client`
+ */
+export type AnonymousModeIdentification = {
+    /**
+     * Anonymous mode
+     */
+    readonly isAnonymous: true;
+    /**
+     * Identifier of the end user
+     *
+     * Note: This can be either some id or email or any other identifier
+     * Note: In anonymous mode, this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
+     */
+    readonly userId?: string_user_id;
+    /**
+     * Configuration for the LLM tools
+     */
+    readonly llmToolsConfiguration: LlmToolsConfiguration;
+};
+/**
+ * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - Pass `userId` in `PromptbookServer_ListModels_Request`
+ */

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/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts

@@ -0,0 +1,17 @@
+import type { Identification } from '../_subtypes/Identification';
+/**
+ * List models available in the server
+ *
+ * This is a request from client to server
+ *
+ * @private internal type of remote server
+ */
+export type PromptbookServer_ListModels_Request<TCustomOptions> = {
+    /**
+     * Identifier of the end user or application
+     */
+    readonly identification: Identification<TCustomOptions>;
+};
+/**
+ * TODO: [🧠] Listing models inanonymous mode does not make sense - keeping only to preserve consistency
+ */