@genesislcap/foundation-comms 14.184.0 → 14.186.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.
Files changed (81) hide show
  1. package/dist/dts/auth/auth.types.d.ts +1 -1
  2. package/dist/dts/auth/auth.types.d.ts.map +1 -1
  3. package/dist/dts/connect/connect.d.ts +14 -6
  4. package/dist/dts/connect/connect.d.ts.map +1 -1
  5. package/dist/dts/connect/connect.events.d.ts +28 -2
  6. package/dist/dts/connect/connect.events.d.ts.map +1 -1
  7. package/dist/dts/connect/connect.types.d.ts +5 -52
  8. package/dist/dts/connect/connect.types.d.ts.map +1 -1
  9. package/dist/dts/connect/http.connect.d.ts +4 -8
  10. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  11. package/dist/dts/connect/http.connect.types.d.ts +62 -0
  12. package/dist/dts/connect/http.connect.types.d.ts.map +1 -0
  13. package/dist/dts/connect/index.d.ts +1 -0
  14. package/dist/dts/connect/index.d.ts.map +1 -1
  15. package/dist/dts/connect/message.d.ts +6 -2
  16. package/dist/dts/connect/message.d.ts.map +1 -1
  17. package/dist/dts/connect/socket.d.ts +3 -56
  18. package/dist/dts/connect/socket.d.ts.map +1 -1
  19. package/dist/dts/connect/socket.types.d.ts +57 -0
  20. package/dist/dts/connect/socket.types.d.ts.map +1 -0
  21. package/dist/dts/connect/updateState.d.ts +3 -0
  22. package/dist/dts/connect/updateState.d.ts.map +1 -0
  23. package/dist/dts/networkMonitor/service.d.ts.map +1 -1
  24. package/dist/dts/testing/mocks/auth/auth.d.ts +1 -1
  25. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  26. package/dist/dts/testing/mocks/connect/connect.d.ts +3 -1
  27. package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
  28. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -1
  29. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  30. package/dist/dts/testing/mocks/datasource/datasource.d.ts +1 -1
  31. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  32. package/dist/esm/connect/connect.events.js +21 -2
  33. package/dist/esm/connect/connect.js +26 -28
  34. package/dist/esm/connect/connect.types.js +21 -5
  35. package/dist/esm/connect/http.connect.js +11 -23
  36. package/dist/esm/connect/http.connect.types.js +24 -0
  37. package/dist/esm/connect/index.js +1 -0
  38. package/dist/esm/connect/message.js +3 -2
  39. package/dist/esm/connect/socket.js +10 -5
  40. package/dist/esm/connect/socket.types.js +1 -0
  41. package/dist/esm/connect/updateState.js +26 -0
  42. package/dist/esm/networkMonitor/service.js +18 -8
  43. package/dist/esm/testing/mocks/connect/connect.js +3 -0
  44. package/dist/esm/testing/mocks/connect/socket.js +1 -1
  45. package/dist/foundation-comms.api.json +823 -384
  46. package/dist/foundation-comms.d.ts +63 -16
  47. package/docs/api/foundation-comms.connect.md +1 -0
  48. package/docs/api/foundation-comms.connect.streamstate.md +30 -0
  49. package/docs/api/foundation-comms.connectconfig.iswebsocketexpression.md +13 -0
  50. package/docs/api/foundation-comms.connectconfig.md +1 -0
  51. package/docs/api/foundation-comms.connectevents.addstreamlistener.md +2 -1
  52. package/docs/api/foundation-comms.connectevents.md +1 -1
  53. package/docs/api/foundation-comms.connecteventsemitter.md +1 -0
  54. package/docs/api/foundation-comms.connecteventsemitter.onstreamerrorevent.md +26 -0
  55. package/docs/api/foundation-comms.defaultconnect._constructor_.md +2 -2
  56. package/docs/api/foundation-comms.defaultconnect.md +1 -0
  57. package/docs/api/foundation-comms.defaultconnect.streamstate.md +26 -0
  58. package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md +2 -1
  59. package/docs/api/foundation-comms.defaultconnectevents.md +2 -1
  60. package/docs/api/foundation-comms.defaultconnectevents.onstreamerrorevent.md +26 -0
  61. package/docs/api/foundation-comms.defaulthttpconnect._constructor_.md +2 -2
  62. package/docs/api/foundation-comms.defaulthttpconnect.md +1 -0
  63. package/docs/api/foundation-comms.defaulthttpconnect.streamstate.md +26 -0
  64. package/docs/api/foundation-comms.md +3 -4
  65. package/docs/api/foundation-comms.pingmessage.md +1 -1
  66. package/docs/api/foundation-comms.streamerrorevent.md +14 -0
  67. package/docs/api/foundation-comms.streamerroreventdetail.md +16 -0
  68. package/docs/api/foundation-comms.streamerroreventtype.md +12 -0
  69. package/docs/api-report.md +36 -38
  70. package/package.json +21 -13
  71. package/docs/api/foundation-comms.defaulthttpconnectconfig.md +0 -13
  72. package/docs/api/foundation-comms.httpconnectconfig.md +0 -20
  73. package/docs/api/foundation-comms.httpconnectconfig.polling.md +0 -13
  74. package/docs/api/foundation-comms.httppollingconfig.md +0 -22
  75. package/docs/api/foundation-comms.httppollingconfig.polling_frequency.md +0 -13
  76. package/docs/api/foundation-comms.httppollingconfig.polling_interval_map.md +0 -15
  77. package/docs/api/foundation-comms.httppollingconfig.polling_map.md +0 -15
  78. package/docs/api/foundation-comms.pollingconfiguration.amount_of_polls.md +0 -18
  79. package/docs/api/foundation-comms.pollingconfiguration.md +0 -22
  80. package/docs/api/foundation-comms.pollingconfiguration.queries.md +0 -13
  81. package/docs/api/foundation-comms.pollingconfiguration.temp_frequency.md +0 -13
package/dist/foundation-comms.api.json CHANGED
@@ -2044,6 +2044,122 @@
2044
2044
  }
2045
2045
  ],
2046
2046
  "name": "stream"
