@genesislcap/foundation-comms 14.184.0 → 14.186.0

package/dist/foundation-comms.api.json

@@ -2044,6 +2044,122 @@
                 }
               ],
               "name": "stream"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!Connect#streamState:member(1)",
+              "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",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "streamState(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", onMessage: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", onError: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", params?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", initialState?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Observable",
+                  "canonicalReference": "rxjs!Observable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any[]>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 11,
+                "endIndex": 13
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "onMessage",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "onError",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "params",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "initialState",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 9,
+                    "endIndex": 10
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "streamState"
             }
           ],
           "extendsTokenRanges": []
@@ -2091,6 +2207,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig#isWebSocketExpression:member",
+              "docComment": "/**\n * Check for web socket url pattern.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isWebSocketExpression: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RegExp",
+                  "canonicalReference": "!RegExp:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "isWebSocketExpression",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig#reconnect:member",
@@ -2258,7 +2402,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addStreamListener:member(1)",
-              "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",
+              "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",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2304,6 +2448,28 @@
                   "kind": "Content",
                   "text": ">"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Listener",
+                  "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "StreamErrorEvent",
+                  "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -2319,8 +2485,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 11,
-                "endIndex": 12
+                "startIndex": 16,
+                "endIndex": 17
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -2340,6 +2506,14 @@
                     "endIndex": 10
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 11,
+                    "endIndex": 15
+                  },
+                  "isOptional": false
                 }
               ],
               "name": "addStreamListener"
@@ -2590,6 +2764,88 @@
               ],
               "name": "onStreamCompleteEvent"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onStreamErrorEvent:member(1)",
+              "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",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onStreamErrorEvent(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", stream: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "stream",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 6,
+                    "endIndex": 7
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onStreamErrorEvent"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onStreamEvent:member(1)",
@@ -6652,7 +6908,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", config?: "
+                  "text": ", config: "
                 },
                 {
                   "kind": "Reference",
@@ -6706,7 +6962,7 @@
                     "startIndex": 9,
                     "endIndex": 10
                   },
-                  "isOptional": true
+                  "isOptional": false
                 }
               ]
             },
@@ -7875,12 +8131,12 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#streamWithoutAutoTeardown:member(1)",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#streamState:member(1)",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "streamWithoutAutoTeardown(resourceName: "
+                  "text": "streamState(resourceName: "
                 },
                 {
                   "kind": "Content",
@@ -7888,7 +8144,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", onMessage: "
+                  "text": ", onMessage?: "
                 },
                 {
                   "kind": "Reference",
@@ -7897,7 +8153,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", onError: "
+                  "text": ", onError?: "
                 },
                 {
                   "kind": "Reference",
@@ -7914,21 +8170,140 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "): "
+                  "text": ", initialState?: "
                 },
                 {
-                  "kind": "Reference",
-                  "text": "SocketObservable",
-                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                  "kind": "Content",
+                  "text": "any[]"
                 },
                 {
                   "kind": "Content",
-                  "text": "<"
+                  "text": "): "
                 },
                 {
                   "kind": "Reference",
-                  "text": "Message",
-                  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
+                  "text": "Observable",
+                  "canonicalReference": "rxjs!Observable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any[]>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 11,
+                "endIndex": 13
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "onMessage",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "onError",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "params",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "initialState",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 9,
+                    "endIndex": 10
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "streamState"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#streamWithoutAutoTeardown:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "streamWithoutAutoTeardown(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", onMessage: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", onError: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", params?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Message",
+                  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
                 },
                 {
                   "kind": "Content",
@@ -8008,7 +8383,7 @@
               "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig:interface"
             }
           ],
-          "fileUrlPath": "src/connect/connect.ts",
+          "fileUrlPath": "src/connect/connect.types.ts",
           "isReadonly": true,
           "releaseTag": "Public",
           "name": "defaultConnectConfig",
@@ -8215,6 +8590,28 @@
                   "kind": "Content",
                   "text": ">"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Listener",
+                  "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "StreamErrorEvent",
+                  "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -8230,8 +8627,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 11,
-                "endIndex": 12
+                "startIndex": 16,
+                "endIndex": 17
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -8252,6 +8649,14 @@
                     "endIndex": 10
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 11,
+                    "endIndex": 15
+                  },
+                  "isOptional": false
                 }
               ],
               "isOptional": false,
@@ -8486,6 +8891,91 @@
               "isAbstract": false,
               "name": "onStreamCompleteEvent"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onStreamErrorEvent:member(1)",
