@simplysm/service-client 13.0.69 → 13.0.71

package/README.md

@@ -1,640 +1,48 @@
 # @simplysm/service-client
 
-A service client package for the Simplysm framework. Provides WebSocket communication with `@simplysm/service-server`, remote service invocation (RPC), event subscription, file upload/download, and ORM remote access.
-
-Works in both browser and Node.js environments, with built-in features like automatic message chunking/merging for large payloads, heartbeat-based connection monitoring, and automatic reconnection.
+Simplysm package - Service module (client)
 
 ## Installation
 
-```bash
-npm install @simplysm/service-client
-# or
 pnpm add @simplysm/service-client
-```
-
-## Main Modules
-
-### Core Functions and Classes
-
-| Function/Class | Description |
-|--------|------|
-| `createServiceClient` | Factory function for creating a ServiceClient instance. **Recommended over using the class constructor directly.** |
-| `ServiceClient` | Main service client class. Provides integrated connection management, RPC calls, events, files, and authentication. |
-| `createServiceTransport` | Factory function for creating a ServiceTransport instance |
-| `ServiceTransport` | Message transport layer. Handles request/response matching, progress tracking, and protocol encoding/decoding. |
-| `createSocketProvider` | Factory function for creating a SocketProvider instance |
-| `SocketProvider` | WebSocket connection management. Handles heartbeat, auto-reconnection, and connection state events. |
-| `createClientProtocolWrapper` | Factory function for creating a ClientProtocolWrapper instance |
-| `ClientProtocolWrapper` | Protocol wrapper. Automatically selects main thread/Web Worker for encoding/decoding based on data size. |
-
-### Feature Functions and Classes
-
-| Function/Class | Description |
-|--------|------|
-| `createEventClient` | Factory function for creating an EventClient instance |
-| `EventClient` | Server event subscription/publishing. Supports automatic listener recovery on reconnection. |
-| `createFileClient` | Factory function for creating a FileClient instance |
-| `FileClient` | Handles HTTP-based file upload/download. |
-| `createOrmClientConnector` | Factory function for creating an OrmClientConnector instance |
-| `OrmClientConnector` | ORM remote connection connector. Supports transaction/non-transaction connections. |
-| `OrmClientDbContextExecutor` | ORM DbContext remote executor. Calls server's `OrmService` via RPC. |
-
-### Types/Interfaces
-
-| Type | Description |
-|------|------|
-| `ServiceConnectionConfig` | Server connection config (host, port, ssl, maxReconnectCount) |
-| `ServiceProgress` | Request/response progress callback |
-| `ServiceProgressState` | Progress state (uuid, totalSize, completedSize) |
-| `SocketProviderEvents` | Event map for SocketProvider (message, state) |
-| `ServiceTransportEvents` | Event map for ServiceTransport (reload, event) |
-| `OrmConnectConfig<T>` | ORM connection config (DbContext type, connection options, DB/schema override) |
-| `RemoteService<T>` | Utility type that wraps all method return types of a service interface with `Promise` |
-
-## Usage
-
-### Basic Connection and Service Call
-
-```typescript
-import { createServiceClient } from "@simplysm/service-client";
-
-// Create client (recommended: use factory function)
-const client = createServiceClient("my-app", {
-  host: "localhost",
-  port: 8080,
-  ssl: false,
-  maxReconnectCount: 10, // Max reconnection attempts (default: 10, 0 means no reconnection)
-});
-
-// Connect to server
-await client.connect();
-
-// Check connection status
-console.log(client.connected); // true
-console.log(client.hostUrl);   // "http://localhost:8080"
-console.log(client.name);      // "my-app"
-
-// Direct RPC call
-const result = await client.send("MyService", "getUsers", [{ page: 1 }]);
-
-// Close connection
-await client.close();
-```
-
-### Type-Safe Service Call (getService)
-
-`getService<T>()` uses `Proxy` to provide type-safe remote calls to service interfaces.
-
-```typescript
-// Server-side service definition
-import { defineService } from "@simplysm/service-server";
-
-export const UserService = defineService("UserService", (ctx) => ({
-  getUsers: async (filter: { page: number }): Promise<User[]> => {
-    // ...
-  },
-  createUser: async (data: CreateUserDto): Promise<number> => {
-    // ...
-  },
-  deleteUser: async (id: number): Promise<void> => {
-    // ...
-  },
-}));
-
-// Export type for client-side usage
-export type UserServiceMethods = import("@simplysm/service-server").ServiceMethods<typeof UserService>;
-
-// Client-side usage
-import type { UserServiceMethods } from "./server/services/user-service";
-
-const userService = client.getService<UserServiceMethods>("UserService");
-
-// Parameter/return types are automatically inferred on method calls
-const users = await userService.getUsers({ page: 1 }); // users: User[]
-const newId = await userService.createUser({ name: "test" }); // newId: number
-```
-
-`ServiceMethods<T>` extracts method types from a service definition. `RemoteService<T>` wraps all method return types with `Promise` (methods already returning `Promise` are not double-wrapped).
-
-### Authentication
-
-```typescript
-// Send auth token after server connection
-await client.connect();
-await client.auth("jwt-token-here");
-
-// Automatically re-authenticated on reconnection
-```
-
-Tokens stored after `auth()` calls are automatically resent to the server on WebSocket reconnection.
-
-### Connection State Monitoring
-
-`ServiceClient` extends `EventEmitter` and supports the following events.
-
-| Event | Type | Description |
-|--------|------|------|
-| `state` | `"connected" \| "closed" \| "reconnecting"` | Connection state change |
-| `request-progress` | `ServiceProgressState` | Request transmission progress |
-| `response-progress` | `ServiceProgressState` | Response reception progress |
-| `reload` | `Set<string>` | File change notification from server (dev mode HMR) |
-
-```typescript
-// Monitor connection state changes
-client.on("state", (state) => {
-  if (state === "connected") {
-    console.log("Connected to server");
-  } else if (state === "reconnecting") {
-    console.log("Reconnection in progress...");
-  } else if (state === "closed") {
-    console.log("Connection closed");
-  }
-});
-
-// Monitor request/response progress (large messages)
-client.on("request-progress", (state) => {
-  const percent = Math.round((state.completedSize / state.totalSize) * 100);
-  console.log(`Sending: ${percent}%`);
-});
-
-client.on("response-progress", (state) => {
-  const percent = Math.round((state.completedSize / state.totalSize) * 100);
-  console.log(`Receiving: ${percent}%`);
-});
-```
-
-### Individual Request Progress Tracking
-
-Track progress of individual requests with the `progress` parameter of the `send()` method.
-
-```typescript
-const result = await client.send("DataService", "getLargeData", [query], {
-  request: (state) => {
-    console.log(`Request sending: ${state.completedSize}/${state.totalSize} bytes`);
-  },
-  response: (state) => {
-    console.log(`Response receiving: ${state.completedSize}/${state.totalSize} bytes`);
-  },
-});
-```
-
-### Event Subscription (Server -> Client)
-
-Subscribe to events from the server, and listeners are automatically recovered on reconnection.
-
-```typescript
-import { defineEvent } from "@simplysm/service-common";
-
-// Event definition (shared between server/client)
-export const SharedDataChangeEvent = defineEvent<
-  { name: string; filter: unknown },
-  (string | number)[] | undefined
->("SharedDataChangeEvent");
-
-// Subscribe to event
-const listenerKey = await client.addEventListener(
-  SharedDataChangeEvent,
-  { name: "users", filter: null },
-  async (data) => {
-    console.log("Data changed:", data);
-  },
-);
-
-// Unsubscribe from event
-await client.removeEventListener(listenerKey);
-```
-
-### Event Publishing (Client -> Server -> Other Clients)
-
-```typescript
-import { defineEvent } from "@simplysm/service-common";
-
-export const SharedDataChangeEvent = defineEvent<
-  { name: string; filter: unknown },
-  (string | number)[] | undefined
->("SharedDataChangeEvent");
-
-// Publish event to listeners matching specific conditions
-await client.emitToServer(
-  SharedDataChangeEvent,
-  (info) => info.name === "users", // Target filter
-  [1, 2, 3],                       // Data to send
-);
-```
-
-The server finds listeners matching the `infoSelector` condition in the registered listener list and delivers the event.
-
-### File Upload
-
-File upload is handled via HTTP POST requests and requires an authentication token.
-
-```typescript
-// Authentication required
-await client.auth("jwt-token");
-
-// Upload with browser File object
-const fileInput = document.querySelector("input[type=file]") as HTMLInputElement;
-const results = await client.uploadFile(fileInput.files!);
-
-// Upload with custom data
-const results = await client.uploadFile([
-  { name: "data.json", data: JSON.stringify({ key: "value" }) },
-  { name: "image.png", data: imageBlob },
-]);
-
-// Upload results
-for (const result of results) {
-  console.log(result.path);     // Server storage path
-  console.log(result.filename); // Original filename
-  console.log(result.size);     // File size (bytes)
-}
-```
-
-### File Download
-
-```typescript
-// Download file from server's relative path
-const buffer = await client.downloadFileBuffer("/uploads/2024/file.pdf");
-// buffer: Uint8Array
-```
-
-### ORM Remote Access
-
-Access the database through the server's ORM service. Transactions are automatically managed.
-
-```typescript
-import { createOrmClientConnector } from "@simplysm/service-client";
-import type { OrmConnectConfig } from "@simplysm/service-client";
-import { DbContext } from "@simplysm/orm-common";
-
-const connector = createOrmClientConnector(client);
-
-// Connect with transaction (auto rollback on error)
-await connector.connect(
-  {
-    dbContextDef: MyDbContext,
-    connOpt: { configName: "default" },
-    dbContextOpt: { database: "mydb", schema: "dbo" }, // Optional
-  },
-  async (db) => {
-    const users = await db.user().result();
-    await db.user().insert([{ name: "test" }]);
-    // Auto commit on callback success
-  },
-);
-
-// Connect without transaction (suitable for read-only operations)
-await connector.connectWithoutTransaction(
-  {
-    dbContextDef: MyDbContext,
-    connOpt: { configName: "default" },
-  },
-  async (db) => {
-    const users = await db.user().result();
-    return users;
-  },
-);
-```
-
-## Detailed API
-
-### ServiceConnectionConfig
-
-Server connection configuration interface.
-
-```typescript
-import type { ServiceConnectionConfig } from "@simplysm/service-client";
-```
-
-| Property | Type | Required | Description |
-|------|------|------|------|
-| `host` | `string` | Yes | Server host address |
-| `port` | `number` | Yes | Server port number |
-| `ssl` | `boolean` | No | SSL usage. If `true`, uses `wss://` / `https://` |
-| `maxReconnectCount` | `number` | No | Max reconnection attempts (default: 10). 0 means no reconnection |
-
-### createServiceClient
-
-Factory function for creating a ServiceClient instance.
-
-```typescript
-import { createServiceClient } from "@simplysm/service-client";
-
-function createServiceClient(name: string, options: ServiceConnectionConfig): ServiceClient
-```
-
-**Parameters:**
-- `name` - Client identifier (used for server-side logging and connection management)
-- `options` - Server connection configuration
-
-**Returns:** ServiceClient instance
-
-**Example:**
-```typescript
-const client = createServiceClient("my-app", {
-  host: "localhost",
-  port: 8080,
-  ssl: false,
-});
-```
-
-### ServiceClient
-
-```typescript
-import { ServiceClient } from "@simplysm/service-client";
-```
-
-Extends `EventEmitter<ServiceClientEvents>`.
-
-| Method/Property | Type / Return Type | Description |
-|-------------|----------|------|
-| `constructor(name, options)` | - | Create client instance. `name` is the client identifier. **Note: Prefer using `createServiceClient()` factory function.** |
-| `name` | `string` | Client identifier (read-only) |
-| `options` | `ServiceConnectionConfig` | Connection configuration (read-only) |
-| `connected` | `boolean` | WebSocket connection status |
-| `hostUrl` | `string` | HTTP URL (e.g., `http://localhost:8080`) |
-| `connect()` | `Promise<void>` | Connect to server via WebSocket |
-| `close()` | `Promise<void>` | Close connection (Graceful Shutdown) |
-| `send(serviceName, methodName, params, progress?)` | `Promise<unknown>` | Remote call to service method |
-| `getService<TService>(serviceName)` | `RemoteService<TService>` | Create type-safe service proxy |
-| `auth(token)` | `Promise<void>` | Send auth token (auto re-auth on reconnection) |
-| `addEventListener(eventDef, info, cb)` | `Promise<string>` | Register event listener. Returns listener key |
-| `removeEventListener(key)` | `Promise<void>` | Remove event listener |
-| `emitToServer(eventDef, infoSelector, data)` | `Promise<void>` | Publish event to other clients through server |
-| `uploadFile(files)` | `Promise<ServiceUploadResult[]>` | File upload (auth required) |
-| `downloadFileBuffer(relPath)` | `Promise<Uint8Array>` | File download |
-
-### ServiceProgress / ServiceProgressState
-
-Interfaces for tracking progress of large message transmissions.
-
-```typescript
-import type { ServiceProgress, ServiceProgressState } from "@simplysm/service-client";
-
-interface ServiceProgress {
-  request?: (s: ServiceProgressState) => void;   // Request transmission progress
-  response?: (s: ServiceProgressState) => void;  // Response reception progress
-}
-
-interface ServiceProgressState {
-  uuid: string;          // Request unique identifier
-  totalSize: number;     // Total size (bytes)
-  completedSize: number; // Completed size (bytes)
-}
-```
-
-### RemoteService\<TService\>
-
-Utility type that converts all methods of a service interface so their return types are wrapped with `Promise`. Methods already returning `Promise` are not double-wrapped. Non-function properties become `never`.
-
-```typescript
-import type { RemoteService } from "@simplysm/service-client";
-
-type RemoteService<TService> = {
-  [K in keyof TService]: TService[K] extends (...args: infer P) => infer R
-    ? (...args: P) => Promise<Awaited<R>>
-    : never;
-};
-```
-
-### SocketProvider / SocketProviderEvents
-
-Low-level WebSocket connection management interface. Not typically used directly — accessed indirectly through `ServiceClient`.
-
-```typescript
-import { createSocketProvider } from "@simplysm/service-client";
-import type { SocketProvider, SocketProviderEvents } from "@simplysm/service-client";
-
-function createSocketProvider(
-  url: string,
-  clientName: string,
-  maxReconnectCount: number,
-): SocketProvider
-```
-
-```typescript
-interface SocketProviderEvents {
-  message: Bytes;
-  state: "connected" | "closed" | "reconnecting";
-}
-
-interface SocketProvider {
-  readonly clientName: string;
-  readonly connected: boolean;
-  on<K extends keyof SocketProviderEvents & string>(type: K, listener: (data: SocketProviderEvents[K]) => void): void;
-  off<K extends keyof SocketProviderEvents & string>(type: K, listener: (data: SocketProviderEvents[K]) => void): void;
-  connect(): Promise<void>;
-  close(): Promise<void>;
-  send(data: Bytes): Promise<void>;
-}
-```
-
-| Constant | Value | Description |
-|------|-----|------|
-| Heartbeat Timeout | 30s | Connection considered disconnected if no messages for this duration |
-| Heartbeat Interval | 5s | Ping transmission interval |
-| Reconnect Delay | 3s | Reconnection attempt interval |
-
-### ServiceTransport / ServiceTransportEvents
-
-Message transport layer interface. Handles request/response matching, progress tracking, and protocol encoding/decoding. Not typically used directly — accessed indirectly through `ServiceClient`.
-
-```typescript
-import { createServiceTransport } from "@simplysm/service-client";
-import type { ServiceTransport, ServiceTransportEvents } from "@simplysm/service-client";
-
-function createServiceTransport(
-  socket: SocketProvider,
-  protocol: ClientProtocolWrapper,
-): ServiceTransport
-```
-
-```typescript
-interface ServiceTransportEvents {
-  reload: Set<string>;
-  event: { keys: string[]; data: unknown };
-}
-
-interface ServiceTransport {
-  on<K extends keyof ServiceTransportEvents & string>(type: K, listener: (data: ServiceTransportEvents[K]) => void): void;
-  off<K extends keyof ServiceTransportEvents & string>(type: K, listener: (data: ServiceTransportEvents[K]) => void): void;
-  send(message: ServiceClientMessage, progress?: ServiceProgress): Promise<unknown>;
-}
-```
-
-### ClientProtocolWrapper
-
-Protocol wrapper interface. Automatically selects main thread/Web Worker for encoding/decoding based on data size. In browser environments, data exceeding 30KB is automatically processed in a Web Worker to prevent main thread blocking.
-
-```typescript
-import { createClientProtocolWrapper } from "@simplysm/service-client";
-import type { ClientProtocolWrapper } from "@simplysm/service-client";
-
-function createClientProtocolWrapper(protocol: ServiceProtocol): ClientProtocolWrapper
-```
-
-```typescript
-interface ClientProtocolWrapper {
-  encode(uuid: string, message: ServiceMessage): Promise<{ chunks: Bytes[]; totalSize: number }>;
-  decode(bytes: Bytes): Promise<ServiceMessageDecodeResult<ServiceMessage>>;
-}
-```
-
-| Threshold | Condition |
-|--------|------|
-| 30KB or less | Processed directly in main thread |
-| Over 30KB | Delegated to Web Worker (browser environments only) |
-
-Worker delegation conditions (during encoding):
-- `Uint8Array` data
-- Strings exceeding 30KB
-- Arrays exceeding 100 elements or arrays containing `Uint8Array`
-
-### EventClient
-
-Server event subscription/publishing interface. Automatically recovers listeners on reconnection.
-
-```typescript
-import { createEventClient } from "@simplysm/service-client";
-import type { EventClient } from "@simplysm/service-client";
-
-function createEventClient(transport: ServiceTransport): EventClient
-```
-
-```typescript
-interface EventClient {
-  addListener<TInfo, TData>(eventDef: ServiceEventDef<TInfo, TData>, info: TInfo, cb: (data: TData) => PromiseLike<void>): Promise<string>;
-  removeListener(key: string): Promise<void>;
-  emitToServer<TInfo, TData>(eventDef: ServiceEventDef<TInfo, TData>, infoSelector: (item: TInfo) => boolean, data: TData): Promise<void>;
-  reRegisterAll(): Promise<void>;
-}
-```
-
-| Method | Description |
-|--------|------|
-| `addListener(eventDef, info, cb)` | Register event listener on the server. Returns a listener key for later removal. |
-| `removeListener(key)` | Unregister event listener from the server by key. |
-| `emitToServer(eventDef, infoSelector, data)` | Send event to all server-registered listeners matching `infoSelector`. |
-| `reRegisterAll()` | Re-register all listeners (called automatically on reconnection). |
-
-### FileClient
-
-HTTP-based file upload/download interface.
-
-```typescript
-import { createFileClient } from "@simplysm/service-client";
-import type { FileClient } from "@simplysm/service-client";
-
-function createFileClient(hostUrl: string, clientName: string): FileClient
-```
-
-```typescript
-interface FileClient {
-  download(relPath: string): Promise<Bytes>;
-  upload(
-    files: File[] | FileList | { name: string; data: BlobPart }[],
-    authToken: string,
-  ): Promise<ServiceUploadResult[]>;
-}
-```
-
-### OrmConnectConfig\<TDef\>
-
-ORM remote connection configuration interface.
-
-```typescript
-import type { OrmConnectConfig } from "@simplysm/service-client";
-```
-
-| Property | Type | Required | Description |
-|------|------|------|------|
-| `dbContextDef` | `TDef` | Yes | DbContext class |
-| `connOpt` | `DbConnOptions & { configName: string }` | Yes | DB connection options. `configName` identifies the server-side DB config; `config` can pass additional connection settings |
-| `dbContextOpt` | `{ database: string; schema: string }` | No | Database/schema override |
-
-### OrmClientConnector
-
-ORM remote connection connector interface. Manages transaction lifecycle over RPC.
-
-```typescript
-import { createOrmClientConnector } from "@simplysm/service-client";
-import type { OrmClientConnector } from "@simplysm/service-client";
 
-function createOrmClientConnector(serviceClient: ServiceClient): OrmClientConnector
-```
+## Source Index
 
