@richie-rpc/client 1.2.3 → 1.2.4

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
-import type { Contract, EndpointDefinition, ExtractBody, ExtractHeaders, ExtractParams, ExtractQuery } from '@richie-rpc/core';
+import type { Contract, DownloadEndpointDefinition, DownloadProgressEvent, EndpointDefinition, ExtractBody, ExtractChunk, ExtractFinalResponse, ExtractHeaders, ExtractParams, ExtractQuery, ExtractSSEEventData, SSEEndpointDefinition, StandardEndpointDefinition, StreamingEndpointDefinition, UploadProgressEvent } from '@richie-rpc/core';
+export type { UploadProgressEvent, DownloadProgressEvent };
 import type { z } from 'zod';
 export interface ClientConfig {
     baseUrl: string;
@@ -12,16 +13,82 @@ export type EndpointRequestOptions<T extends EndpointDefinition> = {
     headers?: ExtractHeaders<T> extends never ? never : ExtractHeaders<T>;
     body?: ExtractBody<T> extends never ? never : ExtractBody<T>;
     abortSignal?: AbortSignal;
+    /** Upload progress callback (uses XHR for progress tracking) */
+    onUploadProgress?: (event: UploadProgressEvent) => void;
 };
-export type EndpointResponse<T extends EndpointDefinition> = {
+export type EndpointResponse<T extends StandardEndpointDefinition> = {
     [Status in keyof T['responses']]: {
         status: Status;
         data: T['responses'][Status] extends z.ZodTypeAny ? z.infer<T['responses'][Status]> : never;
     };
 }[keyof T['responses']];
-export type ClientMethod<T extends EndpointDefinition> = (options: EndpointRequestOptions<T>) => Promise<EndpointResponse<T>>;
+export type ClientMethod<T extends StandardEndpointDefinition> = (options: EndpointRequestOptions<T>) => Promise<EndpointResponse<T>>;
+/**
+ * Result object for streaming endpoints - event-based API
+ */
+export interface StreamingResult<T extends StreamingEndpointDefinition> {
+    /** Subscribe to chunks */
+    on(event: 'chunk', handler: (chunk: ExtractChunk<T>) => void): () => void;
+    /** Subscribe to stream close (with optional final response) */
+    on(event: 'close', handler: (final?: ExtractFinalResponse<T>) => void): () => void;
+    /** Subscribe to errors */
+    on(event: 'error', handler: (error: Error) => void): () => void;
+    /** Abort the stream */
+    abort(): void;
+    /** Check if aborted */
+    readonly aborted: boolean;
+}
+/**
+ * Client method type for streaming endpoints
+ */
+export type StreamingClientMethod<T extends StreamingEndpointDefinition> = (options: EndpointRequestOptions<T>) => Promise<StreamingResult<T>>;
+/**
+ * Connection object for SSE endpoints - event-based API
+ */
+export interface SSEConnection<T extends SSEEndpointDefinition> {
+    /** Subscribe to a specific event type */
+    on<K extends keyof T['events']>(event: K, handler: (data: ExtractSSEEventData<T, K>, id?: string) => void): () => void;
+    /** Subscribe to errors */
+    on(event: 'error', handler: (error: Error) => void): () => void;
+    /** Close the connection */
+    close(): void;
+    /** Current connection state */
+    readonly state: 'connecting' | 'open' | 'closed';
+}
+/**
+ * Client method type for SSE endpoints
+ */
+export type SSEClientMethod<T extends SSEEndpointDefinition> = (options?: Omit<EndpointRequestOptions<T>, 'body' | 'onUploadProgress'>) => SSEConnection<T>;
+/**
+ * Request options for download endpoints
+ */
+export type DownloadRequestOptions<T extends DownloadEndpointDefinition> = {
+    params?: ExtractParams<T> extends never ? never : ExtractParams<T>;
+    query?: ExtractQuery<T> extends never ? never : ExtractQuery<T>;
+    headers?: ExtractHeaders<T> extends never ? never : ExtractHeaders<T>;
+    abortSignal?: AbortSignal;
+    /** Download progress callback */
+    onDownloadProgress?: (event: DownloadProgressEvent) => void;
+};
+/**
+ * Response type for download endpoints
+ * Success (200) returns File, errors return typed error response
+ */
+export type DownloadResponse<T extends DownloadEndpointDefinition> = {
+    status: 200;
+    data: File;
+} | (T['errorResponses'] extends Record<number, z.ZodTypeAny> ? {
+    [S in keyof T['errorResponses']]: {
+        status: S;
+        data: T['errorResponses'][S] extends z.ZodTypeAny ? z.infer<T['errorResponses'][S]> : never;
+    };
+}[keyof T['errorResponses']] : never);
+/**
+ * Client method type for download endpoints
+ */
+export type DownloadClientMethod<T extends DownloadEndpointDefinition> = (options?: DownloadRequestOptions<T>) => Promise<DownloadResponse<T>>;
 export type Client<T extends Contract> = {
-    [K in keyof T]: ClientMethod<T[K]>;
+    [K in keyof T]: T[K] extends StandardEndpointDefinition ? ClientMethod<T[K]> : T[K] extends StreamingEndpointDefinition ? StreamingClientMethod<T[K]> : T[K] extends SSEEndpointDefinition ? SSEClientMethod<T[K]> : T[K] extends DownloadEndpointDefinition ? DownloadClientMethod<T[K]> : never;
 };
 export declare class ClientValidationError extends Error {
     field: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@richie-rpc/client",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "main": "./dist/cjs/index.cjs",
   "exports": {
     ".": {
@@ -10,7 +10,7 @@
     }
   },
   "peerDependencies": {
-    "@richie-rpc/core": "^1.2.2",
+    "@richie-rpc/core": "^1.2.3",
     "typescript": "^5",
     "zod": "^4.1.12"
   },