+              "docComment": "/**\n * {@inheritDoc ConnectEventsEmitter.onStreamErrorEvent}\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onStreamErrorEvent(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", stream: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "stream",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 6,
+                    "endIndex": 7
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "onStreamErrorEvent"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onStreamEvent:member(1)",
@@ -11251,12 +11741,12 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", config?: "
+                  "text": ", config: "
                 },
                 {
                   "kind": "Reference",
                   "text": "HttpConnectConfig",
-                  "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface"
+                  "canonicalReference": "@genesislcap/foundation-comms!~HttpConnectConfig:interface"
                 },
                 {
                   "kind": "Content",
@@ -11313,7 +11803,7 @@
                     "startIndex": 11,
                     "endIndex": 12
                   },
-                  "isOptional": true
+                  "isOptional": false
                 }
               ]
             },
@@ -12311,11 +12801,107 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "snapshot(resourceName: "
+                  "text": "snapshot(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", params?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Message",
+                  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "params",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "snapshot"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#stream:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stream(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", onMessage: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
                 },
                 {
                   "kind": "Content",
-                  "text": "string"
+                  "text": ", onError: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
                 },
                 {
                   "kind": "Content",
@@ -12331,8 +12917,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Promise",
-                  "canonicalReference": "!Promise:interface"
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
                 },
                 {
                   "kind": "Content",
@@ -12354,8 +12940,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 9
+                "startIndex": 9,
+                "endIndex": 13
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -12370,26 +12956,42 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "params",
+                  "parameterName": "onMessage",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4
                   },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "onError",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "params",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
                   "isOptional": true
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "snapshot"
+              "name": "stream"
             },
             {
               "kind": "Method",
-              "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#stream:member(1)",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#streamState:member(1)",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "stream(resourceName: "
+                  "text": "streamState(resourceName: "
                 },
                 {
                   "kind": "Content",
@@ -12397,7 +12999,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", onMessage: "
+                  "text": ", onMessage?: "
                 },
                 {
                   "kind": "Reference",
@@ -12406,7 +13008,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", onError: "
+                  "text": ", onError?: "
                 },
                 {
                   "kind": "Reference",
@@ -12423,25 +13025,24 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "): "
+                  "text": ", initialState?: "
                 },
                 {
-                  "kind": "Reference",
-                  "text": "SocketObservable",
-                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                  "kind": "Content",
+                  "text": "any[]"
                 },
                 {
                   "kind": "Content",
-                  "text": "<"
+                  "text": "): "
                 },
                 {
                   "kind": "Reference",
-                  "text": "Message",
-                  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
+                  "text": "Observable",
+                  "canonicalReference": "rxjs!Observable:class"
                 },
                 {
                   "kind": "Content",
-                  "text": ">"
+                  "text": "<any[]>"
                 },
                 {
                   "kind": "Content",
@@ -12450,7 +13051,7 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 9,
+                "startIndex": 11,
                 "endIndex": 13
               },
               "releaseTag": "Public",
@@ -12471,7 +13072,7 @@
                     "startIndex": 3,
                     "endIndex": 4
                   },
-                  "isOptional": false
+                  "isOptional": true
                 },
                 {
                   "parameterName": "onError",
@@ -12479,7 +13080,7 @@
                     "startIndex": 5,
                     "endIndex": 6
                   },
-                  "isOptional": false
+                  "isOptional": true
                 },
                 {
                   "parameterName": "params",
@@ -12488,11 +13089,19 @@
                     "endIndex": 8
                   },
                   "isOptional": true
