@promptbook/remote-client 0.89.0-6 → 0.89.0-8

package/esm/typings/src/_packages/remote-client.index.d.ts

@@ -6,7 +6,6 @@ import type { PromptbookServer_Identification } from '../remote-server/socket-ty
 import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
 import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
 import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
-import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { compilePipelineOnRemoteServer };
 export { RemoteLlmExecutionTools };
@@ -15,4 +14,3 @@ export type { PromptbookServer_Identification };
 export type { PromptbookServer_ApplicationIdentification };
 export type { PromptbookServer_AnonymousIdentification };
 export type { RemoteClientOptions };
-export type { RemoteServerOptions };

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

@@ -121,6 +121,7 @@ import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOpt
 import type { AnonymousRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { ApplicationRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { ApplicationRemoteServerClientOptions } from '../remote-server/types/RemoteServerOptions';
+import type { ApplicationRemoteServerOptionsLoginResponse } from '../remote-server/types/RemoteServerOptions';
 import type { Converter } from '../scrapers/_common/Converter';
 import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
 import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
@@ -411,6 +412,7 @@ export type { RemoteServerOptions };
 export type { AnonymousRemoteServerOptions };
 export type { ApplicationRemoteServerOptions };
 export type { ApplicationRemoteServerClientOptions };
+export type { ApplicationRemoteServerOptionsLoginResponse };
 export type { Converter };
 export type { ScraperAndConverterMetadata };
 export type { ScraperConstructor };

package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts

@@ -0,0 +1,7 @@
+import { Command } from 'commander';
+/**
+ * Note: `$` is used to indicate that this function is not a pure function - it registers an option in the CLI
+ *
+ * @private utility of CLI
+ */
+export declare function $addGlobalOptionsToCommand(command: Command): void;

package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts

@@ -0,0 +1,15 @@
+import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
+import type { string_url } from '../../types/typeAliases';
+type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
+    cliOptions: {
+        verbose: boolean;
+        interactive: boolean;
+        provider: 'BYOK' | 'BRING_YOUR_OWN_KEYS' | 'REMOTE_SERVER' | 'RS' | string;
+        remoteServerUrl: string_url;
+    };
+};
+/**
+ * @private utility of CLI
+ */
+export declare function $provideLlmToolsForCli(options: ProvideLlmToolsForCliOptions): Promise<import("../../_packages/types.index").LlmExecutionToolsWithTotalUsage>;
+export {};

package/esm/typings/src/config.d.ts

@@ -1,5 +1,6 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_app_id } from './types/typeAliases';
 import type { string_email } from './types/typeAliases';
 import type { string_name } from './types/typeAliases';
 import type { string_url_image } from './types/typeAliases';
@@ -208,6 +209,18 @@ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
+/**
+ * Id of application for the CLI when using remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CLI_APP_ID: string_app_id;
+/**
+ * Id of application for the playground
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PLAYGROUND_APP_ID: string_app_id;
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
@@ -228,13 +241,7 @@ export declare const MOMENT_ARG_THRESHOLDS: {
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+export declare const DEFAULT_REMOTE_SERVER_URL = "https://api.pavolhejny.com/promptbook";
 /**
  * @@@
  *
@@ -281,5 +288,5 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 export declare const IS_COST_PREVENTED: boolean;
 /**
  * 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
  */

package/esm/typings/src/errors/0-index.d.ts

@@ -1,5 +1,6 @@
 import { CsvFormatError } from '../formats/csv/CsvFormatError';
 import { AbstractFormatError } from './AbstractFormatError';
+import { AuthenticationError } from './AuthenticationError';
 import { CollectionError } from './CollectionError';
 import { EnvironmentMismatchError } from './EnvironmentMismatchError';
 import { ExpectError } from './ExpectError';
@@ -49,6 +50,7 @@ export declare const COMMON_JAVASCRIPT_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
+    readonly AuthenticationError: typeof AuthenticationError;
 };
 /**
  * Index of all errors
@@ -64,6 +66,7 @@ export declare const ALL_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
+    readonly AuthenticationError: typeof AuthenticationError;
     readonly AbstractFormatError: typeof AbstractFormatError;
     readonly CsvFormatError: typeof CsvFormatError;
     readonly CollectionError: typeof CollectionError;

package/esm/typings/src/errors/AuthenticationError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * AuthenticationError is thrown from login function which is dependency of remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class AuthenticationError extends Error {
+    readonly name = "AuthenticationError";
+    constructor(message: string);
+}

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts

@@ -1,11 +1,44 @@
+import { Promisable } from 'type-fest';
+import type { PromptbookServer_Identification } from '../../../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { really_any } from '../../../utils/organization/really_any';
+import type { string_app_id } from '../../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
+    /**
+     * Use local keys and execute LLMs directly
+     */
+    readonly strategy: 'BRING_YOUR_OWN_KEYS';
+} | {
+    /**
+     * Do not use local keys but login to Promptbook server and execute LLMs there
+     */
+    readonly strategy: 'REMOTE_SERVER';
+    /**
+     * URL of the remote server
+     *
+     * @default `DEFAULT_REMOTE_SERVER_URL`
+     */
+    readonly remoteServerUrl?: string_url;
+    /**
+     * Identifier of the application which will be passed to the remote server identification
+     *
+     * Note: This can be some id or some semantic name like "email-agent"
+     */
+    readonly appId: string_app_id;
+    /**
+     *
+     */
+    loginPrompt(): Promisable<PromptbookServer_Identification<really_any>>;
+});
 /**
  * Returns LLM tools for CLI
  *
  * @private within the repository - for CLI utils
  */