2047
+ },
2048
+ {
2049
+ "kind": "MethodSignature",
2050
+ "canonicalReference": "@genesislcap/foundation-comms!Connect#streamState:member(1)",
2051
+ "docComment": "/**\n * Starts listening for updates on the specified resource.\n *\n * @param resourceName - The name of the resource to listen for updates on.\n *\n * @param onMessage - A callback function to handle received messages.\n *\n * @param onError - A callback function to handle errors.\n *\n * @param params - Additional parameters to pass to the server.\n *\n * @param initialState - State of the list to start with, defaults to empty array.\n *\n * @returns An observable that emits latest state of the list it subscribes to.\n *\n * @public\n */\n",
2052
+ "excerptTokens": [
2053
+ {
2054
+ "kind": "Content",
2055
+ "text": "streamState(resourceName: "
2056
+ },
2057
+ {
2058
+ "kind": "Content",
2059
+ "text": "string"
2060
+ },
2061
+ {
2062
+ "kind": "Content",
2063
+ "text": ", onMessage: "
2064
+ },
2065
+ {
2066
+ "kind": "Reference",
2067
+ "text": "Function",
2068
+ "canonicalReference": "!Function:interface"
2069
+ },
2070
+ {
2071
+ "kind": "Content",
2072
+ "text": ", onError: "
2073
+ },
2074
+ {
2075
+ "kind": "Reference",
2076
+ "text": "Function",
2077
+ "canonicalReference": "!Function:interface"
2078
+ },
2079
+ {
2080
+ "kind": "Content",
2081
+ "text": ", params?: "
2082
+ },
2083
+ {
2084
+ "kind": "Content",
2085
+ "text": "any"
2086
+ },
2087
+ {
2088
+ "kind": "Content",
2089
+ "text": ", initialState?: "
2090
+ },
2091
+ {
2092
+ "kind": "Content",
2093
+ "text": "any[]"
2094
+ },
2095
+ {
2096
+ "kind": "Content",
2097
+ "text": "): "
2098
+ },
2099
+ {
2100
+ "kind": "Reference",
2101
+ "text": "Observable",
2102
+ "canonicalReference": "rxjs!Observable:class"
2103
+ },
2104
+ {
2105
+ "kind": "Content",
2106
+ "text": "<any[]>"
2107
+ },
2108
+ {
2109
+ "kind": "Content",
2110
+ "text": ";"
2111
+ }
2112
+ ],
2113
+ "isOptional": false,
2114
+ "returnTypeTokenRange": {
2115
+ "startIndex": 11,
2116
+ "endIndex": 13
2117
+ },
2118
+ "releaseTag": "Public",
2119
+ "overloadIndex": 1,
2120
+ "parameters": [
2121
+ {
2122
+ "parameterName": "resourceName",
2123
+ "parameterTypeTokenRange": {
2124
+ "startIndex": 1,
2125
+ "endIndex": 2
2126
+ },
2127
+ "isOptional": false
2128
+ },
2129
+ {
2130
+ "parameterName": "onMessage",
2131
+ "parameterTypeTokenRange": {
2132
+ "startIndex": 3,
2133
+ "endIndex": 4
2134
+ },
2135
+ "isOptional": false
2136
+ },
2137
+ {
2138
+ "parameterName": "onError",
2139
+ "parameterTypeTokenRange": {
2140
+ "startIndex": 5,
2141
+ "endIndex": 6
2142
+ },
2143
+ "isOptional": false
2144
+ },
2145
+ {
2146
+ "parameterName": "params",
2147
+ "parameterTypeTokenRange": {
2148
+ "startIndex": 7,
2149
+ "endIndex": 8
2150
+ },
2151
+ "isOptional": true
2152
+ },
2153
+ {
2154
+ "parameterName": "initialState",
2155
+ "parameterTypeTokenRange": {
2156
+ "startIndex": 9,
2157
+ "endIndex": 10
2158
+ },
2159
+ "isOptional": true
2160
+ }
2161
+ ],
2162
+ "name": "streamState"
2047
2163
  }
2048
2164
  ],
2049
2165
  "extendsTokenRanges": []
@@ -2091,6 +2207,34 @@
2091
2207
  "endIndex": 2
2092
2208
  }
2093
2209
  },
2210
+ {
2211
+ "kind": "PropertySignature",
2212
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig#isWebSocketExpression:member",
2213
+ "docComment": "/**\n * Check for web socket url pattern.\n */\n",
2214
+ "excerptTokens": [
2215
+ {
2216
+ "kind": "Content",
2217
+ "text": "isWebSocketExpression: "
2218
+ },
2219
+ {
2220
+ "kind": "Reference",
2221
+ "text": "RegExp",
2222
+ "canonicalReference": "!RegExp:interface"
2223
+ },
2224
+ {
2225
+ "kind": "Content",
2226
+ "text": ";"
2227
+ }
2228
+ ],
2229
+ "isReadonly": false,
2230
+ "isOptional": false,
2231
+ "releaseTag": "Public",
2232
+ "name": "isWebSocketExpression",
2233
+ "propertyTypeTokenRange": {
2234
+ "startIndex": 1,
2235
+ "endIndex": 2
2236
+ }
2237
+ },
2094
2238
  {
2095
2239
  "kind": "PropertySignature",
2096
2240
  "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig#reconnect:member",
@@ -2258,7 +2402,7 @@
2258
2402
  {
2259
2403
  "kind": "MethodSignature",
2260
2404
  "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addStreamListener:member(1)",
2261
- "docComment": "/**\n * Add a stream listener.\n *\n * @param listener - A listener callback function.\n *\n * @param complete - A complete listener callback function.\n */\n",
2405
+ "docComment": "/**\n * Add a stream listener.\n *\n * @param listener - A listener callback function.\n *\n * @param complete - A complete listener callback function.\n *\n * @param error - A error listener callback function.\n */\n",
2262
2406
  "excerptTokens": [
2263
2407
  {
2264
2408
  "kind": "Content",
@@ -2304,6 +2448,28 @@
2304
2448
  "kind": "Content",
2305
2449
  "text": ">"
2306
2450
  },
2451
+ {
2452
+ "kind": "Content",
2453
+ "text": ", error: "
2454
+ },
2455
+ {
2456
+ "kind": "Reference",
2457
+ "text": "Listener",
2458
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
2459
+ },
2460
+ {
2461
+ "kind": "Content",
2462
+ "text": "<"
2463
+ },
2464
+ {
2465
+ "kind": "Reference",
2466
+ "text": "StreamErrorEvent",
2467
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
2468
+ },
2469
+ {
2470
+ "kind": "Content",
2471
+ "text": ">"
2472
+ },
2307
2473
  {
2308
2474
  "kind": "Content",
2309
2475
  "text": "): "
@@ -2319,8 +2485,8 @@
2319
2485
  ],
2320
2486
  "isOptional": false,
2321
2487
  "returnTypeTokenRange": {
2322
- "startIndex": 11,
2323
- "endIndex": 12
2488
+ "startIndex": 16,
2489
+ "endIndex": 17
2324
2490
  },
2325
2491
  "releaseTag": "Public",
2326
2492
  "overloadIndex": 1,
@@ -2340,6 +2506,14 @@
2340
2506
  "endIndex": 10
2341
2507
  },
2342
2508
  "isOptional": false
2509
+ },
2510
+ {
2511
+ "parameterName": "error",
2512
+ "parameterTypeTokenRange": {
2513
+ "startIndex": 11,
2514
+ "endIndex": 15
2515
+ },
2516
+ "isOptional": false
2343
2517
  }
2344
2518
  ],
2345
2519
  "name": "addStreamListener"
@@ -2590,6 +2764,88 @@
2590
2764
  ],
2591
2765
  "name": "onStreamCompleteEvent"
2592
2766
  },