+                },
+                {
+                  "parameterName": "initialState",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 9,
+                    "endIndex": 10
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "stream"
+              "name": "streamState"
             },
             {
               "kind": "Method",
@@ -12614,30 +13223,6 @@
             }
           ]
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-comms!defaultHttpConnectConfig:var",
-          "docComment": "/**\n * The default configuration for connecting to an HTTP service.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "defaultHttpConnectConfig: "
-            },
-            {
-              "kind": "Reference",
-              "text": "HttpConnectConfig",
-              "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface"
-            }
-          ],
-          "fileUrlPath": "src/connect/http.connect.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "defaultHttpConnectConfig",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-comms!DefaultMessageBuilder:class",
@@ -18309,245 +18894,91 @@
             },
             {
               "kind": "MethodSignature",
-              "canonicalReference": "@genesislcap/foundation-comms!Http#post:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "post<T = "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">(url: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", requestInit: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "HttpRequestInit",
-                  "canonicalReference": "@genesislcap/foundation-comms!HttpRequestInit:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Promise",
-                  "canonicalReference": "!Promise:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<T>"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "returnTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 9
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "url",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "requestInit",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                }
-              ],
-              "typeParameters": [
-                {
-                  "typeParameterName": "T",
-                  "constraintTokenRange": {
-                    "startIndex": 0,
-                    "endIndex": 0
-                  },
-                  "defaultTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  }
-                }
-              ],
-              "name": "post"
-            }
-          ],
-          "extendsTokenRanges": []
-        },
-        {
-          "kind": "Interface",
-          "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface",
-          "docComment": "/**\n * Configuration options for the Connect (HTTP) instance.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface HttpConnectConfig "
-            }
-          ],
-          "fileUrlPath": "src/connect/connect.types.ts",
-          "releaseTag": "Public",
-          "name": "HttpConnectConfig",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig#polling:member",
-              "docComment": "/**\n * Configuration options for http polling.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "polling: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "HttpPollingConfig",
-                  "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "polling",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "extendsTokenRanges": []
-        },
-        {
-          "kind": "Interface",
-          "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig:interface",
-          "docComment": "/**\n * Configuration options for http connection.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface HttpPollingConfig "
-            }
-          ],
-          "fileUrlPath": "src/connect/connect.types.ts",
-          "releaseTag": "Public",
-          "name": "HttpPollingConfig",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_FREQUENCY:member",
-              "docComment": "/**\n * The frequency of polling.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "POLLING_FREQUENCY?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "POLLING_FREQUENCY",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_INTERVAL_MAP:member",
-              "docComment": "/**\n * The interval map of polling.\n */\n",
+              "canonicalReference": "@genesislcap/foundation-comms!Http#post:member(1)",
+              "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "POLLING_INTERVAL_MAP?: "
+                  "text": "post<T = "
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        [resource: string]: number;\n    }"
+                  "text": "any"
                 },
                 {
                   "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "POLLING_INTERVAL_MAP",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_MAP:member",
-              "docComment": "/**\n * The map of polling configuration.\n */\n",
-              "excerptTokens": [
+                  "text": ">(url: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
                 {
                   "kind": "Content",
-                  "text": "POLLING_MAP?: "
+                  "text": ", requestInit: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HttpRequestInit",
+                  "canonicalReference": "@genesislcap/foundation-comms!HttpRequestInit:interface"
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        [key: string]: "
+                  "text": "): "
                 },
                 {
                   "kind": "Reference",
-                  "text": "PollingConfiguration",
-                  "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration:interface"
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
                 },
                 {
                   "kind": "Content",
-                  "text": ";\n    }"
+                  "text": "<T>"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isReadonly": false,
-              "isOptional": true,
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 9
+              },
               "releaseTag": "Public",
-              "name": "POLLING_MAP",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 4
-              }
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "url",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "requestInit",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "T",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "name": "post"
             }
           ],
           "extendsTokenRanges": []
@@ -20836,7 +21267,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-comms!messageHasErrorCode:var",
-          "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",
+          "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",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -22713,7 +23144,7 @@
             },
             {
               "kind": "Content",
-              "text": ", 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {\n    VERBOSE?: boolean;\n    [key: string]: any;\n}"
+              "text": ", 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {\n    VERBOSE?: boolean;\n    [key: string]: any;\n}"
             },
             {
               "kind": "Content",
@@ -22728,105 +23159,6 @@
             "endIndex": 5
           }
         },
-        {
-          "kind": "Interface",
-          "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration:interface",
-          "docComment": "/**\n * Configuration options for http polling.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface PollingConfiguration "
-            }
-          ],
-          "fileUrlPath": "src/connect/connect.types.ts",
-          "releaseTag": "Public",
-          "name": "PollingConfiguration",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#AMOUNT_OF_POLLS:member",
-              "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",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "AMOUNT_OF_POLLS: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "AMOUNT_OF_POLLS",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#QUERIES:member",
-              "docComment": "/**\n * The queries to be polled.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "QUERIES: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string[]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "QUERIES",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#TEMP_FREQUENCY:member",
-              "docComment": "/**\n * The temporary polling frequency.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "TEMP_FREQUENCY: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "TEMP_FREQUENCY",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "extendsTokenRanges": []
-        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-comms!PongMessage:type",
@@ -25097,7 +25429,7 @@
               "text": ";"
             }
           ],
-          "fileUrlPath": "src/connect/socket.ts",
+          "fileUrlPath": "src/connect/socket.types.ts",
           "releaseTag": "Public",
           "name": "SocketConnectOptions",
           "typeTokenRange": {
@@ -25955,6 +26287,113 @@
             "endIndex": 0
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StreamErrorEvent = "
+            },
+            {
+              "kind": "Reference",
+              "text": "CustomEvent",
+              "canonicalReference": "!CustomEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "StreamErrorEventDetail",
+              "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/connect/connect.events.ts",
+          "releaseTag": "Public",
+          "name": "StreamErrorEvent",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventDetail:type",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StreamErrorEventDetail = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Pick",
+              "canonicalReference": "!Pick:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "StreamEventDetail",
+              "canonicalReference": "@genesislcap/foundation-comms!StreamEventDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", 'resourceName' | 'stream'> & {\n    error: any;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/connect/connect.events.ts",
+          "releaseTag": "Public",
+          "name": "StreamErrorEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventType:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "StreamErrorEventType = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"connect-stream-error-event\""
+            }
+          ],
+          "fileUrlPath": "src/connect/connect.events.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "StreamErrorEventType",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-comms!StreamEvent:type",