@hyper-fetch/react 9.8.1 → 10.0.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/README.md +24 -26
- package/__tests__/features/use-listener/use-listener.payload.spec.tsx +196 -0
- package/__tests__/features/use-listener/use-listener.ssr.spec.tsx +22 -1
- package/__tests__/features/use-listener/use-listener.status.spec.tsx +288 -0
- package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts +10 -3
- package/dist/helpers/use-socket-state/use-socket-state.hooks.d.ts.map +1 -1
- package/dist/hooks/use-listener/use-listener.hooks.d.ts +20 -4
- package/dist/hooks/use-listener/use-listener.hooks.d.ts.map +1 -1
- package/dist/hooks/use-listener/use-listener.types.d.ts +11 -0
- package/dist/hooks/use-listener/use-listener.types.d.ts.map +1 -1
- package/dist/index.mjs +66 -10
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/helpers/use-socket-state/use-socket-state.hooks.ts +36 -11
- package/src/hooks/use-listener/use-listener.hooks.ts +66 -13
- package/src/hooks/use-listener/use-listener.types.ts +12 -0
|
@@ -1,3 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where the subscription of `useListener` is:
|
|
3
|
+
* - `idle` - not listening yet (e.g. during server rendering)
|
|
4
|
+
* - `starting` - subscribed, waiting for the server to confirm it (tRPC, oRPC)
|
|
5
|
+
* - `listening` - messages can arrive. Adapters without confirmation get here right after subscribing
|
|
6
|
+
* - `ended` - the server finished the subscription
|
|
7
|
+
* - `failed` - the server ended the subscription with an error, see `error`
|
|
8
|
+
*
|
|
9
|
+
* After `ended` or `failed` the hook stays unsubscribed until `listen()` is called or the listener changes.
|
|
10
|
+
*/
|
|
11
|
+
export type ListenerStatusType = "idle" | "starting" | "listening" | "ended" | "failed";
|
|
1
12
|
export type UseListenerOptionsType<DataType = any, TSelected = DataType> = {
|
|
2
13
|
/** When true (default), only re-renders when accessed state properties change */
|
|
3
14
|
dependencyTracking?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use-listener.types.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-listener/use-listener.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,CAAC,QAAQ,GAAG,GAAG,EAAE,SAAS,GAAG,QAAQ,IAAI;IACzE,iFAAiF;IACjF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,SAAS,CAAC;IACvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC"}
|
|
1
|
+
{"version":3,"file":"use-listener.types.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-listener/use-listener.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,QAAQ,CAAC;AAExF,MAAM,MAAM,sBAAsB,CAAC,QAAQ,GAAG,GAAG,EAAE,SAAS,GAAG,QAAQ,IAAI;IACzE,iFAAiF;IACjF,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,SAAS,CAAC;IACvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC"}
|
package/dist/index.mjs
CHANGED
|
@@ -1072,7 +1072,12 @@ var useTrackedState = ({ request, dispatcher, initialResponse, deepCompare, depe
|
|
|
1072
1072
|
};
|
|
1073
1073
|
//#endregion
|
|
1074
1074
|
//#region src/helpers/use-socket-state/use-socket-state.hooks.ts
|
|
1075
|
-
|
|
1075
|
+
/**
|
|
1076
|
+
* Tracked socket state shared by the socket hooks. `extendedState` adds hook-specific fields (e.g. the listener
|
|
1077
|
+
* status) that are tracked the same way and changed with `actions.setExtendedState`.
|
|
1078
|
+
*/
|
|
1079
|
+
var useSocketState = (socket, { dependencyTracking, extendedState }) => {
|
|
1080
|
+
const initialExtendedState = useRef(extendedState);
|
|
1076
1081
|
const onDisconnectCallback = useRef(null);
|
|
1077
1082
|
const onErrorCallback = useRef(null);
|
|
1078
1083
|
const onConnectedCallback = useRef(null);
|
|
@@ -1080,6 +1085,7 @@ var useSocketState = (socket, { dependencyTracking }) => {
|
|
|
1080
1085
|
const onReconnectingCallback = useRef(null);
|
|
1081
1086
|
const onReconnectingFailedCallback = useRef(null);
|
|
1082
1087
|
const state = useRef({
|
|
1088
|
+
...initialExtendedState.current,
|
|
1083
1089
|
data: null,
|
|
1084
1090
|
extra: null,
|
|
1085
1091
|
connected: socket.adapter.connected,
|
|
@@ -1136,6 +1142,7 @@ var useSocketState = (socket, { dependencyTracking }) => {
|
|
|
1136
1142
|
},
|
|
1137
1143
|
clearState: () => {
|
|
1138
1144
|
state.current = {
|
|
1145
|
+
...initialExtendedState.current,
|
|
1139
1146
|
data: null,
|
|
1140
1147
|
extra: null,
|
|
1141
1148
|
connected: false,
|
|
@@ -1199,6 +1206,11 @@ var useSocketState = (socket, { dependencyTracking }) => {
|
|
|
1199
1206
|
};
|
|
1200
1207
|
}, [socket]);
|
|
1201
1208
|
const getState = () => state.current;
|
|
1209
|
+
/** Changes the hook-specific fields added with `extendedState` */
|
|
1210
|
+
const setExtendedState = (newState) => {
|
|
1211
|
+
Object.assign(state.current, newState);
|
|
1212
|
+
renderKeyTrigger(Object.keys(newState));
|
|
1213
|
+
};
|
|
1202
1214
|
return [
|
|
1203
1215
|
state.current,
|
|
1204
1216
|
actions,
|
|
@@ -1206,7 +1218,8 @@ var useSocketState = (socket, { dependencyTracking }) => {
|
|
|
1206
1218
|
{
|
|
1207
1219
|
setRenderKey,
|
|
1208
1220
|
getState,
|
|
1209
|
-
rerender: emitChange
|
|
1221
|
+
rerender: emitChange,
|
|
1222
|
+
setExtendedState
|
|
1210
1223
|
}
|
|
1211
1224
|
];
|
|
1212
1225
|
};
|
|
@@ -3269,7 +3282,10 @@ var useStream = (request, options) => {
|
|
|
3269
3282
|
};
|
|
3270
3283
|
//#endregion
|
|
3271
3284
|
//#region src/hooks/use-listener/use-listener.hooks.ts
|
|
3272
|
-
/**
|
|
3285
|
+
/**
|
|
3286
|
+
* Subscribe to incoming socket messages on a given listener topic with tracked connection state and callbacks.
|
|
3287
|
+
* Changing the topic params, payload, options, delivery or socket of the listener starts a new subscription.
|
|
3288
|
+
*/
|
|
3273
3289
|
var useListener = (listener, options) => {
|
|
3274
3290
|
const { config: globalConfig } = useProvider();
|
|
3275
3291
|
const { dependencyTracking = true, structuralSharing = true } = {
|
|
@@ -3277,7 +3293,13 @@ var useListener = (listener, options) => {
|
|
|
3277
3293
|
...options
|
|
3278
3294
|
};
|
|
3279
3295
|
const select = options?.select;
|
|
3280
|
-
const [state, actions, callbacks, { setRenderKey, getState, rerender }] = useSocketState(listener.socket, {
|
|
3296
|
+
const [state, actions, callbacks, { setRenderKey, getState, rerender, setExtendedState }] = useSocketState(listener.socket, {
|
|
3297
|
+
dependencyTracking,
|
|
3298
|
+
extendedState: {
|
|
3299
|
+
status: "idle",
|
|
3300
|
+
error: null
|
|
3301
|
+
}
|
|
3302
|
+
});
|
|
3281
3303
|
const removeListenerRef = useRef(null);
|
|
3282
3304
|
/**
|
|
3283
3305
|
* Selection
|
|
@@ -3305,6 +3327,8 @@ var useListener = (listener, options) => {
|
|
|
3305
3327
|
* Callbacks
|
|
3306
3328
|
*/
|
|
3307
3329
|
const onEventCallback = useRef(null);
|
|
3330
|
+
const onStartCallback = useRef(null);
|
|
3331
|
+
const onEndCallback = useRef(null);
|
|
3308
3332
|
/**
|
|
3309
3333
|
* Actions
|
|
3310
3334
|
*/
|
|
@@ -3313,7 +3337,26 @@ var useListener = (listener, options) => {
|
|
|
3313
3337
|
};
|
|
3314
3338
|
const listen = () => {
|
|
3315
3339
|
stopListener();
|
|
3316
|
-
|
|
3340
|
+
setExtendedState({
|
|
3341
|
+
status: "starting",
|
|
3342
|
+
error: null
|
|
3343
|
+
});
|
|
3344
|
+
const lifecycle = {
|
|
3345
|
+
onStart: (data) => {
|
|
3346
|
+
setExtendedState({ status: "listening" });
|
|
3347
|
+
onStartCallback.current?.(data);
|
|
3348
|
+
},
|
|
3349
|
+
onEnd: (data) => {
|
|
3350
|
+
removeListenerRef.current = null;
|
|
3351
|
+
setExtendedState({
|
|
3352
|
+
status: data.error ? "failed" : "ended",
|
|
3353
|
+
error: data.error
|
|
3354
|
+
});
|
|
3355
|
+
onEndCallback.current?.(data);
|
|
3356
|
+
}
|
|
3357
|
+
};
|
|
3358
|
+
const listenWithLifecycle = listener.listen;
|
|
3359
|
+
removeListenerRef.current = listenWithLifecycle(({ data, extra }) => {
|
|
3317
3360
|
onEventCallback.current?.({
|
|
3318
3361
|
data,
|
|
3319
3362
|
extra
|
|
@@ -3331,11 +3374,19 @@ var useListener = (listener, options) => {
|
|
|
3331
3374
|
if (!selectRef.current || !Object.is(selected, getState().data)) actions.setData(selected);
|
|
3332
3375
|
actions.setExtra(extra);
|
|
3333
3376
|
actions.setTimestamp(Date.now());
|
|
3334
|
-
});
|
|
3377
|
+
}, lifecycle);
|
|
3378
|
+
};
|
|
3379
|
+
const additionalCallbacks = {
|
|
3380
|
+
onEvent: (callback) => {
|
|
3381
|
+
onEventCallback.current = callback;
|
|
3382
|
+
},
|
|
3383
|
+
onStart: (callback) => {
|
|
3384
|
+
onStartCallback.current = callback;
|
|
3385
|
+
},
|
|
3386
|
+
onEnd: (callback) => {
|
|
3387
|
+
onEndCallback.current = callback;
|
|
3388
|
+
}
|
|
3335
3389
|
};
|
|
3336
|
-
const additionalCallbacks = { onEvent: (callback) => {
|
|
3337
|
-
onEventCallback.current = callback;
|
|
3338
|
-
} };
|
|
3339
3390
|
/**
|
|
3340
3391
|
* Lifecycle
|
|
3341
3392
|
*/
|
|
@@ -3344,6 +3395,7 @@ var useListener = (listener, options) => {
|
|
|
3344
3395
|
}, [
|
|
3345
3396
|
listener.socket,
|
|
3346
3397
|
listener.topic,
|
|
3398
|
+
stringifyKey(listener.payload),
|
|
3347
3399
|
JSON.stringify(listener.options),
|
|
3348
3400
|
getDeliveryKey(listener.delivery)
|
|
3349
3401
|
], true);
|
|
@@ -3355,7 +3407,9 @@ var useListener = (listener, options) => {
|
|
|
3355
3407
|
"extra",
|
|
3356
3408
|
"connected",
|
|
3357
3409
|
"connecting",
|
|
3358
|
-
"timestamp"
|
|
3410
|
+
"timestamp",
|
|
3411
|
+
"status",
|
|
3412
|
+
"error"
|
|
3359
3413
|
];
|
|
3360
3414
|
return createTrackedProxy({
|
|
3361
3415
|
data: state.data,
|
|
@@ -3363,6 +3417,8 @@ var useListener = (listener, options) => {
|
|
|
3363
3417
|
connected: state.connected,
|
|
3364
3418
|
connecting: state.connecting,
|
|
3365
3419
|
timestamp: state.timestamp,
|
|
3420
|
+
status: state.status,
|
|
3421
|
+
error: state.error,
|
|
3366
3422
|
...actions,
|
|
3367
3423
|
...callbacks,
|
|
3368
3424
|
...additionalCallbacks,
|