@hyper-fetch/sockets 9.0.3 → 9.1.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.
- package/__tests__/e2e/e2e.delivery.spec.ts +81 -0
- package/__tests__/features/delivery/delivery.batch.spec.ts +203 -0
- package/__tests__/features/delivery/delivery.latest.spec.ts +254 -0
- package/__tests__/features/delivery/delivery.typescript.spec.ts +143 -0
- package/__tests__/features/delivery/delivery.utils.spec.ts +122 -0
- package/__tests__/features/listener/listener.delivery.spec.ts +385 -0
- package/__tests__/features/listener/listener.delivery.sse.spec.ts +55 -0
- package/__tests__/features/sdk/sdk.configuration.spec.ts +60 -0
- package/__tests__/features/sdk/sdk.types.spec.ts +41 -17
- package/dist/delivery/delivery.batch.d.ts +19 -0
- package/dist/delivery/delivery.batch.d.ts.map +1 -0
- package/dist/delivery/delivery.latest.d.ts +18 -0
- package/dist/delivery/delivery.latest.d.ts.map +1 -0
- package/dist/delivery/delivery.types.d.ts +113 -0
- package/dist/delivery/delivery.types.d.ts.map +1 -0
- package/dist/delivery/delivery.utils.d.ts +50 -0
- package/dist/delivery/delivery.utils.d.ts.map +1 -0
- package/dist/delivery/index.d.ts +5 -0
- package/dist/delivery/index.d.ts.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +198 -4
- package/dist/index.mjs.map +1 -1
- package/dist/listener/listener.d.ts +22 -7
- package/dist/listener/listener.d.ts.map +1 -1
- package/dist/listener/listener.types.d.ts +29 -9
- package/dist/listener/listener.types.d.ts.map +1 -1
- package/dist/sdk/sdk.d.ts +6 -2
- package/dist/sdk/sdk.d.ts.map +1 -1
- package/dist/socket/socket.d.ts +2 -1
- package/dist/socket/socket.d.ts.map +1 -1
- package/dist/types/extract.types.d.ts +10 -4
- package/dist/types/extract.types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/delivery/delivery.batch.ts +71 -0
- package/src/delivery/delivery.latest.ts +64 -0
- package/src/delivery/delivery.types.ts +129 -0
- package/src/delivery/delivery.utils.ts +96 -0
- package/src/delivery/index.ts +4 -0
- package/src/index.ts +1 -0
- package/src/listener/listener.ts +48 -9
- package/src/listener/listener.types.ts +45 -10
- package/src/sdk/sdk.ts +27 -7
- package/src/socket/socket.ts +8 -2
- package/src/types/extract.types.ts +10 -4
- package/tsconfig.json +2 -0
|
@@ -1,26 +1,41 @@
|
|
|
1
1
|
import { ExtractUrlParams, ParamsType } from '@hyper-fetch/core';
|
|
2
|
+
import { ListenerDeliveryType, ResolveDeliveredType } from '../delivery';
|
|
2
3
|
import { ListenType, ListenerConfigurationType, ListenerOptionsType } from '.';
|
|
3
4
|
import { SocketInstance } from '../socket';
|
|
4
5
|
import { ExtractAdapterListenerOptionsType, ExtractSocketAdapterType } from '../types';
|
|
5
6
|
/**
|
|
6
7
|
* Represents a socket message listener bound to a specific topic. Use it to subscribe to
|
|
7
8
|
* typed messages from WebSocket or Server-Sent Events connections via the socket adapter.
|
|
9
|
+
*
|
|
10
|
+
* `Response` is the raw message type, `Delivered` is what `listen` callbacks receive. They differ only
|
|
11
|
+
* when a `delivery` strategy changes the shape (e.g. `batch` delivers `Response[]`).
|
|
8
12
|
*/
|
|
9
|
-
export declare class Listener<Response, Topic extends string, Socket extends SocketInstance, HasParams extends boolean = false> {
|
|
13
|
+
export declare class Listener<Response, Topic extends string, Socket extends SocketInstance, HasParams extends boolean = false, Delivered = Response> {
|
|
10
14
|
readonly socket: Socket;
|
|
11
|
-
readonly listenerOptions: ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>>;
|
|
12
15
|
readonly topic: Topic;
|
|
13
16
|
params?: ParamsType;
|
|
14
17
|
options?: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>;
|
|
15
|
-
|
|
18
|
+
/**
|
|
19
|
+
* How messages reach `listen` callbacks. Typed with `any` input on purpose - it keeps `Response`
|
|
20
|
+
* covariant so partial `ListenerInstance<{ response: ... }>` constraints keep matching wider listeners.
|
|
21
|
+
*/
|
|
22
|
+
delivery?: ListenerDeliveryType<any, ExtractSocketAdapterType<Socket>>;
|
|
23
|
+
/** Stored with an `any` response for the same covariance reason as `delivery`. */
|
|
24
|
+
readonly listenerOptions: ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>>;
|
|
25
|
+
constructor(socket: Socket, listenerOptions: ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>, Response>);
|
|
16
26
|
/** Set adapter-specific listener options. */
|
|
17
|
-
setOptions(options: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>): Listener<Response, Topic, Socket, HasParams>;
|
|
27
|
+
setOptions(options: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>): Listener<Response, Topic, Socket, HasParams, Delivered>;
|
|
18
28
|
/** Set the URL path parameters for the topic (e.g., `:channelId`). */
|
|
19
|
-
setParams(params: ExtractUrlParams<Topic>): Listener<Response, Topic, Socket, true>;
|
|
29
|
+
setParams(params: ExtractUrlParams<Topic>): Listener<Response, Topic, Socket, true, Delivered>;
|
|
30
|
+
/**
|
|
31
|
+
* Set how messages are delivered to `listen` callbacks - a `latest` / `batch` preset or a custom strategy.
|
|
32
|
+
* Pass `undefined` to restore immediate delivery. Returns a clone; the callback data type follows the strategy.
|
|
33
|
+
*/
|
|
34
|
+
setDelivery<NewDelivery extends ListenerDeliveryType<Response, ExtractSocketAdapterType<Socket>> | undefined>(delivery: NewDelivery): Listener<Response, Topic, Socket, HasParams, ResolveDeliveredType<Response, NewDelivery>>;
|
|
20
35
|
/** Create a new listener instance with optional configuration overrides. */
|
|
21
|
-
clone<NewHasParams extends true | false = HasParams>(options?: ListenerConfigurationType<ExtractUrlParams<Topic>, Topic, Socket>): Listener<Response, Topic, Socket, NewHasParams>;
|
|
36
|
+
clone<NewHasParams extends true | false = HasParams, NewDelivered = Delivered>(options?: ListenerConfigurationType<ExtractUrlParams<Topic>, Topic, Socket, Response>): Listener<Response, Topic, Socket, NewHasParams, NewDelivered>;
|
|
22
37
|
/** Start listening for messages on the configured topic. Returns a function to unsubscribe. */
|
|
23
|
-
listen: ListenType<Listener<Response, Topic, Socket, HasParams>, Socket>;
|
|
38
|
+
listen: ListenType<Listener<Response, Topic, Socket, HasParams, Delivered>, Socket>;
|
|
24
39
|
private paramsMapper;
|
|
25
40
|
}
|
|
26
41
|
//# sourceMappingURL=listener.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC3F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,iCAAiC,EAAE,wBAAwB,EAAE,MAAM,OAAO,CAAC;AAEzF
|
|
1
|
+
{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EAA+B,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAExG,OAAO,KAAK,EAAE,UAAU,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC3F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,iCAAiC,EAAE,wBAAwB,EAAE,MAAM,OAAO,CAAC;AAEzF;;;;;;GAMG;AACH,qBAAa,QAAQ,CACnB,QAAQ,EACR,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,cAAc,EAC7B,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,SAAS,GAAG,QAAQ;IAclB,QAAQ,CAAC,MAAM,EAAE,MAAM;IAZzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,MAAM,CAAC,EAAE,UAAU,CAAa;IAChC,OAAO,CAAC,EAAE,iCAAiC,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAa;IAC1F;;;OAGG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC,GAAG,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAa;IACnF,kFAAkF;IAClF,QAAQ,CAAC,eAAe,EAAE,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;gBAG5E,MAAM,EAAE,MAAM,EACvB,eAAe,EAAE,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAazF,6CAA6C;IAC7C,UAAU,CAAC,OAAO,EAAE,iCAAiC,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAIvF,sEAAsE;IACtE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAIzC;;;OAGG;IACH,WAAW,CAAC,WAAW,SAAS,oBAAoB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,EAC1G,QAAQ,EAAE,WAAW;IAKvB,4EAA4E;IAC5E,KAAK,CAAC,YAAY,SAAS,IAAI,GAAG,KAAK,GAAG,SAAS,EAAE,YAAY,GAAG,SAAS,EAC3E,OAAO,CAAC,EAAE,yBAAyB,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC;IAWvF,+FAA+F;IAC/F,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAoBjF;IAEF,OAAO,CAAC,YAAY,CASlB;CACH"}
|
|
@@ -1,13 +1,19 @@
|
|
|
1
1
|
import { ExtractUrlParams, EmptyTypes, TypeWithDefaults } from '@hyper-fetch/core';
|
|
2
2
|
import { SocketAdapterInstance } from '../adapter';
|
|
3
|
+
import { ListenerDeliveryType } from '../delivery';
|
|
3
4
|
import { Listener } from '.';
|
|
4
5
|
import { Socket, SocketInstance } from '../socket';
|
|
5
|
-
import { ExtractListenerHasParamsType, ExtractListenerTopicType, ExtractListenerResponseType, ExtractAdapterListenerOptionsType, ExtractAdapterExtraType, ExtractListenerSocketType, ExtractSocketAdapterType } from '../types';
|
|
6
|
+
import { ExtractListenerHasParamsType, ExtractListenerTopicType, ExtractListenerResponseType, ExtractAdapterListenerOptionsType, ExtractAdapterExtraType, ExtractListenerSocketType, ExtractSocketAdapterType, ExtractListenerDeliveredType } from '../types';
|
|
6
7
|
export type ListenerInstanceProperties = {
|
|
7
8
|
response?: any;
|
|
8
9
|
topic?: string;
|
|
9
10
|
socket?: SocketInstance;
|
|
10
11
|
hasParams?: boolean;
|
|
12
|
+
/**
|
|
13
|
+
* Type received by `listen` callbacks. Differs from `response` only when a `delivery` strategy
|
|
14
|
+
* changes the shape (e.g. `batch` delivers `response[]`).
|
|
15
|
+
*/
|
|
16
|
+
delivered?: any;
|
|
11
17
|
};
|
|
12
18
|
/**
|
|
13
19
|
* The **constraint** form of a Listener type. Mindset: "any Listener that matches this partial shape".
|
|
@@ -28,7 +34,7 @@ export type ListenerInstanceProperties = {
|
|
|
28
34
|
*
|
|
29
35
|
* @see {@link ListenerModel} - definition counterpart for SDK schema modeling.
|
|
30
36
|
*/
|
|
31
|
-
export type ListenerInstance<ListenerProperties extends ListenerInstanceProperties = {}> = Listener<TypeWithDefaults<ListenerProperties, "response", any>, TypeWithDefaults<ListenerProperties, "topic", any>, TypeWithDefaults<ListenerProperties, "socket", SocketInstance>, TypeWithDefaults<ListenerProperties, "hasParams", any>>;
|
|
37
|
+
export type ListenerInstance<ListenerProperties extends ListenerInstanceProperties = {}> = Listener<TypeWithDefaults<ListenerProperties, "response", any>, TypeWithDefaults<ListenerProperties, "topic", any>, TypeWithDefaults<ListenerProperties, "socket", SocketInstance>, TypeWithDefaults<ListenerProperties, "hasParams", any>, TypeWithDefaults<ListenerProperties, "delivered", any>>;
|
|
32
38
|
/**
|
|
33
39
|
* The **definition** form of a Listener type. Mindset: "**this** specific topic".
|
|
34
40
|
*
|
|
@@ -49,6 +55,7 @@ export type ListenerInstance<ListenerProperties extends ListenerInstanceProperti
|
|
|
49
55
|
* | `topic` | `string` | Allows literal narrowing without erasure. Pass a string literal. |
|
|
50
56
|
* | `socket` | `SocketInstance` | Injected by `createSocketSdk(socket)`; do not set this manually. |
|
|
51
57
|
* | `hasParams` | `false` | "Caller must call `.setParams()`." Override only when bound. |
|
|
58
|
+
* | `delivered` | same as `response` | Set only when a `delivery` strategy changes the callback shape. |
|
|
52
59
|
*
|
|
53
60
|
* @example
|
|
54
61
|
* ```ts
|
|
@@ -73,24 +80,36 @@ export type ListenerInstance<ListenerProperties extends ListenerInstanceProperti
|
|
|
73
80
|
*
|
|
74
81
|
* @see {@link ListenerInstance} - constraint counterpart for accepting any Listener.
|
|
75
82
|
*/
|
|
76
|
-
export type ListenerModel<ListenerProperties extends ListenerInstanceProperties = {}> = Listener<TypeWithDefaults<ListenerProperties, "response", unknown>, TypeWithDefaults<ListenerProperties, "topic", string>, TypeWithDefaults<ListenerProperties, "socket", SocketInstance>, TypeWithDefaults<ListenerProperties, "hasParams", false
|
|
77
|
-
export type ListenerOfAdapter<A extends SocketAdapterInstance> = Listener<any, any, Socket<A>, any>;
|
|
83
|
+
export type ListenerModel<ListenerProperties extends ListenerInstanceProperties = {}> = Listener<TypeWithDefaults<ListenerProperties, "response", unknown>, TypeWithDefaults<ListenerProperties, "topic", string>, TypeWithDefaults<ListenerProperties, "socket", SocketInstance>, TypeWithDefaults<ListenerProperties, "hasParams", false>, TypeWithDefaults<ListenerProperties, "delivered", TypeWithDefaults<ListenerProperties, "response", unknown>>>;
|
|
84
|
+
export type ListenerOfAdapter<A extends SocketAdapterInstance> = Listener<any, any, Socket<A>, any, any>;
|
|
78
85
|
/** Configuration options for creating a Listener instance. */
|
|
79
|
-
export type ListenerOptionsType<Topic extends string, AdapterType extends SocketAdapterInstance> = {
|
|
86
|
+
export type ListenerOptionsType<Topic extends string, AdapterType extends SocketAdapterInstance, Response = any, Delivery extends ListenerDeliveryType<Response, AdapterType> | undefined = ListenerDeliveryType<Response, AdapterType> | undefined> = {
|
|
80
87
|
/** The topic/channel name to listen on */
|
|
81
88
|
topic: Topic;
|
|
82
89
|
/** Adapter-specific listener options */
|
|
83
90
|
options?: ExtractAdapterListenerOptionsType<AdapterType>;
|
|
91
|
+
/**
|
|
92
|
+
* Controls how incoming messages reach `listen` callbacks. Omit it for immediate delivery of every message.
|
|
93
|
+
*
|
|
94
|
+
* - `{ strategy: "latest", interval }` - sampling: deliver the first message immediately, then at most one
|
|
95
|
+
* (the newest) per `interval` ms. Intermediate messages are dropped. For state-like data such as prices.
|
|
96
|
+
* - `{ strategy: "batch", interval, maxSize? }` - deliver every message collected during `interval` ms as one
|
|
97
|
+
* array. Nothing is dropped and callbacks receive `Response[]`. For event-like data such as trades.
|
|
98
|
+
* - a function created with `createDeliveryStrategy()` - full control over buffering and timing.
|
|
99
|
+
*
|
|
100
|
+
* Pending messages are dropped on unsubscribe. See the "Throttling & Batching" guide for details.
|
|
101
|
+
*/
|
|
102
|
+
delivery?: Delivery;
|
|
84
103
|
};
|
|
85
|
-
export type ListenerConfigurationType<Params, Topic extends string, Socket extends SocketInstance> = {
|
|
104
|
+
export type ListenerConfigurationType<Params, Topic extends string, Socket extends SocketInstance, Response = any> = {
|
|
86
105
|
params?: Params;
|
|
87
|
-
} & Partial<ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket
|
|
106
|
+
} & Partial<ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>, Response>>;
|
|
88
107
|
export type ListenerParamsOptionsType<Listener extends ListenerInstance> = ExtractListenerHasParamsType<Listener> extends false ? {
|
|
89
108
|
params: ExtractUrlParams<ExtractListenerTopicType<Listener>>;
|
|
90
109
|
} : {
|
|
91
110
|
params?: never;
|
|
92
111
|
};
|
|
93
|
-
export type ListenType<Listener extends ListenerInstance, Socket extends SocketInstance> = ExtractUrlParams<ExtractListenerTopicType<Listener>> extends EmptyTypes ? (callback: ListenerCallbackType<ExtractSocketAdapterType<Socket>,
|
|
112
|
+
export type ListenType<Listener extends ListenerInstance, Socket extends SocketInstance> = ExtractUrlParams<ExtractListenerTopicType<Listener>> extends EmptyTypes ? (callback: ListenerCallbackType<ExtractSocketAdapterType<Socket>, ExtractListenerDeliveredType<Listener>>) => () => void : ExtractListenerHasParamsType<Listener> extends true ? (callback: ListenerCallbackType<ExtractSocketAdapterType<Socket>, ExtractListenerDeliveredType<Listener>>) => () => void : (callback: ListenerCallbackType<ExtractSocketAdapterType<Socket>, ExtractListenerDeliveredType<Listener>>) => () => void;
|
|
94
113
|
export type ListenerCallbackType<AdapterType extends SocketAdapterInstance, D> = (response: {
|
|
95
114
|
data: D;
|
|
96
115
|
extra: ExtractAdapterExtraType<AdapterType>;
|
|
@@ -100,5 +119,6 @@ export type ExtendListener<T extends ListenerInstance, Properties extends {
|
|
|
100
119
|
topic?: string;
|
|
101
120
|
socket?: SocketInstance;
|
|
102
121
|
hasParams?: true | false;
|
|
103
|
-
|
|
122
|
+
delivered?: any;
|
|
123
|
+
}> = Listener<TypeWithDefaults<Properties, "response", ExtractListenerResponseType<T>>, Properties["topic"] extends string ? Properties["topic"] : ExtractListenerTopicType<T>, Properties["socket"] extends SocketInstance ? Properties["socket"] : ExtractListenerSocketType<T>, Properties["hasParams"] extends true ? true : ExtractListenerHasParamsType<T>, TypeWithDefaults<Properties, "delivered", "response" extends keyof Properties ? Properties["response"] : ExtractListenerDeliveredType<T>>>;
|
|
104
124
|
//# sourceMappingURL=listener.types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"listener.types.d.ts","sourceRoot":"","sources":["../../src/listener/listener.types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACrD,OAAO,KAAK,EACV,4BAA4B,EAC5B,wBAAwB,EACxB,2BAA2B,EAC3B,iCAAiC,EACjC,uBAAuB,EACvB,yBAAyB,EACzB,wBAAwB,
|
|
1
|
+
{"version":3,"file":"listener.types.d.ts","sourceRoot":"","sources":["../../src/listener/listener.types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACrD,OAAO,KAAK,EACV,4BAA4B,EAC5B,wBAAwB,EACxB,2BAA2B,EAC3B,iCAAiC,EACjC,uBAAuB,EACvB,yBAAyB,EACzB,wBAAwB,EACxB,4BAA4B,EAC7B,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,gBAAgB,CAAC,kBAAkB,SAAS,0BAA0B,GAAG,EAAE,IAAI,QAAQ,CACjG,gBAAgB,CAAC,kBAAkB,EAAE,UAAU,EAAE,GAAG,CAAC,EACrD,gBAAgB,CAAC,kBAAkB,EAAE,OAAO,EAAE,GAAG,CAAC,EAClD,gBAAgB,CAAC,kBAAkB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC9D,gBAAgB,CAAC,kBAAkB,EAAE,WAAW,EAAE,GAAG,CAAC,EACtD,gBAAgB,CAAC,kBAAkB,EAAE,WAAW,EAAE,GAAG,CAAC,CACvD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,aAAa,CAAC,kBAAkB,SAAS,0BAA0B,GAAG,EAAE,IAAI,QAAQ,CAC9F,gBAAgB,CAAC,kBAAkB,EAAE,UAAU,EAAE,OAAO,CAAC,EACzD,gBAAgB,CAAC,kBAAkB,EAAE,OAAO,EAAE,MAAM,CAAC,EACrD,gBAAgB,CAAC,kBAAkB,EAAE,QAAQ,EAAE,cAAc,CAAC,EAC9D,gBAAgB,CAAC,kBAAkB,EAAE,WAAW,EAAE,KAAK,CAAC,EACxD,gBAAgB,CAAC,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAC7G,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,IAAI,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEzG,8DAA8D;AAC9D,MAAM,MAAM,mBAAmB,CAC7B,KAAK,SAAS,MAAM,EACpB,WAAW,SAAS,qBAAqB,EACzC,QAAQ,GAAG,GAAG,EACd,QAAQ,SAAS,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,SAAS,GACpE,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,GAC3C,SAAS,IACX;IACF,0CAA0C;IAC1C,KAAK,EAAE,KAAK,CAAC;IACb,wCAAwC;IACxC,OAAO,CAAC,EAAE,iCAAiC,CAAC,WAAW,CAAC,CAAC;IACzD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,CAAC,MAAM,EAAE,KAAK,SAAS,MAAM,EAAE,MAAM,SAAS,cAAc,EAAE,QAAQ,GAAG,GAAG,IAAI;IACnH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEpF,MAAM,MAAM,yBAAyB,CAAC,QAAQ,SAAS,gBAAgB,IACrE,4BAA4B,CAAC,QAAQ,CAAC,SAAS,KAAK,GAChD;IACE,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC9D,GACD;IACE,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAER,MAAM,MAAM,UAAU,CAAC,QAAQ,SAAS,gBAAgB,EAAE,MAAM,SAAS,cAAc,IACrF,gBAAgB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC,SAAS,UAAU,GACnE,CACE,QAAQ,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAC,QAAQ,CAAC,CAAC,KACrG,MAAM,IAAI,GACf,4BAA4B,CAAC,QAAQ,CAAC,SAAS,IAAI,GACjD,CACE,QAAQ,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAC,QAAQ,CAAC,CAAC,KACrG,MAAM,IAAI,GACf,CACE,QAAQ,EAAE,oBAAoB,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAC,QAAQ,CAAC,CAAC,KACrG,MAAM,IAAI,CAAC;AAExB,MAAM,MAAM,oBAAoB,CAAC,WAAW,SAAS,qBAAqB,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;IAC1F,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC7C,KAAK,IAAI,CAAC;AAEX,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS;IACjB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;IACzB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB,IACC,QAAQ,CACV,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAC,EACxE,UAAU,CAAC,OAAO,CAAC,SAAS,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,EACtF,UAAU,CAAC,QAAQ,CAAC,SAAS,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,yBAAyB,CAAC,CAAC,CAAC,EACjG,UAAU,CAAC,WAAW,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,4BAA4B,CAAC,CAAC,CAAC,EAC7E,gBAAgB,CACd,UAAU,EACV,WAAW,EACX,UAAU,SAAS,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAC/F,CACF,CAAC"}
|
package/dist/sdk/sdk.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
+
import { ListenerDeliveryType } from '../delivery';
|
|
1
2
|
import { Emitter, EmitterInstance } from '../emitter';
|
|
2
3
|
import { Listener, ListenerInstance } from '../listener';
|
|
3
4
|
import { SocketInstance } from '../socket';
|
|
4
|
-
import { ExtractListenerResponseType, ExtractListenerTopicType, ExtractListenerHasParamsType, ExtractEmitterPayloadType, ExtractEmitterTopicType, ExtractEmitterHasPayloadType, ExtractEmitterHasParamsType } from '../types';
|
|
5
|
+
import { ExtractListenerResponseType, ExtractListenerTopicType, ExtractListenerHasParamsType, ExtractListenerDeliveredType, ExtractEmitterPayloadType, ExtractEmitterTopicType, ExtractEmitterHasPayloadType, ExtractEmitterHasParamsType } from '../types';
|
|
5
6
|
export type RecursiveSocketSchemaType = Record<string, any>;
|
|
6
7
|
type SocketSdkLeaf = ListenerInstance | EmitterInstance;
|
|
7
8
|
/**
|
|
@@ -14,7 +15,7 @@ type SocketSdkLeaf = ListenerInstance | EmitterInstance;
|
|
|
14
15
|
* objects are recursed into. Depth is guarded at 10 levels to keep the type checker within
|
|
15
16
|
* reasonable bounds.
|
|
16
17
|
*/
|
|
17
|
-
export type InjectSocket<T, S extends SocketInstance, Depth extends unknown[] = []> = Depth["length"] extends 10 ? T : T extends ListenerInstance ? Listener<ExtractListenerResponseType<T>, ExtractListenerTopicType<T> extends string ? ExtractListenerTopicType<T> : string, S, ExtractListenerHasParamsType<T> extends boolean ? ExtractListenerHasParamsType<T> : false
|
|
18
|
+
export type InjectSocket<T, S extends SocketInstance, Depth extends unknown[] = []> = Depth["length"] extends 10 ? T : T extends ListenerInstance ? Listener<ExtractListenerResponseType<T>, ExtractListenerTopicType<T> extends string ? ExtractListenerTopicType<T> : string, S, ExtractListenerHasParamsType<T> extends boolean ? ExtractListenerHasParamsType<T> : false, ExtractListenerDeliveredType<T>> : T extends EmitterInstance ? Emitter<ExtractEmitterPayloadType<T>, ExtractEmitterTopicType<T> extends string ? ExtractEmitterTopicType<T> : string, S, ExtractEmitterHasPayloadType<T> extends boolean ? ExtractEmitterHasPayloadType<T> : false, ExtractEmitterHasParamsType<T> extends boolean ? ExtractEmitterHasParamsType<T> : false> : T extends Record<string, any> ? {
|
|
18
19
|
[K in keyof T]: InjectSocket<T[K], S, [...Depth, unknown]>;
|
|
19
20
|
} : T;
|
|
20
21
|
type ExtractTopicFromLeaf<T> = T extends {
|
|
@@ -48,7 +49,10 @@ type AllTopicKeys<Schema extends RecursiveSocketSchemaType> = ExtractSocketTopic
|
|
|
48
49
|
*/
|
|
49
50
|
type SocketSdkConfigurationKeys<Schema extends RecursiveSocketSchemaType> = "*" | AllTopicKeys<Schema> | `${(AllTopicKeys<Schema> | TopicPrefixes<AllTopicKeys<Schema> & string>) & string}/*` | ExtractSocketSdkPaths<Schema>;
|
|
50
51
|
export type SocketSdkDefaults = {
|
|
52
|
+
/** Adapter-specific options applied with `setOptions` to listeners and emitters. */
|
|
51
53
|
options?: Record<string, unknown>;
|
|
54
|
+
/** Delivery strategy applied with `setDelivery` to listeners. Ignored for emitters. */
|
|
55
|
+
delivery?: ListenerDeliveryType;
|
|
52
56
|
};
|
|
53
57
|
export type SocketSdkConfigurationValue = SocketSdkDefaults | ((instance: SocketSdkLeaf) => SocketSdkLeaf);
|
|
54
58
|
/**
|
package/dist/sdk/sdk.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EACV,2BAA2B,EAC3B,wBAAwB,EACxB,4BAA4B,EAC5B,4BAA4B,EAC5B,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5D,KAAK,aAAa,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,cAAc,EAAE,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,GAC5G,CAAC,GACD,CAAC,SAAS,gBAAgB,GACxB,QAAQ,CACN,2BAA2B,CAAC,CAAC,CAAC,EAC9B,wBAAwB,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,wBAAwB,CAAC,CAAC,CAAC,GAAG,MAAM,EACjF,CAAC,EACD,4BAA4B,CAAC,CAAC,CAAC,SAAS,OAAO,GAAG,4BAA4B,CAAC,CAAC,CAAC,GAAG,KAAK,EACzF,4BAA4B,CAAC,CAAC,CAAC,CAChC,GACD,CAAC,SAAS,eAAe,GACvB,OAAO,CACL,yBAAyB,CAAC,CAAC,CAAC,EAC5B,uBAAuB,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,uBAAuB,CAAC,CAAC,CAAC,GAAG,MAAM,EAC/E,CAAC,EACD,4BAA4B,CAAC,CAAC,CAAC,SAAS,OAAO,GAAG,4BAA4B,CAAC,CAAC,CAAC,GAAG,KAAK,EACzF,2BAA2B,CAAC,CAAC,CAAC,SAAS,OAAO,GAAG,2BAA2B,CAAC,CAAC,CAAC,GAAG,KAAK,CACxF,GACD,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC3B;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,CAAC;CAAE,GAC9D,CAAC,CAAC;AAEZ,KAAK,oBAAoB,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,KAAK,EAAE,MAAM,KAAK,SAAS,MAAM,CAAA;CAAE,GAAG,KAAK,GAAG,KAAK,CAAC;AAE/F;;GAEG;AACH,KAAK,mBAAmB,CAAC,CAAC,EAAE,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,GAClF,KAAK,GACL;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,GAC/C,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC1B,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC9B,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,CAAC,GAC9C,KAAK;CACZ,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC;AAExB;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GAC1E,IAAI,GAAG,GAAG,IAAI,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,MAAM,EAAE,GAChD,KAAK,CAAC;AAEV;;;GAGG;AACH,KAAK,qBAAqB,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,EAAE,EAAE,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,GAChH,KAAK,GACL;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,GAC/C,GAAG,MAAM,GAAG,CAAC,EAAE,GACf,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC9B,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,CAAC,GAClE,KAAK;CACZ,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC;AAExB,KAAK,YAAY,CAAC,MAAM,SAAS,yBAAyB,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAE1F;;;;;;GAMG;AACH,KAAK,0BAA0B,CAAC,MAAM,SAAS,yBAAyB,IACpE,GAAG,GACH,YAAY,CAAC,MAAM,CAAC,GACpB,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,MAAM,IAAI,GACrF,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAElC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,uFAAuF;IACvF,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,GAAG,CAAC,CAAC,QAAQ,EAAE,aAAa,KAAK,aAAa,CAAC,CAAC;AAE3G;;;GAGG;AACH,KAAK,cAAc,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,IAAI,IAAI,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACpF,IAAI,SAAS,MAAM,CAAC,GAClB,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GAC7B,aAAa,GACf,IAAI,SAAS,MAAM,CAAC,GAClB,CAAC,CAAC,IAAI,CAAC,GACP,aAAa,CAAC;AAEpB,KAAK,8BAA8B,CAAC,CAAC,IAAI,iBAAiB,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAElF,MAAM,MAAM,yBAAyB,CAAC,MAAM,SAAS,yBAAyB,GAAG,yBAAyB,IAAI;KAC3G,CAAC,IAAI,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,8BAA8B,CACxE,CAAC,SAAS,qBAAqB,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,aAAa,CACpF;CACF,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,yBAAyB,GAAG,yBAAyB,IAAI;IACzG,oBAAoB;IACpB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,qDAAqD;IACrD,QAAQ,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAC;CAC9C,CAAC;AAqJF;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,CAC3B,MAAM,SAAS,yBAAyB,EACxC,CAAC,SAAS,cAAc,GAAG,cAAc,IACvC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG;IAC5B,UAAU,EAAE,CAAC,QAAQ,EAAE,yBAAyB,CAAC,MAAM,CAAC,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;CAC3F,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,cAAc,EAAE,eAAe,SAAS,yBAAyB,EACzG,QAAQ,CAAC,EACT,UAAU,sBAAsB,CAAC,eAAe,CAAC,KAChD,iBAAiB,CAAC,eAAe,EAAE,CAAC,CAoBtC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,GAAI,MAAM,SAAS,yBAAyB,QACxE,UAAU,yBAAyB,CAAC,MAAM,CAAC,KAAG,yBAAyB,CAAC,MAAM,CACvF,CAAC"}
|
package/dist/socket/socket.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { LogLevel, LoggerManager, AppManager } from '@hyper-fetch/core';
|
|
2
2
|
import { SocketAdapterInstance } from '../adapter';
|
|
3
3
|
import { WebsocketAdapterType } from '../adapter-websockets/websocket-adapter';
|
|
4
|
+
import { ListenerDeliveryType, ResolveDeliveredType } from '../delivery';
|
|
4
5
|
import { EmitterInstance, EmitterOptionsType, Emitter } from '../emitter';
|
|
5
6
|
import { default as EventEmitter } from 'events';
|
|
6
7
|
import { ListenerOptionsType, Listener } from '../listener';
|
|
@@ -211,7 +212,7 @@ export declare class Socket<Adapter extends SocketAdapterInstance = WebsocketAda
|
|
|
211
212
|
* @param options
|
|
212
213
|
* @returns
|
|
213
214
|
*/
|
|
214
|
-
createListener: <Response>() => <
|
|
215
|
+
createListener: <Response>() => <Topic extends string, Delivery extends ListenerDeliveryType<Response, Adapter> | undefined = undefined>(options: ListenerOptionsType<Topic, Adapter, Response, Delivery>) => Listener<Response, Topic, Socket<Adapter>, false, ResolveDeliveredType<Response, Delivery>>;
|
|
215
216
|
/**
|
|
216
217
|
* Create event emitter
|
|
217
218
|
* @param options
|
|
@@ -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,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,
|
|
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"}
|
|
@@ -12,10 +12,16 @@ export type ExtractEmitterTopicType<E> = E extends Emitter<any, infer T, any, an
|
|
|
12
12
|
export type ExtractEmitterSocketType<E> = E extends Emitter<any, any, infer A, any, any> ? A : never;
|
|
13
13
|
export type ExtractEmitterHasPayloadType<E> = E extends Emitter<any, any, any, infer D, any> ? D : never;
|
|
14
14
|
export type ExtractEmitterHasParamsType<E> = E extends Emitter<any, any, any, any, infer P> ? P : never;
|
|
15
|
-
|
|
16
|
-
export type
|
|
17
|
-
export type
|
|
18
|
-
export type
|
|
15
|
+
/** Raw message type of a listener - what arrives on the wire, before any `delivery` strategy. */
|
|
16
|
+
export type ExtractListenerResponseType<T> = T extends Listener<infer R, any, any, any, any> ? R : never;
|
|
17
|
+
export type ExtractListenerTopicType<E> = E extends Listener<any, infer T, any, any, any> ? T : never;
|
|
18
|
+
export type ExtractListenerSocketType<E> = E extends Listener<any, any, infer A, any, any> ? A : never;
|
|
19
|
+
export type ExtractListenerHasParamsType<E> = E extends Listener<any, any, any, infer P, any> ? P : never;
|
|
20
|
+
/**
|
|
21
|
+
* What `listen` callbacks receive. Equals {@link ExtractListenerResponseType} unless the listener has a
|
|
22
|
+
* `delivery` strategy (e.g. `batch` delivers `Response[]`).
|
|
23
|
+
*/
|
|
24
|
+
export type ExtractListenerDeliveredType<T> = T extends Listener<any, any, any, any, infer D> ? D : never;
|
|
19
25
|
export type ExtractSocketAdapterType<T extends SocketInstance> = T extends Socket<infer Adapter> ? Adapter : never;
|
|
20
26
|
export type ExtractSocketOptionsType<T extends SocketInstance> = T extends Socket<infer Adapter> ? ExtractAdapterOptionsType<Adapter> : never;
|
|
21
27
|
export type ExtractSocketExtraType<T extends SocketInstance> = T extends Socket<infer Adapter> ? ExtractAdapterExtraType<Adapter> : never;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extract.types.d.ts","sourceRoot":"","sources":["../../src/types/extract.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAErD,MAAM,MAAM,eAAe,CAAC,eAAe,EAAE,OAAO,SAAS,qBAAqB,IAAI;IACpF,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;CACzC,CAAC;AAIF,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACtG,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACpG,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACrG,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACzG,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAIxG,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"extract.types.d.ts","sourceRoot":"","sources":["../../src/types/extract.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAErD,MAAM,MAAM,eAAe,CAAC,eAAe,EAAE,OAAO,SAAS,qBAAqB,IAAI;IACpF,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;CACzC,CAAC;AAIF,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACtG,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACpG,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACrG,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACzG,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAIxG,iGAAiG;AACjG,MAAM,MAAM,2BAA2B,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACzG,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACtG,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACvG,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAC1G;;;GAGG;AACH,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAI1G,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,cAAc,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;AACnH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,cAAc,IAC3D,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,yBAAyB,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAC/E,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,IACzD,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,uBAAuB,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAC7E,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,cAAc,IAC7D,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,iCAAiC,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AACvF,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,cAAc,IAC5D,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,gCAAgC,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAItF,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,qBAAqB,IACjE,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACxE,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,qBAAqB,IACnE,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACxE,MAAM,MAAM,iCAAiC,CAAC,CAAC,SAAS,qBAAqB,IAC3E,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACxE,MAAM,MAAM,gCAAgC,CAAC,CAAC,SAAS,qBAAqB,IAC1E,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACxE,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,qBAAqB,IACvE,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AACxE,MAAM,MAAM,mCAAmC,CAAC,CAAC,SAAS,qBAAqB,IAC7E,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hyper-fetch/sockets",
|
|
3
|
-
"version": "9.0
|
|
3
|
+
"version": "9.1.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/",
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import type { BatchDeliveryType, DeliveryStrategyType } from "delivery";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Creates the built-in `batch` strategy.
|
|
5
|
+
*
|
|
6
|
+
* Timeline for `interval: 100` with messages A, B, C at 0/20/40ms and D at 300ms:
|
|
7
|
+
* ```
|
|
8
|
+
* t=0 push(A) buffer=[A], open 100ms window
|
|
9
|
+
* t=20 push(B) buffer=[A, B]
|
|
10
|
+
* t=40 push(C) buffer=[A, B, C]
|
|
11
|
+
* t=100 window closes → deliver([A, B, C])
|
|
12
|
+
* t=300 push(D) buffer=[D], open window
|
|
13
|
+
* t=400 window closes → deliver([D])
|
|
14
|
+
* ```
|
|
15
|
+
*
|
|
16
|
+
* The delivered `extra` is the one of the last message in the batch.
|
|
17
|
+
* Exported so custom strategies can compose it.
|
|
18
|
+
*/
|
|
19
|
+
export const createBatchDeliveryStrategy = <Data, Extra = any>({
|
|
20
|
+
interval,
|
|
21
|
+
maxSize = Infinity,
|
|
22
|
+
}: Omit<BatchDeliveryType, "strategy">): DeliveryStrategyType<Data, Data[], Extra> => {
|
|
23
|
+
return ({ deliver }) => {
|
|
24
|
+
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
25
|
+
let buffer: Data[] = [];
|
|
26
|
+
let lastExtra: Extra | undefined;
|
|
27
|
+
let disposed = false;
|
|
28
|
+
|
|
29
|
+
const flush = () => {
|
|
30
|
+
if (timer !== undefined) {
|
|
31
|
+
clearTimeout(timer);
|
|
32
|
+
}
|
|
33
|
+
timer = undefined;
|
|
34
|
+
if (buffer.length === 0) {
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
const data = buffer;
|
|
38
|
+
const extra = lastExtra as Extra;
|
|
39
|
+
// Reset before delivering, so a synchronous unsubscribe inside the callback sees clean state.
|
|
40
|
+
buffer = [];
|
|
41
|
+
lastExtra = undefined;
|
|
42
|
+
deliver({ data, extra });
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
return {
|
|
46
|
+
push: ({ data, extra }) => {
|
|
47
|
+
if (disposed) {
|
|
48
|
+
return;
|
|
49
|
+
}
|
|
50
|
+
buffer.push(data);
|
|
51
|
+
lastExtra = extra;
|
|
52
|
+
if (buffer.length >= maxSize) {
|
|
53
|
+
flush();
|
|
54
|
+
return;
|
|
55
|
+
}
|
|
56
|
+
if (timer === undefined) {
|
|
57
|
+
timer = setTimeout(flush, interval);
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
dispose: () => {
|
|
61
|
+
disposed = true;
|
|
62
|
+
buffer = [];
|
|
63
|
+
lastExtra = undefined;
|
|
64
|
+
if (timer !== undefined) {
|
|
65
|
+
clearTimeout(timer);
|
|
66
|
+
}
|
|
67
|
+
timer = undefined;
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
};
|
|
71
|
+
};
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import type { DeliveryMessageType, DeliveryStrategyType, LatestDeliveryType } from "delivery";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Creates the built-in `latest` (sampling) strategy.
|
|
5
|
+
*
|
|
6
|
+
* Timeline for `interval: 100` with messages A, B, C at 0/20/40ms and D at 300ms:
|
|
7
|
+
* ```
|
|
8
|
+
* t=0 push(A) idle → deliver(A) immediately, open 100ms window
|
|
9
|
+
* t=20 push(B) pending = B
|
|
10
|
+
* t=40 push(C) pending = C (B is dropped)
|
|
11
|
+
* t=100 window closes → deliver(C), open next window
|
|
12
|
+
* t=200 window closes → nothing pending → idle
|
|
13
|
+
* t=300 push(D) idle → deliver(D) immediately
|
|
14
|
+
* ```
|
|
15
|
+
*
|
|
16
|
+
* Exported so custom strategies can compose it.
|
|
17
|
+
*/
|
|
18
|
+
export const createLatestDeliveryStrategy = <Data, Extra = any>({
|
|
19
|
+
interval,
|
|
20
|
+
leading = true,
|
|
21
|
+
}: Omit<LatestDeliveryType, "strategy">): DeliveryStrategyType<Data, Data, Extra> => {
|
|
22
|
+
return ({ deliver }) => {
|
|
23
|
+
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
24
|
+
let pending: DeliveryMessageType<Data, Extra> | undefined;
|
|
25
|
+
let disposed = false;
|
|
26
|
+
|
|
27
|
+
const closeWindow = () => {
|
|
28
|
+
timer = undefined;
|
|
29
|
+
if (!pending) {
|
|
30
|
+
// Nothing arrived during the window - go idle, the next message leads again.
|
|
31
|
+
return;
|
|
32
|
+
}
|
|
33
|
+
const message = pending;
|
|
34
|
+
pending = undefined;
|
|
35
|
+
// Re-arm before delivering, so a synchronous unsubscribe inside the callback clears this timer.
|
|
36
|
+
timer = setTimeout(closeWindow, interval);
|
|
37
|
+
deliver(message);
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
return {
|
|
41
|
+
push: (message) => {
|
|
42
|
+
if (disposed) {
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
if (timer === undefined) {
|
|
46
|
+
timer = setTimeout(closeWindow, interval);
|
|
47
|
+
if (leading) {
|
|
48
|
+
deliver(message);
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
pending = message;
|
|
53
|
+
},
|
|
54
|
+
dispose: () => {
|
|
55
|
+
disposed = true;
|
|
56
|
+
pending = undefined;
|
|
57
|
+
if (timer !== undefined) {
|
|
58
|
+
clearTimeout(timer);
|
|
59
|
+
}
|
|
60
|
+
timer = undefined;
|
|
61
|
+
},
|
|
62
|
+
};
|
|
63
|
+
};
|
|
64
|
+
};
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type { SocketAdapterInstance } from "adapter";
|
|
2
|
+
import type { ExtractAdapterExtraType } from "types";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* A single message flowing through a delivery strategy.
|
|
6
|
+
*
|
|
7
|
+
* `data` is the payload, `extra` is adapter-specific metadata (for the WebSocket adapter it is the raw `MessageEvent`).
|
|
8
|
+
*/
|
|
9
|
+
export type DeliveryMessageType<Data, Extra = any> = {
|
|
10
|
+
data: Data;
|
|
11
|
+
extra: Extra;
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* The object a delivery strategy returns for a single `listen()` subscription.
|
|
16
|
+
*
|
|
17
|
+
* Think of it as a tiny pipe: `push` is the input (every raw message lands here), `deliver` from the
|
|
18
|
+
* {@link DeliveryStrategyContextType} is the output, and `dispose` is the cleanup.
|
|
19
|
+
*/
|
|
20
|
+
export type DeliveryControllerType<Input, Extra = any> = {
|
|
21
|
+
/**
|
|
22
|
+
* Receives every raw message of the subscription. The strategy decides if and when to call `deliver`.
|
|
23
|
+
*/
|
|
24
|
+
push: (message: DeliveryMessageType<Input, Extra>) => void;
|
|
25
|
+
/**
|
|
26
|
+
* Called when the subscription ends (`unlisten()` / component unmount). Clear timers and drop pending
|
|
27
|
+
* state here. Nothing may be delivered after `dispose` was called. Must be safe to call more than once.
|
|
28
|
+
*/
|
|
29
|
+
dispose: () => void;
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Context handed to a delivery strategy when a subscription starts.
|
|
34
|
+
*/
|
|
35
|
+
export type DeliveryStrategyContextType<Output, Extra = any> = {
|
|
36
|
+
/**
|
|
37
|
+
* Hands a (possibly aggregated) message to the user's `listen` callback.
|
|
38
|
+
*/
|
|
39
|
+
deliver: (message: DeliveryMessageType<Output, Extra>) => void;
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* A custom delivery strategy. It is a factory invoked once per `listen()` call, so every subscription
|
|
44
|
+
* owns its own timers and buffers.
|
|
45
|
+
*
|
|
46
|
+
* `Input` is the raw message type (the listener's response type), `Output` is what `listen` callbacks
|
|
47
|
+
* receive. Use {@link createDeliveryStrategy} to author one with full type inference.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Deliver after 50ms of silence (debounce)
|
|
52
|
+
* const settle = createDeliveryStrategy<Tick>(({ deliver }) => {
|
|
53
|
+
* let timer: ReturnType<typeof setTimeout> | undefined;
|
|
54
|
+
* let last: DeliveryMessageType<Tick> | undefined;
|
|
55
|
+
* return {
|
|
56
|
+
* push: (message) => {
|
|
57
|
+
* last = message;
|
|
58
|
+
* clearTimeout(timer);
|
|
59
|
+
* timer = setTimeout(() => {
|
|
60
|
+
* if (last) deliver(last);
|
|
61
|
+
* last = undefined;
|
|
62
|
+
* }, 50);
|
|
63
|
+
* },
|
|
64
|
+
* dispose: () => {
|
|
65
|
+
* clearTimeout(timer);
|
|
66
|
+
* last = undefined;
|
|
67
|
+
* },
|
|
68
|
+
* };
|
|
69
|
+
* });
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
export type DeliveryStrategyType<Input, Output = Input, Extra = any> = (
|
|
73
|
+
context: DeliveryStrategyContextType<Output, Extra>,
|
|
74
|
+
) => DeliveryControllerType<Input, Extra>;
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Sampling delivery. The first message of an idle period is delivered immediately (when `leading` is `true`),
|
|
78
|
+
* then at most one message per `interval` is delivered - always the most recent one. Intermediate messages
|
|
79
|
+
* are dropped. Best for state-like data (prices, positions, cursors) where only the newest value matters.
|
|
80
|
+
*/
|
|
81
|
+
export type LatestDeliveryType = {
|
|
82
|
+
strategy: "latest";
|
|
83
|
+
/** Minimum time in milliseconds between two deliveries. */
|
|
84
|
+
interval: number;
|
|
85
|
+
/**
|
|
86
|
+
* Deliver the first message of an idle period immediately instead of waiting for the interval to pass.
|
|
87
|
+
* @default true
|
|
88
|
+
*/
|
|
89
|
+
leading?: boolean;
|
|
90
|
+
};
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Batching delivery. The first message opens a window of `interval` milliseconds; when it closes, every
|
|
94
|
+
* message collected in it is delivered at once as an array, in arrival order. Nothing is dropped.
|
|
95
|
+
* Best for event-like data (trades, chat messages, logs) where every message must be processed.
|
|
96
|
+
*/
|
|
97
|
+
export type BatchDeliveryType = {
|
|
98
|
+
strategy: "batch";
|
|
99
|
+
/** Window length in milliseconds, measured from the first message of a batch. */
|
|
100
|
+
interval: number;
|
|
101
|
+
/** Deliver early as soon as this many messages were collected. Defaults to no limit. */
|
|
102
|
+
maxSize?: number;
|
|
103
|
+
};
|
|
104
|
+
|
|
105
|
+
/** Built-in, serializable delivery presets. */
|
|
106
|
+
export type DeliveryPresetType = LatestDeliveryType | BatchDeliveryType;
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Everything accepted by the listener `delivery` option: a built-in preset or a custom strategy.
|
|
110
|
+
*/
|
|
111
|
+
export type ListenerDeliveryType<Response = any, Adapter extends SocketAdapterInstance = SocketAdapterInstance> =
|
|
112
|
+
| DeliveryPresetType
|
|
113
|
+
| DeliveryStrategyType<Response, any, ExtractAdapterExtraType<Adapter>>;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Resolves what `listen` callbacks receive for a given `delivery` configuration.
|
|
117
|
+
*
|
|
118
|
+
* - no delivery → `Response`
|
|
119
|
+
* - `{ strategy: "latest" }` → `Response`
|
|
120
|
+
* - `{ strategy: "batch" }` → `Response[]`
|
|
121
|
+
* - custom strategy → its `Output` type
|
|
122
|
+
*/
|
|
123
|
+
export type ResolveDeliveredType<Response, Delivery> = [Delivery] extends [undefined]
|
|
124
|
+
? Response
|
|
125
|
+
: Delivery extends DeliveryStrategyType<any, infer Output, any>
|
|
126
|
+
? Output
|
|
127
|
+
: Delivery extends { strategy: "batch" }
|
|
128
|
+
? Response[]
|
|
129
|
+
: Response;
|