2767
+ {
2768
+ "kind": "MethodSignature",
2769
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onStreamErrorEvent:member(1)",
2770
+ "docComment": "/**\n * Called by Connect.\n *\n * @param resourceName - The name of the resource.\n *\n * @param stream - The actual stream itself.\n *\n * @param error - The error that occurred.\n */\n",
2771
+ "excerptTokens": [
2772
+ {
2773
+ "kind": "Content",
2774
+ "text": "onStreamErrorEvent(resourceName: "
2775
+ },
2776
+ {
2777
+ "kind": "Content",
2778
+ "text": "string"
2779
+ },
2780
+ {
2781
+ "kind": "Content",
2782
+ "text": ", stream: "
2783
+ },
2784
+ {
2785
+ "kind": "Reference",
2786
+ "text": "SocketObservable",
2787
+ "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
2788
+ },
2789
+ {
2790
+ "kind": "Content",
2791
+ "text": "<any>"
2792
+ },
2793
+ {
2794
+ "kind": "Content",
2795
+ "text": ", error: "
2796
+ },
2797
+ {
2798
+ "kind": "Content",
2799
+ "text": "any"
2800
+ },
2801
+ {
2802
+ "kind": "Content",
2803
+ "text": "): "
2804
+ },
2805
+ {
2806
+ "kind": "Content",
2807
+ "text": "void"
2808
+ },
2809
+ {
2810
+ "kind": "Content",
2811
+ "text": ";"
2812
+ }
2813
+ ],
2814
+ "isOptional": false,
2815
+ "returnTypeTokenRange": {
2816
+ "startIndex": 8,
2817
+ "endIndex": 9
2818
+ },
2819
+ "releaseTag": "Public",
2820
+ "overloadIndex": 1,
2821
+ "parameters": [
2822
+ {
2823
+ "parameterName": "resourceName",
2824
+ "parameterTypeTokenRange": {
2825
+ "startIndex": 1,
2826
+ "endIndex": 2
2827
+ },
2828
+ "isOptional": false
2829
+ },
2830
+ {
2831
+ "parameterName": "stream",
2832
+ "parameterTypeTokenRange": {
2833
+ "startIndex": 3,
2834
+ "endIndex": 5
2835
+ },
2836
+ "isOptional": false
2837
+ },
2838
+ {
2839
+ "parameterName": "error",
2840
+ "parameterTypeTokenRange": {
2841
+ "startIndex": 6,
2842
+ "endIndex": 7
2843
+ },
2844
+ "isOptional": false
2845
+ }
2846
+ ],
2847
+ "name": "onStreamErrorEvent"
2848
+ },
2593
2849
  {
2594
2850
  "kind": "MethodSignature",
2595
2851
  "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onStreamEvent:member(1)",
@@ -6652,7 +6908,7 @@
6652
6908
  },
6653
6909
  {
6654
6910
  "kind": "Content",
6655
- "text": ", config?: "
6911
+ "text": ", config: "
6656
6912
  },
6657
6913
  {
6658
6914
  "kind": "Reference",
@@ -6706,7 +6962,7 @@
6706
6962
  "startIndex": 9,
6707
6963
  "endIndex": 10
6708
6964
  },
6709
- "isOptional": true
6965
+ "isOptional": false
6710
6966
  }
6711
6967
  ]
6712
6968
  },
@@ -7875,12 +8131,12 @@
7875
8131
  },
7876
8132
  {
7877
8133
  "kind": "Method",
7878
- "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#streamWithoutAutoTeardown:member(1)",
8134
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#streamState:member(1)",
7879
8135
  "docComment": "",
7880
8136
  "excerptTokens": [
7881
8137
  {
7882
8138
  "kind": "Content",
7883
- "text": "streamWithoutAutoTeardown(resourceName: "
8139
+ "text": "streamState(resourceName: "
7884
8140
  },
7885
8141
  {
7886
8142
  "kind": "Content",
@@ -7888,7 +8144,7 @@
7888
8144
  },
7889
8145
  {
7890
8146
  "kind": "Content",
7891
- "text": ", onMessage: "
8147
+ "text": ", onMessage?: "
7892
8148
  },
7893
8149
  {
7894
8150
  "kind": "Reference",
@@ -7897,7 +8153,7 @@
7897
8153
  },
7898
8154
  {
7899
8155
  "kind": "Content",
7900
- "text": ", onError: "
8156
+ "text": ", onError?: "
7901
8157
  },
7902
8158
  {
7903
8159
  "kind": "Reference",
@@ -7914,21 +8170,140 @@
7914
8170
  },
7915
8171
  {
7916
8172
  "kind": "Content",
7917
- "text": "): "
8173
+ "text": ", initialState?: "
7918
8174
  },
7919
8175
  {
7920
- "kind": "Reference",
7921
- "text": "SocketObservable",
7922
- "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
8176
+ "kind": "Content",
8177
+ "text": "any[]"
7923
8178
  },
7924
8179
  {
7925
8180
  "kind": "Content",
7926
- "text": "<"
8181
+ "text": "): "
7927
8182
  },
7928
8183
  {
7929
8184
  "kind": "Reference",
7930
- "text": "Message",
7931
- "canonicalReference": "@genesislcap/foundation-comms!Message:type"
8185
+ "text": "Observable",
8186
+ "canonicalReference": "rxjs!Observable:class"
8187
+ },
8188
+ {
8189
+ "kind": "Content",
8190
+ "text": "<any[]>"
8191
+ },
8192
+ {
8193
+ "kind": "Content",
8194
+ "text": ";"
8195
+ }
8196
+ ],
8197
+ "isStatic": false,
8198
+ "returnTypeTokenRange": {
8199
+ "startIndex": 11,
8200
+ "endIndex": 13
8201
+ },
8202
+ "releaseTag": "Public",
8203
+ "isProtected": false,
8204
+ "overloadIndex": 1,
8205
+ "parameters": [
8206
+ {
8207
+ "parameterName": "resourceName",
8208
+ "parameterTypeTokenRange": {
8209
+ "startIndex": 1,
8210
+ "endIndex": 2
8211
+ },
8212
+ "isOptional": false
8213
+ },
8214
+ {
8215
+ "parameterName": "onMessage",
8216
+ "parameterTypeTokenRange": {
8217
+ "startIndex": 3,
8218
+ "endIndex": 4
8219
+ },
8220
+ "isOptional": true
8221
+ },
8222
+ {
8223
+ "parameterName": "onError",
8224
+ "parameterTypeTokenRange": {
8225
+ "startIndex": 5,
8226
+ "endIndex": 6
8227
+ },
8228
+ "isOptional": true
8229
+ },
8230
+ {
8231
+ "parameterName": "params",
8232
+ "parameterTypeTokenRange": {
8233
+ "startIndex": 7,
8234
+ "endIndex": 8
8235
+ },
8236
+ "isOptional": true
8237
+ },
8238
+ {
8239
+ "parameterName": "initialState",
8240
+ "parameterTypeTokenRange": {
8241
+ "startIndex": 9,
8242
+ "endIndex": 10
8243
+ },
8244
+ "isOptional": true
8245
+ }
8246
+ ],
8247
+ "isOptional": false,
8248
+ "isAbstract": false,
8249
+ "name": "streamState"
8250
+ },
8251
+ {
8252
+ "kind": "Method",
8253
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#streamWithoutAutoTeardown:member(1)",
8254
+ "docComment": "",
8255
+ "excerptTokens": [
8256
+ {
8257
+ "kind": "Content",
8258
+ "text": "streamWithoutAutoTeardown(resourceName: "
8259
+ },
8260
+ {
8261
+ "kind": "Content",
8262
+ "text": "string"
8263
+ },
8264
+ {
8265
+ "kind": "Content",
8266
+ "text": ", onMessage: "
8267
+ },
8268
+ {
8269
+ "kind": "Reference",
8270
+ "text": "Function",
8271
+ "canonicalReference": "!Function:interface"
8272
+ },
8273
+ {
8274
+ "kind": "Content",
8275
+ "text": ", onError: "
8276
+ },
8277
+ {
8278
+ "kind": "Reference",
8279
+ "text": "Function",
8280
+ "canonicalReference": "!Function:interface"
8281
+ },
8282
+ {
8283
+ "kind": "Content",
8284
+ "text": ", params?: "
8285
+ },
8286
+ {
8287
+ "kind": "Content",
8288
+ "text": "any"
8289
+ },
8290
+ {
8291
+ "kind": "Content",
8292
+ "text": "): "
8293
+ },
8294
+ {
8295
+ "kind": "Reference",
8296
+ "text": "SocketObservable",
8297
+ "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
8298
+ },
8299
+ {
8300
+ "kind": "Content",
8301
+ "text": "<"
8302
+ },
8303
+ {
8304
+ "kind": "Reference",
8305
+ "text": "Message",
8306
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
7932
8307
  },
7933
8308
  {
7934
8309
  "kind": "Content",
@@ -8008,7 +8383,7 @@
8008
8383
  "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig:interface"
8009
8384
  }
8010
8385
  ],
8011
- "fileUrlPath": "src/connect/connect.ts",
8386
+ "fileUrlPath": "src/connect/connect.types.ts",
8012
8387
  "isReadonly": true,
8013
8388
  "releaseTag": "Public",
8014
8389
  "name": "defaultConnectConfig",
@@ -8215,6 +8590,28 @@
8215
8590
  "kind": "Content",
8216
8591
  "text": ">"
8217
8592
  },
