@genesislcap/foundation-comms 14.167.3-alpha-b40d1e5.0 → 14.167.3-alpha-69ba23f.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (224) hide show
  1. package/dist/dts/auth/auth.d.ts.map +1 -1
  2. package/dist/dts/connect/connect.d.ts +1 -11
  3. package/dist/dts/connect/connect.d.ts.map +1 -1
  4. package/dist/dts/connect/http.connect.d.ts +0 -1
  5. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  6. package/dist/dts/connect/index.d.ts +0 -2
  7. package/dist/dts/connect/index.d.ts.map +1 -1
  8. package/dist/dts/connect/message.d.ts +0 -51
  9. package/dist/dts/connect/message.d.ts.map +1 -1
  10. package/dist/dts/connect/socket.d.ts +8 -72
  11. package/dist/dts/connect/socket.d.ts.map +1 -1
  12. package/dist/dts/datasource/datasource.d.ts +0 -9
  13. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  14. package/dist/dts/fdc3/fdc3.d.ts +1 -17
  15. package/dist/dts/fdc3/fdc3.d.ts.map +1 -1
  16. package/dist/dts/index.d.ts +0 -1
  17. package/dist/dts/index.d.ts.map +1 -1
  18. package/dist/dts/testing/mocks/connect/connect.d.ts +0 -1
  19. package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
  20. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -5
  21. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  22. package/dist/dts/testing/mocks/datasource/datasource.d.ts +0 -1
  23. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  24. package/dist/dts/user/user.d.ts +0 -15
  25. package/dist/dts/user/user.d.ts.map +1 -1
  26. package/dist/esm/auth/auth.js +2 -5
  27. package/dist/esm/connect/connect.js +8 -30
  28. package/dist/esm/connect/http.connect.js +0 -6
  29. package/dist/esm/connect/index.js +0 -2
  30. package/dist/esm/connect/message.js +4 -25
  31. package/dist/esm/connect/socket.js +44 -113
  32. package/dist/esm/datasource/datasource.js +8 -18
  33. package/dist/esm/fdc3/fdc3.js +4 -4
  34. package/dist/esm/index.js +0 -1
  35. package/dist/esm/testing/mocks/connect/connect.js +0 -3
  36. package/dist/esm/testing/mocks/connect/socket.js +1 -1
  37. package/dist/esm/testing/mocks/datasource/datasource.js +0 -1
  38. package/dist/esm/user/user.js +1 -22
  39. package/dist/foundation-comms.api.json +6567 -13112
  40. package/dist/foundation-comms.d.ts +13 -841
  41. package/docs/api/foundation-comms.connect.md +0 -1
  42. package/docs/api/foundation-comms.currentuser.md +0 -2
  43. package/docs/api/foundation-comms.datasource.md +0 -1
  44. package/docs/api/foundation-comms.defaultconnect._constructor_.md +1 -2
  45. package/docs/api/foundation-comms.defaultconnect.md +1 -2
  46. package/docs/api/foundation-comms.defaultdatasource.md +0 -1
  47. package/docs/api/foundation-comms.defaulthttpconnect.md +0 -1
  48. package/docs/api/foundation-comms.md +0 -39
  49. package/docs/api/foundation-comms.messagebuilder.md +0 -1
  50. package/docs/api/foundation-comms.messagetype.md +0 -2
  51. package/docs/api/foundation-comms.socket.hasvalidsession.md +11 -0
  52. package/docs/api/foundation-comms.socket.isconnected.md +11 -0
  53. package/docs/api/{foundation-comms.socketstatus.isconnectedsubject.md → foundation-comms.socket.isconnectedsubject.md} +2 -2
  54. package/docs/api/foundation-comms.socket.isreconnecting.md +11 -0
  55. package/docs/api/foundation-comms.socket.md +11 -3
  56. package/docs/api/foundation-comms.socket.sendforstream.md +1 -2
  57. package/docs/api/foundation-comms.user.md +0 -2
  58. package/docs/api-report.md +16 -520
  59. package/package.json +11 -13
  60. package/dist/dts/connect/connect.events.d.ts +0 -173
  61. package/dist/dts/connect/connect.events.d.ts.map +0 -1
  62. package/dist/dts/connect/socket.status.d.ts +0 -79
  63. package/dist/dts/connect/socket.status.d.ts.map +0 -1
  64. package/dist/dts/networkMonitor/config.d.ts +0 -56
  65. package/dist/dts/networkMonitor/config.d.ts.map +0 -1
  66. package/dist/dts/networkMonitor/index.d.ts +0 -4
  67. package/dist/dts/networkMonitor/index.d.ts.map +0 -1
  68. package/dist/dts/networkMonitor/service.d.ts +0 -193
  69. package/dist/dts/networkMonitor/service.d.ts.map +0 -1
  70. package/dist/dts/networkMonitor/types.d.ts +0 -133
  71. package/dist/dts/networkMonitor/types.d.ts.map +0 -1
  72. package/dist/esm/connect/connect.events.js +0 -113
  73. package/dist/esm/connect/socket.status.js +0 -119
  74. package/dist/esm/networkMonitor/config.js +0 -46
  75. package/dist/esm/networkMonitor/index.js +0 -3
  76. package/dist/esm/networkMonitor/service.js +0 -432
  77. package/dist/esm/networkMonitor/types.js +0 -5
  78. package/docs/api/foundation-comms.commitevent.md +0 -14
  79. package/docs/api/foundation-comms.commiteventdetail.md +0 -17
  80. package/docs/api/foundation-comms.commiteventtype.md +0 -12
  81. package/docs/api/foundation-comms.connect.getmorecolumns.md +0 -26
  82. package/docs/api/foundation-comms.connectevents.addcommitlistener.md +0 -24
  83. package/docs/api/foundation-comms.connectevents.addmetadatalistener.md +0 -24
  84. package/docs/api/foundation-comms.connectevents.addstreamlistener.md +0 -25
  85. package/docs/api/foundation-comms.connectevents.md +0 -22
  86. package/docs/api/foundation-comms.connecteventsemitter.md +0 -24
  87. package/docs/api/foundation-comms.connecteventsemitter.oncommitevent.md +0 -25
  88. package/docs/api/foundation-comms.connecteventsemitter.onmetadataevent.md +0 -26
  89. package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.md +0 -24
  90. package/docs/api/foundation-comms.connecteventsemitter.onstreamevent.md +0 -27
  91. package/docs/api/foundation-comms.currentuser.set.md +0 -22
  92. package/docs/api/foundation-comms.currentuser.unset.md +0 -15
  93. package/docs/api/foundation-comms.datasource.destroy.md +0 -17
  94. package/docs/api/foundation-comms.defaultconnect.getmorecolumns.md +0 -22
  95. package/docs/api/foundation-comms.defaultconnectevents.addcommitlistener.md +0 -24
  96. package/docs/api/foundation-comms.defaultconnectevents.addmetadatalistener.md +0 -24
  97. package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md +0 -25
  98. package/docs/api/foundation-comms.defaultconnectevents.md +0 -27
  99. package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.md +0 -25
  100. package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.md +0 -26
  101. package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md +0 -24
  102. package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md +0 -27
  103. package/docs/api/foundation-comms.defaultdatasource.destroy.md +0 -17
  104. package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.md +0 -22
  105. package/docs/api/foundation-comms.defaultmessagebuilder._constructor_.md +0 -21
  106. package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md +0 -24
  107. package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md +0 -23
  108. package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md +0 -22
  109. package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md +0 -23
  110. package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md +0 -24
  111. package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md +0 -25
  112. package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md +0 -23
  113. package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.md +0 -22
  114. package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.md +0 -22
  115. package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.md +0 -23
  116. package/docs/api/foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md +0 -22
  117. package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +0 -22
  118. package/docs/api/foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md +0 -15
  119. package/docs/api/foundation-comms.defaultmessagebuilder.createrequestmessage.md +0 -23
  120. package/docs/api/foundation-comms.defaultmessagebuilder.createresourcesmessage.md +0 -22
  121. package/docs/api/foundation-comms.defaultmessagebuilder.md +0 -41
  122. package/docs/api/foundation-comms.defaultnetworkmonitor.addresource.md +0 -23
  123. package/docs/api/foundation-comms.defaultnetworkmonitor.create.md +0 -16
  124. package/docs/api/foundation-comms.defaultnetworkmonitor.destroy.md +0 -16
  125. package/docs/api/foundation-comms.defaultnetworkmonitor.md +0 -31
  126. package/docs/api/foundation-comms.defaultnetworkmonitor.removeresource.md +0 -22
  127. package/docs/api/foundation-comms.defaultnetworkmonitor.runallchecks.md +0 -11
  128. package/docs/api/foundation-comms.defaultnetworkmonitor.status.md +0 -12
  129. package/docs/api/foundation-comms.defaultnetworkmonitorconfig.md +0 -13
  130. package/docs/api/foundation-comms.defaultsocket._constructor_.md +0 -24
  131. package/docs/api/foundation-comms.defaultsocket.connect.md +0 -24
  132. package/docs/api/foundation-comms.defaultsocket.hasvalidsession.md +0 -13
  133. package/docs/api/foundation-comms.defaultsocket.isconfigured.md +0 -11
  134. package/docs/api/foundation-comms.defaultsocket.isconnected.md +0 -11
  135. package/docs/api/foundation-comms.defaultsocket.isconnectedsubject.md +0 -11
  136. package/docs/api/foundation-comms.defaultsocket.isconnecting.md +0 -11
  137. package/docs/api/foundation-comms.defaultsocket.isdisconnected.md +0 -11
  138. package/docs/api/foundation-comms.defaultsocket.isdisconnectedbyserver.md +0 -11
  139. package/docs/api/foundation-comms.defaultsocket.isreconnecting.md +0 -11
  140. package/docs/api/foundation-comms.defaultsocket.md +0 -44
  141. package/docs/api/foundation-comms.defaultsocket.reset.md +0 -15
  142. package/docs/api/foundation-comms.defaultsocket.send.md +0 -23
  143. package/docs/api/foundation-comms.defaultsocket.sendforstream.md +0 -25
  144. package/docs/api/foundation-comms.defaultsocket.socketmessages.md +0 -11
  145. package/docs/api/foundation-comms.defaultsocketstatus.closedclean.md +0 -11
  146. package/docs/api/foundation-comms.defaultsocketstatus.closedcode.md +0 -11
  147. package/docs/api/foundation-comms.defaultsocketstatus.closedreason.md +0 -11
  148. package/docs/api/foundation-comms.defaultsocketstatus.hasvalidsession.md +0 -11
  149. package/docs/api/foundation-comms.defaultsocketstatus.isconfigured.md +0 -11
  150. package/docs/api/foundation-comms.defaultsocketstatus.isconnected.md +0 -11
  151. package/docs/api/foundation-comms.defaultsocketstatus.isconnectedchanged.md +0 -15
  152. package/docs/api/foundation-comms.defaultsocketstatus.isconnectedsubject.md +0 -11
  153. package/docs/api/foundation-comms.defaultsocketstatus.isconnecting.md +0 -11
  154. package/docs/api/foundation-comms.defaultsocketstatus.isdisconnected.md +0 -11
  155. package/docs/api/foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md +0 -11
  156. package/docs/api/foundation-comms.defaultsocketstatus.isreconnecting.md +0 -11
  157. package/docs/api/foundation-comms.defaultsocketstatus.isreconnectingchanged.md +0 -15
  158. package/docs/api/foundation-comms.defaultsocketstatus.md +0 -42
  159. package/docs/api/foundation-comms.defaultsocketstatus.onclose.md +0 -22
  160. package/docs/api/foundation-comms.defaultsocketstatus.reconnectionlimitreached.md +0 -11
  161. package/docs/api/foundation-comms.defaultsocketstatus.resetclosedstate.md +0 -15
  162. package/docs/api/foundation-comms.defaultsocketstatus.serialize.md +0 -15
  163. package/docs/api/foundation-comms.genesisconnectevents.md +0 -18
  164. package/docs/api/foundation-comms.getnetworkmonitor.md +0 -30
  165. package/docs/api/foundation-comms.getsocket.md +0 -30
  166. package/docs/api/foundation-comms.getsocketstatus.md +0 -30
  167. package/docs/api/foundation-comms.messagebuilder.createmorecolumnsmessage.md +0 -30
  168. package/docs/api/foundation-comms.messagehaserrorcode.md +0 -13
  169. package/docs/api/foundation-comms.metadataevent.md +0 -14
  170. package/docs/api/foundation-comms.metadataeventdetail.md +0 -18
  171. package/docs/api/foundation-comms.metadataeventtype.md +0 -12
  172. package/docs/api/foundation-comms.monitoredresource.md +0 -15
  173. package/docs/api/foundation-comms.monitoredresourcechecks.md +0 -15
  174. package/docs/api/foundation-comms.monitoredresourcechecksresult.isconnected.md +0 -11
  175. package/docs/api/foundation-comms.monitoredresourcechecksresult.lastmessage.md +0 -11
  176. package/docs/api/foundation-comms.monitoredresourcechecksresult.lastupdated.md +0 -11
  177. package/docs/api/foundation-comms.monitoredresourcechecksresult.md +0 -23
  178. package/docs/api/foundation-comms.monitoredresourcechecksresult.timeout.md +0 -11
  179. package/docs/api/foundation-comms.monitoredresourcedatalogon.md +0 -15
  180. package/docs/api/foundation-comms.monitoredresourcemetadata.md +0 -15
  181. package/docs/api/foundation-comms.networklogger.md +0 -12
  182. package/docs/api/foundation-comms.networkmonitor.addresource.md +0 -23
  183. package/docs/api/foundation-comms.networkmonitor.create.md +0 -15
  184. package/docs/api/foundation-comms.networkmonitor.destroy.md +0 -15
  185. package/docs/api/foundation-comms.networkmonitor.md +0 -34
  186. package/docs/api/foundation-comms.networkmonitor.removeresource.md +0 -22
  187. package/docs/api/foundation-comms.networkmonitor.runallchecks.md +0 -23
  188. package/docs/api/foundation-comms.networkmonitor.status.md +0 -11
  189. package/docs/api/foundation-comms.networkmonitorconfig.checkinterval.md +0 -13
  190. package/docs/api/foundation-comms.networkmonitorconfig.checktimeout.md +0 -13
  191. package/docs/api/foundation-comms.networkmonitorconfig.documentevents.md +0 -13
  192. package/docs/api/foundation-comms.networkmonitorconfig.eventemitter.md +0 -13
  193. package/docs/api/foundation-comms.networkmonitorconfig.genesisconnectevents.md +0 -13
  194. package/docs/api/foundation-comms.networkmonitorconfig.md +0 -27
  195. package/docs/api/foundation-comms.networkmonitorconfig.resourcechecks.md +0 -13
  196. package/docs/api/foundation-comms.networkmonitorconfig.resourcedatalogon.md +0 -18
  197. package/docs/api/foundation-comms.networkmonitorconfig.windowevents.md +0 -13
  198. package/docs/api/foundation-comms.resourcehealth.md +0 -19
  199. package/docs/api/foundation-comms.serializedsocketstatus.closedclean.md +0 -11
  200. package/docs/api/foundation-comms.serializedsocketstatus.closedcode.md +0 -11
  201. package/docs/api/foundation-comms.serializedsocketstatus.closedreason.md +0 -11
  202. package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md +0 -11
  203. package/docs/api/foundation-comms.serializedsocketstatus.isconfigured.md +0 -13
  204. package/docs/api/foundation-comms.serializedsocketstatus.isconnected.md +0 -11
  205. package/docs/api/foundation-comms.serializedsocketstatus.isconnecting.md +0 -11
  206. package/docs/api/foundation-comms.serializedsocketstatus.isdisconnected.md +0 -11
  207. package/docs/api/foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md +0 -11
  208. package/docs/api/foundation-comms.serializedsocketstatus.isreconnecting.md +0 -11
  209. package/docs/api/foundation-comms.serializedsocketstatus.md +0 -30
  210. package/docs/api/foundation-comms.serializedsocketstatus.reconnectionlimitreached.md +0 -11
  211. package/docs/api/foundation-comms.socketstatus.md +0 -28
  212. package/docs/api/foundation-comms.socketstatus.onclose.md +0 -22
  213. package/docs/api/foundation-comms.socketstatus.serialize.md +0 -15
  214. package/docs/api/foundation-comms.streamcompleteevent.md +0 -14
  215. package/docs/api/foundation-comms.streamcompleteeventtype.md +0 -12
  216. package/docs/api/foundation-comms.streamevent.md +0 -14
  217. package/docs/api/foundation-comms.streameventdetail.md +0 -19
  218. package/docs/api/foundation-comms.streameventfunctions.md +0 -19
  219. package/docs/api/foundation-comms.streameventtype.md +0 -12
  220. package/docs/api/foundation-comms.systemhealthchanged.md +0 -13
  221. package/docs/api/foundation-comms.systemhealthchangedevent.md +0 -15
  222. package/docs/api/foundation-comms.systemhealthstatus.md +0 -29
  223. package/docs/api/foundation-comms.user.set.md +0 -22
  224. package/docs/api/foundation-comms.user.unset.md +0 -15
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [hasValidSession](./foundation-comms.defaultsocketstatus.hasvalidsession.md)
4
-
5
- ## DefaultSocketStatus.hasValidSession property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- hasValidSession: boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isConfigured](./foundation-comms.defaultsocketstatus.isconfigured.md)
4
-
5
- ## DefaultSocketStatus.isConfigured property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- isConfigured: boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isConnected](./foundation-comms.defaultsocketstatus.isconnected.md)
4
-
5
- ## DefaultSocketStatus.isConnected property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- isConnected: boolean;
11
- ```
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isConnectedChanged](./foundation-comms.defaultsocketstatus.isconnectedchanged.md)
4
-
5
- ## DefaultSocketStatus.isConnectedChanged() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected isConnectedChanged(): void;
11
- ```
12
- **Returns:**
13
-
14
- void
15
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isConnectedSubject](./foundation-comms.defaultsocketstatus.isconnectedsubject.md)
4
-
5
- ## DefaultSocketStatus.isConnectedSubject property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- isConnectedSubject: BehaviorSubject<boolean>;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isConnecting](./foundation-comms.defaultsocketstatus.isconnecting.md)
4
-
5
- ## DefaultSocketStatus.isConnecting property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- isConnecting: boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isDisconnected](./foundation-comms.defaultsocketstatus.isdisconnected.md)
4
-
5
- ## DefaultSocketStatus.isDisconnected property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- get isDisconnected(): boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isDisconnectedByServer](./foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md)
4
-
5
- ## DefaultSocketStatus.isDisconnectedByServer property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- get isDisconnectedByServer(): boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isReconnecting](./foundation-comms.defaultsocketstatus.isreconnecting.md)
4
-
5
- ## DefaultSocketStatus.isReconnecting property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- isReconnecting: boolean;
11
- ```
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [isReconnectingChanged](./foundation-comms.defaultsocketstatus.isreconnectingchanged.md)
4
-
5
- ## DefaultSocketStatus.isReconnectingChanged() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected isReconnectingChanged(): void;
11
- ```
12
- **Returns:**
13
-
14
- void
15
-
@@ -1,42 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md)
4
-
5
- ## DefaultSocketStatus class
6
-
7
- Default SocketStatus implementation.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare class DefaultSocketStatus implements SocketStatus
13
- ```
14
- **Implements:** [SocketStatus](./foundation-comms.socketstatus.md)
15
-
16
- ## Properties
17
-
18
- | Property | Modifiers | Type | Description |
19
- | --- | --- | --- | --- |
20
- | [closedClean](./foundation-comms.defaultsocketstatus.closedclean.md) | | any | |
21
- | [closedCode](./foundation-comms.defaultsocketstatus.closedcode.md) | | any | |
22
- | [closedReason](./foundation-comms.defaultsocketstatus.closedreason.md) | | any | |
23
- | [hasValidSession](./foundation-comms.defaultsocketstatus.hasvalidsession.md) | | boolean | |
24
- | [isConfigured](./foundation-comms.defaultsocketstatus.isconfigured.md) | | boolean | |
25
- | [isConnected](./foundation-comms.defaultsocketstatus.isconnected.md) | | boolean | |
26
- | [isConnectedSubject](./foundation-comms.defaultsocketstatus.isconnectedsubject.md) | | BehaviorSubject&lt;boolean&gt; | |
27
- | [isConnecting](./foundation-comms.defaultsocketstatus.isconnecting.md) | | boolean | |
28
- | [isDisconnected](./foundation-comms.defaultsocketstatus.isdisconnected.md) | <code>readonly</code> | boolean | |
29
- | [isDisconnectedByServer](./foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md) | <code>readonly</code> | boolean | |
30
- | [isReconnecting](./foundation-comms.defaultsocketstatus.isreconnecting.md) | | boolean | |
31
- | [reconnectionLimitReached](./foundation-comms.defaultsocketstatus.reconnectionlimitreached.md) | | boolean | |
32
-
33
- ## Methods
34
-
35
- | Method | Modifiers | Description |
36
- | --- | --- | --- |
37
- | [isConnectedChanged()](./foundation-comms.defaultsocketstatus.isconnectedchanged.md) | <code>protected</code> | |
38
- | [isReconnectingChanged()](./foundation-comms.defaultsocketstatus.isreconnectingchanged.md) | <code>protected</code> | |
39
- | [onClose(event)](./foundation-comms.defaultsocketstatus.onclose.md) | | |
40
- | [resetClosedState()](./foundation-comms.defaultsocketstatus.resetclosedstate.md) | <code>protected</code> | |
41
- | [serialize()](./foundation-comms.defaultsocketstatus.serialize.md) | | |
42
-
@@ -1,22 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [onClose](./foundation-comms.defaultsocketstatus.onclose.md)
4
-
5
- ## DefaultSocketStatus.onClose() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- onClose(event: CloseEvent): void;
11
- ```
12
-
13
- ## Parameters
14
-
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | event | CloseEvent | |
18
-
19
- **Returns:**
20
-
21
- void
22
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [reconnectionLimitReached](./foundation-comms.defaultsocketstatus.reconnectionlimitreached.md)
4
-
5
- ## DefaultSocketStatus.reconnectionLimitReached property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- reconnectionLimitReached: boolean;
11
- ```
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [resetClosedState](./foundation-comms.defaultsocketstatus.resetclosedstate.md)
4
-
5
- ## DefaultSocketStatus.resetClosedState() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- protected resetClosedState(): void;
11
- ```
12
- **Returns:**
13
-
14
- void
15
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [serialize](./foundation-comms.defaultsocketstatus.serialize.md)
4
-
5
- ## DefaultSocketStatus.serialize() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- serialize(): SerializedSocketStatus;
11
- ```
12
- **Returns:**
13
-
14
- [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
15
-
@@ -1,18 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md)
4
-
5
- ## GenesisConnectEvents type
6
-
7
- Genesis connect events that can be monitored to invoke resource checking.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export type GenesisConnectEvents = 'stream' | 'commit';
13
- ```
14
-
15
- ## Remarks
16
-
17
- 'steam' and 'commit' are monitored by default and will invoke resource checking. 'metadata' request failures are monitored for the purpose of surfacing such errors to the console only. For now, 'metadata' errors are unrecoverable.
18
-
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getNetworkMonitor](./foundation-comms.getnetworkmonitor.md)
4
-
5
- ## getNetworkMonitor() function
6
-
7
- Gets NetworkMonitor from the DI container.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare function getNetworkMonitor(): NetworkMonitor;
13
- ```
14
- **Returns:**
15
-
16
- [NetworkMonitor](./foundation-comms.networkmonitor.md)
17
-
18
- ## Remarks
19
-
20
- A utility method for host applications that are not using decorators or the DI container.
21
-
22
- ## Example
23
-
24
-
25
- ```ts
26
- import { getNetworkMonitor } from '@genesislcap/foundation-comms';
27
- ...
28
- private monitor = getNetworkMonitor();
29
- ```
30
-
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getSocket](./foundation-comms.getsocket.md)
4
-
5
- ## getSocket() function
6
-
7
- Gets Socket from the DI container.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare function getSocket(): Socket;
13
- ```
14
- **Returns:**
15
-
16
- [Socket](./foundation-comms.socket.md)
17
-
18
- ## Remarks
19
-
20
- A utility method for host applications that are not using decorators or the DI container.
21
-
22
- ## Example
23
-
24
-
25
- ```ts
26
- import { getSocket } from '@genesislcap/foundation-comms';
27
- ...
28
- private socket = getSocket();
29
- ```
30
-
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getSocketStatus](./foundation-comms.getsocketstatus.md)
4
-
5
- ## getSocketStatus() function
6
-
7
- Gets SocketStatus from the DI container.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare function getSocketStatus(): SocketStatus;
13
- ```
14
- **Returns:**
15
-
16
- [SocketStatus](./foundation-comms.socketstatus.md)
17
-
18
- ## Remarks
19
-
20
- A utility method for host applications that are not using decorators or the DI container.
21
-
22
- ## Example
23
-
24
-
25
- ```ts
26
- import { getSocketStatus } from '@genesislcap/foundation-comms';
27
- ...
28
- private socketStatus = getSocketStatus();
29
- ```
30
-
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MessageBuilder](./foundation-comms.messagebuilder.md) &gt; [createMoreColumnsMessage](./foundation-comms.messagebuilder.createmorecolumnsmessage.md)
4
-
5
- ## MessageBuilder.createMoreColumnsMessage() method
6
-
7
- Creates a message to request more columns.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- createMoreColumnsMessage(sourceRef: string): Message;
13
- ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | sourceRef | string | The source reference. |
20
-
21
- **Returns:**
22
-
23
- [Message](./foundation-comms.message.md)
24
-
25
- The more columns message.
26
-
27
- ## Remarks
28
-
29
- MORE\_COLUMNS
30
-
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md)
4
-
5
- ## messageHasErrorCode variable
6
-
7
- Check if the message contains an error code.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- messageHasErrorCode: (message: Message, code: string | number) => boolean
13
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MetadataEvent](./foundation-comms.metadataevent.md)
4
-
5
- ## MetadataEvent type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type MetadataEvent = CustomEvent<MetadataEventDetail>;
12
- ```
13
- **References:** [MetadataEventDetail](./foundation-comms.metadataeventdetail.md)
14
-
@@ -1,18 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MetadataEventDetail](./foundation-comms.metadataeventdetail.md)
4
-
5
- ## MetadataEventDetail type
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- export type MetadataEventDetail = {
12
- resourceName: string;
13
- message: Message<MessageDetails.MetaRequest>;
14
- error?: any;
15
- };
16
- ```
17
- **References:** [Message](./foundation-comms.message.md)<!-- -->, [MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)
18
-
@@ -1,12 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MetadataEventType](./foundation-comms.metadataeventtype.md)
4
-
5
- ## MetadataEventType variable
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- MetadataEventType = "connect-metadata-event"
12
- ```
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResource](./foundation-comms.monitoredresource.md)
4
-
5
- ## MonitoredResource type
6
-
7
- MonitoredResource.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export type MonitoredResource = SocketObservable<any>;
13
- ```
14
- **References:** [SocketObservable](./foundation-comms.socketobservable.md)
15
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md)
4
-
5
- ## MonitoredResourceChecks type
6
-
7
- MonitoredResourceChecks.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
13
- ```
14
- **References:** [MonitoredResource](./foundation-comms.monitoredresource.md)<!-- -->, [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)
15
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) &gt; [isConnected](./foundation-comms.monitoredresourcechecksresult.isconnected.md)
4
-
5
- ## MonitoredResourceChecksResult.isConnected property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- isConnected: boolean;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) &gt; [lastMessage](./foundation-comms.monitoredresourcechecksresult.lastmessage.md)
4
-
5
- ## MonitoredResourceChecksResult.lastMessage property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- lastMessage?: Message;
11
- ```
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) &gt; [lastUpdated](./foundation-comms.monitoredresourcechecksresult.lastupdated.md)
4
-
5
- ## MonitoredResourceChecksResult.lastUpdated property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- lastUpdated: number;
11
- ```
@@ -1,23 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)
4
-
5
- ## MonitoredResourceChecksResult interface
6
-
7
- MonitoredResourceChecksResult.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export interface MonitoredResourceChecksResult
13
- ```
14
-
15
- ## Properties
16
-
17
- | Property | Modifiers | Type | Description |
18
- | --- | --- | --- | --- |
19
- | [isConnected](./foundation-comms.monitoredresourcechecksresult.isconnected.md) | | boolean | |
20
- | [lastMessage?](./foundation-comms.monitoredresourcechecksresult.lastmessage.md) | | [Message](./foundation-comms.message.md) | _(Optional)_ |
21
- | [lastUpdated](./foundation-comms.monitoredresourcechecksresult.lastupdated.md) | | number | |
22
- | [timeout?](./foundation-comms.monitoredresourcechecksresult.timeout.md) | | boolean | _(Optional)_ |
23
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md) &gt; [timeout](./foundation-comms.monitoredresourcechecksresult.timeout.md)
4
-
5
- ## MonitoredResourceChecksResult.timeout property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- timeout?: boolean;
11
- ```
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md)
4
-
5
- ## MonitoredResourceDataLogon type
6
-
7
- MonitoredResourceDataLogon.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
13
- ```
14
- **References:** [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md)
15
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md)
4
-
5
- ## MonitoredResourceMetadata interface
6
-
7
- MonitoredResourceMetadata.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail>
13
- ```
14
- **Extends:** Partial&lt;[MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)<!-- -->&gt;, Partial&lt;[StreamEventDetail](./foundation-comms.streameventdetail.md)<!-- -->&gt;
15
-
@@ -1,12 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [networkLogger](./foundation-comms.networklogger.md)
4
-
5
- ## networkLogger variable
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- networkLogger: import("@genesislcap/foundation-logger").Logger
12
- ```
@@ -1,23 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [addResource](./foundation-comms.networkmonitor.addresource.md)
4
-
5
- ## NetworkMonitor.addResource() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
11
- ```
12
-
13
- ## Parameters
14
-
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
18
- | metadata | [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | The resource metadata. |
19
-
20
- **Returns:**
21
-
22
- void
23
-
@@ -1,15 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [create](./foundation-comms.networkmonitor.create.md)
4
-
5
- ## NetworkMonitor.create() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- create(): void;
11
- ```
12
- **Returns:**
13
-
14
- void
15
-