@genesislcap/foundation-comms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (384) hide show
  1. package/dist/dts/auth/loginDTOMapper.d.ts.map +1 -1
  2. package/dist/dts/connect/message.d.ts.map +1 -1
  3. package/dist/dts/connect/reconnectStrategy.d.ts.map +1 -1
  4. package/dist/dts/connect/socket.d.ts.map +1 -1
  5. package/dist/dts/connect/ticker.d.ts +1 -1
  6. package/dist/dts/connect/ticker.d.ts.map +1 -1
  7. package/dist/dts/connect/updateState.d.ts.map +1 -1
  8. package/dist/dts/credentialManager/credentialManager.types.d.ts +1 -0
  9. package/dist/dts/credentialManager/credentialManager.types.d.ts.map +1 -1
  10. package/dist/dts/datasource/datasource.mixins.d.ts +218 -259
  11. package/dist/dts/datasource/datasource.mixins.d.ts.map +1 -1
  12. package/dist/dts/datasource/entityDatasource.d.ts.map +1 -1
  13. package/dist/dts/metadata/metadata.utils.d.ts.map +1 -1
  14. package/dist/dts/networkMonitor/service.d.ts.map +1 -1
  15. package/dist/dts/testing/mocks/auth/auth.d.ts +2 -1
  16. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  17. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -1
  18. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  19. package/dist/dts/tsdoc-metadata.json +1 -1
  20. package/dist/esm/auth/auth.js +2 -2
  21. package/dist/esm/connect/connect.js +8 -8
  22. package/dist/esm/connect/http.connect.js +7 -8
  23. package/dist/esm/connect/socket.js +19 -16
  24. package/dist/esm/connect/ticker.js +6 -8
  25. package/dist/esm/credentialManager/credentialManager.js +2 -2
  26. package/dist/esm/datasource/datasource.js +7 -7
  27. package/dist/esm/networkMonitor/config.js +2 -1
  28. package/dist/esm/resources/genesis/genesis.js +1 -1
  29. package/dist/esm/storage/kv/kv.service.js +3 -3
  30. package/dist/foundation-comms.api.json +620 -3335
  31. package/dist/foundation-comms.d.ts +222 -261
  32. package/docs/api/foundation-comms.auth.login.md +3 -33
  33. package/docs/api/foundation-comms.auth.md +10 -128
  34. package/docs/api/foundation-comms.autherror._constructor_.md +5 -63
  35. package/docs/api/foundation-comms.autherror.haserrorcode.md +3 -31
  36. package/docs/api/foundation-comms.autherror.md +15 -178
  37. package/docs/api/foundation-comms.authtype.md +6 -73
  38. package/docs/api/foundation-comms.connect.commitevent.md +4 -47
  39. package/docs/api/foundation-comms.connect.connect.md +3 -33
  40. package/docs/api/foundation-comms.connect.datalogoff.md +3 -33
  41. package/docs/api/foundation-comms.connect.getavailableresources.md +3 -33
  42. package/docs/api/foundation-comms.connect.getjsonschema.md +3 -33
  43. package/docs/api/foundation-comms.connect.getmetadata.md +4 -49
  44. package/docs/api/foundation-comms.connect.getmorecolumns.md +3 -33
  45. package/docs/api/foundation-comms.connect.getmorerows.md +4 -49
  46. package/docs/api/foundation-comms.connect.md +22 -287
  47. package/docs/api/foundation-comms.connect.request.md +4 -49
  48. package/docs/api/foundation-comms.connect.snapshot.md +4 -49
  49. package/docs/api/foundation-comms.connect.stream.md +6 -81
  50. package/docs/api/foundation-comms.connect.streamstate.md +7 -97
  51. package/docs/api/foundation-comms.connectconfig.md +5 -79
  52. package/docs/api/foundation-comms.connectevents.addcommitlistener.md +3 -33
  53. package/docs/api/foundation-comms.connectevents.addcommitresponselistener.md +3 -33
  54. package/docs/api/foundation-comms.connectevents.addmetadatalistener.md +3 -33
  55. package/docs/api/foundation-comms.connectevents.addstreamlistener.md +5 -65
  56. package/docs/api/foundation-comms.connectevents.md +6 -56
  57. package/docs/api/foundation-comms.connecteventsemitter.md +8 -78
  58. package/docs/api/foundation-comms.connecteventsemitter.oncommitevent.md +4 -49
  59. package/docs/api/foundation-comms.connecteventsemitter.oncommitresponseevent.md +4 -49
  60. package/docs/api/foundation-comms.connecteventsemitter.onmetadataevent.md +5 -65
  61. package/docs/api/foundation-comms.connecteventsemitter.onstreamcompleteevent.md +4 -49
  62. package/docs/api/foundation-comms.connecteventsemitter.onstreamerrorevent.md +5 -65
  63. package/docs/api/foundation-comms.connecteventsemitter.onstreamevent.md +6 -81
  64. package/docs/api/foundation-comms.credentialmanager.createbasiccredentials.md +3 -33
  65. package/docs/api/foundation-comms.credentialmanager.createrefreshcredentials.md +3 -33
  66. package/docs/api/foundation-comms.credentialmanager.createssocredentials.md +3 -33
  67. package/docs/api/foundation-comms.credentialmanager.getcredentials.md +3 -33
  68. package/docs/api/foundation-comms.credentialmanager.getcredentialsfromcontainer.md +3 -33
  69. package/docs/api/foundation-comms.credentialmanager.md +27 -287
  70. package/docs/api/foundation-comms.credentialmanager.normaliselegacycredentialdata.md +4 -49
  71. package/docs/api/foundation-comms.credentialmanager.storecredentials.md +3 -33
  72. package/docs/api/foundation-comms.credentialmanager.storecredentialsincontainer.md +3 -33
  73. package/docs/api/foundation-comms.credentialmanager.storecredentialsincookie.md +3 -33
  74. package/docs/api/foundation-comms.credentialmanager.validatebasiccredentials.md +3 -33
  75. package/docs/api/foundation-comms.credentialmanager.validaterefreshcredentials.md +3 -33
  76. package/docs/api/foundation-comms.credentialmanager.validatessocredentials.md +3 -33
  77. package/docs/api/foundation-comms.credentialmanager.validateusercredentialdata.md +4 -49
  78. package/docs/api/foundation-comms.credentialmanagerconfig.md +3 -39
  79. package/docs/api/foundation-comms.credentialmanagercookieconfig.md +6 -92
  80. package/docs/api/foundation-comms.criteriafilterstofields.md +3 -33
  81. package/docs/api/foundation-comms.dataserverresultfilter.md +4 -49
  82. package/docs/api/foundation-comms.datasource.addview.md +3 -33
  83. package/docs/api/foundation-comms.datasource.clearfilter.md +3 -33
  84. package/docs/api/foundation-comms.datasource.createitem.md +3 -33
  85. package/docs/api/foundation-comms.datasource.datahandler.md +3 -33
  86. package/docs/api/foundation-comms.datasource.deleteitem.md +3 -33
  87. package/docs/api/foundation-comms.datasource.dropview.md +3 -33
  88. package/docs/api/foundation-comms.datasource.getmetadata.md +3 -33
  89. package/docs/api/foundation-comms.datasource.init.md +5 -65
  90. package/docs/api/foundation-comms.datasource.md +25 -304
  91. package/docs/api/foundation-comms.datasource.setfilter.md +5 -65
  92. package/docs/api/foundation-comms.datasource.snapshot.md +3 -33
  93. package/docs/api/foundation-comms.datasource.snapshotfiltered.md +3 -33
  94. package/docs/api/foundation-comms.datasource.updatedata.md +3 -33
  95. package/docs/api/foundation-comms.datasource.updateitem.md +4 -49
  96. package/docs/api/foundation-comms.datasource.validresourcename.md +3 -31
  97. package/docs/api/foundation-comms.datasourceconfig.criteriatofields.md +3 -31
  98. package/docs/api/foundation-comms.datasourceconfig.dataserverresultfilter.md +4 -47
  99. package/docs/api/foundation-comms.datasourceconfig.md +8 -88
  100. package/docs/api/foundation-comms.datasourcedefaults.md +8 -148
  101. package/docs/api/foundation-comms.datasourceeventhandler.md +219 -300
  102. package/docs/api/foundation-comms.datasourcemetadata.md +9 -151
  103. package/docs/api/foundation-comms.datasourceoptions.md +17 -307
  104. package/docs/api/foundation-comms.dataupdate.md +5 -79
  105. package/docs/api/foundation-comms.dataview.md +6 -98
  106. package/docs/api/foundation-comms.defaultauth._constructor_.md +7 -87
  107. package/docs/api/foundation-comms.defaultauth.login.md +3 -31
  108. package/docs/api/foundation-comms.defaultauth.md +15 -195
  109. package/docs/api/foundation-comms.defaultconnect._constructor_.md +7 -87
  110. package/docs/api/foundation-comms.defaultconnect.commitevent.md +4 -47
  111. package/docs/api/foundation-comms.defaultconnect.connect.md +3 -33
  112. package/docs/api/foundation-comms.defaultconnect.datalogoff.md +3 -31
  113. package/docs/api/foundation-comms.defaultconnect.getavailableresources.md +3 -33
  114. package/docs/api/foundation-comms.defaultconnect.getjsonschema.md +4 -47
  115. package/docs/api/foundation-comms.defaultconnect.getmetadata.md +4 -47
  116. package/docs/api/foundation-comms.defaultconnect.getmorecolumns.md +3 -31
  117. package/docs/api/foundation-comms.defaultconnect.getmorerows.md +4 -47
  118. package/docs/api/foundation-comms.defaultconnect.md +30 -384
  119. package/docs/api/foundation-comms.defaultconnect.request.md +4 -47
  120. package/docs/api/foundation-comms.defaultconnect.send.md +4 -47
  121. package/docs/api/foundation-comms.defaultconnect.setvalidsession.md +3 -31
  122. package/docs/api/foundation-comms.defaultconnect.snapshot.md +4 -47
  123. package/docs/api/foundation-comms.defaultconnect.stream.md +6 -75
  124. package/docs/api/foundation-comms.defaultconnect.streamstate.md +7 -95
  125. package/docs/api/foundation-comms.defaultconnect.streamwithoutautoteardown.md +6 -75
  126. package/docs/api/foundation-comms.defaultconnectevents.addcommitlistener.md +3 -33
  127. package/docs/api/foundation-comms.defaultconnectevents.addcommitresponselistener.md +3 -33
  128. package/docs/api/foundation-comms.defaultconnectevents.addmetadatalistener.md +3 -33
  129. package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md +5 -65
  130. package/docs/api/foundation-comms.defaultconnectevents.md +12 -157
  131. package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.md +4 -47
  132. package/docs/api/foundation-comms.defaultconnectevents.oncommitresponseevent.md +4 -49
  133. package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.md +5 -65
  134. package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md +4 -49
  135. package/docs/api/foundation-comms.defaultconnectevents.onstreamerrorevent.md +5 -65
  136. package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md +6 -81
  137. package/docs/api/foundation-comms.defaultcredentialmanager._constructor_.md +4 -47
  138. package/docs/api/foundation-comms.defaultcredentialmanager.createbasiccredentials.md +3 -31
  139. package/docs/api/foundation-comms.defaultcredentialmanager.createrefreshcredentials.md +3 -33
  140. package/docs/api/foundation-comms.defaultcredentialmanager.createssocredentials.md +3 -33
  141. package/docs/api/foundation-comms.defaultcredentialmanager.getcredentials.md +3 -33
  142. package/docs/api/foundation-comms.defaultcredentialmanager.getcredentialsfromcontainer.md +3 -33
  143. package/docs/api/foundation-comms.defaultcredentialmanager.md +30 -348
  144. package/docs/api/foundation-comms.defaultcredentialmanager.normaliselegacycredentialdata.md +4 -49
  145. package/docs/api/foundation-comms.defaultcredentialmanager.storecredentials.md +3 -31
  146. package/docs/api/foundation-comms.defaultcredentialmanager.storecredentialsincontainer.md +3 -31
  147. package/docs/api/foundation-comms.defaultcredentialmanager.storecredentialsincookie.md +3 -31
  148. package/docs/api/foundation-comms.defaultcredentialmanager.validatebasiccredentials.md +3 -31
  149. package/docs/api/foundation-comms.defaultcredentialmanager.validaterefreshcredentials.md +3 -31
  150. package/docs/api/foundation-comms.defaultcredentialmanager.validatessocredentials.md +3 -31
  151. package/docs/api/foundation-comms.defaultcredentialmanager.validateusercredentialdata.md +4 -47
  152. package/docs/api/foundation-comms.defaultdatasource._constructor_.md +7 -87
  153. package/docs/api/foundation-comms.defaultdatasource.fetchandapplymetadata.md +3 -31
  154. package/docs/api/foundation-comms.defaultdatasource.init.md +5 -63
  155. package/docs/api/foundation-comms.defaultdatasource.md +32 -488
  156. package/docs/api/foundation-comms.defaultdatasource.snapshot.md +3 -33
  157. package/docs/api/foundation-comms.defaultdatasource.snapshotfiltered.md +3 -33
  158. package/docs/api/foundation-comms.defaultdatasource.validresourcename.md +3 -31
  159. package/docs/api/foundation-comms.defaultfoundationanalytics._constructor_.md +3 -31
  160. package/docs/api/foundation-comms.defaultfoundationanalytics.md +7 -74
  161. package/docs/api/foundation-comms.defaultfoundationanalytics.trackevent.md +4 -45
  162. package/docs/api/foundation-comms.defaultfoundationanalytics.trackevent_1.md +4 -45
  163. package/docs/api/foundation-comms.defaultgenesisresources._constructor_.md +4 -45
  164. package/docs/api/foundation-comms.defaultgenesisresources.getresourcetypefor.md +3 -33
  165. package/docs/api/foundation-comms.defaultgenesisresources.isvalidresource.md +3 -33
  166. package/docs/api/foundation-comms.defaultgenesisresources.md +17 -230
  167. package/docs/api/foundation-comms.defaulthttp._constructor_.md +3 -31
  168. package/docs/api/foundation-comms.defaulthttp.get.md +4 -45
  169. package/docs/api/foundation-comms.defaulthttp.md +7 -72
  170. package/docs/api/foundation-comms.defaulthttp.post.md +4 -45
  171. package/docs/api/foundation-comms.defaulthttpconnect._constructor_.md +8 -101
  172. package/docs/api/foundation-comms.defaulthttpconnect.commitevent.md +4 -47
  173. package/docs/api/foundation-comms.defaulthttpconnect.connect.md +3 -31
  174. package/docs/api/foundation-comms.defaulthttpconnect.datalogoff.md +3 -31
  175. package/docs/api/foundation-comms.defaulthttpconnect.getavailableresources.md +3 -33
  176. package/docs/api/foundation-comms.defaulthttpconnect.getjsonschema.md +3 -31
  177. package/docs/api/foundation-comms.defaulthttpconnect.getmetadata.md +4 -47
  178. package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.md +3 -31
  179. package/docs/api/foundation-comms.defaulthttpconnect.getmorerows.md +3 -31
  180. package/docs/api/foundation-comms.defaulthttpconnect.md +30 -376
  181. package/docs/api/foundation-comms.defaulthttpconnect.request.md +4 -47
  182. package/docs/api/foundation-comms.defaulthttpconnect.send.md +4 -47
  183. package/docs/api/foundation-comms.defaulthttpconnect.setvalidsession.md +3 -31
  184. package/docs/api/foundation-comms.defaulthttpconnect.snapshot.md +4 -47
  185. package/docs/api/foundation-comms.defaulthttpconnect.stream.md +6 -75
  186. package/docs/api/foundation-comms.defaulthttpconnect.streamstate.md +7 -95
  187. package/docs/api/foundation-comms.defaulthttpconnect.streamwithoutautoteardown.md +6 -75
  188. package/docs/api/foundation-comms.defaultmessagebuilder._constructor_.md +4 -45
  189. package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md +5 -59
  190. package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md +4 -47
  191. package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md +3 -31
  192. package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md +4 -47
  193. package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md +5 -61
  194. package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md +6 -75
  195. package/docs/api/foundation-comms.defaultmessagebuilder.createheartbeatpingmessage.md +3 -33
  196. package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md +4 -47
  197. package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.md +3 -31
  198. package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.md +3 -33
  199. package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.md +4 -47
  200. package/docs/api/foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md +3 -31
  201. package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +4 -47
  202. package/docs/api/foundation-comms.defaultmessagebuilder.createrequestmessage.md +4 -47
  203. package/docs/api/foundation-comms.defaultmessagebuilder.createresourcesmessage.md +3 -33
  204. package/docs/api/foundation-comms.defaultmessagebuilder.md +21 -240
  205. package/docs/api/foundation-comms.defaultmetacache.getjsonschemafor.md +3 -31
  206. package/docs/api/foundation-comms.defaultmetacache.getmetadatafor.md +3 -31
  207. package/docs/api/foundation-comms.defaultmetacache.hasjsonschemafor.md +3 -31
  208. package/docs/api/foundation-comms.defaultmetacache.hasmetadatafor.md +3 -31
  209. package/docs/api/foundation-comms.defaultmetacache.md +12 -145
  210. package/docs/api/foundation-comms.defaultmetacache.setjsonschemafor.md +4 -45
  211. package/docs/api/foundation-comms.defaultmetacache.setmetadatafor.md +4 -45
  212. package/docs/api/foundation-comms.defaultnetworkmonitor.addresource.md +4 -49
  213. package/docs/api/foundation-comms.defaultnetworkmonitor.md +13 -155
  214. package/docs/api/foundation-comms.defaultnetworkmonitor.removeresource.md +3 -33
  215. package/docs/api/foundation-comms.defaultsession.getitem.md +4 -45
  216. package/docs/api/foundation-comms.defaultsession.getlocalstorageitem.md +3 -31
  217. package/docs/api/foundation-comms.defaultsession.getsessionstorageitem.md +3 -31
  218. package/docs/api/foundation-comms.defaultsession.md +18 -212
  219. package/docs/api/foundation-comms.defaultsession.removeitem.md +4 -45
  220. package/docs/api/foundation-comms.defaultsession.removelocalstorageitem.md +3 -31
  221. package/docs/api/foundation-comms.defaultsession.removesessionstorageitem.md +3 -31
  222. package/docs/api/foundation-comms.defaultsession.setauthresult.md +3 -31
  223. package/docs/api/foundation-comms.defaultsession.setitem.md +5 -59
  224. package/docs/api/foundation-comms.defaultsession.setlocalstorageitem.md +4 -45
  225. package/docs/api/foundation-comms.defaultsession.setsessionstorageitem.md +4 -45
  226. package/docs/api/foundation-comms.defaultsession.setstoragekeyprefix.md +3 -31
  227. package/docs/api/foundation-comms.defaultsocket._constructor_.md +9 -115
  228. package/docs/api/foundation-comms.defaultsocket.connect.md +5 -65
  229. package/docs/api/foundation-comms.defaultsocket.md +25 -373
  230. package/docs/api/foundation-comms.defaultsocket.send.md +4 -47
  231. package/docs/api/foundation-comms.defaultsocket.sendforstream.md +6 -75
  232. package/docs/api/foundation-comms.defaultsocket.sendforstreamwithoutteardown.md +5 -59
  233. package/docs/api/foundation-comms.defaultsocketstatus.md +22 -334
  234. package/docs/api/foundation-comms.defaultsocketstatus.onclose.md +3 -31
  235. package/docs/api/foundation-comms.eventmessagetype.md +16 -213
  236. package/docs/api/foundation-comms.extractfielddefinitions.md +1 -44
  237. package/docs/api/foundation-comms.fieldtypeenum.md +10 -129
  238. package/docs/api/foundation-comms.foundationanalytics.md +5 -45
  239. package/docs/api/foundation-comms.foundationanalytics.trackevent.md +4 -49
  240. package/docs/api/foundation-comms.foundationanalytics.trackevent_1.md +4 -49
  241. package/docs/api/foundation-comms.foundationanalytics.trackevent_2.md +4 -49
  242. package/docs/api/foundation-comms.foundationanalyticsevent.controlclicked.md +3 -39
  243. package/docs/api/foundation-comms.foundationanalyticsevent.md +4 -34
  244. package/docs/api/foundation-comms.foundationanalyticsevent.routechanged.md +4 -58
  245. package/docs/api/foundation-comms.foundationanalyticseventtype.md +4 -45
  246. package/docs/api/foundation-comms.genesisresources.md +6 -98
  247. package/docs/api/foundation-comms.genesisresourcesconfig.md +4 -60
  248. package/docs/api/foundation-comms.genesisresourcesmock.getresourcetypefor.md +3 -33
  249. package/docs/api/foundation-comms.genesisresourcesmock.isvalidresource.md +3 -33
  250. package/docs/api/foundation-comms.genesisresourcesmock.md +11 -142
  251. package/docs/api/foundation-comms.getkvstorage.md +1 -1
  252. package/docs/api/foundation-comms.http.get.md +4 -45
  253. package/docs/api/foundation-comms.http.md +4 -30
  254. package/docs/api/foundation-comms.http.post.md +4 -45
  255. package/docs/api/foundation-comms.httprequestinit.md +3 -41
  256. package/docs/api/foundation-comms.jsonschemacache.getjsonschemafor.md +3 -31
  257. package/docs/api/foundation-comms.jsonschemacache.hasjsonschemafor.md +3 -31
  258. package/docs/api/foundation-comms.jsonschemacache.md +8 -78
  259. package/docs/api/foundation-comms.jsonschemacache.setjsonschemafor.md +4 -45
  260. package/docs/api/foundation-comms.logoutresult.md +4 -60
  261. package/docs/api/foundation-comms.md +189 -2081
  262. package/docs/api/foundation-comms.messagebuilder.createchangepasswordmessage.md +5 -65
  263. package/docs/api/foundation-comms.messagebuilder.createcommitmessage.md +4 -49
  264. package/docs/api/foundation-comms.messagebuilder.createdatalogoffmessage.md +3 -33
  265. package/docs/api/foundation-comms.messagebuilder.createdatalogonmessage.md +4 -49
  266. package/docs/api/foundation-comms.messagebuilder.createforgotpasswordmessage.md +5 -65
  267. package/docs/api/foundation-comms.messagebuilder.createforgotpasswordtokenmessage.md +6 -81
  268. package/docs/api/foundation-comms.messagebuilder.createheartbeatpingmessage.md +3 -33
  269. package/docs/api/foundation-comms.messagebuilder.createhttpheadersfrommessage.md +4 -49
  270. package/docs/api/foundation-comms.messagebuilder.createloginmessage.md +3 -33
  271. package/docs/api/foundation-comms.messagebuilder.createlogoutmessage.md +3 -33
  272. package/docs/api/foundation-comms.messagebuilder.createmetarequestmessage.md +4 -49
  273. package/docs/api/foundation-comms.messagebuilder.createmorecolumnsmessage.md +3 -33
  274. package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +4 -49
  275. package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md +4 -49
  276. package/docs/api/foundation-comms.messagebuilder.createresourcesmessage.md +3 -33
  277. package/docs/api/foundation-comms.messagebuilder.md +18 -186
  278. package/docs/api/foundation-comms.messagecode.md +4 -45
  279. package/docs/api/foundation-comms.messagedetails.md +18 -188
  280. package/docs/api/foundation-comms.messagehaserrorcode.md +1 -58
  281. package/docs/api/foundation-comms.messageorthrow.md +1 -44
  282. package/docs/api/foundation-comms.messagetype.md +16 -213
  283. package/docs/api/foundation-comms.metadatacache.getmetadatafor.md +3 -33
  284. package/docs/api/foundation-comms.metadatacache.hasmetadatafor.md +3 -33
  285. package/docs/api/foundation-comms.metadatacache.md +8 -86
  286. package/docs/api/foundation-comms.metadatacache.setmetadatafor.md +4 -49
  287. package/docs/api/foundation-comms.monitoredresourcechecksresult.md +6 -94
  288. package/docs/api/foundation-comms.networkmonitor.addresource.md +4 -49
  289. package/docs/api/foundation-comms.networkmonitor.md +10 -96
  290. package/docs/api/foundation-comms.networkmonitor.removeresource.md +3 -33
  291. package/docs/api/foundation-comms.networkmonitor.runallchecks.md +4 -49
  292. package/docs/api/foundation-comms.networkmonitorconfig.md +13 -231
  293. package/docs/api/foundation-comms.normalisecriteria.md +4 -49
  294. package/docs/api/foundation-comms.resourcetype.md +5 -59
  295. package/docs/api/foundation-comms.retryinterval.md +1 -60
  296. package/docs/api/foundation-comms.serializedsocketstatus.md +13 -217
  297. package/docs/api/foundation-comms.serializer.deserialize.md +3 -33
  298. package/docs/api/foundation-comms.serializer.deserialize_1.md +3 -33
  299. package/docs/api/foundation-comms.serializer.deserialize_2.md +3 -33
  300. package/docs/api/foundation-comms.serializer.md +6 -56
  301. package/docs/api/foundation-comms.serializer.serialize.md +3 -33
  302. package/docs/api/foundation-comms.session.getitem.md +4 -49
  303. package/docs/api/foundation-comms.session.getlocalstorageitem.md +3 -33
  304. package/docs/api/foundation-comms.session.getsessionstorageitem.md +3 -33
  305. package/docs/api/foundation-comms.session.md +18 -196
  306. package/docs/api/foundation-comms.session.removeitem.md +4 -49
  307. package/docs/api/foundation-comms.session.removelocalstorageitem.md +3 -33
  308. package/docs/api/foundation-comms.session.removesessionstorageitem.md +3 -33
  309. package/docs/api/foundation-comms.session.setauthresult.md +3 -33
  310. package/docs/api/foundation-comms.session.setitem.md +5 -65
  311. package/docs/api/foundation-comms.session.setlocalstorageitem.md +4 -49
  312. package/docs/api/foundation-comms.session.setsessionstorageitem.md +4 -49
  313. package/docs/api/foundation-comms.session.setstoragekeyprefix.md +3 -33
  314. package/docs/api/foundation-comms.socket.connect.md +5 -63
  315. package/docs/api/foundation-comms.socket.md +10 -109
  316. package/docs/api/foundation-comms.socket.send.md +4 -47
  317. package/docs/api/foundation-comms.socket.sendforstream.md +6 -75
  318. package/docs/api/foundation-comms.socketmessagehandler._constructor_.md +6 -73
  319. package/docs/api/foundation-comms.socketmessagehandler.md +9 -137
  320. package/docs/api/foundation-comms.socketobservable._constructor_.md +3 -31
  321. package/docs/api/foundation-comms.socketobservable.md +3 -31
  322. package/docs/api/foundation-comms.socketreconnectstrategy.md +4 -45
  323. package/docs/api/foundation-comms.socketstatus.md +7 -69
  324. package/docs/api/foundation-comms.socketstatus.onclose.md +3 -31
  325. package/docs/api/foundation-comms.socketsubject.md +3 -31
  326. package/docs/api/foundation-comms.tofieldmetadata.md +1 -44
  327. package/docs/api/foundation-comms.until.md +4 -49
  328. package/docs/api/index.md +3 -21
  329. package/package.json +16 -14
  330. package/docs/api/foundation-comms.connect.streamwithoutautoteardown.md +0 -112
  331. package/docs/api/foundation-comms.defaultentitydatasource._initialized.md +0 -15
  332. package/docs/api/foundation-comms.defaultentitydatasource.cache.md +0 -19
  333. package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md +0 -19
  334. package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md +0 -14
  335. package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md +0 -14
  336. package/docs/api/foundation-comms.defaultentitydatasource.initialize.md +0 -19
  337. package/docs/api/foundation-comms.defaultentitydatasource.initialized.md +0 -16
  338. package/docs/api/foundation-comms.defaultentitydatasource.isempty.md +0 -19
  339. package/docs/api/foundation-comms.defaultentitydatasource.mapper.md +0 -14
  340. package/docs/api/foundation-comms.defaultentitydatasource.md +0 -312
  341. package/docs/api/foundation-comms.defaultentitydatasource.rowid.md +0 -14
  342. package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md +0 -14
  343. package/docs/api/foundation-comms.defaultentitydatasource.subscription.md +0 -14
  344. package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md +0 -14
  345. package/docs/api/foundation-comms.defaultkvstorage._constructor_.md +0 -81
  346. package/docs/api/foundation-comms.defaultkvstorage.md +0 -98
  347. package/docs/api/foundation-comms.defaultkvstorage.user.md +0 -14
  348. package/docs/api/foundation-comms.defaultkvstorageconfig.md +0 -16
  349. package/docs/api/foundation-comms.entitydatasource.cache.md +0 -19
  350. package/docs/api/foundation-comms.entitydatasource.disconnect.md +0 -22
  351. package/docs/api/foundation-comms.entitydatasource.initialize.md +0 -57
  352. package/docs/api/foundation-comms.entitydatasource.isempty.md +0 -19
  353. package/docs/api/foundation-comms.entitydatasource.md +0 -171
  354. package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.md +0 -14
  355. package/docs/api/foundation-comms.entitydatasourceinit.mapper.md +0 -14
  356. package/docs/api/foundation-comms.entitydatasourceinit.md +0 -99
  357. package/docs/api/foundation-comms.entitydatasourceinit.options.md +0 -14
  358. package/docs/api/foundation-comms.keyvalue.base64.md +0 -16
  359. package/docs/api/foundation-comms.keyvalue.expiration.md +0 -16
  360. package/docs/api/foundation-comms.keyvalue.key.md +0 -16
  361. package/docs/api/foundation-comms.keyvalue.md +0 -137
  362. package/docs/api/foundation-comms.keyvalue.metadata.md +0 -18
  363. package/docs/api/foundation-comms.keyvalue.value.md +0 -16
  364. package/docs/api/foundation-comms.keyvaluetransfer.deserialize.md +0 -53
  365. package/docs/api/foundation-comms.keyvaluetransfer.kv.md +0 -14
  366. package/docs/api/foundation-comms.keyvaluetransfer.md +0 -98
  367. package/docs/api/foundation-comms.keyvaluetransfer.serialize.md +0 -53
  368. package/docs/api/foundation-comms.kveventfailureresponse.md +0 -21
  369. package/docs/api/foundation-comms.kveventmessagetype.md +0 -69
  370. package/docs/api/foundation-comms.kvmessagetype.md +0 -69
  371. package/docs/api/foundation-comms.kvstorage.delete.md +0 -53
  372. package/docs/api/foundation-comms.kvstorage.get.md +0 -18
  373. package/docs/api/foundation-comms.kvstorage.get_1.md +0 -53
  374. package/docs/api/foundation-comms.kvstorage.list.md +0 -18
  375. package/docs/api/foundation-comms.kvstorage.md +0 -91
  376. package/docs/api/foundation-comms.kvstorage.put.md +0 -53
  377. package/docs/api/foundation-comms.kvstorageconfig.account.md +0 -16
  378. package/docs/api/foundation-comms.kvstorageconfig.authemail.md +0 -21
  379. package/docs/api/foundation-comms.kvstorageconfig.authkey.md +0 -16
  380. package/docs/api/foundation-comms.kvstorageconfig.md +0 -118
  381. package/docs/api/foundation-comms.kvstorageconfig.namespace.md +0 -16
  382. package/docs/api/foundation-comms.kvvalue.md +0 -16
  383. package/docs/api/foundation-comms.socket.sendforstreamwithoutteardown.md +0 -91
  384. package/docs/api-report.md.api.md +0 -2909