8593
+ {
8594
+ "kind": "Content",
8595
+ "text": ", error: "
8596
+ },
8597
+ {
8598
+ "kind": "Reference",
8599
+ "text": "Listener",
8600
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
8601
+ },
8602
+ {
8603
+ "kind": "Content",
8604
+ "text": "<"
8605
+ },
8606
+ {
8607
+ "kind": "Reference",
8608
+ "text": "StreamErrorEvent",
8609
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
8610
+ },
8611
+ {
8612
+ "kind": "Content",
8613
+ "text": ">"
8614
+ },
8218
8615
  {
8219
8616
  "kind": "Content",
8220
8617
  "text": "): "
@@ -8230,8 +8627,8 @@
8230
8627
  ],
8231
8628
  "isStatic": false,
8232
8629
  "returnTypeTokenRange": {
8233
- "startIndex": 11,
8234
- "endIndex": 12
8630
+ "startIndex": 16,
8631
+ "endIndex": 17
8235
8632
  },
8236
8633
  "releaseTag": "Public",
8237
8634
  "isProtected": false,
@@ -8252,6 +8649,14 @@
8252
8649
  "endIndex": 10
8253
8650
  },
8254
8651
  "isOptional": false
8652
+ },
8653
+ {
8654
+ "parameterName": "error",
8655
+ "parameterTypeTokenRange": {
8656
+ "startIndex": 11,
8657
+ "endIndex": 15
8658
+ },
8659
+ "isOptional": false
8255
8660
  }
8256
8661
  ],
8257
8662
  "isOptional": false,
@@ -8486,6 +8891,91 @@
8486
8891
  "isAbstract": false,
8487
8892
  "name": "onStreamCompleteEvent"
8488
8893
  },
8894
+ {
8895
+ "kind": "Method",
8896
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onStreamErrorEvent:member(1)",
8897
+ "docComment": "/**\n * {@inheritDoc ConnectEventsEmitter.onStreamErrorEvent}\n */\n",
8898
+ "excerptTokens": [
8899
+ {
8900
+ "kind": "Content",
8901
+ "text": "onStreamErrorEvent(resourceName: "
8902
+ },
8903
+ {
8904
+ "kind": "Content",
8905
+ "text": "string"
8906
+ },
8907
+ {
8908
+ "kind": "Content",
8909
+ "text": ", stream: "
8910
+ },
8911
+ {
8912
+ "kind": "Reference",
8913
+ "text": "SocketObservable",
8914
+ "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
8915
+ },
8916
+ {
8917
+ "kind": "Content",
8918
+ "text": "<any>"
8919
+ },
8920
+ {
8921
+ "kind": "Content",
8922
+ "text": ", error: "
8923
+ },
8924
+ {
8925
+ "kind": "Content",
8926
+ "text": "any"
8927
+ },
8928
+ {
8929
+ "kind": "Content",
8930
+ "text": "): "
8931
+ },
8932
+ {
8933
+ "kind": "Content",
8934
+ "text": "void"
8935
+ },
8936
+ {
8937
+ "kind": "Content",
8938
+ "text": ";"
8939
+ }
8940
+ ],
8941
+ "isStatic": false,
8942
+ "returnTypeTokenRange": {
8943
+ "startIndex": 8,
8944
+ "endIndex": 9
8945
+ },
8946
+ "releaseTag": "Public",
8947
+ "isProtected": false,
8948
+ "overloadIndex": 1,
8949
+ "parameters": [
8950
+ {
8951
+ "parameterName": "resourceName",
8952
+ "parameterTypeTokenRange": {
8953
+ "startIndex": 1,
8954
+ "endIndex": 2
8955
+ },
8956
+ "isOptional": false
8957
+ },
8958
+ {
8959
+ "parameterName": "stream",
8960
+ "parameterTypeTokenRange": {
8961
+ "startIndex": 3,
8962
+ "endIndex": 5
8963
+ },
8964
+ "isOptional": false
8965
+ },
8966
+ {
8967
+ "parameterName": "error",
8968
+ "parameterTypeTokenRange": {
8969
+ "startIndex": 6,
8970
+ "endIndex": 7
8971
+ },
8972
+ "isOptional": false
8973
+ }
8974
+ ],
8975
+ "isOptional": false,
8976
+ "isAbstract": false,
8977
+ "name": "onStreamErrorEvent"
8978
+ },
8489
8979
  {
8490
8980
  "kind": "Method",
8491
8981
  "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onStreamEvent:member(1)",
@@ -11251,12 +11741,12 @@
11251
11741
  },
11252
11742
  {
11253
11743
  "kind": "Content",
11254
- "text": ", config?: "
11744
+ "text": ", config: "
11255
11745
  },
11256
11746
  {
11257
11747
  "kind": "Reference",
11258
11748
  "text": "HttpConnectConfig",
11259
- "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface"
11749
+ "canonicalReference": "@genesislcap/foundation-comms!~HttpConnectConfig:interface"
11260
11750
  },
11261
11751
  {
11262
11752
  "kind": "Content",
@@ -11313,7 +11803,7 @@
11313
11803
  "startIndex": 11,
11314
11804
  "endIndex": 12
11315
11805
  },
11316
- "isOptional": true
11806
+ "isOptional": false
11317
11807
  }
11318
11808
  ]
11319
11809
  },