-```typescript
-interface OrmClientConnector {
-  connect<TDef extends DbContextDef<any, any, any>, R>(
-    config: OrmConnectConfig<TDef>,
-    callback: (db: DbContextInstance<TDef>) => Promise<R> | R,
-  ): Promise<R>;
-  connectWithoutTransaction<TDef extends DbContextDef<any, any, any>, R>(
-    config: OrmConnectConfig<TDef>,
-    callback: (db: DbContextInstance<TDef>) => Promise<R> | R,
-  ): Promise<R>;
-}
-```
+### Types
 
-| Method | Description |
-|--------|------|
-| `connect(config, callback)` | Open a transactional DB connection. Commits on success, rolls back on error. Foreign key errors are converted to user-friendly messages. |
-| `connectWithoutTransaction(config, callback)` | Open a non-transactional DB connection. Suitable for read-only operations. |
+| Source | Exports | Description | Test |
+|--------|---------|-------------|------|
+| `src/types/connection-config.ts` | `ServiceConnectionConfig` | Host, port, SSL, and reconnect options for a service connection | - |
+| `src/types/progress.types.ts` | `ServiceProgress`, `ServiceProgressState` | Callbacks and state shape for tracking request/response progress | - |
 
-### OrmClientDbContextExecutor
+### Transport
 