package/docs/api/foundation-comms.defaulthttpconnect.streamstate.md CHANGED
@@ -12,101 +12,13 @@ streamState(resourceName: string, onMessage?: Function, onError?: Function, para
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- resourceName
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- onMessage
48
-
49
-
50
- </td><td>
51
-
52
- Function
53
-
54
-
55
- </td><td>
56
-
57
- _(Optional)_
58
-
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- onError
64
-
65
-
66
- </td><td>
67
-
68
- Function
69
-
70
-
71
- </td><td>
72
-
73
- _(Optional)_
74
-
75
-
76
- </td></tr>
77
- <tr><td>
78
-
79
- params
80
-
81
-
82
- </td><td>
83
-
84
- any
85
-
86
-
87
- </td><td>
88
-
89
- _(Optional)_
90
-
91
-
92
- </td></tr>
93
- <tr><td>
94
-
95
- initialState
96
-
97
-
98
- </td><td>
99
-
100
- any\[\]
101
-
102
-
103
- </td><td>
104
-
105
- _(Optional)_
106
-
107
-
108
- </td></tr>
109
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | resourceName | string | |
18
+ | onMessage | Function | _(Optional)_ |
19
+ | onError | Function | _(Optional)_ |
20
+ | params | any | _(Optional)_ |
21
+ | initialState | any\[\] | _(Optional)_ |
110
22
 
111
23
  **Returns:**
112
24
 
package/docs/api/foundation-comms.defaulthttpconnect.streamwithoutautoteardown.md CHANGED
@@ -12,81 +12,12 @@ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Fu
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- resourceName
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- onMessage
48
-
49
-
50
- </td><td>
51
-
52
- Function
53
-
54
-
55
- </td><td>
56
-
57
-
58
- </td></tr>
59
- <tr><td>
60
-
61
- onError
62
-
63
-
64
- </td><td>
65
-
66
- Function
67
-
68
-
69
- </td><td>
70
-
71
-
72
- </td></tr>
73
- <tr><td>
74
-
75
- params
76
-
77
-
78
- </td><td>
79
-
80
- any
81
-
82
-
83
- </td><td>
84
-
85
- _(Optional)_
86
-
87
-
88
- </td></tr>
89
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | resourceName | string | |
18
+ | onMessage | Function | |
19
+ | onError | Function | |
20
+ | params | any | _(Optional)_ |
90
21
 
91
22
  **Returns:**
92
23
 
package/docs/api/foundation-comms.defaultmessagebuilder._constructor_.md CHANGED
@@ -14,49 +14,8 @@ constructor(session: Session, uuid: UUID);
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- session
36
-
37
-
38
- </td><td>
39
-
40
- [Session](./foundation-comms.session.md)
41
-
42
-
43
- </td><td>
44
-
45
-
46
- </td></tr>
47
- <tr><td>
48
-
49
- uuid
50
-
51
-
52
- </td><td>
53
-
54
- UUID
55
-
56
-
57
- </td><td>
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | session | [Session](./foundation-comms.session.md) | |
20
+ | uuid | UUID | |
62
21
 
package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md CHANGED
@@ -12,65 +12,11 @@ createChangePasswordMessage(username: string, oldPassword: string, newPassword:
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- username
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- oldPassword
48
-
49
-
50
- </td><td>
51
-
52
- string
53
-
54
-
55
- </td><td>
56
-
57
-
58
- </td></tr>
59
- <tr><td>
60
-
61
- newPassword
62
-
63
-
64
- </td><td>
65
-
66
- string
67
-
68
-
69
- </td><td>
70
-
71
-
72
- </td></tr>
73
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | username | string | |
18
+ | oldPassword | string | |
19
+ | newPassword | string | |
74
20
 
75
21
  **Returns:**
76
22
 
package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md CHANGED
@@ -12,53 +12,10 @@ createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- eventName
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- params
48
-
49
-
50
- </td><td>
51
-
52
- [CommitParams](./foundation-comms.commitparams.md)
53
-
54
-
55
- </td><td>
56
-
57
- _(Optional)_
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | eventName | string | |
18
+ | params | [CommitParams](./foundation-comms.commitparams.md) | _(Optional)_ |
62
19
 
63
20
  **Returns:**
64
21
 
package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md CHANGED
@@ -12,37 +12,9 @@ createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- sourceRef
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | sourceRef | string | |
46
18
 
47
19
  **Returns:**
48
20
 
package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md CHANGED
@@ -12,53 +12,10 @@ createDataLogonMessage(resourceName: string, params?: DataserverParams): Message
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- resourceName
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- params
48
-
49
-
50
- </td><td>
51
-
52
- [DataserverParams](./foundation-comms.dataserverparams.md)
53
-
54
-
55
- </td><td>
56
-
57
- _(Optional)_
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | resourceName | string | |
18
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ |
62
19
 
63
20
  **Returns:**
64
21
 
package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md CHANGED
@@ -12,67 +12,11 @@ createForgotPasswordMessage(username: string, returnUrl: string, requester?: str
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- username
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- returnUrl
48
-
49
-
50
- </td><td>
51
-
52
- string
53
-
54
-
55
- </td><td>
56
-
57
-
58
- </td></tr>
59
- <tr><td>
60
-
61
- requester
62
-
63
-
64
- </td><td>
65
-
66
- string
67
-
68
-
69
- </td><td>
70
-
71
- _(Optional)_
72
-
73
-
74
- </td></tr>
75
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | username | string | |
18
+ | returnUrl | string | |
19
+ | requester | string | _(Optional)_ |
76
20
 
77
21
  **Returns:**
78
22
 
package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md CHANGED
@@ -12,81 +12,12 @@ createForgotPasswordTokenMessage(username: string, resetToken: string, newPasswo
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- username
34
-
35
-
36
- </td><td>
37
-
38
- string
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- <tr><td>
46
-
47
- resetToken
48
-
49
-
50
- </td><td>
51
-
52
- string
53
-
54
-
55
- </td><td>
56
-
57
-
58
- </td></tr>
59
- <tr><td>
60
-
61
- newPassword
62
-
63
-
64
- </td><td>
65
-
66
- string
67
-
68
-
69
- </td><td>
70
-
71
-
72
- </td></tr>
73
- <tr><td>
74
-
75
- requester
76
-
77
-
78
- </td><td>
79
-
80
- string
81
-
82
-
83
- </td><td>
84
-
85
- _(Optional)_
86
-
87
-
88
- </td></tr>
89
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | username | string | |
18
+ | resetToken | string | |
19
+ | newPassword | string | |
20
+ | requester | string | _(Optional)_ |
90
21
 
91
22
  **Returns:**
92
23
 
package/docs/api/foundation-comms.defaultmessagebuilder.createheartbeatpingmessage.md CHANGED
@@ -12,39 +12,9 @@ createHeartbeatPingMessage(verbose?: boolean): PingMessage;
12
12
 
13
13
  ## Parameters
14
14
 
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- verbose
34
-
35
-
36
- </td><td>
37
-
38
- boolean
39
-
40
-
41
- </td><td>
42
-
43
- _(Optional)_ A flag to inform the backend you require a verbose response.
44
-
45
-
46
- </td></tr>
47
- </tbody></table>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | verbose | boolean | _(Optional)_ A flag to inform the backend you require a verbose response. |
48
18
 
49
19
  **Returns:**
50
20