@@ -12311,11 +12801,107 @@
12311
12801
  "excerptTokens": [
12312
12802
  {
12313
12803
  "kind": "Content",
12314
- "text": "snapshot(resourceName: "
12804
+ "text": "snapshot(resourceName: "
12805
+ },
12806
+ {
12807
+ "kind": "Content",
12808
+ "text": "string"
12809
+ },
12810
+ {
12811
+ "kind": "Content",
12812
+ "text": ", params?: "
12813
+ },
12814
+ {
12815
+ "kind": "Content",
12816
+ "text": "any"
12817
+ },
12818
+ {
12819
+ "kind": "Content",
12820
+ "text": "): "
12821
+ },
12822
+ {
12823
+ "kind": "Reference",
12824
+ "text": "Promise",
12825
+ "canonicalReference": "!Promise:interface"
12826
+ },
12827
+ {
12828
+ "kind": "Content",
12829
+ "text": "<"
12830
+ },
12831
+ {
12832
+ "kind": "Reference",
12833
+ "text": "Message",
12834
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
12835
+ },
12836
+ {
12837
+ "kind": "Content",
12838
+ "text": ">"
12839
+ },
12840
+ {
12841
+ "kind": "Content",
12842
+ "text": ";"
12843
+ }
12844
+ ],
12845
+ "isStatic": false,
12846
+ "returnTypeTokenRange": {
12847
+ "startIndex": 5,
12848
+ "endIndex": 9
12849
+ },
12850
+ "releaseTag": "Public",
12851
+ "isProtected": false,
12852
+ "overloadIndex": 1,
12853
+ "parameters": [
12854
+ {
12855
+ "parameterName": "resourceName",
12856
+ "parameterTypeTokenRange": {
12857
+ "startIndex": 1,
12858
+ "endIndex": 2
12859
+ },
12860
+ "isOptional": false
12861
+ },
12862
+ {
12863
+ "parameterName": "params",
12864
+ "parameterTypeTokenRange": {
12865
+ "startIndex": 3,
12866
+ "endIndex": 4
12867
+ },
12868
+ "isOptional": true
12869
+ }
12870
+ ],
12871
+ "isOptional": false,
12872
+ "isAbstract": false,
12873
+ "name": "snapshot"
12874
+ },
12875
+ {
12876
+ "kind": "Method",
12877
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#stream:member(1)",
12878
+ "docComment": "",
12879
+ "excerptTokens": [
12880
+ {
12881
+ "kind": "Content",
12882
+ "text": "stream(resourceName: "
12883
+ },
12884
+ {
12885
+ "kind": "Content",
12886
+ "text": "string"
12887
+ },
12888
+ {
12889
+ "kind": "Content",
12890
+ "text": ", onMessage: "
12891
+ },
12892
+ {
12893
+ "kind": "Reference",
12894
+ "text": "Function",
12895
+ "canonicalReference": "!Function:interface"
12315
12896
  },
12316
12897
  {
12317
12898
  "kind": "Content",
12318
- "text": "string"
12899
+ "text": ", onError: "
12900
+ },
12901
+ {
12902
+ "kind": "Reference",
12903
+ "text": "Function",
12904
+ "canonicalReference": "!Function:interface"
12319
12905
  },
12320
12906
  {
12321
12907
  "kind": "Content",
@@ -12331,8 +12917,8 @@
12331
12917
  },
12332
12918
  {
12333
12919
  "kind": "Reference",
12334
- "text": "Promise",
12335
- "canonicalReference": "!Promise:interface"
12920
+ "text": "SocketObservable",
12921
+ "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
12336
12922
  },
12337
12923
  {
12338
12924
  "kind": "Content",
@@ -12354,8 +12940,8 @@
12354
12940
  ],
12355
12941
  "isStatic": false,
12356
12942
  "returnTypeTokenRange": {
12357
- "startIndex": 5,
12358
- "endIndex": 9
12943
+ "startIndex": 9,
12944
+ "endIndex": 13
12359
12945
  },
12360
12946
  "releaseTag": "Public",
12361
12947
  "isProtected": false,
@@ -12370,26 +12956,42 @@
12370
12956
  "isOptional": false
12371
12957
  },
12372
12958
  {
12373
- "parameterName": "params",
12959
+ "parameterName": "onMessage",
12374
12960
  "parameterTypeTokenRange": {
12375
12961
  "startIndex": 3,
12376
12962
  "endIndex": 4
12377
12963
  },
12964
+ "isOptional": false
12965
+ },
12966
+ {
12967
+ "parameterName": "onError",
12968
+ "parameterTypeTokenRange": {
12969
+ "startIndex": 5,
12970
+ "endIndex": 6
12971
+ },
12972
+ "isOptional": false
12973
+ },
12974
+ {
12975
+ "parameterName": "params",
12976
+ "parameterTypeTokenRange": {
12977
+ "startIndex": 7,
12978
+ "endIndex": 8
12979
+ },
12378
12980
  "isOptional": true
12379
12981
  }
12380
12982
  ],
12381
12983
  "isOptional": false,
12382
12984
  "isAbstract": false,
12383
- "name": "snapshot"
12985
+ "name": "stream"
12384
12986
  },
12385
12987
  {
12386
12988
  "kind": "Method",
12387
- "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#stream:member(1)",
12989
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#streamState:member(1)",
12388
12990
  "docComment": "",
12389
12991
  "excerptTokens": [
12390
12992
  {
12391
12993
  "kind": "Content",
12392
- "text": "stream(resourceName: "
12994
+ "text": "streamState(resourceName: "
12393
12995
  },
12394
12996
  {
12395
12997
  "kind": "Content",
@@ -12397,7 +12999,7 @@
12397
12999
  },
12398
13000
  {
12399
13001
  "kind": "Content",
12400
- "text": ", onMessage: "
13002
+ "text": ", onMessage?: "
12401
13003
  },
12402
13004
  {
12403
13005
  "kind": "Reference",
@@ -12406,7 +13008,7 @@
12406
13008
  },
12407
13009
  {
12408
13010
  "kind": "Content",
12409
- "text": ", onError: "
13011
+ "text": ", onError?: "
12410
13012
  },
12411
13013
  {
12412
13014
  "kind": "Reference",
@@ -12423,25 +13025,24 @@
12423
13025
  },
12424
13026
  {
12425
13027
  "kind": "Content",
12426
- "text": "): "
13028
+ "text": ", initialState?: "
12427
13029
  },
12428
13030
  {
12429
- "kind": "Reference",
12430
- "text": "SocketObservable",
12431
- "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
13031
+ "kind": "Content",
13032
+ "text": "any[]"
12432
13033
  },
12433
13034
  {
12434
13035
  "kind": "Content",
12435
- "text": "<"
13036
+ "text": "): "
12436
13037
  },
12437
13038
  {
12438
13039
  "kind": "Reference",
12439
- "text": "Message",
12440
- "canonicalReference": "@genesislcap/foundation-comms!Message:type"
13040
+ "text": "Observable",
13041
+ "canonicalReference": "rxjs!Observable:class"
12441
13042
  },
12442
13043
  {
12443
13044
  "kind": "Content",
12444
- "text": ">"
13045
+ "text": "<any[]>"
12445
13046
  },
12446
13047
  {
12447
13048
  "kind": "Content",
@@ -12450,7 +13051,7 @@
12450
13051
  ],
12451
13052
  "isStatic": false,
12452
13053
  "returnTypeTokenRange": {
12453
- "startIndex": 9,
13054
+ "startIndex": 11,
12454
13055
  "endIndex": 13
12455
13056
  },
12456
13057
  "releaseTag": "Public",
@@ -12471,7 +13072,7 @@
12471
13072
  "startIndex": 3,
12472
13073
  "endIndex": 4
12473
13074
  },
12474
- "isOptional": false
13075
+ "isOptional": true
12475
13076
  },