-Implements the `DbContextExecutor` interface from `@simplysm/orm-common`. Delegates all DB operations to the server's `OrmService` via RPC. Not typically used directly — used internally by `OrmClientConnector`.
+| Source | Exports | Description | Test |
+|--------|---------|-------------|------|
+| `src/transport/socket-provider.ts` | `SocketProviderEvents`, `SocketProvider`, `createSocketProvider` | WebSocket wrapper with heartbeat, auto-reconnect, and ping/pong | - |
+| `src/transport/service-transport.ts` | `ServiceTransportEvents`, `ServiceTransport`, `createServiceTransport` | Sends protocol messages over a socket and matches responses by UUID | - |
 
-```typescript
-import { OrmClientDbContextExecutor } from "@simplysm/service-client";
+### Protocol
 
-class OrmClientDbContextExecutor implements DbContextExecutor {
-  constructor(client: ServiceClient, opt: DbConnOptions & { configName: string })
-  getInfo(): Promise<{ dialect: Dialect; database?: string; schema?: string }>
-  connect(): Promise<void>
-  beginTransaction(isolationLevel?: IsolationLevel): Promise<void>
-  commitTransaction(): Promise<void>
-  rollbackTransaction(): Promise<void>
-  close(): Promise<void>
-  executeDefs<T = Record<string, unknown>>(defs: QueryDef[], options?: (ResultMeta | undefined)[]): Promise<T[][]>
-  executeParametrized(query: string, params?: unknown[]): Promise<unknown[][]>
-  bulkInsert(tableName: string, columnDefs: Record<string, ColumnMeta>, records: Record<string, unknown>[]): Promise<void>
-}
-```
+| Source | Exports | Description | Test |
+|--------|---------|-------------|------|
+| `src/protocol/client-protocol-wrapper.ts` | `ClientProtocolWrapper`, `createClientProtocolWrapper` | Encodes/decodes protocol messages, offloading large payloads to a Web Worker | - |
 
