@genesislcap/foundation-comms 15.89.0 → 15.90.1
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/dist/dts/connect/reconnectStrategy.d.ts +13 -0
- package/dist/dts/connect/reconnectStrategy.d.ts.map +1 -1
- package/dist/dts/connect/socket.d.ts +9 -0
- package/dist/dts/connect/socket.d.ts.map +1 -1
- package/dist/esm/connect/socket.js +18 -0
- package/dist/foundation-comms.api.json +11 -2
- package/dist/foundation-comms.d.ts +22 -0
- package/package.json +12 -12
|
@@ -42,6 +42,19 @@ export type SocketReconnectOptions = {
|
|
|
42
42
|
* @public
|
|
43
43
|
*/
|
|
44
44
|
reconnectStrategy?: SocketReconnectStrategy;
|
|
45
|
+
/**
|
|
46
|
+
* Called each time a reconnect loop uses up `reconnectAttempts` and stops reconnecting
|
|
47
|
+
* @public
|
|
48
|
+
* @remarks
|
|
49
|
+
* The socket then stays closed until the app reconnects it or the page reloads, so this is where
|
|
50
|
+
* the app decides what the user sees: reload the page, go to the login screen, or show a message.
|
|
51
|
+
* Called after the reconnect loop has been torn down; with the default `reconnectObserver`,
|
|
52
|
+
* `isReconnecting` is already false. Not called when the socket never stops retrying
|
|
53
|
+
* (`alwaysOn`) or never starts (`enableHeartbeat: false` without `alwaysOn`, or a custom
|
|
54
|
+
* `connectObserver`). The callback may be async; the socket does not wait for it, and an error
|
|
55
|
+
* or rejection is logged.
|
|
56
|
+
*/
|
|
57
|
+
onReconnectionLimitReached?: () => void | Promise<void>;
|
|
45
58
|
};
|
|
46
59
|
/**
|
|
47
60
|
* Socket reconnection scheduler
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reconnectStrategy.d.ts","sourceRoot":"","sources":["../../../src/connect/reconnectStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAK5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,WAAW;IACjB,WAAW,gBAAgB;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"reconnectStrategy.d.ts","sourceRoot":"","sources":["../../../src/connect/reconnectStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAK5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,WAAW;IACjB,WAAW,gBAAgB;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IAClC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;IAC5C;;;;;;;;;;;OAWG;IACH,0BAA0B,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,gBAAgB,EAAE,sBAAsB,EACxC,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,CAAC;AAEZ;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GACxB,kBAAkB,sBAAsB,EACxC,WAAW,wBAAwB,uBAuBpC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,EAAE,wBAWlC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE,wBAS7B,CAAC"}
|
|
@@ -208,6 +208,15 @@ export declare class DefaultSocket implements Socket {
|
|
|
208
208
|
private applyServerHeartbeatInterval;
|
|
209
209
|
private prepareHeartbeat;
|
|
210
210
|
private reconnect;
|
|
211
|
+
/**
|
|
212
|
+
* Runs the app's `onReconnectionLimitReached` callback after the reconnect loop's teardown.
|
|
213
|
+
* @remarks
|
|
214
|
+
* Deferred to a microtask, so the app's code never runs inside the teardown, which with
|
|
215
|
+
* `reconnectAttempts: 0` happens inside `reconnect()` itself (`retryInterval` emits its first tick
|
|
216
|
+
* synchronously). An error thrown by the callback, or a rejection of the promise it returns, is
|
|
217
|
+
* logged, not rethrown.
|
|
218
|
+
*/
|
|
219
|
+
private notifyReconnectionLimitReached;
|
|
211
220
|
private refreshSessionBeforeReconnect;
|
|
212
221
|
private reloadPage;
|
|
213
222
|
reset(): void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/connect/socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAsB,cAAc,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAGzF,OAAO,EAAQ,UAAU,EAAgB,OAAO,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAKzF,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAIrC,OAAO,EAAE,aAAa,EAAE,KAAK,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE5E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAEL,OAAO,EACP,cAAc,EAIf,MAAM,WAAW,CAAC;AACnB,OAAO,EAKL,sBAAsB,EAEvB,MAAM,qBAAqB,CAAC;AAS7B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAG3D;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;;CAI/C;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAC;gBACxC,GAAG,IAAI,EAAE,GAAG,EAAE;CAG3B;AAED;;;GAGG;AACH,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,CAAC;AAE9C;;;GAGG;AACH,qBAAa,oBAAoB;gBACnB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO;IAO7F;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,QAAQ,CAEhC;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,QAAQ,CAE9B;IAED;;;OAGG;IACH,IAAI,cAAc,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAU;IAE1B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAW;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAW;IAE3B;;OAEG;IACH,OAAO,CAAC,eAAe,CAAU;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAO,SAAQ,IAAI,CAClC,YAAY,EACV,WAAW,GACX,SAAS,GACT,0BAA0B,GAC1B,YAAY,GACZ,cAAc,GACd,aAAa,CAChB;IACC,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,oBAAoB,EAC9B,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;;OASG;IACH,IAAI,CAAC,CAAC,EACJ,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,aAAa,CAAC,EAAE,OAAO,EACvB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC;IAE1B,aAAa,CAAC,CAAC,EACb,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,4BAA4B,CAAC,CAAC,EAC5B,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB,cAAc,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAEzC;;;OAGG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAE9F;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC,IAAI,EAAE,MAAM,CAAC;CACd;AAOD;;;GAGG;AACH,qBAAa,aAAc,YAAW,MAAM;IAoGxB,OAAO,CAAC,cAAc;IAC7B,OAAO,CAAC,OAAO;IACR,OAAO,CAAC,UAAU;IAC5B,OAAO,CAAC,IAAI;IACJ,OAAO,CAAC,MAAM;IAC5B;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,IAAI;IACX,SAAS,CAAC,MAAM,EAAE,aAAa;IA5GhD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;IAG9C,OAAO,CAAC,SAAS,CAAwB;IAGzC,OAAO,CAAC,UAAU,CAAyB;IAG3C,OAAO,CAAC,iBAAiB,CAAoC;IAE7D,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,iBAAiB,CAAS;IAE5B,IAAI,EAAE,IAAI,CAAC;IACN,OAAO,CAAC,SAAS,CAAY;IAExC,IAAI,YAAY,YAEf;IAED,IAAI,YAAY,YAEf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,kBAAkB,4CAErB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,sBAAsB,YAEzB;IAED,IAAI,cAAc,YAEjB;IAED;;OAEG;IACH,IAAI,eAAe,IASQ,OAAO,CAFjC;IAED,IAAI,eAAe,CAAC,KAAK,EAAE,OAAO,EAMjC;IAED,IAAI,IAAI,WAEP;IAGD,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,iBAAiB,CAAwB;IACjD,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,kBAAkB,CAAe;IACzC,OAAO,CAAC,OAAO,CAAC,CAAmB;IACnC,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,gBAAgB,CAAC,CAAmB;IAE5C,IAAI,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAEpD;IAED,gFAAgF;IAChF,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,kBAAkB,CAAK;IAE/B,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IACD,kFAAkF;IAClF,OAAO,CAAC,UAAU,CAA+B;gBAGvB,cAAc,EAAE,cAAc,EACrC,OAAO,EAAE,OAAO,EACT,UAAU,EAAE,cAAc,EACpC,IAAI,EAAE,IAAI,EACF,MAAM,EAAE,YAAY;IAC1C;;OAEG;IACa,IAAI,EAAE,IAAI,EACD,MAAM,EAAE,aAAa;IAOhD,0FAA0F;IAC1F,OAAO,KAAK,WAAW,GAGtB;IAED,OAAO,KAAK,yBAAyB,GAEpC;IAED,OAAO,KAAK,uBAAuB,GAElC;IAEM,OAAO,CACZ,IAAI,GAAE,MAA2B,EACjC,cAAc,CAAC,EAAE,oBAAoB,EACrC,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC;IA0NnB;;;;;OAKG;YACW,oBAAoB;IAclC,OAAO,KAAK,cAAc,GAEzB;YAEa,uBAAuB;IAiBrC,OAAO,CAAC,6BAA6B;IAWrC;;;;OAIG;IACH,OAAO,CAAC,4BAA4B;IASpC,OAAO,CAAC,gBAAgB;IAyDxB,OAAO,CAAC,SAAS;
|
|
1
|
+
{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/connect/socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAsB,cAAc,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAGzF,OAAO,EAAQ,UAAU,EAAgB,OAAO,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAKzF,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAIrC,OAAO,EAAE,aAAa,EAAE,KAAK,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE5E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAEL,OAAO,EACP,cAAc,EAIf,MAAM,WAAW,CAAC;AACnB,OAAO,EAKL,sBAAsB,EAEvB,MAAM,qBAAqB,CAAC;AAS7B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAG3D;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;;CAI/C;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAC;gBACxC,GAAG,IAAI,EAAE,GAAG,EAAE;CAG3B;AAED;;;GAGG;AACH,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,CAAC;AAE9C;;;GAGG;AACH,qBAAa,oBAAoB;gBACnB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO;IAO7F;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,QAAQ,CAEhC;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,QAAQ,CAE9B;IAED;;;OAGG;IACH,IAAI,cAAc,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAU;IAE1B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAW;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAW;IAE3B;;OAEG;IACH,OAAO,CAAC,eAAe,CAAU;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAO,SAAQ,IAAI,CAClC,YAAY,EACV,WAAW,GACX,SAAS,GACT,0BAA0B,GAC1B,YAAY,GACZ,cAAc,GACd,aAAa,CAChB;IACC,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,oBAAoB,EAC9B,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;;OASG;IACH,IAAI,CAAC,CAAC,EACJ,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,aAAa,CAAC,EAAE,OAAO,EACvB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC;IAE1B,aAAa,CAAC,CAAC,EACb,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,4BAA4B,CAAC,CAAC,EAC5B,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB,cAAc,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IAEzC;;;OAGG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAE9F;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC,IAAI,EAAE,MAAM,CAAC;CACd;AAOD;;;GAGG;AACH,qBAAa,aAAc,YAAW,MAAM;IAoGxB,OAAO,CAAC,cAAc;IAC7B,OAAO,CAAC,OAAO;IACR,OAAO,CAAC,UAAU;IAC5B,OAAO,CAAC,IAAI;IACJ,OAAO,CAAC,MAAM;IAC5B;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,IAAI;IACX,SAAS,CAAC,MAAM,EAAE,aAAa;IA5GhD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAU;IAG9C,OAAO,CAAC,SAAS,CAAwB;IAGzC,OAAO,CAAC,UAAU,CAAyB;IAG3C,OAAO,CAAC,iBAAiB,CAAoC;IAE7D,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,iBAAiB,CAAS;IAE5B,IAAI,EAAE,IAAI,CAAC;IACN,OAAO,CAAC,SAAS,CAAY;IAExC,IAAI,YAAY,YAEf;IAED,IAAI,YAAY,YAEf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,kBAAkB,4CAErB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,sBAAsB,YAEzB;IAED,IAAI,cAAc,YAEjB;IAED;;OAEG;IACH,IAAI,eAAe,IASQ,OAAO,CAFjC;IAED,IAAI,eAAe,CAAC,KAAK,EAAE,OAAO,EAMjC;IAED,IAAI,IAAI,WAEP;IAGD,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,iBAAiB,CAAwB;IACjD,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,kBAAkB,CAAe;IACzC,OAAO,CAAC,OAAO,CAAC,CAAmB;IACnC,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,gBAAgB,CAAC,CAAmB;IAE5C,IAAI,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAEpD;IAED,gFAAgF;IAChF,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,kBAAkB,CAAK;IAE/B,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IACD,kFAAkF;IAClF,OAAO,CAAC,UAAU,CAA+B;gBAGvB,cAAc,EAAE,cAAc,EACrC,OAAO,EAAE,OAAO,EACT,UAAU,EAAE,cAAc,EACpC,IAAI,EAAE,IAAI,EACF,MAAM,EAAE,YAAY;IAC1C;;OAEG;IACa,IAAI,EAAE,IAAI,EACD,MAAM,EAAE,aAAa;IAOhD,0FAA0F;IAC1F,OAAO,KAAK,WAAW,GAGtB;IAED,OAAO,KAAK,yBAAyB,GAEpC;IAED,OAAO,KAAK,uBAAuB,GAElC;IAEM,OAAO,CACZ,IAAI,GAAE,MAA2B,EACjC,cAAc,CAAC,EAAE,oBAAoB,EACrC,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC;IA0NnB;;;;;OAKG;YACW,oBAAoB;IAclC,OAAO,KAAK,cAAc,GAEzB;YAEa,uBAAuB;IAiBrC,OAAO,CAAC,6BAA6B;IAWrC;;;;OAIG;IACH,OAAO,CAAC,4BAA4B;IASpC,OAAO,CAAC,gBAAgB;IAyDxB,OAAO,CAAC,SAAS;IAoFjB;;;;;;;OAOG;IACH,OAAO,CAAC,8BAA8B;YAQxB,6BAA6B;IAqB3C,OAAO,CAAC,UAAU;IAIX,KAAK,IAAI,IAAI;IAepB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,qBAAqB;IAYtB,IAAI,CAAC,CAAC,EACX,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,aAAa,UAAO,EACpB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;IAkClB,aAAa,CAAC,CAAC,EACpB,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC;IAyDf,4BAA4B,CAAC,CAAC,EACnC,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC;IAef,cAAc,QAAO,aAAa,CAAC,OAAO,CAAC,CAAoB;IAEtE,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,oBAAoB;IAI5B;;;OAGG;IACH,wBAAwB,CAAC,SAAS,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI;IAI5F;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,kBAAkB;CAkB3B;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,8DAAgE,CAAC;AAEpF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC"}
|
|
@@ -464,6 +464,7 @@ let DefaultSocket = class DefaultSocket {
|
|
|
464
464
|
settle = resolve;
|
|
465
465
|
});
|
|
466
466
|
this.reconnectOutcome = outcome;
|
|
467
|
+
let limitReached = false;
|
|
467
468
|
const reconnectObservable = this.isConnectedSubject.asObservable().pipe(switchMap((isConnected) => !isConnected
|
|
468
469
|
? retryInterval(this.reconnectOptions, scheduler).pipe(exhaustMap((tick, attempt) => {
|
|
469
470
|
var _a, _b, _c;
|
|
@@ -472,6 +473,7 @@ let DefaultSocket = class DefaultSocket {
|
|
|
472
473
|
: ((_c = (_b = this.reconnectOptions) === null || _b === void 0 ? void 0 : _b.reconnectAttempts) !== null && _c !== void 0 ? _c : MAX_RECONNECT_ATTEMPTS);
|
|
473
474
|
if (attempt >= attemptsAmount) {
|
|
474
475
|
this.status.reconnectionLimitReached = true;
|
|
476
|
+
limitReached = true;
|
|
475
477
|
return throwError(() => new Error(`Max reconnect attempts ${attemptsAmount} reached.`));
|
|
476
478
|
}
|
|
477
479
|
return tick > 0 && this.user.isAuthenticated && this.usesCookieAuth
|
|
@@ -485,6 +487,9 @@ let DefaultSocket = class DefaultSocket {
|
|
|
485
487
|
this.reconnectOutcome = undefined;
|
|
486
488
|
}
|
|
487
489
|
settle(this.isConnected);
|
|
490
|
+
if (limitReached) {
|
|
491
|
+
this.notifyReconnectionLimitReached();
|
|
492
|
+
}
|
|
488
493
|
}));
|
|
489
494
|
this.reconnectLoop = reconnectObservable.subscribe((_e = (_d = this.reconnectOptions) === null || _d === void 0 ? void 0 : _d.reconnectObserver) !== null && _e !== void 0 ? _e : {
|
|
490
495
|
next: (value) => {
|
|
@@ -509,6 +514,19 @@ let DefaultSocket = class DefaultSocket {
|
|
|
509
514
|
},
|
|
510
515
|
});
|
|
511
516
|
}
|
|
517
|
+
/**
|
|
518
|
+
* Runs the app's `onReconnectionLimitReached` callback after the reconnect loop's teardown.
|
|
519
|
+
* @remarks
|
|
520
|
+
* Deferred to a microtask, so the app's code never runs inside the teardown, which with
|
|
521
|
+
* `reconnectAttempts: 0` happens inside `reconnect()` itself (`retryInterval` emits its first tick
|
|
522
|
+
* synchronously). An error thrown by the callback, or a rejection of the promise it returns, is
|
|
523
|
+
* logged, not rethrown.
|
|
524
|
+
*/
|
|
525
|
+
notifyReconnectionLimitReached() {
|
|
526
|
+
Promise.resolve()
|
|
527
|
+
.then(() => { var _a, _b; return (_b = (_a = this.reconnectOptions) === null || _a === void 0 ? void 0 : _a.onReconnectionLimitReached) === null || _b === void 0 ? void 0 : _b.call(_a); })
|
|
528
|
+
.catch((error) => logger.error('onReconnectionLimitReached failed: ', error));
|
|
529
|
+
}
|
|
512
530
|
// The router rejects a handshake carrying a dead session cookie with a 401, which the browser
|
|
513
531
|
// reports as a plain 1006 close, so the session can only be checked over HTTP.
|
|
514
532
|
refreshSessionBeforeReconnect() {
|
|
@@ -39768,7 +39768,16 @@
|
|
|
39768
39768
|
},
|
|
39769
39769
|
{
|
|
39770
39770
|
"kind": "Content",
|
|
39771
|
-
"text": ";\n
|
|
39771
|
+
"text": ";\n onReconnectionLimitReached?: () => void | "
|
|
39772
|
+
},
|
|
39773
|
+
{
|
|
39774
|
+
"kind": "Reference",
|
|
39775
|
+
"text": "Promise",
|
|
39776
|
+
"canonicalReference": "!Promise:interface"
|
|
39777
|
+
},
|
|
39778
|
+
{
|
|
39779
|
+
"kind": "Content",
|
|
39780
|
+
"text": "<void>;\n}"
|
|
39772
39781
|
},
|
|
39773
39782
|
{
|
|
39774
39783
|
"kind": "Content",
|
|
@@ -39780,7 +39789,7 @@
|
|
|
39780
39789
|
"name": "SocketReconnectOptions",
|
|
39781
39790
|
"typeTokenRange": {
|
|
39782
39791
|
"startIndex": 1,
|
|
39783
|
-
"endIndex":
|
|
39792
|
+
"endIndex": 8
|
|
39784
39793
|
}
|
|
39785
39794
|
},
|
|
39786
39795
|
{
|
|
@@ -2992,6 +2992,15 @@ export declare class DefaultSocket implements Socket {
|
|
|
2992
2992
|
private applyServerHeartbeatInterval;
|
|
2993
2993
|
private prepareHeartbeat;
|
|
2994
2994
|
private reconnect;
|
|
2995
|
+
/**
|
|
2996
|
+
* Runs the app's `onReconnectionLimitReached` callback after the reconnect loop's teardown.
|
|
2997
|
+
* @remarks
|
|
2998
|
+
* Deferred to a microtask, so the app's code never runs inside the teardown, which with
|
|
2999
|
+
* `reconnectAttempts: 0` happens inside `reconnect()` itself (`retryInterval` emits its first tick
|
|
3000
|
+
* synchronously). An error thrown by the callback, or a rejection of the promise it returns, is
|
|
3001
|
+
* logged, not rethrown.
|
|
3002
|
+
*/
|
|
3003
|
+
private notifyReconnectionLimitReached;
|
|
2995
3004
|
private refreshSessionBeforeReconnect;
|
|
2996
3005
|
private reloadPage;
|
|
2997
3006
|
reset(): void;
|
|
@@ -5591,6 +5600,19 @@ export declare type SocketReconnectOptions = {
|
|
|
5591
5600
|
* @public
|
|
5592
5601
|
*/
|
|
5593
5602
|
reconnectStrategy?: SocketReconnectStrategy;
|
|
5603
|
+
/**
|
|
5604
|
+
* Called each time a reconnect loop uses up `reconnectAttempts` and stops reconnecting
|
|
5605
|
+
* @public
|
|
5606
|
+
* @remarks
|
|
5607
|
+
* The socket then stays closed until the app reconnects it or the page reloads, so this is where
|
|
5608
|
+
* the app decides what the user sees: reload the page, go to the login screen, or show a message.
|
|
5609
|
+
* Called after the reconnect loop has been torn down; with the default `reconnectObserver`,
|
|
5610
|
+
* `isReconnecting` is already false. Not called when the socket never stops retrying
|
|
5611
|
+
* (`alwaysOn`) or never starts (`enableHeartbeat: false` without `alwaysOn`, or a custom
|
|
5612
|
+
* `connectObserver`). The callback may be async; the socket does not wait for it, and an error
|
|
5613
|
+
* or rejection is logged.
|
|
5614
|
+
*/
|
|
5615
|
+
onReconnectionLimitReached?: () => void | Promise<void>;
|
|
5594
5616
|
};
|
|
5595
5617
|
|
|
5596
5618
|
/**
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-comms",
|
|
3
3
|
"description": "Genesis Foundation UI Comms",
|
|
4
|
-
"version": "15.
|
|
4
|
+
"version": "15.90.1",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -75,12 +75,12 @@
|
|
|
75
75
|
}
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
|
-
"@genesislcap/foundation-testing": "15.
|
|
79
|
-
"@genesislcap/genx": "15.
|
|
80
|
-
"@genesislcap/ts-builder": "15.
|
|
81
|
-
"@genesislcap/uvu-playwright-builder": "15.
|
|
82
|
-
"@genesislcap/vite-builder": "15.
|
|
83
|
-
"@genesislcap/webpack-builder": "15.
|
|
78
|
+
"@genesislcap/foundation-testing": "15.90.1",
|
|
79
|
+
"@genesislcap/genx": "15.90.1",
|
|
80
|
+
"@genesislcap/ts-builder": "15.90.1",
|
|
81
|
+
"@genesislcap/uvu-playwright-builder": "15.90.1",
|
|
82
|
+
"@genesislcap/vite-builder": "15.90.1",
|
|
83
|
+
"@genesislcap/webpack-builder": "15.90.1",
|
|
84
84
|
"@types/js-cookie": "^3.0.2",
|
|
85
85
|
"@types/json-schema": "^7.0.11",
|
|
86
86
|
"@types/webappsec-credential-management": "^0.6.2",
|
|
@@ -88,11 +88,11 @@
|
|
|
88
88
|
"sinon": "^17.0.1"
|
|
89
89
|
},
|
|
90
90
|
"dependencies": {
|
|
91
|
-
"@genesislcap/foundation-broadcast-channel": "15.
|
|
92
|
-
"@genesislcap/foundation-logger": "15.
|
|
93
|
-
"@genesislcap/foundation-user": "15.
|
|
94
|
-
"@genesislcap/foundation-utils": "15.
|
|
95
|
-
"@genesislcap/web-core": "15.
|
|
91
|
+
"@genesislcap/foundation-broadcast-channel": "15.90.1",
|
|
92
|
+
"@genesislcap/foundation-logger": "15.90.1",
|
|
93
|
+
"@genesislcap/foundation-user": "15.90.1",
|
|
94
|
+
"@genesislcap/foundation-utils": "15.90.1",
|
|
95
|
+
"@genesislcap/web-core": "15.90.1",
|
|
96
96
|
"@microsoft/fast-element": "1.14.0",
|
|
97
97
|
"@microsoft/fast-foundation": "2.50.0",
|
|
98
98
|
"bowser": "^2.11.0",
|