12476
13077
  {
12477
13078
  "parameterName": "onError",
@@ -12479,7 +13080,7 @@
12479
13080
  "startIndex": 5,
12480
13081
  "endIndex": 6
12481
13082
  },
12482
- "isOptional": false
13083
+ "isOptional": true
12483
13084
  },
12484
13085
  {
12485
13086
  "parameterName": "params",
@@ -12488,11 +13089,19 @@
12488
13089
  "endIndex": 8
12489
13090
  },
12490
13091
  "isOptional": true
13092
+ },
13093
+ {
13094
+ "parameterName": "initialState",
13095
+ "parameterTypeTokenRange": {
13096
+ "startIndex": 9,
13097
+ "endIndex": 10
13098
+ },
13099
+ "isOptional": true
12491
13100
  }
12492
13101
  ],
12493
13102
  "isOptional": false,
12494
13103
  "isAbstract": false,
12495
- "name": "stream"
13104
+ "name": "streamState"
12496
13105
  },
12497
13106
  {
12498
13107
  "kind": "Method",
@@ -12614,30 +13223,6 @@
12614
13223
  }
12615
13224
  ]
12616
13225
  },
12617
- {
12618
- "kind": "Variable",
12619
- "canonicalReference": "@genesislcap/foundation-comms!defaultHttpConnectConfig:var",
12620
- "docComment": "/**\n * The default configuration for connecting to an HTTP service.\n *\n * @public\n */\n",
12621
- "excerptTokens": [
12622
- {
12623
- "kind": "Content",
12624
- "text": "defaultHttpConnectConfig: "
12625
- },
12626
- {
12627
- "kind": "Reference",
12628
- "text": "HttpConnectConfig",
12629
- "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface"
12630
- }
12631
- ],
12632
- "fileUrlPath": "src/connect/http.connect.ts",
12633
- "isReadonly": true,
12634
- "releaseTag": "Public",
12635
- "name": "defaultHttpConnectConfig",
12636
- "variableTypeTokenRange": {
12637
- "startIndex": 1,
12638
- "endIndex": 2
12639
- }
12640
- },
12641
13226
  {
12642
13227
  "kind": "Class",
12643
13228
  "canonicalReference": "@genesislcap/foundation-comms!DefaultMessageBuilder:class",
@@ -18309,245 +18894,91 @@
18309
18894
  },