-## Architecture
+### Features
 
-```
-ServiceClient (integrated entry point)
-  |
-  +-- SocketProvider (WebSocket connection management)
-  |     +-- Heartbeat (Ping/Pong)
-  |     +-- Auto reconnection
-  |
-  +-- ServiceTransport (message send/receive)
-  |     +-- ClientProtocolWrapper (encoding/decoding)
-  |     |     +-- ServiceProtocol (main thread)
-  |     |     +-- Web Worker (large data)
-  |     +-- Request/response matching (UUID-based)
-  |     +-- Progress tracking
-  |
-  +-- EventClient (event subscription/publishing)
-  |     +-- Listener management (registration/removal)
-  |     +-- Auto recovery on reconnection
-  |
-  +-- FileClient (HTTP file transfer)
-        +-- Upload (FormData, POST)
-        +-- Download (GET)
-```
+| Source | Exports | Description | Test |
+|--------|---------|-------------|------|
+| `src/features/event-client.ts` | `EventClient`, `createEventClient` | Registers, removes, and re-registers server-side event listeners | - |
+| `src/features/file-client.ts` | `FileClient`, `createFileClient` | Downloads files via fetch and uploads files via multipart form-data | - |
+| `src/features/orm/orm-connect-config.ts` | `OrmConnectConfig` | Config type pairing a DbContextDef with connection options and DB name | - |
+| `src/features/orm/orm-client-connector.ts` | `OrmClientConnector`, `createOrmClientConnector` | Opens a remote ORM DB context with or without a transaction | - |
+| `src/features/orm/orm-client-db-context-executor.ts` | `OrmClientDbContextExecutor` | DbContextExecutor that delegates all DB operations to the server OrmService | - |
 
