@hyper-fetch/sockets 8.1.1 → 8.2.2
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.
- package/README.md +81 -28
- package/__tests__/e2e/e2e.connection.spec.ts +1 -1
- package/__tests__/e2e/e2e.edge-cases.spec.ts +1 -1
- package/__tests__/e2e/e2e.emitters.spec.ts +1 -1
- package/__tests__/e2e/e2e.heartbeat.spec.ts +4 -4
- package/__tests__/features/adapter/adapter.base.spec.ts +1 -0
- package/__tests__/features/adapter/adapter.bindings.spec.ts +2 -1
- package/__tests__/features/adapter/adapter.connection.spec.ts +2 -2
- package/__tests__/features/adapter/adapter.error.spec.ts +1 -1
- package/__tests__/features/adapter/adapter.sse.connection.spec.ts +2 -2
- package/__tests__/features/adapter/adapter.sse.spec.ts +6 -6
- package/__tests__/features/adapter/adapter.websocket.heartbeat.spec.ts +1 -1
- package/__tests__/features/adapter/adapter.websocket.spec.ts +5 -5
- package/__tests__/features/listener/listener.listen.spec.ts +1 -1
- package/__tests__/features/listener/listener.sse.spec.ts +2 -2
- package/__tests__/features/listener/listener.typescript.spec.ts +0 -1
- package/__tests__/features/sdk/sdk.base.spec.ts +11 -14
- package/__tests__/features/sdk/sdk.configuration.spec.ts +9 -11
- package/__tests__/features/sdk/sdk.types.spec.ts +303 -0
- package/__tests__/features/socket/socket.base.spec.ts +4 -4
- package/__tests__/features/socket/socket.callbacks.spec.ts +1 -1
- package/__tests__/features/socket/socket.methods.spec.ts +1 -2
- package/__tests__/features/socket/socket.misc.spec.ts +3 -3
- package/__tests__/features/socket/socket.utils.spec.ts +0 -1
- package/__tests__/tsconfig.json +4 -17
- package/__tests__/utils/client.utils.ts +1 -1
- package/__tests__/utils/emitter.utils.ts +1 -2
- package/__tests__/utils/listener.utils.ts +2 -3
- package/__tests__/utils/socket.utils.ts +2 -2
- package/dist/adapter/adapter.bindings.d.ts +3 -3
- package/dist/adapter/adapter.bindings.d.ts.map +1 -1
- package/dist/adapter/adapter.d.ts +4 -4
- package/dist/adapter/adapter.d.ts.map +1 -1
- package/dist/adapter/adapter.types.d.ts.map +1 -1
- package/dist/adapter-sse/sse-adapter.d.ts +2 -1
- package/dist/adapter-sse/sse-adapter.d.ts.map +1 -1
- package/dist/adapter-sse/sse-adapter.utils.d.ts.map +1 -1
- package/dist/adapter-websockets/websocket-adapter.d.ts +1 -0
- package/dist/adapter-websockets/websocket-adapter.d.ts.map +1 -1
- package/dist/adapter-websockets/websocket-adapter.utils.d.ts.map +1 -1
- package/dist/emitter/emitter.d.ts +11 -1
- package/dist/emitter/emitter.d.ts.map +1 -1
- package/dist/emitter/emitter.types.d.ts +62 -0
- package/dist/emitter/emitter.types.d.ts.map +1 -1
- package/dist/index.mjs +862 -842
- package/dist/index.mjs.map +1 -1
- package/dist/listener/listener.d.ts +9 -1
- package/dist/listener/listener.d.ts.map +1 -1
- package/dist/listener/listener.types.d.ts +67 -0
- package/dist/listener/listener.types.d.ts.map +1 -1
- package/dist/sdk/sdk.d.ts +27 -5
- package/dist/sdk/sdk.d.ts.map +1 -1
- package/dist/socket/socket.create.d.ts +1 -1
- package/dist/socket/socket.create.d.ts.map +1 -1
- package/dist/socket/socket.d.ts +5 -5
- package/dist/socket/socket.d.ts.map +1 -1
- package/dist/socket/socket.events.d.ts +2 -2
- package/dist/socket/socket.events.d.ts.map +1 -1
- package/dist/socket/socket.types.d.ts +1 -1
- package/dist/socket/socket.types.d.ts.map +1 -1
- package/dist/socket/socket.utils.d.ts.map +1 -1
- package/dist/types/tuple.types.d.ts +1 -1
- package/dist/types/tuple.types.d.ts.map +1 -1
- package/dist/utils/socket.errors.d.ts.map +1 -1
- package/package.json +8 -8
- package/src/adapter/adapter.bindings.ts +3 -3
- package/src/adapter/adapter.ts +8 -8
- package/src/adapter/adapter.types.ts +1 -0
- package/src/adapter-sse/sse-adapter.ts +9 -8
- package/src/adapter-sse/sse-adapter.utils.ts +4 -4
- package/src/adapter-websockets/websocket-adapter.ts +12 -11
- package/src/adapter-websockets/websocket-adapter.utils.ts +4 -4
- package/src/emitter/emitter.ts +15 -6
- package/src/emitter/emitter.types.ts +69 -1
- package/src/listener/listener.ts +12 -5
- package/src/listener/listener.types.ts +73 -1
- package/src/sdk/sdk.ts +64 -13
- package/src/socket/socket.create.ts +1 -1
- package/src/socket/socket.events.ts +3 -4
- package/src/socket/socket.ts +8 -9
- package/src/socket/socket.types.ts +1 -1
- package/src/socket/socket.utils.ts +3 -2
- package/src/types/tuple.types.ts +1 -1
- package/src/utils/socket.errors.ts +26 -13
- package/tsconfig.json +20 -2
- package/vite.config.ts +30 -21
- package/.eslintrc.cjs +0 -12
package/README.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
# 🛰️ Hyper Fetch Sockets
|
|
2
2
|
|
|
3
|
-
<p>
|
|
3
|
+
<p align="center">
|
|
4
|
+
<b>Real-time data exchange for WebSockets, SSE, and Firebase. Type-safe listeners with automatic reconnection.</b>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
4
8
|
<a href="https://bettertyped.com/">
|
|
5
9
|
<img src="https://custom-icon-badges.demolab.com/static/v1?label=&message=BetterTyped&color=333&logo=BT" />
|
|
6
10
|
</a>
|
|
@@ -13,56 +17,105 @@
|
|
|
13
17
|
<a href="https://www.npmjs.com/package/@hyper-fetch/sockets">
|
|
14
18
|
<img src="https://custom-icon-badges.demolab.com/npm/v/@hyper-fetch/sockets.svg?logo=npm&color=e76f51" />
|
|
15
19
|
</a>
|
|
20
|
+
<a href="https://www.npmjs.com/package/@hyper-fetch/sockets">
|
|
21
|
+
<img src="https://custom-icon-badges.demolab.com/npm/dm/@hyper-fetch/sockets?logoColor=fff&logo=trending-up" />
|
|
22
|
+
</a>
|
|
16
23
|
<a href="https://github.com/BetterTyped/hyper-fetch">
|
|
17
24
|
<img src="https://custom-icon-badges.demolab.com/badge/typescript-%23007ACC.svg?logo=typescript&logoColor=white" />
|
|
18
25
|
</a>
|
|
19
|
-
<a href="https://
|
|
26
|
+
<a href="https://bundlephobia.com/package/@hyper-fetch/sockets">
|
|
20
27
|
<img src="https://custom-icon-badges.demolab.com/bundlephobia/minzip/@hyper-fetch/sockets?color=64BC4B&logo=package" />
|
|
21
28
|
</a>
|
|
22
29
|
</p>
|
|
23
30
|
|
|
24
|
-
## About
|
|
31
|
+
## 📖 About
|
|
32
|
+
|
|
33
|
+
`@hyper-fetch/sockets` provides a typed abstraction for real-time communication. It wraps WebSockets and Server-Sent
|
|
34
|
+
Events behind a consistent API with typed listeners and emitters, automatic reconnection, offline queuing, and
|
|
35
|
+
authentication support.
|
|
36
|
+
|
|
37
|
+
## 🎯 Key Capabilities
|
|
38
|
+
|
|
39
|
+
- 🔮 **Type-safe events** — Every listener and emitter is typed end-to-end, no more `JSON.parse` guessing
|
|
40
|
+
- 📡 **WebSocket + SSE, one API** — Switch between protocols without rewriting your event handlers
|
|
41
|
+
- 🔁 **Never lose connection** — Auto-reconnect with exponential backoff handles flaky networks for you
|
|
42
|
+
- 📴 **Offline event queuing** — Events you emit offline are saved and sent when connection returns
|
|
43
|
+
- 🔐 **Auth built in** — Token and session-based authentication flows for socket connections
|
|
44
|
+
- ⚛️ **React hooks included** — `useListener` and `useEmitter` plug real-time data straight into components
|
|
45
|
+
- 🖥️ **SSR safe** — Import in server-rendered apps without breaking hydration
|
|
46
|
+
|
|
47
|
+
## 🚀 Quick Start
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npm install @hyper-fetch/sockets
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
import { Socket } from "@hyper-fetch/sockets";
|
|
25
55
|
|
|
26
|
-
|
|
27
|
-
**neutral layer of control** to which we can easily integrate any available solution for dynamic two-way communication.
|
|
56
|
+
const socket = new Socket({ url: "ws://localhost:3000" });
|
|
28
57
|
|
|
29
|
-
|
|
58
|
+
const onMessage = socket.createListener<{ response: { text: string; author: string } }>()({
|
|
59
|
+
endpoint: "chat-message",
|
|
60
|
+
});
|
|
30
61
|
|
|
31
|
-
|
|
62
|
+
onMessage.listen({ callback: ({ data }) => console.log(`${data.author}: ${data.text}`) });
|
|
63
|
+
```
|
|
32
64
|
|
|
33
|
-
|
|
65
|
+
## 📚 Documentation
|
|
34
66
|
|
|
35
|
-
|
|
67
|
+
- [Getting Started](https://hyperfetch.bettertyped.com/docs/getting-started/quick-start)
|
|
68
|
+
- [Sockets Overview](https://hyperfetch.bettertyped.com/docs/sockets/overview)
|
|
69
|
+
- [API Reference](https://hyperfetch.bettertyped.com/api/)
|
|
36
70
|
|
|
37
|
-
|
|
71
|
+
## 💡 Examples
|
|
38
72
|
|
|
39
|
-
|
|
73
|
+
### Emitting typed events
|
|
40
74
|
|
|
41
|
-
|
|
75
|
+
```ts
|
|
76
|
+
const sendMessage = socket.createEmitter<{ payload: { text: string; room: string } }>()({
|
|
77
|
+
endpoint: "send-message",
|
|
78
|
+
});
|
|
42
79
|
|
|
43
|
-
|
|
80
|
+
sendMessage.emit({ data: { text: "Hello!", room: "general" } });
|
|
81
|
+
```
|
|
44
82
|
|
|
45
|
-
|
|
83
|
+
### Listening with React hooks
|
|
46
84
|
|
|
47
|
-
|
|
85
|
+
```tsx
|
|
86
|
+
import { useListener } from "@hyper-fetch/react";
|
|
48
87
|
|
|
49
|
-
|
|
88
|
+
const ChatMessages = ({ room }: { room: string }) => {
|
|
89
|
+
const { data, connected, timestamp } = useListener(onMessage);
|
|
50
90
|
|
|
51
|
-
|
|
91
|
+
return (
|
|
92
|
+
<div>
|
|
93
|
+
<p>Status: {connected ? "Connected" : "Disconnected"}</p>
|
|
94
|
+
{data && (
|
|
95
|
+
<div>
|
|
96
|
+
<strong>{data.author}</strong>: {data.text}
|
|
97
|
+
<small>{new Date(timestamp).toLocaleTimeString()}</small>
|
|
98
|
+
</div>
|
|
99
|
+
)}
|
|
100
|
+
</div>
|
|
101
|
+
);
|
|
102
|
+
};
|
|
103
|
+
```
|
|
52
104
|
|
|
53
|
-
|
|
105
|
+
### Server-Sent Events
|
|
54
106
|
|
|
55
|
-
|
|
107
|
+
```ts
|
|
108
|
+
const sseSocket = new Socket({ url: "https://api.example.com/events" });
|
|
56
109
|
|
|
57
|
-
|
|
110
|
+
const onUpdate = sseSocket.createListener<{ response: { type: string; payload: unknown } }>()({
|
|
111
|
+
endpoint: "data-update",
|
|
112
|
+
});
|
|
58
113
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
- #### [Guides](https://hyperfetch.bettertyped.com/docs/guides/sockets/setup)
|
|
114
|
+
onUpdate.listen({
|
|
115
|
+
callback: ({ data }) => console.log(`Event: ${data.type}`, data.payload),
|
|
116
|
+
});
|
|
117
|
+
```
|
|
64
118
|
|
|
65
|
-
##
|
|
119
|
+
## License
|
|
66
120
|
|
|
67
|
-
|
|
68
|
-
- #### [React Hyper Fetch](https://github.com/BetterTyped/hyper-fetch/tree/main/packages/react)
|
|
121
|
+
[MIT](https://github.com/BetterTyped/hyper-fetch/blob/main/License.md)
|
|
@@ -35,7 +35,7 @@ describe("E2E [ WebSocket Connection ]", () => {
|
|
|
35
35
|
const socket = new Socket({ url, adapterOptions: { autoConnect: false } });
|
|
36
36
|
|
|
37
37
|
socket.events.onConnecting(({ connecting }) => {
|
|
38
|
-
if (connecting) events.push("connecting");
|
|
38
|
+
if (connecting) {events.push("connecting");}
|
|
39
39
|
});
|
|
40
40
|
socket.events.onConnected(() => {
|
|
41
41
|
events.push("connected");
|
|
@@ -145,7 +145,7 @@ describe("E2E [ WebSocket Edge Cases ]", () => {
|
|
|
145
145
|
await waitForConnection(socket);
|
|
146
146
|
|
|
147
147
|
const listenerCount = 100;
|
|
148
|
-
const receivedCounts =
|
|
148
|
+
const receivedCounts = Array.from({ length: listenerCount }, () => 0);
|
|
149
149
|
|
|
150
150
|
for (let i = 0; i < listenerCount; i += 1) {
|
|
151
151
|
const idx = i;
|
|
@@ -140,7 +140,7 @@ describe("E2E [ WebSocket Emitters ]", () => {
|
|
|
140
140
|
|
|
141
141
|
const messages: any[] = [];
|
|
142
142
|
wsServer.onMessage((msg) => {
|
|
143
|
-
if (msg.topic === "sequential") messages.push(msg);
|
|
143
|
+
if (msg.topic === "sequential") {messages.push(msg);}
|
|
144
144
|
});
|
|
145
145
|
|
|
146
146
|
for (let i = 0; i < 5; i += 1) {
|
|
@@ -22,7 +22,7 @@ describe("E2E [ WebSocket Heartbeat ]", () => {
|
|
|
22
22
|
|
|
23
23
|
const heartbeats: any[] = [];
|
|
24
24
|
onMessage((msg) => {
|
|
25
|
-
if (msg.topic === "heartbeat") heartbeats.push(msg);
|
|
25
|
+
if (msg.topic === "heartbeat") {heartbeats.push(msg);}
|
|
26
26
|
});
|
|
27
27
|
|
|
28
28
|
// Wait for at least one heartbeat
|
|
@@ -82,7 +82,7 @@ describe("E2E [ WebSocket Heartbeat ]", () => {
|
|
|
82
82
|
|
|
83
83
|
const heartbeats: any[] = [];
|
|
84
84
|
onMessage((msg) => {
|
|
85
|
-
if (msg.topic === "heartbeat") heartbeats.push(msg);
|
|
85
|
+
if (msg.topic === "heartbeat") {heartbeats.push(msg);}
|
|
86
86
|
});
|
|
87
87
|
|
|
88
88
|
// Send activity messages to keep resetting the heartbeat timer
|
|
@@ -119,7 +119,7 @@ describe("E2E [ WebSocket Heartbeat ]", () => {
|
|
|
119
119
|
|
|
120
120
|
const heartbeats: any[] = [];
|
|
121
121
|
onMessage((msg) => {
|
|
122
|
-
if (msg.topic === "heartbeat") heartbeats.push(msg);
|
|
122
|
+
if (msg.topic === "heartbeat") {heartbeats.push(msg);}
|
|
123
123
|
});
|
|
124
124
|
|
|
125
125
|
await sleep(600);
|
|
@@ -148,7 +148,7 @@ describe("E2E [ WebSocket Heartbeat ]", () => {
|
|
|
148
148
|
|
|
149
149
|
const heartbeats: any[] = [];
|
|
150
150
|
onMessage((msg) => {
|
|
151
|
-
if (msg.topic === "heartbeat") heartbeats.push(msg);
|
|
151
|
+
if (msg.topic === "heartbeat") {heartbeats.push(msg);}
|
|
152
152
|
});
|
|
153
153
|
|
|
154
154
|
await sleep(500);
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { createSocket } from "../../utils/socket.utils";
|
|
2
1
|
import { getAdapterBindings } from "adapter";
|
|
3
2
|
|
|
3
|
+
import { createSocket } from "../../utils/socket.utils";
|
|
4
|
+
|
|
4
5
|
describe("Socket Adapter [ Bindings ]", () => {
|
|
5
6
|
let socket = createSocket({ adapterOptions: { autoConnect: false } });
|
|
6
7
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { waitFor } from "@testing-library/dom";
|
|
2
1
|
import { createWebsocketMockingServer, sleep, waitForConnection } from "@hyper-fetch/testing";
|
|
2
|
+
import { waitFor } from "@testing-library/dom";
|
|
3
|
+
import { Socket } from "socket";
|
|
3
4
|
|
|
4
5
|
import { createSocket } from "../../utils/socket.utils";
|
|
5
|
-
import { Socket } from "socket";
|
|
6
6
|
|
|
7
7
|
const socketOptions: Parameters<typeof createSocket>[0] = {
|
|
8
8
|
reconnectTime: 10,
|
|
@@ -84,7 +84,7 @@ describe("Adapter [ Error ]", () => {
|
|
|
84
84
|
);
|
|
85
85
|
const event3 = new Event("close");
|
|
86
86
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
87
|
-
// @ts-
|
|
87
|
+
// @ts-expect-error
|
|
88
88
|
event3.code = 1010;
|
|
89
89
|
expect(getSocketError(event3)).toBe(
|
|
90
90
|
"An endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. <br /> Specifically, the extensions that are needed are: Unknown reason",
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { waitFor } from "@testing-library/dom";
|
|
2
1
|
import { createSseMockingServer, sleep } from "@hyper-fetch/testing";
|
|
2
|
+
import { waitFor } from "@testing-library/dom";
|
|
3
|
+
import { ServerSentEventsAdapter } from "adapter-sse";
|
|
3
4
|
|
|
4
5
|
import { createSocket } from "../../utils/socket.utils";
|
|
5
|
-
import { ServerSentEventsAdapter } from "adapter-sse";
|
|
6
6
|
|
|
7
7
|
const socketOptions: Parameters<typeof createSocket>[0] = {
|
|
8
8
|
reconnectTime: 10,
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
+
import { createSseMockingServer, sleep } from "@hyper-fetch/testing";
|
|
1
2
|
/* eslint-disable max-classes-per-file */
|
|
2
3
|
import { waitFor } from "@testing-library/dom";
|
|
3
|
-
import { createSseMockingServer, sleep } from "@hyper-fetch/testing";
|
|
4
|
-
|
|
5
|
-
import { createSocket } from "../../utils/socket.utils";
|
|
6
4
|
import type { ServerSentEventsAdapterType } from "adapter-sse/sse-adapter";
|
|
7
5
|
import { ServerSentEventsAdapter } from "adapter-sse/sse-adapter";
|
|
6
|
+
|
|
8
7
|
import { getServerSentEventsAdapter } from "../../../src/adapter-sse/sse-adapter.utils";
|
|
8
|
+
import { createSocket } from "../../utils/socket.utils";
|
|
9
9
|
|
|
10
10
|
const socketOptions: Parameters<typeof createSocket>[0] = {
|
|
11
11
|
adapter: ServerSentEventsAdapter,
|
|
@@ -135,7 +135,7 @@ describe("Socket Adapter [ SSE ]", () => {
|
|
|
135
135
|
it("should handle missing EventSource gracefully", async () => {
|
|
136
136
|
const eventSource = window.EventSource;
|
|
137
137
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
138
|
-
// @ts-
|
|
138
|
+
// @ts-expect-error-error
|
|
139
139
|
window.EventSource = undefined;
|
|
140
140
|
|
|
141
141
|
const spy = vi.fn();
|
|
@@ -177,7 +177,7 @@ describe("Socket Adapter [ SSE ]", () => {
|
|
|
177
177
|
}
|
|
178
178
|
}
|
|
179
179
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
180
|
-
// @ts-
|
|
180
|
+
// @ts-expect-error-error
|
|
181
181
|
window.EventSource = OpenEventSource;
|
|
182
182
|
|
|
183
183
|
const newSocket = createSocket<ServerSentEventsAdapterType>({
|
|
@@ -203,7 +203,7 @@ describe("Socket Adapter [ SSE ]", () => {
|
|
|
203
203
|
}
|
|
204
204
|
}
|
|
205
205
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
206
|
-
// @ts-
|
|
206
|
+
// @ts-expect-error-error
|
|
207
207
|
window.EventSource = OpenEventSource;
|
|
208
208
|
|
|
209
209
|
const newSocket = createSocket<ServerSentEventsAdapterType>(socketOptions);
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
+
import { createWebsocketMockingServer, waitForConnection } from "@hyper-fetch/testing";
|
|
1
2
|
/* eslint-disable max-classes-per-file */
|
|
2
3
|
import { waitFor } from "@testing-library/dom";
|
|
3
|
-
import {
|
|
4
|
+
import type { Socket } from "socket";
|
|
4
5
|
|
|
5
6
|
import type { WebsocketAdapterType } from "../../../src/adapter-websockets/websocket-adapter";
|
|
6
7
|
import { WebsocketAdapter } from "../../../src/adapter-websockets/websocket-adapter";
|
|
7
8
|
import { getWebsocketAdapter } from "../../../src/adapter-websockets/websocket-adapter.utils";
|
|
8
9
|
import { createSocket } from "../../utils/socket.utils";
|
|
9
|
-
import type { Socket } from "socket";
|
|
10
10
|
|
|
11
11
|
describe("Websocket Adapter [ Base ]", () => {
|
|
12
12
|
const { url, getServer, startServer, stopServer } = createWebsocketMockingServer();
|
|
@@ -38,7 +38,7 @@ describe("Websocket Adapter [ Base ]", () => {
|
|
|
38
38
|
it("should handle missing WebSocket gracefully", async () => {
|
|
39
39
|
const eventSource = window.WebSocket;
|
|
40
40
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
41
|
-
// @ts-
|
|
41
|
+
// @ts-expect-error-error
|
|
42
42
|
window.WebSocket = undefined;
|
|
43
43
|
|
|
44
44
|
const spy = vi.fn();
|
|
@@ -82,7 +82,7 @@ describe("Websocket Adapter [ Base ]", () => {
|
|
|
82
82
|
}
|
|
83
83
|
}
|
|
84
84
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
85
|
-
// @ts-
|
|
85
|
+
// @ts-expect-error-error
|
|
86
86
|
window.WebSocket = NewWebsocket;
|
|
87
87
|
|
|
88
88
|
const newSocket = createSocket({
|
|
@@ -111,7 +111,7 @@ describe("Websocket Adapter [ Base ]", () => {
|
|
|
111
111
|
}
|
|
112
112
|
}
|
|
113
113
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
114
|
-
// @ts-
|
|
114
|
+
// @ts-expect-error-error
|
|
115
115
|
window.WebSocket = NewWebsocket;
|
|
116
116
|
|
|
117
117
|
const newSocket = createSocket();
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { waitFor } from "@testing-library/dom";
|
|
2
1
|
import { createWebsocketMockingServer, sleep } from "@hyper-fetch/testing";
|
|
2
|
+
import { waitFor } from "@testing-library/dom";
|
|
3
3
|
|
|
4
4
|
import { createListener } from "../../utils/listener.utils";
|
|
5
5
|
import { createSocket } from "../../utils/socket.utils";
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { waitFor } from "@testing-library/dom";
|
|
2
1
|
import { createSseMockingServer, sleep, waitForConnection } from "@hyper-fetch/testing";
|
|
2
|
+
import { waitFor } from "@testing-library/dom";
|
|
3
|
+
import { ServerSentEventsAdapter } from "adapter-sse/sse-adapter";
|
|
3
4
|
|
|
4
5
|
import { createListener } from "../../utils/listener.utils";
|
|
5
6
|
import { createSocket } from "../../utils/socket.utils";
|
|
6
|
-
import { ServerSentEventsAdapter } from "adapter-sse/sse-adapter";
|
|
7
7
|
|
|
8
8
|
const config = {
|
|
9
9
|
adapter: ServerSentEventsAdapter,
|
|
@@ -1,40 +1,38 @@
|
|
|
1
|
-
import type { SocketInstance } from "socket";
|
|
2
|
-
import { Listener } from "listener";
|
|
3
|
-
import type { ListenerInstance } from "listener";
|
|
4
1
|
import { Emitter } from "emitter";
|
|
5
|
-
import type {
|
|
2
|
+
import type { EmitterModel } from "emitter";
|
|
3
|
+
import { Listener } from "listener";
|
|
4
|
+
import type { ListenerModel } from "listener";
|
|
6
5
|
import { createSocketSdk } from "sdk";
|
|
6
|
+
import type { SocketInstance } from "socket";
|
|
7
|
+
|
|
7
8
|
import { createSocket } from "../../utils/socket.utils";
|
|
8
9
|
|
|
9
10
|
type TestSocket = SocketInstance;
|
|
10
11
|
|
|
12
|
+
// Schema does not need to declare `socket` per leaf - the SDK injects it from createSocketSdk(socket).
|
|
11
13
|
type TestSchema = {
|
|
12
14
|
chat: {
|
|
13
15
|
messages: {
|
|
14
|
-
$listener:
|
|
16
|
+
$listener: ListenerModel<{
|
|
15
17
|
response: { text: string; user: string };
|
|
16
18
|
topic: "chat/messages";
|
|
17
|
-
socket: TestSocket;
|
|
18
19
|
}>;
|
|
19
|
-
$emitter:
|
|
20
|
+
$emitter: EmitterModel<{
|
|
20
21
|
payload: { text: string };
|
|
21
22
|
topic: "chat/messages";
|
|
22
|
-
socket: TestSocket;
|
|
23
23
|
}>;
|
|
24
24
|
};
|
|
25
25
|
$roomId: {
|
|
26
|
-
$listener:
|
|
26
|
+
$listener: ListenerModel<{
|
|
27
27
|
response: { text: string; user: string };
|
|
28
28
|
topic: "chat/:roomId";
|
|
29
|
-
socket: TestSocket;
|
|
30
29
|
}>;
|
|
31
30
|
};
|
|
32
31
|
};
|
|
33
32
|
notifications: {
|
|
34
|
-
$listener:
|
|
33
|
+
$listener: ListenerModel<{
|
|
35
34
|
response: { message: string };
|
|
36
35
|
topic: "notifications";
|
|
37
|
-
socket: TestSocket;
|
|
38
36
|
}>;
|
|
39
37
|
};
|
|
40
38
|
};
|
|
@@ -107,10 +105,9 @@ describe("Socket SDK [ Base ]", () => {
|
|
|
107
105
|
it("should handle camelCase to kebab-case conversion", () => {
|
|
108
106
|
type KebabSchema = {
|
|
109
107
|
someChannel: {
|
|
110
|
-
$listener:
|
|
108
|
+
$listener: ListenerModel<{
|
|
111
109
|
response: any;
|
|
112
110
|
topic: "some-channel";
|
|
113
|
-
socket: TestSocket;
|
|
114
111
|
}>;
|
|
115
112
|
};
|
|
116
113
|
};
|
|
@@ -1,39 +1,37 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
import type { EmitterInstance } from "emitter";
|
|
1
|
+
import type { EmitterModel } from "emitter";
|
|
2
|
+
import type { ListenerModel } from "listener";
|
|
4
3
|
import type { SocketSdkConfigurationValue } from "sdk";
|
|
5
4
|
import { createSocketSdk, createSocketConfiguration } from "sdk";
|
|
5
|
+
import type { SocketInstance } from "socket";
|
|
6
|
+
|
|
6
7
|
import { createSocket } from "../../utils/socket.utils";
|
|
7
8
|
|
|
8
9
|
type TestSocket = SocketInstance;
|
|
9
10
|
|
|
11
|
+
// Schema does not need to declare `socket` per leaf - the SDK injects it from createSocketSdk(socket).
|
|
10
12
|
type TestSchema = {
|
|
11
13
|
chat: {
|
|
12
14
|
messages: {
|
|
13
|
-
$listener:
|
|
15
|
+
$listener: ListenerModel<{
|
|
14
16
|
response: { text: string; user: string };
|
|
15
17
|
topic: "chat/messages";
|
|
16
|
-
socket: TestSocket;
|
|
17
18
|
}>;
|
|
18
|
-
$emitter:
|
|
19
|
+
$emitter: EmitterModel<{
|
|
19
20
|
payload: { text: string };
|
|
20
21
|
topic: "chat/messages";
|
|
21
|
-
socket: TestSocket;
|
|
22
22
|
}>;
|
|
23
23
|
};
|
|
24
24
|
rooms: {
|
|
25
|
-
$listener:
|
|
25
|
+
$listener: ListenerModel<{
|
|
26
26
|
response: { name: string };
|
|
27
27
|
topic: "chat/rooms";
|
|
28
|
-
socket: TestSocket;
|
|
29
28
|
}>;
|
|
30
29
|
};
|
|
31
30
|
};
|
|
32
31
|
notifications: {
|
|
33
|
-
$listener:
|
|
32
|
+
$listener: ListenerModel<{
|
|
34
33
|
response: { message: string };
|
|
35
34
|
topic: "notifications";
|
|
36
|
-
socket: TestSocket;
|
|
37
35
|
}>;
|
|
38
36
|
};
|
|
39
37
|
};
|