@hyper-fetch/sockets 9.1.0 → 9.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -115,6 +115,12 @@ export declare class Socket<Adapter extends SocketAdapterInstance = WebsocketAda
115
115
  * This method reconnect the socket to the server
116
116
  */
117
117
  reconnect: () => Promise<void>;
118
+ /**
119
+ * Set the url used by the next connection attempts - e.g. when switching tenants, regions or environments at runtime.
120
+ * Call `reconnect()` to apply it to a live connection, or use `onConnect` to resolve it per attempt.
121
+ * Listeners stay registered, so they keep receiving events after reconnecting.
122
+ */
123
+ setUrl: (url: string) => this;
118
124
  /**
119
125
  * Set the default query params used by the next connection attempts.
120
126
  * Call `reconnect()` to apply them to a live connection, or use `onConnect` to resolve them per attempt.
@@ -1 +1 @@
1
- {"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../src/socket/socket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAQ,MAAM,mBAAmB,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC3E,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC3B,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,OAAO,CAAC;AAEpF,qBAAa,MAAM,CAAC,OAAO,SAAS,qBAAqB,GAAG,oBAAoB;IA4B3D,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;IA3B/C,OAAO,eAAsB;IAC7B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAiC;IAE9C,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IAGrB,2BAA2B,EAAE,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAM;IACjE,6BAA6B,EAAE,gBAAgB,EAAE,CAAM;IACvD,8BAA8B,EAAE,iBAAiB,EAAE,CAAM;IACzD,6BAA6B,EAAE,qBAAqB,EAAE,CAAM;IAC5D,mCAAmC,EAAE,2BAA2B,EAAE,CAAM;IACxE,2BAA2B,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAM;IAC7D,wBAAwB,EAAE,gBAAgB,CAAC,eAAe,CAAC,EAAE,CAAM;IACnE,yBAAyB,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAM;IAGzD,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,gBAAuB;IACpC,UAAU,aAAoB;IAG9B,MAAM,4CAAiD;gBAEpC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAkBtD;;OAEG;IACH,OAAO,sBAEL;IAEF;;OAEG;IACH,UAAU,sBAER;IAEF;;OAEG;IACH,SAAS,sBAEP;IAEF;;;OAGG;IACH,cAAc,GAAI,aAAa,6BAA6B,CAAC,OAAO,CAAC,UAGnE;IAEF;;OAEG;IACH,QAAQ,GAAI,SAAS,OAAO,UAG1B;IAEF;;OAEG;IACH,WAAW,GAAI,OAAO,QAAQ,UAG5B;IAEF;;OAEG;IACH,SAAS,GAAI,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,aAAa,UAG/D;IAEF;;OAEG;IAEH;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAKhD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,gBAAgB;IAItC;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,iBAAiB;IAK1C;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,qBAAqB;IAK3C;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,2BAA2B;IAKvD;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,mBAAmB,CAAC,KAAK,CAAC;IAKrD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,CAAC,eAAe,CAAC;IAKlD;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;IAKjD;;;;OAIG;IAEH,0BAA0B,GAAI,MAAM;QAAE,UAAU,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,4CAEhG;IAEF,oBAAoB,GAAI,SAAS,eAAe,qBAE9C;IAEF,wBAAwB,GAAI,MAAM;QAAE,IAAI,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAA;KAAE;;;MAEtF;IAEF;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc,GAAI,QAAQ,QAChB,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,SAAS,EAC5G,SAAS,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,iGAOlE;IAEF;;;;OAIG;IACH,aAAa,GAAI,OAAO,QACd,QAAQ,SAAS,MAAM,EAAE,SAAS,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,+DAG/E;CACH"}
1
+ {"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../src/socket/socket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAQ,MAAM,mBAAmB,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC3E,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC3B,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,OAAO,CAAC;AAEpF,qBAAa,MAAM,CAAC,OAAO,SAAS,qBAAqB,GAAG,oBAAoB;IA4B3D,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;IA3B/C,OAAO,eAAsB;IAC7B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAiC;IAE9C,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IAGrB,2BAA2B,EAAE,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAM;IACjE,6BAA6B,EAAE,gBAAgB,EAAE,CAAM;IACvD,8BAA8B,EAAE,iBAAiB,EAAE,CAAM;IACzD,6BAA6B,EAAE,qBAAqB,EAAE,CAAM;IAC5D,mCAAmC,EAAE,2BAA2B,EAAE,CAAM;IACxE,2BAA2B,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAM;IAC7D,wBAAwB,EAAE,gBAAgB,CAAC,eAAe,CAAC,EAAE,CAAM;IACnE,yBAAyB,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAM;IAGzD,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,gBAAuB;IACpC,UAAU,aAAoB;IAG9B,MAAM,4CAAiD;gBAEpC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAkBtD;;OAEG;IACH,OAAO,sBAEL;IAEF;;OAEG;IACH,UAAU,sBAER;IAEF;;OAEG;IACH,SAAS,sBAEP;IAEF;;;;OAIG;IACH,MAAM,GAAI,KAAK,MAAM,UAGnB;IAEF;;;OAGG;IACH,cAAc,GAAI,aAAa,6BAA6B,CAAC,OAAO,CAAC,UAGnE;IAEF;;OAEG;IACH,QAAQ,GAAI,SAAS,OAAO,UAG1B;IAEF;;OAEG;IACH,WAAW,GAAI,OAAO,QAAQ,UAG5B;IAEF;;OAEG;IACH,SAAS,GAAI,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,aAAa,UAG/D;IAEF;;OAEG;IAEH;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAKhD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,gBAAgB;IAItC;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,iBAAiB;IAK1C;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,qBAAqB;IAK3C;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,2BAA2B;IAKvD;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,mBAAmB,CAAC,KAAK,CAAC;IAKrD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,CAAC,eAAe,CAAC;IAKlD;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC;IAKjD;;;;OAIG;IAEH,0BAA0B,GAAI,MAAM;QAAE,UAAU,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,4CAEhG;IAEF,oBAAoB,GAAI,SAAS,eAAe,qBAE9C;IAEF,wBAAwB,GAAI,MAAM;QAAE,IAAI,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAA;KAAE;;;MAEtF;IAEF;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc,GAAI,QAAQ,QAChB,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,SAAS,EAC5G,SAAS,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,iGAOlE;IAEF;;;;OAIG;IACH,aAAa,GAAI,OAAO,QACd,QAAQ,SAAS,MAAM,EAAE,SAAS,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,+DAG/E;CACH"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hyper-fetch/sockets",
3
- "version": "9.1.0",
3
+ "version": "9.2.0",
4
4
  "description": "Sockets connection for hyper-fetch",
5
5
  "author": "Maciej Pyrc <maciekpyrc@gmail.com>, Kacper Skawina <kacper.skawina@gmail.com>",
6
6
  "homepage": "https://hyperfetch.bettertyped.com/",
@@ -7,7 +7,7 @@ import type { ListenerCallbackType, ListenerOfAdapter } from "listener";
7
7
 
8
8
  import { getSocketUrl, parseMessageEvent } from "../utils";
9
9
  import { getSocketError } from "../utils/socket.errors";
10
- import type { SSEAdapterOptionsType } from "./sse-adapter.types";
10
+ import type { SSEAdapterOptionsType, SSEDecodedMessageType } from "./sse-adapter.types";
11
11
  import { getServerSentEventsAdapter } from "./sse-adapter.utils";
12
12
 
13
13
  /**
@@ -60,6 +60,23 @@ export const ServerSentEventsAdapter = (): ServerSentEventsAdapterType =>
60
60
  ? socket.adapter.adapterOptions?.autoConnect
61
61
  : true;
62
62
 
63
+ /** Maps an incoming message to the listener event, reporting decoder failures instead of throwing */
64
+ const decodeMessage = (
65
+ event: MessageEvent<SocketData>,
66
+ decode: SSEAdapterOptionsType["decode"],
67
+ ): SSEDecodedMessageType | null => {
68
+ try {
69
+ if (decode) {
70
+ return decode(event);
71
+ }
72
+ const { topic, data } = parseMessageEvent(event);
73
+ return { topic, data };
74
+ } catch (error) {
75
+ onError({ error: error as Error });
76
+ return null;
77
+ }
78
+ };
79
+
63
80
  const connect = async (): Promise<boolean> => {
64
81
  const connection = await onConnect();
65
82
  if (!connection) {
@@ -97,10 +114,12 @@ export const ServerSentEventsAdapter = (): ServerSentEventsAdapterType =>
97
114
  onError({ error: new Error(error) });
98
115
  });