18310
18895
  {
18311
18896
  "kind": "MethodSignature",
18312
- "canonicalReference": "@genesislcap/foundation-comms!Http#post:member(1)",
18313
- "docComment": "",
18314
- "excerptTokens": [
18315
- {
18316
- "kind": "Content",
18317
- "text": "post<T = "
18318
- },
18319
- {
18320
- "kind": "Content",
18321
- "text": "any"
18322
- },
18323
- {
18324
- "kind": "Content",
18325
- "text": ">(url: "
18326
- },
18327
- {
18328
- "kind": "Content",
18329
- "text": "string"
18330
- },
18331
- {
18332
- "kind": "Content",
18333
- "text": ", requestInit: "
18334
- },
18335
- {
18336
- "kind": "Reference",
18337
- "text": "HttpRequestInit",
18338
- "canonicalReference": "@genesislcap/foundation-comms!HttpRequestInit:interface"
18339
- },
18340
- {
18341
- "kind": "Content",
18342
- "text": "): "
18343
- },
18344
- {
18345
- "kind": "Reference",
18346
- "text": "Promise",
18347
- "canonicalReference": "!Promise:interface"
18348
- },
18349
- {
18350
- "kind": "Content",
18351
- "text": "<T>"
18352
- },
18353
- {
18354
- "kind": "Content",
18355
- "text": ";"
18356
- }
18357
- ],
18358
- "isOptional": false,
18359
- "returnTypeTokenRange": {
18360
- "startIndex": 7,
18361
- "endIndex": 9
18362
- },
18363
- "releaseTag": "Public",
18364
- "overloadIndex": 1,
18365
- "parameters": [
18366
- {
18367
- "parameterName": "url",
18368
- "parameterTypeTokenRange": {
18369
- "startIndex": 3,
18370
- "endIndex": 4
18371
- },
18372
- "isOptional": false
18373
- },
18374
- {
18375
- "parameterName": "requestInit",
18376
- "parameterTypeTokenRange": {
18377
- "startIndex": 5,
18378
- "endIndex": 6
18379
- },
18380
- "isOptional": false
18381
- }
18382
- ],
18383
- "typeParameters": [
18384
- {
18385
- "typeParameterName": "T",
18386
- "constraintTokenRange": {
18387
- "startIndex": 0,
18388
- "endIndex": 0
18389
- },
18390
- "defaultTypeTokenRange": {
18391
- "startIndex": 1,
18392
- "endIndex": 2
18393
- }
18394
- }
18395
- ],
18396
- "name": "post"
18397
- }
18398
- ],
18399
- "extendsTokenRanges": []
18400
- },
18401
- {
18402
- "kind": "Interface",
18403
- "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface",
18404
- "docComment": "/**\n * Configuration options for the Connect (HTTP) instance.\n *\n * @public\n */\n",
18405
- "excerptTokens": [
18406
- {
18407
- "kind": "Content",
18408
- "text": "export interface HttpConnectConfig "
18409
- }
18410
- ],
18411
- "fileUrlPath": "src/connect/connect.types.ts",
18412
- "releaseTag": "Public",
18413
- "name": "HttpConnectConfig",
18414
- "preserveMemberOrder": false,
18415
- "members": [
18416
- {
18417
- "kind": "PropertySignature",
18418
- "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig#polling:member",
18419
- "docComment": "/**\n * Configuration options for http polling.\n */\n",
18420
- "excerptTokens": [
18421
- {
18422
- "kind": "Content",
18423
- "text": "polling: "
18424
- },
18425
- {
18426
- "kind": "Reference",
18427
- "text": "HttpPollingConfig",
18428
- "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig:interface"
18429
- },
18430
- {
18431
- "kind": "Content",
18432
- "text": ";"
18433
- }
18434
- ],
18435
- "isReadonly": false,
18436
- "isOptional": false,
18437
- "releaseTag": "Public",
18438
- "name": "polling",
18439
- "propertyTypeTokenRange": {
18440
- "startIndex": 1,
18441
- "endIndex": 2
18442
- }
18443
- }
18444
- ],
18445
- "extendsTokenRanges": []
18446
- },
18447
- {
18448
- "kind": "Interface",
18449
- "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig:interface",
18450
- "docComment": "/**\n * Configuration options for http connection.\n *\n * @public\n */\n",
18451
- "excerptTokens": [
18452
- {
18453
- "kind": "Content",
18454
- "text": "export interface HttpPollingConfig "
18455
- }
18456
- ],
18457
- "fileUrlPath": "src/connect/connect.types.ts",
18458
- "releaseTag": "Public",
18459
- "name": "HttpPollingConfig",
18460
- "preserveMemberOrder": false,
18461
- "members": [
18462
- {
18463
- "kind": "PropertySignature",
18464
- "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_FREQUENCY:member",
18465
- "docComment": "/**\n * The frequency of polling.\n */\n",
18466
- "excerptTokens": [
18467
- {
18468
- "kind": "Content",
18469
- "text": "POLLING_FREQUENCY?: "
18470
- },
18471
- {
18472
- "kind": "Content",
18473
- "text": "number"
18474
- },
18475
- {
18476
- "kind": "Content",
18477
- "text": ";"
18478
- }
18479
- ],
18480
- "isReadonly": false,
18481
- "isOptional": true,
18482
- "releaseTag": "Public",
18483
- "name": "POLLING_FREQUENCY",
18484
- "propertyTypeTokenRange": {
18485
- "startIndex": 1,
18486
- "endIndex": 2
18487
- }
18488
- },
18489
- {
18490
- "kind": "PropertySignature",
18491
- "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_INTERVAL_MAP:member",
18492
- "docComment": "/**\n * The interval map of polling.\n */\n",
18897
+ "canonicalReference": "@genesislcap/foundation-comms!Http#post:member(1)",
18898
+ "docComment": "",
18493
18899
  "excerptTokens": [
18494
18900
  {
18495
18901
  "kind": "Content",
18496
- "text": "POLLING_INTERVAL_MAP?: "
18902
+ "text": "post<T = "
18497
18903
  },
18498
18904
  {
18499
18905
  "kind": "Content",
18500
- "text": "{\n [resource: string]: number;\n }"
18906
+ "text": "any"
18501
18907
  },
18502
18908
  {
18503
18909
  "kind": "Content",
18504
- "text": ";"
18505
- }
18506
- ],
18507
- "isReadonly": false,
18508
- "isOptional": true,
18509
- "releaseTag": "Public",
18510
- "name": "POLLING_INTERVAL_MAP",
18511
- "propertyTypeTokenRange": {
18512
- "startIndex": 1,
18513
- "endIndex": 2
18514
- }
18515
- },
18516
- {
18517
- "kind": "PropertySignature",
18518
- "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_MAP:member",
18519
- "docComment": "/**\n * The map of polling configuration.\n */\n",
18520
- "excerptTokens": [
18910
+ "text": ">(url: "
18911
+ },
18912
+ {
18913
+ "kind": "Content",
18914
+ "text": "string"
18915
+ },
18521
18916
  {
18522
18917
  "kind": "Content",
18523
- "text": "POLLING_MAP?: "
18918
+ "text": ", requestInit: "
18919
+ },
18920
+ {
18921
+ "kind": "Reference",
18922
+ "text": "HttpRequestInit",
18923
+ "canonicalReference": "@genesislcap/foundation-comms!HttpRequestInit:interface"
18524
18924
  },
18525
18925
  {
18526
18926
  "kind": "Content",
18527
- "text": "{\n [key: string]: "
18927
+ "text": "): "
18528
18928
  },
18529
18929
  {
18530
18930
  "kind": "Reference",
18531
- "text": "PollingConfiguration",
18532
- "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration:interface"
18931
+ "text": "Promise",
18932
+ "canonicalReference": "!Promise:interface"
18533
18933
  },
18534
18934
  {
18535
18935
  "kind": "Content",
18536
- "text": ";\n }"
18936
+ "text": "<T>"
18537
18937
  },
18538
18938
  {
18539
18939
  "kind": "Content",
18540
18940
  "text": ";"
18541
18941
  }
18542
18942
  ],
18543
- "isReadonly": false,
18544
- "isOptional": true,
18943
+ "isOptional": false,
18944
+ "returnTypeTokenRange": {
18945
+ "startIndex": 7,
18946
+ "endIndex": 9
18947
+ },
18545
18948
  "releaseTag": "Public",
18546
- "name": "POLLING_MAP",
18547
- "propertyTypeTokenRange": {
18548
- "startIndex": 1,
18549
- "endIndex": 4
18550
- }
18949
+ "overloadIndex": 1,
18950
+ "parameters": [
18951
+ {
18952
+ "parameterName": "url",
18953
+ "parameterTypeTokenRange": {
18954
+ "startIndex": 3,
18955
+ "endIndex": 4
18956
+ },
18957
+ "isOptional": false
18958
+ },
18959
+ {
18960
+ "parameterName": "requestInit",
18961
+ "parameterTypeTokenRange": {
18962
+ "startIndex": 5,
18963
+ "endIndex": 6
18964
+ },
18965
+ "isOptional": false
18966
+ }
18967
+ ],
18968
+ "typeParameters": [
18969
+ {
18970
+ "typeParameterName": "T",
18971
+ "constraintTokenRange": {
18972
+ "startIndex": 0,
18973
+ "endIndex": 0
18974
+ },
18975
+ "defaultTypeTokenRange": {
18976
+ "startIndex": 1,
18977
+ "endIndex": 2
18978
+ }
18979
+ }
18980
+ ],
18981
+ "name": "post"
18551
18982
  }
18552
18983
  ],
18553
18984
  "extendsTokenRanges": []