-export declare function $provideLlmToolsForWizzardOrCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): Promise<LlmExecutionToolsWithTotalUsage>;
+export declare function $provideLlmToolsForWizzardOrCli(options?: ProvideLlmToolsForWizzardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
+export {};
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts

@@ -25,7 +25,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & Cl
  */
 export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied: true;
-} & Pick<RemoteClientOptions<undefined>, 'remoteUrl' | 'path'>;
+} & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;
 /**
  * TODO: [🧠][🤺] Pass `userId`
  */

package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts

@@ -11,4 +11,4 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AnthropicClaudeMetadataRegistration: Registration;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

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

@@ -1,6 +1,5 @@
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_base_url } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
 import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
 /**
  * Options for `RemoteLlmExecutionTools`
@@ -12,14 +11,7 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
      * URL of the remote server
      * On this server will be connected to the socket.io server
      */
-    readonly remoteUrl: string_base_url;
-    /**
-     * Path for the Socket.io server to listen
-     *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
-     */
-    readonly path: string_uri;
+    readonly remoteServerUrl: string_base_url;
     /**
      * Identification of client for Socket.io remote server
      */
@@ -28,5 +20,5 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
 /**
  * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
  */

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

@@ -1,10 +1,15 @@
+import type { Request, Response } from 'express';
 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 { 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_user_id } from '../../types/typeAliases';
+import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
 /**
  * @@@
  *
@@ -16,7 +21,6 @@ import type { string_user_id } from '../../types/typeAliases';
  *
  * You can enable both modes at the same time.
  *
- * @public exported from `@promptbook/remote-client`
  * @public exported from `@promptbook/remote-server`
  */
 export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
@@ -32,8 +36,12 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @default '/'
      * @example '/api/promptbook/'
      */
-    readonly rootPath: string_uri;
-} & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+    readonly rootPath?: string_uri;
+} & ((AnonymousRemoteServerOptions & {
+    readonly isApplicationModeAllowed?: false;
+}) | ({
+    readonly isAnonymousModeAllowed?: false;
+} & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
@@ -51,6 +59,43 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
      * This is used to check validity of the prompt to prevent misuse
      */
     readonly collection: PipelineCollection;
+    /**
+     * User tries to login to the server, this function will be called verify the user and return the identification or throw an error
+     * This can be also doubled as a function to register the user
+     *
+     * Note: In most cases, you will return `PromptbookServer_ApplicationIdentification`
+     *       `PromptbookServer_AnonymousIdentification` is useful only in scenarios when user stores its own api keys on the application server and
+     *       server acts only as a api key provider
+     *
+     * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
+     * @throws `AuthenticationError`  if the user is not allowed to login for example because of invalid credentials
+     */
+    login(credentials: {
+        /**
+         * Identifier of the application you are using
+         *
+         * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+         */
+        readonly appId: string_app_id | null;
+        /**
+         * Username (for example email) of the user
+         */
+        readonly username: string_email | string;
+        /**
+         * Password of the user
+         */
+        readonly password: string_password;
+        /**
+         * Request object from express if you want to access some request data for example headers, IP address, etc.
+         */
+        readonly rawRequest: Request;
+        /**
+         * Response object from express if you want to add some custom headers.
+         *
+         * Note: It is not recommended to use this object to send body of the response because it can confuse the client
+         */
+        readonly rawResponse: Response;
+    }): Promise<ApplicationRemoteServerOptionsLoginResponse<TCustomOptions>>;
     /**
      * Creates llm execution tools for each client
      */
@@ -82,6 +127,18 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
      */
     readonly customOptions?: TCustomOptions;
 };
+export type ApplicationRemoteServerOptionsLoginResponse<TCustomOptions> = {
+    /**
+     * Was the login successful
+     */
+    readonly isSuccess: boolean;
+    /**
+     *
+     */
+    readonly message?: string;
+    readonly error?: AuthenticationError;
+    readonly identification?: PromptbookServer_Identification<TCustomOptions>;
+};
 /**
  * TODO: Constrain anonymous mode for specific models / providers
  */

package/package.json

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

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-6';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-8';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -59,6 +59,19 @@
         }
     }
 
+    /**
+     * 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);
+        }
+    }
+
     /**
      * This error indicates that the pipeline collection cannot be propperly loaded
      *
@@ -349,7 +362,7 @@
     });
     /**
      * 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
      */
 
     /**
@@ -457,6 +470,7 @@
         TypeError,
         URIError,
         AggregateError,
+        AuthenticationError,
         /*
       Note: Not widely supported
       > InternalError,
@@ -513,22 +527,26 @@
      * @private internal utility function
      */
     async function createRemoteClient(options) {
-        const { remoteUrl, path } = options;
+        const { remoteServerUrl } = options;
+        let path = new URL(remoteServerUrl).pathname;
+        if (path.endsWith('/')) {
+            path = path.slice(0, -1);
+        }
+        path = `${path}/socket.io`;
         return new Promise((resolve, reject) => {
-            const socket = socket_ioClient.io(remoteUrl, {
+            const socket = socket_ioClient.io(remoteServerUrl, {
                 retries: CONNECTION_RETRIES_LIMIT,
                 timeout: CONNECTION_TIMEOUT_MS,
                 path,
-                // path: `${this.remoteUrl.pathname}/socket.io`,
                 transports: [/*'websocket', <- TODO: [🌬] Make websocket transport work */ 'polling'],
             });
-            // console.log('Connecting to', this.options.remoteUrl.href, { socket });
+            // console.log('Connecting to', this.options.remoteServerUrl.href, { socket });
             socket.on('connect', () => {
                 resolve(socket);
             });
             // TODO: [💩] Better timeout handling
             setTimeout(() => {
-                reject(new Error(`Timeout while connecting to ${remoteUrl}`));
+                reject(new Error(`Timeout while connecting to ${remoteServerUrl}`));
             }, CONNECTION_TIMEOUT_MS);
         });
     }