99
116
 
117
+ const { decode } = connection.adapterOptions || {};
100
118
  eventSource.addEventListener("message", (newEvent: MessageEvent<SocketData>) => {
101
- const { topic, data, event } = parseMessageEvent(newEvent);
102
-
103
- onEvent({ topic, data, extra: event });
119
+ const message = decodeMessage(newEvent, decode);
120
+ if (message) {
121
+ onEvent({ topic: message.topic, data: message.data, extra: newEvent });
122
+ }
104
123
  });
105
124
 
106
125
  return new Promise((resolve) => {
@@ -1,6 +1,15 @@
1
1
  // Options
2
2
 
3
+ /** Listener event decoded from an incoming message */
4
+ export type SSEDecodedMessageType = { topic: string; data: unknown };
5
+
3
6
  export type SSEAdapterOptionsType = {
4
7
  eventSourceInit?: EventSourceInit;
5
8
  autoConnect?: boolean;
9
+ /**
10
+ * Turns an incoming message into a listener event - use it when the server does not send `{ topic, data }`
11
+ * (e.g. `{ type, payload }`). Return `null` to ignore the message.
12
+ * Defaults to parsing the message as JSON and reading its `topic` and `data` fields.
13
+ */
14
+ decode?: (event: MessageEvent) => SSEDecodedMessageType | null;
6
15
  };
@@ -8,7 +8,7 @@ import type { ListenerCallbackType, ListenerOfAdapter } from "listener";
8
8
 
9
9
  import { getSocketUrl, parseMessageEvent } from "../utils";
10
10
  import { getSocketError } from "../utils/socket.errors";
11
- import type { WebsocketAdapterOptionsType } from "./websocket-adapter.types";
11
+ import type { WebsocketAdapterOptionsType, WebsocketDecodedMessageType } from "./websocket-adapter.types";
12
12
  import { getWebsocketAdapter } from "./websocket-adapter.utils";
13
13
 
14
14
  /**
@@ -120,10 +120,13 @@ export const WebsocketAdapter = (): WebsocketAdapterType =>
120
120
  });
121
121
 
122
122
  newWebsocket.addEventListener("message", (newEvent: MessageEvent<SocketData>) => {
123
- const { topic, data, event } = parseMessageEvent(newEvent);
124
-
125
- onEvent({ topic, data, extra: event });
123
+ // Any frame proves the connection is alive, even the ones ignored by the decoder
126
124
  onHeartbeat();
125
+
126
+ const message = decodeMessage(newEvent);
127
+ if (message) {
128
+ onEvent({ topic: message.topic, data: message.data, extra: newEvent });
129
+ }
127
130
  });
128
131
 
129
132
  return new Promise((resolve) => {
@@ -209,12 +212,34 @@ export const WebsocketAdapter = (): WebsocketAdapterType =>
209
212
  clearTimeout(pongTimer);
210
213
  };
211
214
 
215
+ /** Maps an incoming frame to the listener event, reporting decoder failures instead of throwing */
216
+ const decodeMessage = (event: MessageEvent<SocketData>): WebsocketDecodedMessageType | null => {
217
+ try {
218
+ if (options?.decode) {
219
+ return options.decode(event);
220
+ }
221
+ const { topic, data } = parseMessageEvent(event);
222
+ return { topic, data };
223
+ } catch (error) {
224
+ onError({ error: error as Error });
225
+ return null;
226
+ }
227
+ };
228
+
212
229
  const sendEventMessage = ({ topic, payload }: Pick<EmitterInstance, "topic" | "payload">) => {
213
230
  if (!websocket) {
214
231
  return false;
215
232
  }
216
- websocket!.send(JSON.stringify({ topic, data: payload }));
217
- return true;
233
+ try {
234
+ const frame = options?.encode
235
+ ? options.encode({ topic, payload })
236
+ : JSON.stringify({ topic, data: payload });
237
+ websocket.send(frame);
238
+ return true;
239
+ } catch (error) {
240
+ onError({ error: error as Error });
241
+ return false;
242
+ }
218
243
  };
219
244
 
220
245
  const onHeartbeat = () => {
@@ -1,3 +1,12 @@
1
+ /** Listener event decoded from an incoming frame */
2
+ export type WebsocketDecodedMessageType = { topic: string; data: unknown };
3
+
4
+ /** Emitted message to be encoded into an outgoing frame */
5
+ export type WebsocketEncodeMessageType = { topic: string; payload: unknown };
6
+
7
+ /** Frame accepted by `WebSocket.send` */
8
+ export type WebsocketFrameType = Parameters<WebSocket["send"]>[0];
9
+
1
10
  export type WebsocketAdapterOptionsType = {
2
11
  /**
3
12
  * Subprotocols passed to the `WebSocket` constructor (`Sec-WebSocket-Protocol` header).
@@ -9,4 +18,15 @@ export type WebsocketAdapterOptionsType = {
9
18
  heartbeatMessage?: string;
10
19
  heartbeat?: boolean;
11
20
  autoConnect?: boolean;
21
+ /**
22
+ * Turns an incoming frame into a listener event - use it when the server does not send `{ topic, data }`
23
+ * (e.g. `{ type, payload }`). Return `null` to ignore the frame (pings, unknown messages).
24
+ * Defaults to parsing the frame as JSON and reading its `topic` and `data` fields.
25
+ */
26
+ decode?: (event: MessageEvent) => WebsocketDecodedMessageType | null;
27
+ /**
28
+ * Turns an emitted message (and the heartbeat ping) into the frame passed to `websocket.send`.
29
+ * Defaults to `JSON.stringify({ topic, data: payload })`.
30
+ */
31
+ encode?: (message: WebsocketEncodeMessageType) => WebsocketFrameType;
12
32
  };
@@ -91,6 +91,16 @@ export class Socket<Adapter extends SocketAdapterInstance = WebsocketAdapterType
91
91
  await this.adapter.reconnect();
92
92
  };
93
93
 
94
+ /**
95
+ * Set the url used by the next connection attempts - e.g. when switching tenants, regions or environments at runtime.
96
+ * Call `reconnect()` to apply it to a live connection, or use `onConnect` to resolve it per attempt.
97
+ * Listeners stay registered, so they keep receiving events after reconnecting.
98
+ */
99
+ setUrl = (url: string) => {
100
+ this.url = url;
101
+ return this;
102
+ };
103
+
94
104
  /**
95
105
  * Set the default query params used by the next connection attempts.
96
106
  * Call `reconnect()` to apply them to a live connection, or use `onConnect` to resolve them per attempt.