-## Caveats
+### Main
 
-- **Auth Required**: You must authenticate with `auth()` before calling `uploadFile()`. An error occurs if not authenticated.
-- **Connection State Check**: `addEventListener()` can only be called when connected to the server. An error occurs if not connected.
-- **Auto Reconnection**: If the connection is lost, automatic reconnection is attempted up to `maxReconnectCount` times at 3-second intervals. On successful reconnection, auth tokens and event listeners are automatically recovered.
-- **Large Messages**: Large messages are automatically split/merged by `ServiceProtocol` from `@simplysm/service-common`. Progress can be tracked via `ServiceProgress` callbacks or `ServiceClient` events.
-- **Web Worker**: In browser environments, encoding/decoding of data exceeding 30KB is automatically handled in a Web Worker. In Node.js environments, it's always processed in the main thread.
-- **Foreign Key Error Conversion**: ORM connection errors due to foreign key constraint violations are automatically converted to user-friendly messages.
+| Source | Exports | Description | Test |
+|--------|---------|-------------|------|
+| `src/service-client.ts` | `ServiceClient`, `RemoteService`, `createServiceClient` | Top-level client that composes socket, transport, events, and file features | - |
 
 ## License
 

package/dist/features/event-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-client.d.ts","sourceRoot":"","sources":["..\\..\\src\\features\\event-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAKvE,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,KAAK,EAAE,KAAK,EACtB,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,EACvC,IAAI,EAAE,KAAK,EACX,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,WAAW,CAAC,IAAI,CAAC,GACrC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,YAAY,CAAC,KAAK,EAAE,KAAK,EACvB,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,EACvC,YAAY,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,OAAO,EACtC,IAAI,EAAE,KAAK,GACV,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,gBAAgB,GAAG,WAAW,CAkG1E"}
+{"version":3,"file":"event-client.d.ts","sourceRoot":"","sources":["..\\..\\src\\features\\event-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAKvE,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,KAAK,EAAE,KAAK,EACtB,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,EACvC,IAAI,EAAE,KAAK,EACX,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,WAAW,CAAC,IAAI,CAAC,GACrC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,YAAY,CAAC,KAAK,EAAE,KAAK,EACvB,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,EACvC,YAAY,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,OAAO,EACtC,IAAI,EAAE,KAAK,GACV,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,gBAAgB,GAAG,WAAW,CAsG1E"}