@arrirpc/client 0.79.1 → 0.80.0

package/dist/index.cjs

@@ -220,23 +220,36 @@ function arriSseRequest(opts, options) {
     maxRetryCount: options.maxRetryCount,
     maxRetryInterval: options.maxRetryInterval
   });
+  let interval;
+  let intervalDuration;
+  const timeoutMultiplier = options.heartbeatTimeoutMultiplier ?? 2;
+  if (timeoutMultiplier < 1) {
+    throw new Error(`heartbeatTimeoutMultiplier cannot be less than 1`);
+  }
+  function resetInterval() {
+    if (interval) clearInterval(interval);
+    if (!intervalDuration) return;
+    interval = setInterval(() => {
+      if (controller.signal.aborted) return;
+      controller.reconnect();
+    }, intervalDuration);
+  }
   const controller = eventSource.listen({
     onMessage(message) {
+      resetInterval();
       if (message.event === "message" || message.event === void 0 || message.event === "") {
         options.onMessage?.(opts.responseFromString(message.data));
         return;
       }
       if (message.event === "done") {
+        if (interval) clearInterval(interval);
         controller.abort();
       }
     },
-    onRequest(context) {
-      options.onRequest?.(context);
-    },
+    onRequest: options.onRequest,
     onRequestError(context) {
-      if (opts.onError) {
-        opts.onError(context.error);
-      }
+      clearInterval(interval);
+      if (opts.onError) opts.onError(context.error);
       options.onRequestError?.({
         ...context,
         error: new ArriErrorInstance({
@@ -247,15 +260,19 @@ function arriSseRequest(opts, options) {
       });
     },
     onResponse(context) {
+      const heartbeatIntervalHeader = Number(
+        context.response?.headers.get("heartbeat-interval") ?? 0
+      );
+      if (context.response.ok && !Number.isNaN(heartbeatIntervalHeader) && heartbeatIntervalHeader > 0) {
+        intervalDuration = heartbeatIntervalHeader * timeoutMultiplier;
+        resetInterval();
+      }
       options.onResponse?.(context);
     },
     async onResponseError(context) {
-      if (opts.onError) {
-        opts.onError(context.error);
-      }
-      if (!options.onResponseError) {
-        return;
-      }
+      clearInterval(interval);
+      if (opts.onError) opts.onError(context.error);
+      if (!options.onResponseError) return;
       try {
         const arriError = ArriErrorInstance.fromJson(
           await context.response.json()

package/dist/index.d.cts

@@ -38,7 +38,13 @@ interface ArriRequestOptions {
     onRequestError?: FetchOptions['onRequestError'];
     onResponse?: FetchOptions['onResponse'];
     onResponseError?: FetchOptions['onResponseError'];
+    /**
+     * Set a timeout in milliseconds to wait for a response before throwing an error
+     */
     timeout?: FetchOptions['timeout'];
+    /**
+     * An AbortController signal - used for cancelling an individual request
+     */
     signal?: FetchOptions['signal'];
 }
 interface ArriRequestConfig<TType, TParams extends Record<any, any> | undefined = undefined> {
@@ -110,9 +116,16 @@ interface SseOptions<TData> {
     onResponseError?: (context: Omit<OnResponseErrorContext, 'error'> & {
         error: ArriErrorInstance;
     }) => any;
-    onClose?: () => any;
     maxRetryCount?: number;
     maxRetryInterval?: number;
+    /**
+     * Defines a multiplier for the Arri server's "Heartbeat-Interval" header.
+     * The client will wait for (Heartbeat-Interval * heartbeatTimeoutMultiplier)
+     * milliseconds without receiving a heartbeat before considering the connection disconnected.
+     *
+     * Default is 2.0 (e.g. if the server sends 10s interval, client waits 20s)
+     */
+    heartbeatTimeoutMultiplier?: number;
 }
 declare function arriSseRequest<TType, TParams extends Record<any, any> | undefined = undefined>(opts: ArriRequestConfig<TType, TParams>, options: SseOptions<TType>): EventSourceController;
 

package/dist/index.d.mts

@@ -38,7 +38,13 @@ interface ArriRequestOptions {
     onRequestError?: FetchOptions['onRequestError'];
     onResponse?: FetchOptions['onResponse'];
     onResponseError?: FetchOptions['onResponseError'];
+    /**
+     * Set a timeout in milliseconds to wait for a response before throwing an error
+     */
     timeout?: FetchOptions['timeout'];
+    /**
+     * An AbortController signal - used for cancelling an individual request
+     */
     signal?: FetchOptions['signal'];
 }
 interface ArriRequestConfig<TType, TParams extends Record<any, any> | undefined = undefined> {
@@ -110,9 +116,16 @@ interface SseOptions<TData> {
     onResponseError?: (context: Omit<OnResponseErrorContext, 'error'> & {
         error: ArriErrorInstance;
     }) => any;
-    onClose?: () => any;
     maxRetryCount?: number;
     maxRetryInterval?: number;
+    /**
+     * Defines a multiplier for the Arri server's "Heartbeat-Interval" header.
+     * The client will wait for (Heartbeat-Interval * heartbeatTimeoutMultiplier)
+     * milliseconds without receiving a heartbeat before considering the connection disconnected.
+     *
+     * Default is 2.0 (e.g. if the server sends 10s interval, client waits 20s)
+     */
+    heartbeatTimeoutMultiplier?: number;
 }
 declare function arriSseRequest<TType, TParams extends Record<any, any> | undefined = undefined>(opts: ArriRequestConfig<TType, TParams>, options: SseOptions<TType>): EventSourceController;
 

package/dist/index.d.ts

@@ -38,7 +38,13 @@ interface ArriRequestOptions {
     onRequestError?: FetchOptions['onRequestError'];
     onResponse?: FetchOptions['onResponse'];
     onResponseError?: FetchOptions['onResponseError'];
+    /**
+     * Set a timeout in milliseconds to wait for a response before throwing an error
+     */
     timeout?: FetchOptions['timeout'];
+    /**
+     * An AbortController signal - used for cancelling an individual request
+     */
     signal?: FetchOptions['signal'];
 }
 interface ArriRequestConfig<TType, TParams extends Record<any, any> | undefined = undefined> {
@@ -110,9 +116,16 @@ interface SseOptions<TData> {
     onResponseError?: (context: Omit<OnResponseErrorContext, 'error'> & {
         error: ArriErrorInstance;
     }) => any;
-    onClose?: () => any;
     maxRetryCount?: number;
     maxRetryInterval?: number;
+    /**
+     * Defines a multiplier for the Arri server's "Heartbeat-Interval" header.
+     * The client will wait for (Heartbeat-Interval * heartbeatTimeoutMultiplier)
+     * milliseconds without receiving a heartbeat before considering the connection disconnected.
+     *
+     * Default is 2.0 (e.g. if the server sends 10s interval, client waits 20s)
+     */
+    heartbeatTimeoutMultiplier?: number;
 }
 declare function arriSseRequest<TType, TParams extends Record<any, any> | undefined = undefined>(opts: ArriRequestConfig<TType, TParams>, options: SseOptions<TType>): EventSourceController;
 

package/dist/index.mjs

@@ -216,23 +216,36 @@ function arriSseRequest(opts, options) {
     maxRetryCount: options.maxRetryCount,
     maxRetryInterval: options.maxRetryInterval
   });
+  let interval;
+  let intervalDuration;
+  const timeoutMultiplier = options.heartbeatTimeoutMultiplier ?? 2;
+  if (timeoutMultiplier < 1) {
+    throw new Error(`heartbeatTimeoutMultiplier cannot be less than 1`);
+  }
+  function resetInterval() {
+    if (interval) clearInterval(interval);
+    if (!intervalDuration) return;
+    interval = setInterval(() => {
+      if (controller.signal.aborted) return;
+      controller.reconnect();
+    }, intervalDuration);
+  }
   const controller = eventSource.listen({
     onMessage(message) {
+      resetInterval();
       if (message.event === "message" || message.event === void 0 || message.event === "") {
         options.onMessage?.(opts.responseFromString(message.data));
         return;
       }
       if (message.event === "done") {
+        if (interval) clearInterval(interval);
         controller.abort();
       }
     },
-    onRequest(context) {
-      options.onRequest?.(context);
-    },
+    onRequest: options.onRequest,
     onRequestError(context) {
-      if (opts.onError) {
-        opts.onError(context.error);
-      }
+      clearInterval(interval);
+      if (opts.onError) opts.onError(context.error);
       options.onRequestError?.({
         ...context,
         error: new ArriErrorInstance({
@@ -243,15 +256,19 @@ function arriSseRequest(opts, options) {
       });
     },
     onResponse(context) {
+      const heartbeatIntervalHeader = Number(
+        context.response?.headers.get("heartbeat-interval") ?? 0
+      );
+      if (context.response.ok && !Number.isNaN(heartbeatIntervalHeader) && heartbeatIntervalHeader > 0) {
+        intervalDuration = heartbeatIntervalHeader * timeoutMultiplier;
+        resetInterval();
+      }
       options.onResponse?.(context);
     },
     async onResponseError(context) {
-      if (opts.onError) {
-        opts.onError(context.error);
-      }
-      if (!options.onResponseError) {
-        return;
-      }
+      clearInterval(interval);
+      if (opts.onError) opts.onError(context.error);
+      if (!options.onResponseError) return;
       try {
         const arriError = ArriErrorInstance.fromJson(
           await context.response.json()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/client",
-  "version": "0.79.1",
+  "version": "0.80.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -22,10 +22,10 @@
     "directory": "languages/ts/ts-client"
   },
   "dependencies": {
-    "event-source-plus": "^0.1.8",
+    "event-source-plus": "^0.1.11",
     "ofetch": "^1.4.1",
     "ws": "^8.18.2",
-    "@arrirpc/schema": "0.79.1"
+    "@arrirpc/schema": "0.80.0"
   },
   "devDependencies": {
     "@types/ws": "^8.18.1"