@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
|
@@ -10,13 +10,75 @@ export type EmitterInstanceProperties = {
|
|
|
10
10
|
hasParams?: boolean;
|
|
11
11
|
hasPayload?: boolean;
|
|
12
12
|
};
|
|
13
|
+
/**
|
|
14
|
+
* The **constraint** form of an Emitter type. Mindset: "any Emitter that matches this partial shape".
|
|
15
|
+
*
|
|
16
|
+
* Use `EmitterInstance` when you are writing a **reusable abstraction** that accepts emitters
|
|
17
|
+
* from the outside - generic helpers (`<T extends EmitterInstance>`), reusable UI components /
|
|
18
|
+
* hooks, `sdk.$configure({...})` callbacks, mocking utilities, return types, etc.
|
|
19
|
+
*
|
|
20
|
+
* Unspecified generic parameters default to `any` **on purpose**: an omitted field means
|
|
21
|
+
* "I do not care about that field, the caller picks anything". This is exactly what you want
|
|
22
|
+
* for a constraint - any concrete `Emitter` satisfies it. Partial constraints work too:
|
|
23
|
+
* `EmitterInstance<{ payload: { text: string } }>` accepts every emitter whose payload has a
|
|
24
|
+
* `text` field, regardless of topic, params, etc.
|
|
25
|
+
*
|
|
26
|
+
* For describing a **single topic** inside a socket SDK schema, use {@link EmitterModel} instead.
|
|
27
|
+
* `EmitterModel` uses safe non-`any` defaults (`undefined`, `string`, `false`) so omitted fields
|
|
28
|
+
* stay strict instead of silently collapsing to `any`.
|
|
29
|
+
*
|
|
30
|
+
* @see {@link EmitterModel} - definition counterpart for SDK schema modeling.
|
|
31
|
+
*/
|
|
13
32
|
export type EmitterInstance<EmitterProperties extends EmitterInstanceProperties = {}> = Emitter<TypeWithDefaults<EmitterProperties, "payload", any>, TypeWithDefaults<EmitterProperties, "topic", any>, TypeWithDefaults<EmitterProperties, "socket", SocketInstance>, TypeWithDefaults<EmitterProperties, "hasPayload", any>, TypeWithDefaults<EmitterProperties, "hasParams", any>>;
|
|
33
|
+
/**
|
|
34
|
+
* The **definition** form of an Emitter type. Mindset: "**this** specific topic".
|
|
35
|
+
*
|
|
36
|
+
* Use `EmitterModel` when you are **defining** an emitter inside a socket SDK schema. Unlike
|
|
37
|
+
* {@link EmitterInstance}, every unspecified field stays strict instead of falling back to
|
|
38
|
+
* `any` - because in a definition, an omitted field means "**this topic carries no payload**",
|
|
39
|
+
* not "anything goes". The type system will reject mismatches at the call site instead of
|
|
40
|
+
* silently erasing them.
|
|
41
|
+
*
|
|
42
|
+
* The `socket` field is also injected automatically by `createSocketSdk(socket)` at the SDK
|
|
43
|
+
* boundary, so you never need to repeat it inside schema declarations.
|
|
44
|
+
*
|
|
45
|
+
* ### Defaults for omitted fields
|
|
46
|
+
*
|
|
47
|
+
* | Field | Default | Why |
|
|
48
|
+
* | ------------ | ---------------- | ---------------------------------------------------------------- |
|
|
49
|
+
* | `payload` | `undefined` | "No payload declared." `.setData()` is required for typed bodies.|
|
|
50
|
+
* | `topic` | `string` | Allows literal narrowing without erasure. Pass a string literal. |
|
|
51
|
+
* | `socket` | `SocketInstance` | Injected by `createSocketSdk(socket)`; do not set this manually. |
|
|
52
|
+
* | `hasPayload` | `false` | "Caller must call `.setData()`." Override only when bound. |
|
|
53
|
+
* | `hasParams` | `false` | "Caller must call `.setParams()`." Override only when bound. |
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* // Schema describes shape only - socket is injected by createSocketSdk(socket).
|
|
58
|
+
* type ChatSchema = {
|
|
59
|
+
* chat: {
|
|
60
|
+
* messages: {
|
|
61
|
+
* $emitter: EmitterModel<{
|
|
62
|
+
* payload: { text: string };
|
|
63
|
+
* topic: "chat/messages";
|
|
64
|
+
* }>;
|
|
65
|
+
* };
|
|
66
|
+
* };
|
|
67
|
+
* };
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @see {@link EmitterInstance} - constraint counterpart for accepting any Emitter.
|
|
71
|
+
*/
|
|
72
|
+
export type EmitterModel<EmitterProperties extends EmitterInstanceProperties = {}> = Emitter<TypeWithDefaults<EmitterProperties, "payload", undefined>, TypeWithDefaults<EmitterProperties, "topic", string>, TypeWithDefaults<EmitterProperties, "socket", SocketInstance>, TypeWithDefaults<EmitterProperties, "hasPayload", false>, TypeWithDefaults<EmitterProperties, "hasParams", false>>;
|
|
14
73
|
export type EmitterCloneOptionsType<Payload, Params, Topic extends string, Socket extends SocketInstance> = {
|
|
15
74
|
payload?: Payload;
|
|
16
75
|
params?: Params | null;
|
|
17
76
|
} & Partial<EmitterOptionsType<Topic, ExtractSocketAdapterType<Socket>>>;
|
|
77
|
+
/** Configuration options for creating an Emitter instance. */
|
|
18
78
|
export type EmitterOptionsType<Topic extends string, AdapterType extends SocketAdapterInstance> = {
|
|
79
|
+
/** The topic/channel name to emit messages on */
|
|
19
80
|
topic: Topic;
|
|
81
|
+
/** Adapter-specific emit options */
|
|
20
82
|
options?: ExtractAdapterEmitterOptionsType<AdapterType>;
|
|
21
83
|
};
|
|
22
84
|
export type EmitterCallbackErrorType = (data: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"emitter.types.d.ts","sourceRoot":"","sources":["../../src/emitter/emitter.types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"emitter.types.d.ts","sourceRoot":"","sources":["../../src/emitter/emitter.types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpG,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EACV,wBAAwB,EACxB,4BAA4B,EAC5B,2BAA2B,EAC3B,uBAAuB,EACvB,yBAAyB,EACzB,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,CAAC,iBAAiB,SAAS,yBAAyB,GAAG,EAAE,IAAI,OAAO,CAC7F,gBAAgB,CAAC,iBAAiB,EAAE,SAAS,EAAE,GAAG,CAAC,EACnD,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,EAAE,GAAG,CAAC,EACjD,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC7D,gBAAgB,CAAC,iBAAiB,EAAE,YAAY,EAAE,GAAG,CAAC,EACtD,gBAAgB,CAAC,iBAAiB,EAAE,WAAW,EAAE,GAAG,CAAC,CACtD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,MAAM,YAAY,CAAC,iBAAiB,SAAS,yBAAyB,GAAG,EAAE,IAAI,OAAO,CAC1F,gBAAgB,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,EACzD,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,EACpD,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC7D,gBAAgB,CAAC,iBAAiB,EAAE,YAAY,EAAE,KAAK,CAAC,EACxD,gBAAgB,CAAC,iBAAiB,EAAE,WAAW,EAAE,KAAK,CAAC,CACxD,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,MAAM,EAAE,MAAM,SAAS,cAAc,IAAI;IAC1G,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GAAG,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEzE,8DAA8D;AAC9D,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,MAAM,EAAE,WAAW,SAAS,qBAAqB,IAAI;IAChG,iDAAiD;IACjD,KAAK,EAAE,KAAK,CAAC;IACb,oCAAoC;IACpC,OAAO,CAAC,EAAE,gCAAgC,CAAC,WAAW,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,KAAK,IAAI,CAAC;AAIxE,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,SAAS,OAAO,IAAI,UAAU,SAAS,KAAK,GACvF;IACE,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE1B,MAAM,MAAM,cAAc,CACxB,MAAM,SAAS,UAAU,GAAG,UAAU,EACtC,UAAU,SAAS,OAAO,IACxB,UAAU,SAAS,KAAK,GACxB,MAAM,SAAS,UAAU,GACvB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACnB;IACE,MAAM,EAAE,MAAM,CAAC;CAChB,GACH;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExB,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,qBAAqB,IACjE,gCAAgC,CAAC,OAAO,CAAC,SAAS,GAAG,GACjD,EAAE,GACF,gCAAgC,CAAC,OAAO,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACnE;IAAE,OAAO,CAAC,EAAE,gCAAgC,CAAC,OAAO,CAAC,CAAA;CAAE,GACvD,EAAE,CAAC;AAEX,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,eAAe,IAAI,eAAe,CAClF,yBAAyB,CAAC,OAAO,CAAC,EAClC,4BAA4B,CAAC,OAAO,CAAC,CACtC,GACC,cAAc,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC,CAAC,GACxG,iBAAiB,CAAC,wBAAwB,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjF,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,eAAe,IAClD,4BAA4B,CAAC,OAAO,CAAC,SAAS,KAAK,GAC/C,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GACjD,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,SAAS,UAAU,GACnE,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GAClD,2BAA2B,CAAC,OAAO,CAAC,SAAS,KAAK,GAChD,CAAC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,GACjD,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;AAE7D,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,eAAe,EACzB,UAAU,SAAS;IACjB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;CAC1B,IACC,OAAO,CACT,gBAAgB,CAAC,UAAU,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC,EACrE,UAAU,CAAC,OAAO,CAAC,SAAS,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,EACrF,UAAU,CAAC,QAAQ,CAAC,SAAS,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,EAChG,UAAU,CAAC,SAAS,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,4BAA4B,CAAC,CAAC,CAAC,EAC3E,UAAU,CAAC,WAAW,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,2BAA2B,CAAC,CAAC,CAAC,CAC7E,CAAC"}
|