@@ -20836,7 +21267,7 @@
20836
21267
  {
20837
21268
  "kind": "Variable",
20838
21269
  "canonicalReference": "@genesislcap/foundation-comms!messageHasErrorCode:var",
20839
- "docComment": "/**\n * Check if the message contains an error code.\n *\n * @param message - The message object.\n *\n * @param code - The error code.\n *\n * @public\n */\n",
21270
+ "docComment": "/**\n * Check if the message contains an error code.\n *\n * @param message - The message object.\n *\n * @param code - The error code. Either a {@link http-status-codes#StatusCodes | StatusCodes} number or an entire status code string.\n *\n * @public\n */\n",
20840
21271
  "excerptTokens": [
20841
21272
  {
20842
21273
  "kind": "Content",
@@ -22713,7 +23144,7 @@
22713
23144
  },
22714
23145
  {
22715
23146
  "kind": "Content",
22716
- "text": ", 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {\n VERBOSE?: boolean;\n [key: string]: any;\n}"
23147
+ "text": ", 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {\n VERBOSE?: boolean;\n [key: string]: any;\n}"
22717
23148
  },
22718
23149
  {
22719
23150
  "kind": "Content",
@@ -22728,105 +23159,6 @@
22728
23159
  "endIndex": 5
22729
23160
  }
22730
23161
  },
22731
- {
22732
- "kind": "Interface",
22733
- "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration:interface",
22734
- "docComment": "/**\n * Configuration options for http polling.\n *\n * @public\n */\n",
22735
- "excerptTokens": [
22736
- {
22737
- "kind": "Content",
22738
- "text": "export interface PollingConfiguration "
22739
- }
22740
- ],
22741
- "fileUrlPath": "src/connect/connect.types.ts",
22742
- "releaseTag": "Public",
22743
- "name": "PollingConfiguration",
22744
- "preserveMemberOrder": false,
22745
- "members": [
22746
- {
22747
- "kind": "PropertySignature",
22748
- "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#AMOUNT_OF_POLLS:member",
22749
- "docComment": "/**\n * The expected amount of HTTP polling attempts to be performed.\n *\n * @remarks\n *\n * TEMP_FREQUENCY * AMOUNT_OF_POLLS = the total polling time/duration\n */\n",
22750
- "excerptTokens": [
22751
- {
22752
- "kind": "Content",
22753
- "text": "AMOUNT_OF_POLLS: "
22754
- },
22755
- {
22756
- "kind": "Content",
22757
- "text": "number"
22758
- },
22759
- {
22760
- "kind": "Content",
22761
- "text": ";"
22762
- }
22763
- ],
22764
- "isReadonly": false,
22765
- "isOptional": false,
22766
- "releaseTag": "Public",
22767
- "name": "AMOUNT_OF_POLLS",
22768
- "propertyTypeTokenRange": {
22769
- "startIndex": 1,
22770
- "endIndex": 2
22771
- }
22772
- },
22773
- {
22774
- "kind": "PropertySignature",
22775
- "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#QUERIES:member",
22776
- "docComment": "/**\n * The queries to be polled.\n */\n",
22777
- "excerptTokens": [
22778
- {
22779
- "kind": "Content",
22780
- "text": "QUERIES: "
22781
- },
22782
- {
22783
- "kind": "Content",
22784
- "text": "string[]"
22785
- },
22786
- {
22787
- "kind": "Content",
22788
- "text": ";"
22789
- }
22790
- ],
22791
- "isReadonly": false,
22792
- "isOptional": false,
22793
- "releaseTag": "Public",
22794
- "name": "QUERIES",
22795
- "propertyTypeTokenRange": {
22796
- "startIndex": 1,
22797
- "endIndex": 2
22798
- }
22799
- },
22800
- {
22801
- "kind": "PropertySignature",
22802
- "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#TEMP_FREQUENCY:member",
22803
- "docComment": "/**\n * The temporary polling frequency.\n */\n",
22804
- "excerptTokens": [
22805
- {
22806
- "kind": "Content",
22807
- "text": "TEMP_FREQUENCY: "
22808
- },
22809
- {
22810
- "kind": "Content",
22811
- "text": "number"
22812
- },
22813
- {
22814
- "kind": "Content",
22815
- "text": ";"
22816
- }
22817
- ],
22818
- "isReadonly": false,
22819
- "isOptional": false,
22820
- "releaseTag": "Public",
22821
- "name": "TEMP_FREQUENCY",
22822
- "propertyTypeTokenRange": {
22823
- "startIndex": 1,
22824
- "endIndex": 2
22825
- }
22826
- }
22827
- ],
22828
- "extendsTokenRanges": []
22829
- },
22830
23162
  {
22831
23163
  "kind": "TypeAlias",
22832
23164
  "canonicalReference": "@genesislcap/foundation-comms!PongMessage:type",
@@ -25097,7 +25429,7 @@
25097
25429
  "text": ";"
25098
25430
  }
25099
25431
  ],
25100
- "fileUrlPath": "src/connect/socket.ts",
25432
+ "fileUrlPath": "src/connect/socket.types.ts",
25101
25433
  "releaseTag": "Public",
25102
25434
  "name": "SocketConnectOptions",
25103
25435
  "typeTokenRange": {
@@ -25955,6 +26287,113 @@
25955
26287
  "endIndex": 0
25956
26288
  }
25957
26289
  },
26290
+ {
26291
+ "kind": "TypeAlias",
26292
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type",
26293
+ "docComment": "/**\n * @public\n */\n",
26294
+ "excerptTokens": [
26295
+ {
26296
+ "kind": "Content",
26297
+ "text": "export type StreamErrorEvent = "
26298
+ },
26299
+ {
26300
+ "kind": "Reference",
26301
+ "text": "CustomEvent",
26302
+ "canonicalReference": "!CustomEvent:interface"
26303
+ },
26304
+ {
26305
+ "kind": "Content",
26306
+ "text": "<"
26307
+ },
26308
+ {
26309
+ "kind": "Reference",
26310
+ "text": "StreamErrorEventDetail",
26311
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventDetail:type"
26312
+ },
26313
+ {
26314
+ "kind": "Content",
26315
+ "text": ">"
26316
+ },
26317
+ {
26318
+ "kind": "Content",
26319
+ "text": ";"
26320
+ }
26321
+ ],
26322
+ "fileUrlPath": "src/connect/connect.events.ts",
26323
+ "releaseTag": "Public",
26324
+ "name": "StreamErrorEvent",
26325
+ "typeTokenRange": {
26326
+ "startIndex": 1,
26327
+ "endIndex": 5
26328
+ }
26329
+ },
26330
+ {
26331
+ "kind": "TypeAlias",
26332
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventDetail:type",
26333
+ "docComment": "/**\n * @public\n */\n",
26334
+ "excerptTokens": [
26335
+ {
26336
+ "kind": "Content",
26337
+ "text": "export type StreamErrorEventDetail = "
26338
+ },
26339
+ {
26340
+ "kind": "Reference",
26341
+ "text": "Pick",
26342
+ "canonicalReference": "!Pick:type"
26343
+ },
26344
+ {
26345
+ "kind": "Content",
26346
+ "text": "<"
26347
+ },
26348
+ {
26349
+ "kind": "Reference",
26350
+ "text": "StreamEventDetail",
26351
+ "canonicalReference": "@genesislcap/foundation-comms!StreamEventDetail:type"
26352
+ },
26353
+ {
26354
+ "kind": "Content",
26355
+ "text": ", 'resourceName' | 'stream'> & {\n error: any;\n}"
26356
+ },
26357
+ {
26358
+ "kind": "Content",
26359
+ "text": ";"
26360
+ }
26361
+ ],
26362
+ "fileUrlPath": "src/connect/connect.events.ts",
26363
+ "releaseTag": "Public",
26364
+ "name": "StreamErrorEventDetail",
26365
+ "typeTokenRange": {
26366
+ "startIndex": 1,
26367
+ "endIndex": 5
26368
+ }
26369
+ },
26370
+ {
26371
+ "kind": "Variable",
26372
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventType:var",
26373
+ "docComment": "/**\n * @public\n */\n",
26374
+ "excerptTokens": [
26375
+ {
26376
+ "kind": "Content",
26377
+ "text": "StreamErrorEventType = "
26378
+ },
26379
+ {
26380
+ "kind": "Content",
26381
+ "text": "\"connect-stream-error-event\""
26382
+ }
26383
+ ],
26384
+ "fileUrlPath": "src/connect/connect.events.ts",
26385
+ "initializerTokenRange": {
26386
+ "startIndex": 1,
26387
+ "endIndex": 2
26388
+ },
26389
+ "isReadonly": true,
26390
+ "releaseTag": "Public",
26391
+ "name": "StreamErrorEventType",
26392
+ "variableTypeTokenRange": {
26393
+ "startIndex": 0,
26394
+ "endIndex": 0
26395
+ }
26396
+ },
25958
26397
  {
25959
26398
  "kind": "TypeAlias",
25960
26399
  "canonicalReference": "@genesislcap/foundation-comms!StreamEvent:type",