@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
@@ -1,2909 +0,0 @@
1
- ## API Report File for "@genesislcap/foundation-comms"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { BehaviorSubject } from 'rxjs';
8
- import { default as Bowser_2 } from 'bowser';
9
- import { Controller } from '@microsoft/fast-element';
10
- import { DefaultUser } from '@genesislcap/foundation-user';
11
- import type { DTOMapper } from '@genesislcap/foundation-utils';
12
- import type { FASTElement } from '@microsoft/fast-element';
13
- import { InterfaceSymbol } from '@microsoft/fast-foundation';
14
- import { JSONSchema7 } from 'json-schema';
15
- import { JSONSerializer } from '@genesislcap/foundation-utils';
16
- import { Listener } from '@genesislcap/foundation-utils';
17
- import { Logger } from '@genesislcap/foundation-logger';
18
- import type { LogLevel } from '@genesislcap/foundation-utils';
19
- import { Observable } from 'rxjs';
20
- import { Observer } from '@genesislcap/foundation-utils';
21
- import { Observer as Observer_2 } from 'rxjs';
22
- import { SetUserProperties } from '@genesislcap/foundation-user';
23
- import { Subscription as SocketSubscription } from 'rxjs';
24
- import { Subject } from 'rxjs';
25
- import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
26
- import { User as User_2 } from '@genesislcap/foundation-user';
27
- import { UUID } from '@genesislcap/foundation-utils';
28
-
29
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Auth" because one of its declarations is marked as @internal
30
- //
31
- // @public
32
- export interface Auth {
33
- // @internal
34
- readonly currentUser: User_2;
35
- readonly isLoggedIn$?: Observable<boolean>;
36
- readonly isLoggedIn: boolean;
37
- isWorking: boolean;
38
- // @internal
39
- readonly loggedUserResult: LoginResult;
40
- login(credentials: AuthInfo): Promise<LoginResult>;
41
- logout(): Promise<LogoutResult>;
42
- reAuthFromSession(): Promise<boolean>;
43
- }
44
-
45
- // @internal
46
- export const Auth: InterfaceSymbol<Auth>;
47
-
48
- // @public
49
- export class AuthError extends Error {
50
- constructor(sent: Message, received?: Message, message?: string);
51
- // (undocumented)
52
- getDetailsError(): string;
53
- // (undocumented)
54
- getMessageError(): string;
55
- // (undocumented)
56
- hasErrorCode(code: string): boolean;
57
- // (undocumented)
58
- hasMFAError(): boolean;
59
- // (undocumented)
60
- hasPasswordExpiredError(): boolean;
61
- // (undocumented)
62
- isIgnorableError(): boolean;
63
- // (undocumented)
64
- received?: Message;
65
- // (undocumented)
66
- sent: Message;
67
- }
68
-
69
- // @public
70
- export type AuthInfo = BasicAuthInfo | SsoAuthInfo | JwtAuthInfo | RefreshAuthInfo;
71
-
72
- // Warning: (ae-internal-missing-underscore) The name "AuthMock" should be prefixed with an underscore because the declaration is marked as @internal
73
- //
74
- // @internal (undocumented)
75
- export class AuthMock implements Auth {
76
- // (undocumented)
77
- currentUser: User_2;
78
- // (undocumented)
79
- get isLoggedIn$(): Observable<boolean>;
80
- // (undocumented)
81
- isLoggedIn: boolean;
82
- // (undocumented)
83
- isWorking: boolean;
84
- // (undocumented)
85
- loggedUserResult: LoginResult;
86
- // (undocumented)
87
- login(credentials: AuthInfo): Promise<LoginResult>;
88
- // (undocumented)
89
- logout(): Promise<LogoutResult>;
90
- // (undocumented)
91
- nextLoginResult: LoginResult;
92
- // (undocumented)
93
- nextLogoutResult: LogoutResult;
94
- // (undocumented)
95
- nextReAuthResult: boolean;
96
- // (undocumented)
97
- reAuthFromSession(): Promise<boolean>;
98
- // (undocumented)
99
- resetTestUser(): void;
100
- // (undocumented)
101
- setTestUser(properties?: Partial<SetUserProperties>): void;
102
- }
103
-
104
- // @public
105
- export enum AuthType {
106
- // (undocumented)
107
- BASIC = "BASIC",
108
- // (undocumented)
109
- JWT = "JWT",
110
- // (undocumented)
111
- REFRESH = "REFRESH",
112
- // (undocumented)
113
- SSO = "SSO"
114
- }
115
-
116
- // @public
117
- export type BasicAuthInfo = {
118
- type: AuthType & AuthType.BASIC;
119
- username: string;
120
- password: string;
121
- mfaToken?: string;
122
- };
123
-
124
- // @public
125
- export type BasicCredentialsInput = {
126
- username: string;
127
- password: string;
128
- };
129
-
130
- // @public (undocumented)
131
- export type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
132
-
133
- // @public (undocumented)
134
- export type CommitAckEventDetail = {
135
- eventName: string;
136
- ack: Message;
137
- };
138
-
139
- // @public (undocumented)
140
- export const CommitAckEventType = "connect-commit-ack-event";
141
-
142
- // @public (undocumented)
143
- export type CommitEvent = CustomEvent<CommitEventDetail>;
144
-
145
- // @public (undocumented)
146
- export type CommitEventDetail = {
147
- eventName: string;
148
- message: Message;
149
- };
150
-
151
- // @public (undocumented)
152
- export const CommitEventType = "connect-commit-event";
153
-
154
- // @public
155
- export type CommitParams = {
156
- DETAILS: any;
157
- HOSTNAME?: string;
158
- IGNORE_WARNINGS?: boolean;
159
- VALIDATE?: boolean;
160
- [key: string]: any;
161
- };
162
-
163
- // @public (undocumented)
164
- export type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
165
-
166
- // @public (undocumented)
167
- export type CommitResponseEventDetail = {
168
- eventName: string;
169
- response: Message;
170
- };
171
-
172
- // @public (undocumented)
173
- export const CommitResponseEventType = "connect-commit-response-event";
174
-
175
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
176
- //
177
- // @public
178
- export interface Connect {
179
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
180
- connect(host?: string): Promise<boolean>;
181
- dataLogoff(sourceRef: string): Promise<Message>;
182
- disconnect(): void;
183
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
184
- getJSONSchema(resourceName: string): Promise<SchemaResponse>;
185
- getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
186
- getMoreColumns(sourceRef: string): Promise<Message>;
187
- getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
188
- // (undocumented)
189
- host: string;
190
- // @internal
191
- httpMode(): boolean;
192
- readonly isConnected$?: Observable<boolean>;
193
- readonly isConnected: boolean;
194
- // @deprecated
195
- readonly isConnectedSubject?: BehaviorSubject<boolean>;
196
- isWorking: boolean;
197
- request(resourceName: string, params?: RequestParams): Promise<Message>;
198
- // @internal
199
- send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
200
- // @internal
201
- setValidSession(valid: boolean): void;
202
- snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
203
- stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
204
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
205
- // @alpha @deprecated
206
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
207
- }
208
-
209
- // @internal
210
- export const Connect: InterfaceSymbol<Connect>;
211
-
212
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectConfig" because one of its declarations is marked as @internal
213
- //
214
- // @public
215
- export interface ConnectConfig {
216
- connect: SocketConnectOptions;
217
- isWebSocketExpression: RegExp;
218
- reconnect: SocketReconnectOptions;
219
- }
220
-
221
- // @internal
222
- export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
223
-
224
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectEvents" because one of its declarations is marked as @internal
225
- //
226
- // @public
227
- export interface ConnectEvents {
228
- addCommitListener(listener: Listener<CommitEvent>): () => void;
229
- addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
230
- addMetadataListener(listener: Listener<MetadataEvent>): () => void;
231
- addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
232
- }
233
-
234
- // @internal
235
- export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
236
-
237
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ConnectEventsEmitter" because one of its declarations is marked as @internal
238
- //
239
- // @public
240
- export interface ConnectEventsEmitter extends ConnectEvents {
241
- onCommitEvent(eventName: string, message: Message): void;
242
- onCommitResponseEvent(eventName: string, response: Message): void;
243
- onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
244
- onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
245
- onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
246
- onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
247
- }
248
-
249
- // @internal
250
- export const ConnectEventsEmitter: InterfaceSymbol<ConnectEventsEmitter>;
251
-
252
- // Warning: (ae-internal-missing-underscore) The name "ConnectEventsMock" should be prefixed with an underscore because the declaration is marked as @internal
253
- //
254
- // @internal (undocumented)
255
- export class ConnectEventsMock {
256
- // Warning: (ae-forgotten-export) The symbol "CommitAckEvent_2" needs to be exported by the entry point index.d.ts
257
- //
258
- // (undocumented)
259
- addCommitAckListener(listener: Listener_2<CommitAckEvent_2>): () => void;
260
- // Warning: (ae-forgotten-export) The symbol "CommitEvent_2" needs to be exported by the entry point index.d.ts
261
- //
262
- // (undocumented)
263
- addCommitListener(listener: Listener_2<CommitEvent_2>): () => void;
264
- // Warning: (ae-forgotten-export) The symbol "CommitResponseEvent_2" needs to be exported by the entry point index.d.ts
265
- //
266
- // (undocumented)
267
- addCommitResponseListener(listener: Listener_2<CommitResponseEvent_2>): () => void;
268
- // Warning: (ae-forgotten-export) The symbol "MetadataEvent_2" needs to be exported by the entry point index.d.ts
269
- //
270
- // (undocumented)
271
- addMetadataListener(listener: Listener_2<MetadataEvent_2>): () => void;
272
- // Warning: (ae-forgotten-export) The symbol "Listener_2" needs to be exported by the entry point index.d.ts
273
- // Warning: (ae-forgotten-export) The symbol "StreamEvent_2" needs to be exported by the entry point index.d.ts
274
- // Warning: (ae-forgotten-export) The symbol "StreamCompleteEvent_2" needs to be exported by the entry point index.d.ts
275
- // Warning: (ae-forgotten-export) The symbol "StreamErrorEvent_2" needs to be exported by the entry point index.d.ts
276
- //
277
- // (undocumented)
278
- addStreamListener(listener: Listener_2<StreamEvent_2>, complete: Listener_2<StreamCompleteEvent_2>, error: Listener_2<StreamErrorEvent_2>): () => void;
279
- // (undocumented)
280
- onCommitEvent(eventName: string, message: Message_2): void;
281
- // (undocumented)
282
- onCommitResponseEvent(eventName: string, response: Message_2): void;
283
- // (undocumented)
284
- onMetadataEvent(resourceName: string, message: Message_2, error?: any): void;
285
- // (undocumented)
286
- onStreamCompleteEvent(resourceName: string, stream: SocketObservable_2<any>): void;
287
- // (undocumented)
288
- onStreamErrorEvent(resourceName: string, stream: SocketObservable_2<any>, error: any): void;
289
- // Warning: (ae-forgotten-export) The symbol "Message_2" needs to be exported by the entry point index.d.ts
290
- // Warning: (ae-forgotten-export) The symbol "SocketObservable_2" needs to be exported by the entry point index.d.ts
291
- // Warning: (ae-forgotten-export) The symbol "StreamEventFunctions_2" needs to be exported by the entry point index.d.ts
292
- //
293
- // (undocumented)
294
- onStreamEvent(resourceName: string, message: Message_2, stream: SocketObservable_2<any>, functions: StreamEventFunctions_2): void;
295
- }
296
-
297
- // @public
298
- export type ConnectionStatus = 'connected' | 'disconnected' | 'busy';
299
-
300
- // Warning: (ae-internal-missing-underscore) The name "ConnectMock" should be prefixed with an underscore because the declaration is marked as @internal
301
- //
302
- // @internal (undocumented)
303
- export class ConnectMock implements Connect {
304
- // (undocumented)
305
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
306
- // (undocumented)
307
- connect(host: string): Promise<boolean>;
308
- // (undocumented)
309
- dataLogoff(sourceRef: string): Promise<Message<any>>;
310
- // (undocumented)
311
- disconnect(): void;
312
- // (undocumented)
313
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
314
- // (undocumented)
315
- getJSONSchema(resourceName: string): Promise<any>;
316
- // (undocumented)
317
- getMetadata(resourceName: string): Promise<Metadata>;
318
- // (undocumented)
319
- getMoreColumns(sourceRef: string): Promise<Message<any>>;
320
- // (undocumented)
321
- getMoreRows(sourceRef: string): Promise<Message<any>>;
322
- // (undocumented)
323
- get host(): string;
324
- // (undocumented)
325
- httpMode(): boolean;
326
- // (undocumented)
327
- get isConnected$(): Observable<boolean>;
328
- // (undocumented)
329
- isConnected: boolean;
330
- // (undocumented)
331
- get isConnectedSubject(): BehaviorSubject<boolean>;
332
- // (undocumented)
333
- isWorking: boolean;
334
- // (undocumented)
335
- nextJSONSchema: any;
336
- // (undocumented)
337
- nextListState: any[];
338
- // (undocumented)
339
- nextMessage: Message;
340
- // (undocumented)
341
- nextMetadata: Metadata;
342
- // (undocumented)
343
- request(resourceName: string, params?: RequestParams): Promise<Message>;
344
- // (undocumented)
345
- requestParams: RequestParams;
346
- // (undocumented)
347
- send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
348
- // (undocumented)
349
- setValidSession(valid: boolean): void;
350
- // (undocumented)
351
- snapshot(resourceName: string, params?: any): Promise<Message>;
352
- // (undocumented)
353
- socket: SocketMock;
354
- // (undocumented)
355
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
356
- // (undocumented)
357
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
358
- // (undocumented)
359
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
360
- }
361
-
362
- // Warning: (ae-internal-missing-underscore) The name "CoreUserPermissions" should be prefixed with an underscore because the declaration is marked as @internal
363
- //
364
- // @internal (undocumented)
365
- export type CoreUserPermissions = 'somePermission' | 'someOtherPermission';
366
-
367
- // Warning: (ae-internal-missing-underscore) The name "CoreUserProfiles" should be prefixed with an underscore because the declaration is marked as @internal
368
- //
369
- // @internal (undocumented)
370
- export type CoreUserProfiles = 'someProfile' | 'someOtherProfile';
371
-
372
- // @public
373
- type CredentialData_2 = PasswordCredentialData & {
374
- password?: string;
375
- };
376
- export { CredentialData_2 as CredentialData }
377
-
378
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "CredentialManager" because one of its declarations is marked as @internal
379
- //
380
- // @public
381
- export interface CredentialManager {
382
- createBasicCredentials(inputs: BasicCredentialsInput): BasicAuthInfo;
383
- createRefreshCredentials(inputs?: RefreshCredentialsInput): RefreshAuthInfo;
384
- createSSOCredentials(inputs?: SSOCredentialsInput): SsoAuthInfo;
385
- getCredentials(options?: GetCredentialOptions): Promise<CredentialData_2 | undefined>;
386
- getCredentialsFromContainer(options?: GetCredentialOptions): Promise<CredentialData_2 | null>;
387
- getCredentialsFromCookie(): CredentialData_2 | undefined;
388
- getMFAToken(): string | null;
389
- getRefreshToken(): string | null;
390
- getSSOToken(): string | null;
391
- getUsername(): string | null;
392
- normaliseLegacyCredentialData(data?: CredentialData_2, cookie?: CredentialData_2): [CredentialData_2 | undefined, boolean];
393
- preventSilentAccess(): Promise<void>;
394
- removeAll(): void;
395
- removeCookie(): void;
396
- removeMFAToken(): void;
397
- removeRefreshToken(): void;
398
- removeSSOToken(): void;
399
- removeUsername(): void;
400
- storeCredentials(data: CredentialData_2): Promise<boolean>;
401
- storeCredentialsInContainer(data: CredentialData_2): Promise<Credential | undefined>;
402
- storeCredentialsInCookie(data: CredentialData_2): boolean;
403
- validateBasicCredentials(credentials: BasicAuthInfo): boolean;
404
- validateRefreshCredentials(credentials: RefreshAuthInfo): boolean;
405
- validateSSOCredentials(credentials: SsoAuthInfo): boolean;
406
- validateUserCredentialData(data: CredentialData_2, ensurePassword?: boolean): boolean;
407
- }
408
-
409
- // @internal
410
- export const CredentialManager: InterfaceSymbol<CredentialManager>;
411
-
412
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "CredentialManagerConfig" because one of its declarations is marked as @internal
413
- //
414
- // @public
415
- export interface CredentialManagerConfig {
416
- // (undocumented)
417
- cookie: CredentialManagerCookieConfig;
418
- }
419
-
420
- // @internal
421
- export const CredentialManagerConfig: InterfaceSymbol<CredentialManagerConfig>;
422
-
423
- // @public
424
- export interface CredentialManagerCookieConfig {
425
- // (undocumented)
426
- expires: number | Date;
427
- // (undocumented)
428
- name: string;
429
- // (undocumented)
430
- path: string;
431
- // (undocumented)
432
- storePasswords?: boolean;
433
- }
434
-
435
- // @public
436
- export const credentialSeparator = ":";
437
-
438
- // @public
439
- export function criteriaFiltersToFields(filters: string): Record<string, string>;
440
-
441
- // @public @deprecated
442
- export class CurrentUser extends DefaultUser implements User {
443
- }
444
-
445
- // @public
446
- export type DataserverParams = {
447
- DATASOURCE_NAME?: string;
448
- CRITERIA_MATCH?: string;
449
- MAX_ROWS?: number;
450
- VIEW_NUMBER?: number;
451
- FIELDS?: string;
452
- MAX_VIEW?: number;
453
- MOVING_VIEW?: boolean;
454
- ORDER_BY?: string;
455
- REVERSE?: boolean;
456
- };
457
-
458
- // @public
459
- export function dataServerResultFilter(result: RawDataServerResult, rowId?: string): FilteredDataServerResult;
460
-
461
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Datasource" because one of its declarations is marked as @internal
462
- //
463
- // @public
464
- export interface Datasource extends DatasourceMetadata {
465
- addView?(view: Dataview): void;
466
- clearFilter?(name: string): Promise<void>;
467
- createItem?(data: any): Promise<string>;
468
- dataHandler?(data: Array<any>): Array<any>;
469
- deleteItem?(itemId: string): Promise<void>;
470
- destroy(): void;
471
- dropView?(view: Dataview): void;
472
- getMetadata?(resourceName: string): Promise<Array<FieldMetadata>>;
473
- init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
474
- initialized: boolean;
475
- readOnly: boolean;
476
- resourceType: ResourceType;
477
- setFilter?(name: string, value: any, type?: string): Promise<void>;
478
- snapshot(overrideParams?: any): Promise<Message>;
479
- snapshotFiltered(rowId?: string): Promise<any[]>;
480
- startStream(): Promise<void>;
481
- // (undocumented)
482
- status: Partial<DatasourceStatus>;
483
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
484
- updateData?(data: Array<any>): Promise<void>;
485
- updateItem?(itemId: string, data: any): Promise<void>;
486
- // @deprecated
487
- validResourceName(resourceName: string): boolean;
488
- }
489
-
490
- // @internal
491
- export const Datasource: InterfaceSymbol<Datasource>;
492
-
493
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "DatasourceConfig" because one of its declarations is marked as @internal
494
- //
495
- // @public
496
- export interface DatasourceConfig {
497
- // (undocumented)
498
- criteriaToFields(filters: string): Record<string, string>;
499
- // (undocumented)
500
- dataServerResultFilter(result: RawDataServerResult, rowId?: string): FilteredDataServerResult;
501
- eventEmitter?: HTMLElement;
502
- // (undocumented)
503
- options: DatasourceOptions;
504
- }
505
-
506
- // @internal
507
- export const DatasourceConfig: InterfaceSymbol<DatasourceConfig>;
508
-
509
- // @public
510
- export class DatasourceDefaults {
511
- // (undocumented)
512
- static readonly DATASERVER_ROW_ID = "ROW_REF";
513
- // (undocumented)
514
- static readonly DEFAULT_PAGINATION_PAGE_SIZE = 25;
515
- // (undocumented)
516
- static readonly MAX_ROWS_250 = 250;
517
- // (undocumented)
518
- static readonly MAX_VIEW_1000 = 1000;
519
- // (undocumented)
520
- static readonly REQ_REP_POLLING_INTERVAL_MS = 10000;
521
- // (undocumented)
522
- static readonly REQUEST_SERVER_ROW_ID = "RECORD_ID";
523
- }
524
-
525
- // @public
526
- export const DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
527
- new (): {
528
- datasourceStatus: DatasourceStatus;
529
- resourceName: string;
530
- onDatasourceStatusChanged: (event: DatasourceStatusChangedEvent) => void;
531
- datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
532
- connectedCallback(): void;
533
- disconnectedCallback(): void;
534
- accessKey: string;
535
- readonly accessKeyLabel: string;
536
- autocapitalize: string;
537
- autocorrect: boolean;
538
- dir: string;
539
- draggable: boolean;
540
- hidden: boolean;
541
- inert: boolean;
542
- innerText: string;
543
- lang: string;
544
- readonly offsetHeight: number;
545
- readonly offsetLeft: number;
546
- readonly offsetParent: Element | null;
547
- readonly offsetTop: number;
548
- readonly offsetWidth: number;
549
- outerText: string;
550
- popover: string | null;
551
- spellcheck: boolean;
552
- title: string;
553
- translate: boolean;
554
- writingSuggestions: string;
555
- attachInternals(): ElementInternals;
556
- click(): void;
557
- hidePopover(): void;
558
- showPopover(): void;
559
- togglePopover(options?: boolean): boolean;
560
- addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
561
- addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
562
- removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
563
- removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
564
- readonly attributes: NamedNodeMap;
565
- get classList(): DOMTokenList;
566
- set classList(value: string);
567
- className: string;
568
- readonly clientHeight: number;
569
- readonly clientLeft: number;
570
- readonly clientTop: number;
571
- readonly clientWidth: number;
572
- readonly currentCSSZoom: number;
573
- id: string;
574
- innerHTML: string;
575
- readonly localName: string;
576
- readonly namespaceURI: string | null;
577
- onfullscreenchange: ((this: Element, ev: Event) => any) | null;
578
- onfullscreenerror: ((this: Element, ev: Event) => any) | null;
579
- outerHTML: string;
580
- readonly ownerDocument: Document;
581
- get part(): DOMTokenList;
582
- set part(value: string);
583
- readonly prefix: string | null;
584
- readonly scrollHeight: number;
585
- scrollLeft: number;
586
- scrollTop: number;
587
- readonly scrollWidth: number;
588
- readonly shadowRoot: ShadowRoot | null;
589
- slot: string;
590
- readonly tagName: string;
591
- attachShadow(init: ShadowRootInit): ShadowRoot;
592
- checkVisibility(options?: CheckVisibilityOptions): boolean;
593
- closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K] | null;
594
- closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K] | null;
595
- closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K] | null;
596
- closest<E extends Element = Element>(selectors: string): E | null;
597
- computedStyleMap(): StylePropertyMapReadOnly;
598
- getAttribute(qualifiedName: string): string | null;
599
- getAttributeNS(namespace: string | null, localName: string): string | null;
600
- getAttributeNames(): string[];
601
- getAttributeNode(qualifiedName: string): Attr | null;
602
- getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;
603
- getBoundingClientRect(): DOMRect;
604
- getClientRects(): DOMRectList;
605
- getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
606
- getElementsByTagName<K extends keyof HTMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
607
- getElementsByTagName<K extends keyof SVGElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
608
- getElementsByTagName<K extends keyof MathMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
609
- getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
610
- getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
611
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
612
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
613
- getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
614
- getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;
615
- getHTML(options?: GetHTMLOptions): string;
616
- hasAttribute(qualifiedName: string): boolean;
617
- hasAttributeNS(namespace: string | null, localName: string): boolean;
618
- hasAttributes(): boolean;
619
- hasPointerCapture(pointerId: number): boolean;
620
- insertAdjacentElement(where: InsertPosition, element: Element): Element | null;
621
- insertAdjacentHTML(position: InsertPosition, string: string): void;
622
- insertAdjacentText(where: InsertPosition, data: string): void;
623
- matches(selectors: string): boolean;
624
- releasePointerCapture(pointerId: number): void;
625
- removeAttribute(qualifiedName: string): void;
626
- removeAttributeNS(namespace: string | null, localName: string): void;
627
- removeAttributeNode(attr: Attr): Attr;
628
- requestFullscreen(options?: FullscreenOptions): Promise<void>;
629
- requestPointerLock(options?: PointerLockOptions): Promise<void>;
630
- scroll(options?: ScrollToOptions): void;
631
- scroll(x: number, y: number): void;
632
- scrollBy(options?: ScrollToOptions): void;
633
- scrollBy(x: number, y: number): void;
634
- scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
635
- scrollTo(options?: ScrollToOptions): void;
636
- scrollTo(x: number, y: number): void;
637
- setAttribute(qualifiedName: string, value: string): void;
638
- setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
639
- setAttributeNode(attr: Attr): Attr | null;
640
- setAttributeNodeNS(attr: Attr): Attr | null;
641
- setHTMLUnsafe(html: string): void;
642
- setPointerCapture(pointerId: number): void;
643
- toggleAttribute(qualifiedName: string, force?: boolean): boolean;
644
- webkitMatchesSelector(selectors: string): boolean;
645
- textContent: string;
646
- readonly baseURI: string;
647
- readonly childNodes: NodeListOf<ChildNode>;
648
- readonly firstChild: ChildNode | null;
649
- readonly isConnected: boolean;
650
- readonly lastChild: ChildNode | null;
651
- readonly nextSibling: ChildNode | null;
652
- readonly nodeName: string;
653
- readonly nodeType: number;
654
- nodeValue: string | null;
655
- readonly parentElement: HTMLElement | null;
656
- readonly parentNode: ParentNode | null;
657
- readonly previousSibling: ChildNode | null;
658
- appendChild<T extends Node>(node: T): T;
659
- cloneNode(subtree?: boolean): Node;
660
- compareDocumentPosition(other: Node): number;
661
- contains(other: Node | null): boolean;
662
- getRootNode(options?: GetRootNodeOptions): Node;
663
- hasChildNodes(): boolean;
664
- insertBefore<T extends Node>(node: T, child: Node | null): T;
665
- isDefaultNamespace(namespace: string | null): boolean;
666
- isEqualNode(otherNode: Node | null): boolean;
667
- isSameNode(otherNode: Node | null): boolean;
668
- lookupNamespaceURI(prefix: string | null): string | null;
669
- lookupPrefix(namespace: string | null): string | null;
670
- normalize(): void;
671
- removeChild<T extends Node>(child: T): T;
672
- replaceChild<T extends Node>(node: Node, child: T): T;
673
- readonly ELEMENT_NODE: 1;
674
- readonly ATTRIBUTE_NODE: 2;
675
- readonly TEXT_NODE: 3;
676
- readonly CDATA_SECTION_NODE: 4;
677
- readonly ENTITY_REFERENCE_NODE: 5;
678
- readonly ENTITY_NODE: 6;
679
- readonly PROCESSING_INSTRUCTION_NODE: 7;
680
- readonly COMMENT_NODE: 8;
681
- readonly DOCUMENT_NODE: 9;
682
- readonly DOCUMENT_TYPE_NODE: 10;
683
- readonly DOCUMENT_FRAGMENT_NODE: 11;
684
- readonly NOTATION_NODE: 12;
685
- readonly DOCUMENT_POSITION_DISCONNECTED: 1;
686
- readonly DOCUMENT_POSITION_PRECEDING: 2;
687
- readonly DOCUMENT_POSITION_FOLLOWING: 4;
688
- readonly DOCUMENT_POSITION_CONTAINS: 8;
689
- readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
690
- readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
691
- dispatchEvent(event: Event): boolean;
692
- ariaActiveDescendantElement: Element | null;
693
- ariaAtomic: string | null;
694
- ariaAutoComplete: string | null;
695
- ariaBrailleLabel: string | null;
696
- ariaBrailleRoleDescription: string | null;
697
- ariaBusy: string | null;
698
- ariaChecked: string | null;
699
- ariaColCount: string | null;
700
- ariaColIndex: string | null;
701
- ariaColIndexText: string | null;
702
- ariaColSpan: string | null;
703
- ariaControlsElements: ReadonlyArray<Element> | null;
704
- ariaCurrent: string | null;
705
- ariaDescribedByElements: ReadonlyArray<Element> | null;
706
- ariaDescription: string | null;
707
- ariaDetailsElements: ReadonlyArray<Element> | null;
708
- ariaDisabled: string | null;
709
- ariaErrorMessageElements: ReadonlyArray<Element> | null;
710
- ariaExpanded: string | null;
711
- ariaFlowToElements: ReadonlyArray<Element> | null;
712
- ariaHasPopup: string | null;
713
- ariaHidden: string | null;
714
- ariaInvalid: string | null;
715
- ariaKeyShortcuts: string | null;
716
- ariaLabel: string | null;
717
- ariaLabelledByElements: ReadonlyArray<Element> | null;
718
- ariaLevel: string | null;
719
- ariaLive: string | null;
720
- ariaModal: string | null;
721
- ariaMultiLine: string | null;
722
- ariaMultiSelectable: string | null;
723
- ariaOrientation: string | null;
724
- ariaOwnsElements: ReadonlyArray<Element> | null;
725
- ariaPlaceholder: string | null;
726
- ariaPosInSet: string | null;
727
- ariaPressed: string | null;
728
- ariaReadOnly: string | null;
729
- ariaRelevant: string | null;
730
- ariaRequired: string | null;
731
- ariaRoleDescription: string | null;
732
- ariaRowCount: string | null;
733
- ariaRowIndex: string | null;
734
- ariaRowIndexText: string | null;
735
- ariaRowSpan: string | null;
736
- ariaSelected: string | null;
737
- ariaSetSize: string | null;
738
- ariaSort: string | null;
739
- ariaValueMax: string | null;
740
- ariaValueMin: string | null;
741
- ariaValueNow: string | null;
742
- ariaValueText: string | null;
743
- role: string | null;
744
- animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;
745
- getAnimations(options?: GetAnimationsOptions): Animation[];
746
- after(...nodes: (Node | string)[]): void;
747
- before(...nodes: (Node | string)[]): void;
748
- remove(): void;
749
- replaceWith(...nodes: (Node | string)[]): void;
750
- readonly nextElementSibling: Element | null;
751
- readonly previousElementSibling: Element | null;
752
- readonly childElementCount: number;
753
- readonly children: HTMLCollection;
754
- readonly firstElementChild: Element | null;
755
- readonly lastElementChild: Element | null;
756
- append(...nodes: (Node | string)[]): void;
757
- prepend(...nodes: (Node | string)[]): void;
758
- querySelector<K extends keyof HTMLElementTagNameMap>(selectors: K): HTMLElementTagNameMap[K] | null;
759
- querySelector<K extends keyof SVGElementTagNameMap>(selectors: K): SVGElementTagNameMap[K] | null;
760
- querySelector<K extends keyof MathMLElementTagNameMap>(selectors: K): MathMLElementTagNameMap[K] | null;
761
- querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;
762
- querySelector<E extends Element = Element>(selectors: string): E | null;
763
- querySelectorAll<K extends keyof HTMLElementTagNameMap>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;
764
- querySelectorAll<K extends keyof SVGElementTagNameMap>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;
765
- querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
766
- querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
767
- querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
768
- replaceChildren(...nodes: (Node | string)[]): void;
769
- readonly assignedSlot: HTMLSlotElement | null;
770
- readonly attributeStyleMap: StylePropertyMap;
771
- get style(): CSSStyleDeclaration;
772
- set style(cssText: string);
773
- contentEditable: string;
774
- enterKeyHint: string;
775
- inputMode: string;
776
- readonly isContentEditable: boolean;
777
- onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
778
- onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
779
- onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
780
- onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
781
- onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
782
- onauxclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
783
- onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;
784
- onbeforematch: ((this: GlobalEventHandlers, ev: Event) => any) | null;
785
- onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
786
- onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
787
- oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null;
788
- oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
789
- oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;
790
- onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
791
- onclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
792
- onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;
793
- oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null;
794
- oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
795
- oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null;
796
- oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
797
- oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
798
- oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
799
- ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
800
- ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
801
- ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
802
- ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
803
- ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
804
- ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
805
- ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
806
- ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
807
- ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
808
- onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;
809
- onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;
810
- onerror: OnErrorEventHandler;
811
- onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
812
- onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null;
813
- ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
814
- oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null;
815
- oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;
816
- onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
817
- onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
818
- onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
819
- onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;
820
- onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
821
- onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
822
- onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
823
- onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
824
- onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
825
- onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
826
- onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
827
- onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
828
- onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
829
- onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
830
- onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
831
- onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
832
- onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;
833
- onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
834
- onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;
835
- onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
836
- onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
837
- onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
838
- onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
839
- onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
840
- onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
841
- onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
842
- onpointerrawupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
843
- onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
844
- onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null;
845
- onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
846
- onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;
847
- onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
848
- onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;
849
- onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
850
- onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null;
851
- onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;
852
- onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;
853
- onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;
854
- onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
855
- onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
856
- onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
857
- onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;
858
- onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;
859
- onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
860
- ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
861
- ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;
862
- ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
863
- ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
864
- ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
865
- ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
866
- ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
867
- ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
868
- ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
869
- ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
870
- onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
871
- onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;
872
- onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
873
- onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;
874
- onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
875
- onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
876
- onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;
877
- autofocus: boolean;
878
- readonly dataset: DOMStringMap;
879
- nonce?: string;
880
- tabIndex: number;
881
- blur(): void;
882
- focus(options?: FocusOptions): void;
883
- readonly $fastController: Controller;
884
- $emit(type: string, detail?: any, options?: Omit<CustomEventInit, "detail">): boolean | void;
885
- attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
886
- };
887
- };
888
-
889
- // @public
890
- export interface DatasourceMetadata {
891
- // (undocumented)
892
- readonly availableIndexes: IndexDetail[];
893
- // (undocumented)
894
- readonly customRequestFields: MetadataDetail[];
895
- // (undocumented)
896
- fetchMetadataRequired: boolean;
897
- // (undocumented)
898
- readonly fieldMetadata: FieldMetadata[];
899
- // (undocumented)
900
- readonly originalFieldDef: MetadataDetail[];
901
- // (undocumented)
902
- readonly requestFields: MetadataDetail[];
903
- // (undocumented)
904
- startStreamRequired: boolean;
905
- }
906
-
907
- // Warning: (ae-internal-missing-underscore) The name "DatasourceMock" should be prefixed with an underscore because the declaration is marked as @internal
908
- //
909
- // @internal (undocumented)
910
- export class DatasourceMock implements Datasource {
911
- // (undocumented)
912
- addView?(view: Dataview): void;
913
- // (undocumented)
914
- availableIndexes: IndexDetail[];
915
- // (undocumented)
916
- clearFilter?(name: string): Promise<void>;
917
- // (undocumented)
918
- createItem?(data: any): Promise<string>;
919
- // (undocumented)
920
- customRequestFields: MetadataDetail[];
921
- // (undocumented)
922
- dataHandler?(data: any[]): any[];
923
- // (undocumented)
924
- deinit(): void;
925
- // (undocumented)
926
- deleteItem?(itemId: string): Promise<void>;
927
- // (undocumented)
928
- destroy(): void;
929
- // (undocumented)
930
- dropView?(view: Dataview): void;
931
- // (undocumented)
932
- protected fetchingMetadata: boolean;
933
- // (undocumented)
934
- fetchMetadataRequired: boolean;
935
- // (undocumented)
936
- fieldMetadata: FieldMetadata[];
937
- // (undocumented)
938
- getMetadata?(resourceName: string): Promise<FieldMetadata[]>;
939
- // (undocumented)
940
- init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
941
- // (undocumented)
942
- initialized: boolean;
943
- // (undocumented)
944
- originalFieldDef: MetadataDetail[];
945
- // (undocumented)
946
- readOnly: boolean;
947
- // (undocumented)
948
- requestFields: MetadataDetail[];
949
- // (undocumented)
950
- resourceType: ResourceType;
951
- // (undocumented)
952
- setFilter?(name: string, value: any, type?: string): Promise<void>;
953
- setMetadata(meta: Metadata): void;
954
- setStream(message: Message): void;
955
- // (undocumented)
956
- snapshot(params?: any): Promise<Message<any>>;
957
- // (undocumented)
958
- snapshotFiltered(rowId?: string): Promise<any[]>;
959
- // (undocumented)
960
- startStream(): Promise<void>;
961
- // (undocumented)
962
- startStreamRequired: boolean;
963
- // (undocumented)
964
- status: DatasourceStatus;
965
- // (undocumented)
966
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
967
- // (undocumented)
968
- unsetMedata(): void;
969
- // (undocumented)
970
- unsetStream(): void;
971
- // (undocumented)
972
- updateData?(data: any[]): Promise<void>;
973
- // (undocumented)
974
- updateItem?(itemId: string, data: any): Promise<void>;
975
- // (undocumented)
976
- validResourceName(resourceName: string): boolean;
977
- }
978
-
979
- // @public
980
- export interface DatasourceOptions {
981
- criteria?: string;
982
- disablePolling?: boolean;
983
- fields?: string;
984
- isSnapshot?: boolean;
985
- maxRows?: number;
986
- maxView?: number;
987
- movingView?: boolean;
988
- orderBy?: string;
989
- pollingInterval?: number;
990
- pollTriggerEvents?: string[];
991
- request?: any;
992
- requestAutoSetup?: boolean;
993
- resourceName?: string;
994
- reverse?: boolean;
995
- viewNumber?: number;
996
- }
997
-
998
- // @public
999
- export type DatasourceStatus = {
1000
- name: string;
1001
- type: `${ResourceType}`;
1002
- isInitialized: boolean;
1003
- metadataRequired: boolean;
1004
- hasMetadata: boolean;
1005
- };
1006
-
1007
- // @public
1008
- export const DatasourceStatusChanged = "datasource-status-changed";
1009
-
1010
- // @public
1011
- export type DatasourceStatusChangedEvent = CustomEvent<DatasourceStatus>;
1012
-
1013
- // @public
1014
- export interface DataUpdate {
1015
- // (undocumented)
1016
- add?: Array<any>;
1017
- // (undocumented)
1018
- drop?: Array<any>;
1019
- // (undocumented)
1020
- modify?: Array<any>;
1021
- }
1022
-
1023
- // @public
1024
- export interface Dataview {
1025
- columnsMetadata?: FieldMetadata[];
1026
- data: any[];
1027
- hideSearch?: boolean;
1028
- update?: (data: DataUpdate) => Promise<void>;
1029
- }
1030
-
1031
- // @public
1032
- export class DefaultAuth implements Auth {
1033
- constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2);
1034
- // (undocumented)
1035
- currentUser: User_2;
1036
- // (undocumented)
1037
- get isLoggedIn$(): Observable<boolean>;
1038
- // (undocumented)
1039
- get isLoggedIn(): boolean;
1040
- // (undocumented)
1041
- isWorking: boolean;
1042
- // (undocumented)
1043
- loggedUserResult: LoginResult;
1044
- // (undocumented)
1045
- login(credentials: AuthInfo): Promise<LoginResult>;
1046
- // (undocumented)
1047
- logout(): Promise<LogoutResult>;
1048
- // (undocumented)
1049
- reAuthFromSession(): Promise<boolean>;
1050
- }
1051
-
1052
- // @public
1053
- export class DefaultConnect implements Connect {
1054
- constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
1055
- // (undocumented)
1056
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
1057
- // (undocumented)
1058
- connect(host?: string): Promise<boolean>;
1059
- // (undocumented)
1060
- dataLogoff(streamSourceRef: string): Promise<Message>;
1061
- // (undocumented)
1062
- disconnect(): void;
1063
- // (undocumented)
1064
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
1065
- // (undocumented)
1066
- getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
1067
- // (undocumented)
1068
- getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
1069
- // (undocumented)
1070
- getMoreColumns(sourceRef: string): Promise<Message>;
1071
- // (undocumented)
1072
- getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
1073
- // (undocumented)
1074
- get host(): string;
1075
- // (undocumented)
1076
- httpMode(): boolean;
1077
- // (undocumented)
1078
- get isConnected$(): Observable<boolean>;
1079
- // (undocumented)
1080
- get isConnected(): boolean;
1081
- // (undocumented)
1082
- get isConnectedSubject(): BehaviorSubject<boolean>;
1083
- // (undocumented)
1084
- isWorking: boolean;
1085
- // (undocumented)
1086
- request(resourceName: string, params?: RequestParams): Promise<Message>;
1087
- // (undocumented)
1088
- send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1089
- // @deprecated (undocumented)
1090
- setValidSession(valid: boolean): void;
1091
- // (undocumented)
1092
- snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
1093
- // (undocumented)
1094
- socket: Socket;
1095
- // (undocumented)
1096
- stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1097
- // (undocumented)
1098
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
1099
- // (undocumented)
1100
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1101
- }
1102
-
1103
- // @public
1104
- export const defaultConnectConfig: ConnectConfig;
1105
-
1106
- // @public
1107
- export class DefaultConnectEvents implements ConnectEventsEmitter {
1108
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
1109
- //
1110
- // (undocumented)
1111
- addCommitListener(listener: Listener<CommitEvent>): () => void;
1112
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
1113
- //
1114
- // (undocumented)
1115
- addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
1116
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
1117
- //
1118
- // (undocumented)
1119
- addMetadataListener(listener: Listener<MetadataEvent>): () => void;
1120
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
1121
- //
1122
- // (undocumented)
1123
- addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
1124
- // @internal (undocumented)
1125
- protected commitListeners: Observer<CommitEvent>;
1126
- // @internal (undocumented)
1127
- protected commitResponseListeners: Observer<CommitResponseEvent>;
1128
- // @internal (undocumented)
1129
- protected metadataListeners: Observer<MetadataEvent>;
1130
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1131
- //
1132
- // (undocumented)
1133
- onCommitEvent(eventName: string, message: Message): void;
1134
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1135
- //
1136
- // (undocumented)
1137
- onCommitResponseEvent(eventName: string, response: Message): void;
1138
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1139
- //
1140
- // (undocumented)
1141
- onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
1142
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1143
- //
1144
- // (undocumented)
1145
- onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
1146
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1147
- //
1148
- // (undocumented)
1149
- onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
1150
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
1151
- //
1152
- // (undocumented)
1153
- onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
1154
- // @internal (undocumented)
1155
- protected streamCompleteListeners: Observer<StreamCompleteEvent>;
1156
- // @internal (undocumented)
1157
- protected streamErrorListeners: Observer<StreamErrorEvent>;
1158
- // @internal (undocumented)
1159
- protected streamListeners: Observer<StreamEvent>;
1160
- }
1161
-
1162
- // @public
1163
- export class DefaultCredentialManager implements CredentialManager {
1164
- constructor(session: Session, config?: CredentialManagerConfig);
1165
- // (undocumented)
1166
- createBasicCredentials(inputs: BasicCredentialsInput): BasicAuthInfo;
1167
- // (undocumented)
1168
- createRefreshCredentials(inputs?: RefreshCredentialsInput): RefreshAuthInfo;
1169
- // (undocumented)
1170
- createSSOCredentials(inputs?: SSOCredentialsInput): SsoAuthInfo;
1171
- // (undocumented)
1172
- getCredentials(options?: GetCredentialOptions): Promise<CredentialData_2 | undefined>;
1173
- // (undocumented)
1174
- getCredentialsFromContainer(options?: CredentialRequestOptions): Promise<CredentialData_2 | null>;
1175
- // (undocumented)
1176
- getCredentialsFromCookie(): CredentialData_2 | undefined;
1177
- // (undocumented)
1178
- getMFAToken(): string;
1179
- // (undocumented)
1180
- getRefreshToken(): string;
1181
- // (undocumented)
1182
- getSSOToken(): string;
1183
- // (undocumented)
1184
- getUsername(): string;
1185
- // (undocumented)
1186
- normaliseLegacyCredentialData(data?: CredentialData_2, cookie?: CredentialData_2): [CredentialData_2 | undefined, boolean];
1187
- // (undocumented)
1188
- preventSilentAccess(): Promise<void>;
1189
- // (undocumented)
1190
- removeAll(): void;
1191
- // (undocumented)
1192
- removeCookie(): void;
1193
- // (undocumented)
1194
- removeMFAToken(): void;
1195
- // (undocumented)
1196
- removeRefreshToken(): void;
1197
- // (undocumented)
1198
- removeSSOToken(): void;
1199
- // (undocumented)
1200
- removeUsername(): void;
1201
- // (undocumented)
1202
- storeCredentials(data: CredentialData_2): Promise<boolean>;
1203
- // (undocumented)
1204
- storeCredentialsInContainer(data: CredentialData_2): Promise<Credential | undefined>;
1205
- // (undocumented)
1206
- storeCredentialsInCookie(data: CredentialData_2): boolean;
1207
- // (undocumented)
1208
- validateBasicCredentials(credentials: BasicAuthInfo): boolean;
1209
- // (undocumented)
1210
- validateRefreshCredentials(credentials: RefreshAuthInfo): boolean;
1211
- // (undocumented)
1212
- validateSSOCredentials(credentials: SsoAuthInfo): boolean;
1213
- // (undocumented)
1214
- validateUserCredentialData(data: CredentialData_2, ensurePassword?: boolean): boolean;
1215
- }
1216
-
1217
- // @public
1218
- export const defaultCredentialManagerConfig: CredentialManagerConfig;
1219
-
1220
- // @public
1221
- export const defaultCredentialRequestOptions: GetCredentialOptions;
1222
-
1223
- // @public
1224
- export class DefaultDatasource implements Datasource {
1225
- constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig, connectEvents: ConnectEvents);
1226
- // @internal (undocumented)
1227
- get allResourceParams(): DataserverParams & RequestParams;
1228
- // (undocumented)
1229
- protected auth: Auth;
1230
- // (undocumented)
1231
- availableIndexes: IndexDetail[];
1232
- // (undocumented)
1233
- protected config: DatasourceConfig;
1234
- // (undocumented)
1235
- protected connect: Connect;
1236
- // (undocumented)
1237
- protected connectEvents: ConnectEvents;
1238
- // (undocumented)
1239
- customRequestFields: MetadataDetail[];
1240
- // @internal (undocumented)
1241
- get dataserverOnlyParams(): DataserverParams;
1242
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1243
- //
1244
- // (undocumented)
1245
- destroy(): void;
1246
- // (undocumented)
1247
- protected fetchAndApplyMetadata(resourceName: string): Promise<void>;
1248
- // (undocumented)
1249
- fetchMetadataRequired: boolean;
1250
- // (undocumented)
1251
- fieldMetadata: FieldMetadata[];
1252
- // (undocumented)
1253
- init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
1254
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1255
- //
1256
- // (undocumented)
1257
- get initialized(): boolean;
1258
- // @internal (undocumented)
1259
- protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
1260
- // (undocumented)
1261
- protected options: DatasourceOptions;
1262
- // (undocumented)
1263
- originalFieldDef: MetadataDetail[];
1264
- // (undocumented)
1265
- readOnly: boolean;
1266
- // @internal (undocumented)
1267
- protected reportStatus(detail?: Partial<DatasourceStatus>): void;
1268
- // (undocumented)
1269
- requestFields: MetadataDetail[];
1270
- // @internal (undocumented)
1271
- get requestOnlyParams(): RequestParams;
1272
- // (undocumented)
1273
- protected resources: GenesisResources;
1274
- // (undocumented)
1275
- resourceType: ResourceType;
1276
- // (undocumented)
1277
- snapshot(overrideParams?: any): Promise<Message>;
1278
- // (undocumented)
1279
- snapshotFiltered(rowId?: string): Promise<any[]>;
1280
- // (undocumented)
1281
- startStream(): Promise<void>;
1282
- // (undocumented)
1283
- startStreamRequired: boolean;
1284
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1285
- //
1286
- // (undocumented)
1287
- status: DatasourceStatus;
1288
- // (undocumented)
1289
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
1290
- // @deprecated (undocumented)
1291
- validResourceName(resourceName: string): boolean;
1292
- }
1293
-
1294
- // @public
1295
- export const defaultDatasourceConfig: DatasourceConfig;
1296
-
1297
- // @alpha
1298
- export class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource implements EntityDatasource<TDTO, TEntity> {
1299
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1300
- //
1301
- // (undocumented)
1302
- get cache(): TEntity[];
1303
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1304
- //
1305
- // (undocumented)
1306
- disconnect: () => void;
1307
- // (undocumented)
1308
- protected entityCache: TEntity[];
1309
- // (undocumented)
1310
- protected entityMap: Map<string, TEntity>;
1311
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1312
- //
1313
- // (undocumented)
1314
- initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
1315
- // (undocumented)
1316
- get initialized(): boolean;
1317
- set initialized(value: boolean);
1318
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1319
- //
1320
- // (undocumented)
1321
- protected _initialized: boolean;
1322
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "EntityDatasource" has more than one declaration; you need to add a TSDoc member reference selector
1323
- //
1324
- // (undocumented)
1325
- get isEmpty(): boolean;
1326
- // (undocumented)
1327
- protected mapper: DTOMapper<TDTO, TEntity>;
1328
- // (undocumented)
1329
- protected processRowDataUpdate(rowData: RowData[], inserting?: boolean): void;
1330
- // (undocumented)
1331
- protected rowId: string;
1332
- // (undocumented)
1333
- protected sourceRef: string;
1334
- // (undocumented)
1335
- protected subscription: SocketSubscription;
1336
- // (undocumented)
1337
- protected subscriptionLoggedOff: boolean;
1338
- // (undocumented)
1339
- protected updateCache(result: FilteredDataServerResult): void;
1340
- }
1341
-
1342
- // @public
1343
- export class DefaultFoundationAnalytics implements FoundationAnalytics {
1344
- constructor(config: {
1345
- app: 'foundation-app';
1346
- debug: true;
1347
- });
1348
- trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: FoundationAnalyticsEvent.ControlClicked): void;
1349
- // (undocumented)
1350
- trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
1351
- }
1352
-
1353
- // @public
1354
- export class DefaultGenesisResources implements GenesisResources {
1355
- constructor(connect: Connect, config: GenesisResourcesConfig);
1356
- // (undocumented)
1357
- protected config: GenesisResourcesConfig;
1358
- // (undocumented)
1359
- protected connect: Connect;
1360
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1361
- //
1362
- // (undocumented)
1363
- destroy(): void;
1364
- // (undocumented)
1365
- protected fetchResources(): Promise<void>;
1366
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1367
- //
1368
- // (undocumented)
1369
- getAllResources(): Promise<ResourceItem[]>;
1370
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1371
- //
1372
- // (undocumented)
1373
- getResourceTypeFor(resourceName: string): Promise<ResourceType>;
1374
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1375
- //
1376
- // (undocumented)
1377
- isValidResource(resourceName: string): Promise<boolean>;
1378
- // (undocumented)
1379
- protected postLoadedMessage(): void;
1380
- // (undocumented)
1381
- protected resources: ResourceItem[];
1382
- // (undocumented)
1383
- protected resourcesPromise: Promise<ResourcesMessage>;
1384
- }
1385
-
1386
- // @public
1387
- export const defaultGenesisResourcesConfig: GenesisResourcesConfig;
1388
-
1389
- // @public
1390
- export class DefaultHttp implements Http {
1391
- constructor(serializer: JSONSerializer);
1392
- // (undocumented)
1393
- get<T>(url: string, requestInit: HttpRequestInit): Promise<T>;
1394
- // (undocumented)
1395
- post<T>(url: string, requestInit: HttpRequestInit): Promise<T>;
1396
- }
1397
-
1398
- // @public
1399
- export class DefaultHttpConnect implements Connect {
1400
- // Warning: (ae-forgotten-export) The symbol "HttpConnectConfig" needs to be exported by the entry point index.d.ts
1401
- constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config: HttpConnectConfig);
1402
- // (undocumented)
1403
- commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
1404
- // (undocumented)
1405
- connect(host: string): Promise<boolean>;
1406
- // (undocumented)
1407
- dataLogoff(streamSourceRef: string): Promise<Message>;
1408
- // (undocumented)
1409
- disconnect(): void;
1410
- // (undocumented)
1411
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
1412
- // (undocumented)
1413
- getJSONSchema(resourceName: string): Promise<SchemaResponse>;
1414
- // (undocumented)
1415
- getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
1416
- // (undocumented)
1417
- getMoreColumns(sourceRef: string): Promise<Message>;
1418
- // (undocumented)
1419
- getMoreRows(sourceRef: string): Promise<Message>;
1420
- // (undocumented)
1421
- host: string;
1422
- // (undocumented)
1423
- http: Http;
1424
- // (undocumented)
1425
- httpMode(): boolean;
1426
- // (undocumented)
1427
- isConnected$: Observable<boolean>;
1428
- // (undocumented)
1429
- get isConnected(): boolean;
1430
- set isConnected(value: boolean);
1431
- // (undocumented)
1432
- isConnectedSubject: BehaviorSubject<boolean>;
1433
- // (undocumented)
1434
- isWorking: boolean;
1435
- // (undocumented)
1436
- request(resourceName: string, params?: RequestParams): Promise<Message>;
1437
- // (undocumented)
1438
- send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1439
- // @deprecated (undocumented)
1440
- setValidSession(valid: boolean): void;
1441
- // (undocumented)
1442
- snapshot(resourceName: string, params?: any): Promise<Message>;
1443
- // (undocumented)
1444
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
1445
- // (undocumented)
1446
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
1447
- // (undocumented)
1448
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message<any>>;
1449
- }
1450
-
1451
- // @alpha
1452
- export class DefaultKVStorage implements KVStorage {
1453
- constructor(connect: Connect, user: User_2, kvStorageConfig?: KVStorageConfig);
1454
- delete(keys: string[]): Promise<true | KVEventFailureResponse>;
1455
- get<T = KVValue>(): Promise<KeyValueTransfer<T>[]>;
1456
- // (undocumented)
1457
- get<T = KVValue>(key: string): Promise<KeyValueTransfer<T>>;
1458
- list(): Promise<string[]>;
1459
- put(kvs: KeyValue<KVValue>[]): Promise<true | KVEventFailureResponse>;
1460
- // (undocumented)
1461
- protected user: User_2;
1462
- }
1463
-
1464
- // @alpha
1465
- export const defaultKVStorageConfig: KVStorageConfig;
1466
-
1467
- // @public
1468
- export class DefaultMessageBuilder implements MessageBuilder {
1469
- constructor(session: Session, uuid: UUID);
1470
- // (undocumented)
1471
- createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
1472
- // (undocumented)
1473
- createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
1474
- // (undocumented)
1475
- createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
1476
- // (undocumented)
1477
- createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
1478
- // (undocumented)
1479
- createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
1480
- // (undocumented)
1481
- createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
1482
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "MessageBuilder" has more than one declaration; you need to add a TSDoc member reference selector
1483
- //
1484
- // (undocumented)
1485
- createHeartbeatPingMessage(verbose?: boolean): PingMessage;
1486
- // (undocumented)
1487
- createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
1488
- // (undocumented)
1489
- createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
1490
- // (undocumented)
1491
- createLogoutMessage(loginResult?: LoginResult): Message;
1492
- // (undocumented)
1493
- createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
1494
- // (undocumented)
1495
- createMoreColumnsMessage(sourceRef: string): Message;
1496
- // (undocumented)
1497
- createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
1498
- // (undocumented)
1499
- createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
1500
- // (undocumented)
1501
- createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
1502
- // (undocumented)
1503
- createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
1504
- }
1505
-
1506
- // @public
1507
- export class DefaultMetaCache implements MetaCache {
1508
- // (undocumented)
1509
- cachedJsonSchema: Map<string, SchemaResponse>;
1510
- // (undocumented)
1511
- cachedMetadata: Map<string, Metadata>;
1512
- // (undocumented)
1513
- getJsonSchemaFor(resourceName: string): SchemaResponse;
1514
- // (undocumented)
1515
- getMetadataFor(resourceName: string): Metadata;
1516
- // (undocumented)
1517
- hasJsonSchemaFor(resourceName: string): boolean;
1518
- // (undocumented)
1519
- hasMetadataFor(resourceName: string): boolean;
1520
- // (undocumented)
1521
- setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): void;
1522
- // (undocumented)
1523
- setMetadataFor(resourceName: string, metadata: Metadata): void;
1524
- }
1525
-
1526
- // @public
1527
- export class DefaultNetworkMonitor implements NetworkMonitor {
1528
- constructor();
1529
- // @internal (undocumented)
1530
- protected addListeners(): void;
1531
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
1532
- //
1533
- // (undocumented)
1534
- addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
1535
- // @internal
1536
- protected config: NetworkMonitorConfig;
1537
- // @internal (undocumented)
1538
- protected connectEvents: ConnectEvents;
1539
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
1540
- //
1541
- // (undocumented)
1542
- create(): void;
1543
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
1544
- //
1545
- // (undocumented)
1546
- destroy(): void;
1547
- // @internal (undocumented)
1548
- protected getFormattedTimestamp(milliseconds: number): string;
1549
- // @internal (undocumented)
1550
- protected getNextTimestamp(): number;
1551
- // @internal (undocumented)
1552
- protected getNowTimestamp(): number;
1553
- // @internal (undocumented)
1554
- protected internalId: ReturnType<typeof setInterval>;
1555
- // @internal (undocumented)
1556
- protected isOnlineCheck(): Promise<boolean>;
1557
- // @internal (undocumented)
1558
- protected isReady: boolean;
1559
- // @internal (undocumented)
1560
- protected isRunningChecks: boolean;
1561
- // @internal (undocumented)
1562
- protected normaliseEventDetail(detail: Partial<SystemHealthStatus>): SystemHealthStatus;
1563
- // @internal (undocumented)
1564
- protected normaliseResourceHealth(health: ResourceHealth, isOnline?: boolean): ResourceHealth;
1565
- // @internal (undocumented)
1566
- protected normaliseSerializedSocketStatus(socketStatus: SerializedSocketStatus, isOnline?: boolean): SerializedSocketStatus;
1567
- // @internal (undocumented)
1568
- protected preFlightSocketChecks(status: SerializedSocketStatus): boolean;
1569
- // @internal (undocumented)
1570
- protected removeListeners(): void;
1571
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
1572
- //
1573
- // (undocumented)
1574
- removeResource(resource: MonitoredResource): void;
1575
- // @internal (undocumented)
1576
- protected reportStabilityToGenesis(detail: Partial<SystemHealthStatus>): Promise<boolean>;
1577
- // @internal (undocumented)
1578
- protected reportSystemHealth(detail: Partial<SystemHealthStatus>): void;
1579
- // @internal (undocumented)
1580
- protected resources: Map<MonitoredResource, MonitoredResourceMetadata>;
1581
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
1582
- //
1583
- // (undocumented)
1584
- runAllChecks: (source?: unknown, force?: boolean) => Promise<void>;
1585
- // @internal (undocumented)
1586
- protected socketStatus: SocketStatus;
1587
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NetworkMonitor" has more than one declaration; you need to add a TSDoc member reference selector
1588
- //
1589
- // (undocumented)
1590
- status: SystemHealthStatus;
1591
- // @internal (undocumented)
1592
- protected synchroniseCheckInterval(): void;
1593
- // @internal (undocumented)
1594
- protected unsubscribableObservers: any[];
1595
- // @internal (undocumented)
1596
- protected user: User_2;
1597
- }
1598
-
1599
- // @public
1600
- export const defaultNetworkMonitorConfig: NetworkMonitorConfig;
1601
-
1602
- // @public
1603
- export class DefaultSession implements Session {
1604
- // (undocumented)
1605
- captureReturnUrl(): void;
1606
- // (undocumented)
1607
- deleteUserFromSessionStorage(): void;
1608
- // (undocumented)
1609
- getItem(key: string | UserInfoKeys, storage: StorageType): string;
1610
- // (undocumented)
1611
- getLocalStorageItem(key: string | UserInfoKeys): string;
1612
- // (undocumented)
1613
- getSessionStorageItem(key: string | UserInfoKeys): string;
1614
- // (undocumented)
1615
- removeItem(key: string | UserInfoKeys, storage: StorageType): void;
1616
- // (undocumented)
1617
- removeLocalStorageItem(key: string | UserInfoKeys): void;
1618
- // (undocumented)
1619
- removeSessionStorageItem(key: string | UserInfoKeys): void;
1620
- // (undocumented)
1621
- returnUrl: string;
1622
- // (undocumented)
1623
- setAuthResult(result: Message): void;
1624
- // Warning: (ae-forgotten-export) The symbol "UserInfoKeys" needs to be exported by the entry point index.d.ts
1625
- //
1626
- // (undocumented)
1627
- setItem(key: string | UserInfoKeys, value: string, storage: StorageType): void;
1628
- // (undocumented)
1629
- setLocalStorageItem(key: string | UserInfoKeys, value: string): void;
1630
- // (undocumented)
1631
- setSessionStorageItem(key: string | UserInfoKeys, value: string): void;
1632
- // (undocumented)
1633
- setStorageKeyPrefix(prefix: string): void;
1634
- }
1635
-
1636
- // @public
1637
- export class DefaultSocket implements Socket {
1638
- constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus,
1639
- user: User_2, config: ConnectConfig);
1640
- // (undocumented)
1641
- protected config: ConnectConfig;
1642
- // (undocumented)
1643
- connect(host?: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
1644
- // @deprecated (undocumented)
1645
- get hasValidSession(): boolean;
1646
- set hasValidSession(value: boolean);
1647
- // (undocumented)
1648
- get host(): string;
1649
- // (undocumented)
1650
- http: Http;
1651
- // (undocumented)
1652
- get isConfigured(): boolean;
1653
- // (undocumented)
1654
- get isConnected(): boolean;
1655
- // (undocumented)
1656
- get isConnectedSubject(): BehaviorSubject<boolean>;
1657
- // (undocumented)
1658
- get isConnecting(): boolean;
1659
- // (undocumented)
1660
- get isDisconnected(): boolean;
1661
- // (undocumented)
1662
- get isDisconnectedByServer(): boolean;
1663
- // (undocumented)
1664
- get isReconnecting(): boolean;
1665
- // (undocumented)
1666
- reset(): void;
1667
- // (undocumented)
1668
- send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
1669
- // (undocumented)
1670
- sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
1671
- // (undocumented)
1672
- sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
1673
- // (undocumented)
1674
- socketMessages: () => SocketSubject<Message>;
1675
- protected user: User_2;
1676
- }
1677
-
1678
- // @public
1679
- export class DefaultSocketStatus implements SocketStatus {
1680
- // (undocumented)
1681
- closedClean: any;
1682
- // (undocumented)
1683
- closedCode: any;
1684
- // (undocumented)
1685
- closedReason: any;
1686
- // (undocumented)
1687
- get hasValidSession(): boolean;
1688
- // (undocumented)
1689
- isConfigured: boolean;
1690
- // (undocumented)
1691
- isConnected: boolean;
1692
- // (undocumented)
1693
- protected isConnectedChanged(): void;
1694
- // (undocumented)
1695
- isConnectedSubject: BehaviorSubject<boolean>;
1696
- // (undocumented)
1697
- isConnecting: boolean;
1698
- // (undocumented)
1699
- get isDisconnected(): boolean;
1700
- // (undocumented)
1701
- get isDisconnectedByServer(): boolean;
1702
- // (undocumented)
1703
- isReconnecting: boolean;
1704
- // (undocumented)
1705
- protected isReconnectingChanged(): void;
1706
- // (undocumented)
1707
- onClose(event: CloseEvent): void;
1708
- // (undocumented)
1709
- reconnectionLimitReached: boolean;
1710
- // (undocumented)
1711
- protected resetClosedState(): void;
1712
- // (undocumented)
1713
- serialize(): SerializedSocketStatus;
1714
- // (undocumented)
1715
- protected user: User_2;
1716
- }
1717
-
1718
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "EntityDatasource" because one of its declarations is marked as @internal
1719
- //
1720
- // @alpha
1721
- export interface EntityDatasource<TDTO, TEntity> extends Datasource {
1722
- // (undocumented)
1723
- readonly cache: TEntity[];
1724
- // (undocumented)
1725
- disconnect(): void;
1726
- // (undocumented)
1727
- initialize(init: EntityDatasourceInit<TDTO, TEntity>): Promise<boolean>;
1728
- // (undocumented)
1729
- readonly isEmpty: boolean;
1730
- }
1731
-
1732
- // @internal
1733
- export const EntityDatasource: InterfaceSymbol<EntityDatasource<any, any>>;
1734
-
1735
- // @alpha
1736
- export interface EntityDatasourceInit<TDTO, TEntity> {
1737
- // (undocumented)
1738
- fetchMeta?: boolean;
1739
- // (undocumented)
1740
- mapper: DTOMapper<TDTO, TEntity>;
1741
- // (undocumented)
1742
- options: Omit<DatasourceOptions, 'isSnapshot'>;
1743
- }
1744
-
1745
- // @public
1746
- export enum EventMessageType {
1747
- // (undocumented)
1748
- DATA_LOGOFF = "DATA_LOGOFF",
1749
- // (undocumented)
1750
- DATA_LOGON = "DATA_LOGON",
1751
- // (undocumented)
1752
- EVENT_CHANGE_USER_PASSWORD = "EVENT_CHANGE_USER_PASSWORD",
1753
- // (undocumented)
1754
- EVENT_LOGIN_AUTH = "EVENT_LOGIN_AUTH",
1755
- // (undocumented)
1756
- EVENT_LOGIN_AUTH_ACK = "EVENT_LOGIN_AUTH_ACK",
1757
- // (undocumented)
1758
- EVENT_LOGIN_AUTH_NACK = "EVENT_LOGIN_AUTH_NACK",
1759
- // (undocumented)
1760
- EVENT_LOGOUT = "EVENT_LOGOUT",
1761
- // (undocumented)
1762
- EVENT_PASSWORD_RESET_ACTION = "EVENT_PASSWORD_RESET_ACTION",
1763
- // (undocumented)
1764
- EVENT_SELF_SERVICE_PASSWORD_RESET = "EVENT_SELF_SERVICE_PASSWORD_RESET",
1765
- // (undocumented)
1766
- JSON_SCHEMA_REQUEST = "JSON_SCHEMA_REQUEST",
1767
- // (undocumented)
1768
- META_REQUEST = "META_REQUEST",
1769
- // (undocumented)
1770
- RESOURCES_REQUEST = "RESOURCES_REQUEST",
1771
- // (undocumented)
1772
- RESOURCES_REQUEST_ACK = "RESOURCES_REQUEST_ACK",
1773
- // (undocumented)
1774
- RESOURCES_REQUEST_NACK = "RESOURCES_REQUEST_NACK"
1775
- }
1776
-
1777
- // @public
1778
- export const exponentialScheduler: SocketReconnectScheduler;
1779
-
1780
- // @public
1781
- export const extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[];
1782
-
1783
- // @public
1784
- export type FieldMetadata = {
1785
- name: string;
1786
- displayName?: string;
1787
- type: FieldTypeEnum;
1788
- enumOptions?: Array<any>;
1789
- enumMultiple?: boolean;
1790
- required?: boolean;
1791
- readOnly?: boolean;
1792
- component?: string;
1793
- };
1794
-
1795
- // @public
1796
- export enum FieldTypeEnum {
1797
- // (undocumented)
1798
- BOOLEAN = "BOOLEAN",
1799
- // (undocumented)
1800
- CUSTOM = "CUSTOM",
1801
- // (undocumented)
1802
- DATE = "DATE",
1803
- // (undocumented)
1804
- DATETIME = "DATETIME",
1805
- // (undocumented)
1806
- ENUM = "ENUM",
1807
- // (undocumented)
1808
- NANO_TIMESTAMP = "NANO_TIMESTAMP",
1809
- // (undocumented)
1810
- NUMBER = "NUMBER",
1811
- // (undocumented)
1812
- STRING = "STRING"
1813
- }
1814
-
1815
- // @public
1816
- export type FilteredDataServerResult = {
1817
- inserts?: RowData[];
1818
- deletes?: RowData[];
1819
- updates?: RowData[];
1820
- SOURCE_REF?: string;
1821
- };
1822
-
1823
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "FoundationAnalytics" because one of its declarations is marked as @internal
1824
- //
1825
- // @public
1826
- export interface FoundationAnalytics {
1827
- trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: FoundationAnalyticsEvent.ControlClicked): void;
1828
- trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
1829
- trackEvent(eventName: FoundationAnalyticsEventType, payload: {}): void;
1830
- }
1831
-
1832
- // @internal
1833
- export const FoundationAnalytics: InterfaceSymbol<FoundationAnalytics>;
1834
-
1835
- // @public
1836
- export namespace FoundationAnalyticsEvent {
1837
- export interface ControlClicked {
1838
- // (undocumented)
1839
- name: string;
1840
- }
1841
- export interface RouteChanged {
1842
- // (undocumented)
1843
- path: string;
1844
- // (undocumented)
1845
- referrer?: string;
1846
- }
1847
- }
1848
-
1849
- // @public
1850
- export enum FoundationAnalyticsEventType {
1851
- // (undocumented)
1852
- controlClicked = "controlClicked",
1853
- // (undocumented)
1854
- routeChanged = "routeChanged"
1855
- }
1856
-
1857
- // @public
1858
- export type GenesisConnectEvents = 'stream' | 'commit';
1859
-
1860
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "GenesisResources" because one of its declarations is marked as @internal
1861
- //
1862
- // @public
1863
- export interface GenesisResources {
1864
- destroy: () => void;
1865
- getAllResources: () => Promise<ResourceItem[]>;
1866
- getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
1867
- isValidResource: (resourceName: string) => Promise<boolean>;
1868
- }
1869
-
1870
- // @internal
1871
- export const GenesisResources: InterfaceSymbol<GenesisResources>;
1872
-
1873
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "GenesisResourcesChannel" because one of its declarations is marked as @internal
1874
- //
1875
- // @public
1876
- export interface GenesisResourcesChannel extends TypedBroadcastChannel<GenesisResourcesEvents> {
1877
- }
1878
-
1879
- // @internal
1880
- export const GenesisResourcesChannel: InterfaceSymbol<TypedBroadcastChannel<GenesisResourcesEvents>>;
1881
-
1882
- // @public (undocumented)
1883
- export const GenesisResourcesChannelId = "genesis-resources";
1884
-
1885
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "GenesisResourcesConfig" because one of its declarations is marked as @internal
1886
- //
1887
- // @public
1888
- export interface GenesisResourcesConfig {
1889
- throwWhenUnavailable?: boolean;
1890
- throwWhenUnknown?: boolean;
1891
- }
1892
-
1893
- // @internal
1894
- export const GenesisResourcesConfig: InterfaceSymbol<GenesisResourcesConfig>;
1895
-
1896
- // @public (undocumented)
1897
- export type GenesisResourcesEvents = {
1898
- 'resources-loaded': ResourceItem[];
1899
- 'resources-unloaded': void;
1900
- };
1901
-
1902
- // @public (undocumented)
1903
- export class GenesisResourcesMock implements GenesisResources {
1904
- // (undocumented)
1905
- destroy(): void;
1906
- // (undocumented)
1907
- getAllResources(): Promise<ResourceItem[]>;
1908
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1909
- //
1910
- // (undocumented)
1911
- getResourceTypeFor(resourceName: string): Promise<ResourceType>;
1912
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1913
- //
1914
- // (undocumented)
1915
- isValidResource(resourceName: string): Promise<boolean>;
1916
- // (undocumented)
1917
- nextIsValidResourceResponse: boolean;
1918
- // (undocumented)
1919
- nextResourceTypeForResponse: ResourceType;
1920
- // (undocumented)
1921
- resources: ResourceItem[];
1922
- }
1923
-
1924
- // @public
1925
- export function getConnect(): Connect;
1926
-
1927
- // @public
1928
- export type GetCredentialOptions = CredentialRequestOptions & {};
1929
-
1930
- // @public
1931
- export function getDatasource(): Datasource;
1932
-
1933
- // @public
1934
- export function getGenesisResources(): GenesisResources;
1935
-
1936
- // @public
1937
- export function getGenesisResourcesChannel(): GenesisResourcesChannel;
1938
-
1939
- // Warning: (ae-incompatible-release-tags) The symbol "getKVStorage" is marked as @public, but its signature references "KVStorage" which is marked as @alpha
1940
- //
1941
- // @public
1942
- export function getKVStorage(): KVStorage;
1943
-
1944
- // @public
1945
- export function getNetworkMonitor(): NetworkMonitor;
1946
-
1947
- // @public
1948
- export function getSocket(): Socket;
1949
-
1950
- // @public
1951
- export function getSocketStatus(): SocketStatus;
1952
-
1953
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Http" because one of its declarations is marked as @internal
1954
- //
1955
- // @public
1956
- export interface Http {
1957
- // (undocumented)
1958
- get<T = any>(url: string, requestInit: HttpRequestInit): Promise<T>;
1959
- // (undocumented)
1960
- post<T = any>(url: string, requestInit: HttpRequestInit): Promise<T>;
1961
- }
1962
-
1963
- // @internal
1964
- export const Http: InterfaceSymbol<Http>;
1965
-
1966
- // Warning: (ae-internal-missing-underscore) The name "HttpConnect" should be prefixed with an underscore because the declaration is marked as @internal
1967
- //
1968
- // @internal
1969
- export const HttpConnect: InterfaceSymbol<Connect>;
1970
-
1971
- // @public
1972
- export interface HttpRequestInit extends RequestInit {
1973
- serializer?: JSONSerializer;
1974
- }
1975
-
1976
- // @public
1977
- export type IndexDetail = {
1978
- NAME: string;
1979
- FIELDS: string;
1980
- };
1981
-
1982
- // @public
1983
- export const isWebSocketExpression: RegExp;
1984
-
1985
- // @public
1986
- export interface JsonSchemaCache {
1987
- // (undocumented)
1988
- cachedJsonSchema: Map<string, SchemaResponse>;
1989
- // (undocumented)
1990
- getJsonSchemaFor(resourceName: string): SchemaResponse;
1991
- // (undocumented)
1992
- hasJsonSchemaFor(resourceName: string): boolean;
1993
- // (undocumented)
1994
- setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): any;
1995
- }
1996
-
1997
- // @public
1998
- export type JwtAuthInfo = {
1999
- type: AuthType & AuthType.JWT;
2000
- jwt: string;
2001
- domain: string;
2002
- };
2003
-
2004
- // @alpha
2005
- export interface KeyValue<T = KVValue> {
2006
- base64?: boolean;
2007
- expiration?: number;
2008
- key: string;
2009
- metadata?: {
2010
- [key: string]: unknown;
2011
- };
2012
- value?: T;
2013
- }
2014
-
2015
- // @alpha
2016
- export interface KeyValueTransfer<T> {
2017
- // (undocumented)
2018
- deserialize?(value: unknown): Promise<T>;
2019
- // (undocumented)
2020
- kv: KeyValue<T>;
2021
- // (undocumented)
2022
- serialize?(value: unknown): unknown;
2023
- }
2024
-
2025
- // @alpha
2026
- export type KVEventFailureResponse = {
2027
- ERROR?: MessageError[];
2028
- WARNING: any[];
2029
- };
2030
-
2031
- // @alpha
2032
- export enum KVEventMessageType {
2033
- // (undocumented)
2034
- EVENT_KEY_VALUE_DELETE = "EVENT_KEY_VALUE_DELETE",
2035
- // (undocumented)
2036
- EVENT_KEY_VALUE_PUT = "EVENT_KEY_VALUE_PUT"
2037
- }
2038
-
2039
- // @alpha
2040
- export enum KVMessageType {
2041
- // (undocumented)
2042
- REQ_KEY_VALUE_LIST = "REQ_KEY_VALUE_LIST",
2043
- // (undocumented)
2044
- REQ_KEY_VALUE_READ = "REQ_KEY_VALUE_READ"
2045
- }
2046
-
2047
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "KVStorage" because one of its declarations is marked as @internal
2048
- //
2049
- // @alpha
2050
- export interface KVStorage {
2051
- // (undocumented)
2052
- delete(keys: string[]): Promise<true | KVEventFailureResponse>;
2053
- // (undocumented)
2054
- get<T = KVValue>(): Promise<KeyValueTransfer<T>[]>;
2055
- // (undocumented)
2056
- get<T = KVValue>(key: string): Promise<KeyValueTransfer<T>>;
2057
- // (undocumented)
2058
- list(): Promise<string[]>;
2059
- // (undocumented)
2060
- put(kvs: KeyValue<KVValue>[]): Promise<true | KVEventFailureResponse>;
2061
- }
2062
-
2063
- // @internal
2064
- export const KVStorage: InterfaceSymbol<KVStorage>;
2065
-
2066
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "KVStorageConfig" because one of its declarations is marked as @internal
2067
- //
2068
- // @alpha
2069
- export interface KVStorageConfig {
2070
- account?: string;
2071
- authEmail?: string;
2072
- authKey?: string;
2073
- namespace?: string;
2074
- }
2075
-
2076
- // @internal
2077
- export const KVStorageConfig: InterfaceSymbol<KVStorageConfig>;
2078
-
2079
- // @alpha
2080
- export type KVValue = string | ArrayBuffer;
2081
-
2082
- // @public
2083
- export const linearScheduler: SocketReconnectScheduler;
2084
-
2085
- // @public
2086
- export const logger: Logger;
2087
-
2088
- // @public
2089
- export type LoginResult = {
2090
- authToken: string;
2091
- refreshToken: string;
2092
- username: string;
2093
- profiles: string[];
2094
- permissions: string[];
2095
- sessionId: string;
2096
- };
2097
-
2098
- // @public
2099
- export interface LogoutResult {
2100
- error?: string;
2101
- success: boolean;
2102
- }
2103
-
2104
- // @public
2105
- export const MAX_RECONNECT_ATTEMPTS = 10;
2106
-
2107
- // @public
2108
- export type Message<T = void | any> = {
2109
- REPLY?: any[];
2110
- CODE?: MessageCode | string;
2111
- DETAILS?: T | any;
2112
- GENERATED?: T | any;
2113
- LOGGED_OUT?: boolean;
2114
- ERROR?: MessageError[];
2115
- MESSAGE_TYPE?: MessageType | EventMessageType | string;
2116
- PERMISSION?: string[];
2117
- PROFILE?: string[];
2118
- RESOURCES?: any[];
2119
- REFRESH_AUTH_TOKEN?: string;
2120
- ROW?: any[];
2121
- ROWS_COUNT?: number;
2122
- SEQUENCE_ID?: number;
2123
- SERVICE_NAME?: string;
2124
- SESSION_AUTH_TOKEN?: string;
2125
- SESSION_ID?: string;
2126
- SOURCE_REF?: string;
2127
- USER_NAME?: string;
2128
- WARNING?: any[];
2129
- };
2130
-
2131
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "MessageBuilder" because one of its declarations is marked as @internal
2132
- //
2133
- // @public
2134
- export interface MessageBuilder {
2135
- createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
2136
- createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
2137
- createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
2138
- createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
2139
- createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
2140
- createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
2141
- // (undocumented)
2142
- createHeartbeatPingMessage(verbose: boolean): PingMessage;
2143
- createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
2144
- createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
2145
- createLogoutMessage(loginResult?: LoginResult): Message;
2146
- createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
2147
- createMoreColumnsMessage(sourceRef: string): Message;
2148
- createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
2149
- createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
2150
- createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
2151
- createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
2152
- }
2153
-
2154
- // @internal
2155
- export const MessageBuilder: InterfaceSymbol<MessageBuilder>;
2156
-
2157
- // @public
2158
- export enum MessageCode {
2159
- // (undocumented)
2160
- SESSION_NOT_FOUND = "SESSION_NOT_FOUND",
2161
- // (undocumented)
2162
- UNKNOWN_MESSAGE_TYPE = "UNKNOWN_MESSAGE_TYPE"
2163
- }
2164
-
2165
- // @public
2166
- export namespace MessageDetails {
2167
- export type ChangePassword = {
2168
- OLD_PASSWORD: string;
2169
- NEW_PASSWORD: string;
2170
- };
2171
- export type DataserverRequest = {
2172
- DATASOURCE_NAME: string;
2173
- };
2174
- export type Error = {
2175
- ERROR: string;
2176
- };
2177
- export type ExpirePassword = {
2178
- USER_NAME: string;
2179
- PASSWORD: string;
2180
- };
2181
- export type ForgotPassword = {
2182
- USER_NAME: string;
2183
- RETURN_URL: string;
2184
- };
2185
- export type ForgotPasswordToken = {
2186
- USER_NAME: string;
2187
- RESET_TOKEN: string;
2188
- NEW_PASSWORD: string;
2189
- };
2190
- export type LoggedInSystemInfo = {
2191
- DAYS_TO_PASSWORD_EXPIRY: number;
2192
- FAILED_LOGIN_ATTEMPTS: number;
2193
- HEARTBEAT_INTERVAL_SECS: number;
2194
- LAST_LOGIN_DATETIME: number;
2195
- NOTIFY_EXPIRY?: boolean;
2196
- PRODUCT?: any[];
2197
- SYSTEM?: any;
2198
- };
2199
- export type Login = LoginBasic | LoginSSO | LoginJWT;
2200
- export type LoginBasic = {
2201
- USER_NAME: string;
2202
- PASSWORD: string;
2203
- };
2204
- export type LoginJWT = {
2205
- JWT: string;
2206
- DOMAIN: string;
2207
- };
2208
- export type LoginSSO = {
2209
- SSO_TOKEN: string;
2210
- };
2211
- export type MetaRequest = {
2212
- FEATURE: string;
2213
- };
2214
- export type MoreRows = {
2215
- SOURCE_REF: string;
2216
- VIEW_NUMBER?: number;
2217
- };
2218
- export type RefreshToken = {
2219
- REFRESH_AUTH_TOKEN: string;
2220
- MFA_CODE?: string;
2221
- };
2222
- export type ResetPassword = {
2223
- USER_NAME: string;
2224
- };
2225
- export type UpdateColumns = {
2226
- SOURCE_REF: string;
2227
- ADD_COLUMNS: string;
2228
- DROP_COLUMNS: string;
2229
- };
2230
- }
2231
-
2232
- // @public
2233
- export type MessageError = {
2234
- CODE: MessageCode | string;
2235
- STATUS_CODE?: string;
2236
- TEXT: string;
2237
- };
2238
-
2239
- // @public
2240
- export const messageHasErrorCode: (message: Message, code: string | number) => boolean;
2241
-
2242
- // @public
2243
- export const messageOrThrow: (message: Message) => Message<any>;
2244
-
2245
- // @public
2246
- export enum MessageType {
2247
- // (undocumented)
2248
- HEARTBEAT_PING = "HEARTBEAT_PING",
2249
- // (undocumented)
2250
- HEARTBEAT_PONG = "HEARTBEAT_PONG",
2251
- // (undocumented)
2252
- LOGOFF_ACK = "LOGOFF_ACK",
2253
- // (undocumented)
2254
- LOGOFF_NACK = "LOGOFF_NACK",
2255
- // (undocumented)
2256
- LOGON_ACK = "LOGON_ACK",
2257
- // (undocumented)
2258
- LOGON_NACK = "LOGON_NACK",
2259
- // (undocumented)
2260
- LOGOUT_ACK = "LOGOUT_ACK",
2261
- // (undocumented)
2262
- LOGOUT_NACK = "LOGOUT_NACK",
2263
- // (undocumented)
2264
- MORE_COLUMNS = "MORE_COLUMNS",
2265
- // (undocumented)
2266
- MORE_COLUMNS_ACK = "MORE_COLUMNS_ACK",
2267
- // (undocumented)
2268
- MORE_ROWS = "MORE_ROWS",
2269
- // (undocumented)
2270
- MSG_ACK = "MSG_ACK",
2271
- // (undocumented)
2272
- MSG_NACK = "MSG_NACK",
2273
- // (undocumented)
2274
- QUERY_UPDATE = "QUERY_UPDATE"
2275
- }
2276
-
2277
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "MetaCache" because one of its declarations is marked as @internal
2278
- //
2279
- // @public
2280
- export type MetaCache = MetadataCache & JsonSchemaCache;
2281
-
2282
- // @internal
2283
- export const MetaCache: InterfaceSymbol<MetaCache>;
2284
-
2285
- // @public
2286
- export type Metadata = {
2287
- DEFINITIONS?: Record<string, any>;
2288
- DESCRIPTION?: string;
2289
- FIELD?: MetadataDetail[];
2290
- REPLY?: ReplyDetail;
2291
- REPLY_FIELD?: MetadataDetail[];
2292
- REQUEST_FIELD?: MetadataDetail[];
2293
- NAME?: string;
2294
- TYPE?: string;
2295
- INDEXES?: IndexDetail[];
2296
- ERROR?: string;
2297
- };
2298
-
2299
- // @public
2300
- export interface MetadataCache {
2301
- cachedMetadata: Map<string, Metadata>;
2302
- getMetadataFor(resourceName: string): Metadata;
2303
- hasMetadataFor(resourceName: string): boolean;
2304
- setMetadataFor(resourceName: string, metadata: Metadata): void;
2305
- }
2306
-
2307
- // @public
2308
- export type MetadataDetail = {
2309
- NAME: string;
2310
- TYPE: string;
2311
- DESCRIPTION?: string;
2312
- JSON_TYPE?: string;
2313
- VALID_VALUES?: string;
2314
- READ_ONLY?: boolean;
2315
- OPTIONAL?: boolean;
2316
- NULLABLE?: boolean;
2317
- UI_LABEL?: string;
2318
- };
2319
-
2320
- // @public (undocumented)
2321
- export type MetadataEvent = CustomEvent<MetadataEventDetail>;
2322
-
2323
- // @public (undocumented)
2324
- export type MetadataEventDetail = {
2325
- resourceName: string;
2326
- message: Message<MessageDetails.MetaRequest>;
2327
- error?: any;
2328
- };
2329
-
2330
- // @public (undocumented)
2331
- export const MetadataEventType = "connect-metadata-event";
2332
-
2333
- // @public
2334
- export type MonitoredResource = SocketObservable<any>;
2335
-
2336
- // @public
2337
- export type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
2338
-
2339
- // @public
2340
- export interface MonitoredResourceChecksResult {
2341
- // (undocumented)
2342
- isConnected: boolean;
2343
- // (undocumented)
2344
- lastMessage?: Message;
2345
- // (undocumented)
2346
- lastUpdated: number;
2347
- // (undocumented)
2348
- timeout?: boolean;
2349
- }
2350
-
2351
- // @public
2352
- export type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
2353
-
2354
- // @public
2355
- export interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail> {
2356
- }
2357
-
2358
- // @public (undocumented)
2359
- export const networkLogger: Logger;
2360
-
2361
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NetworkMonitor" because one of its declarations is marked as @internal
2362
- //
2363
- // @public
2364
- export interface NetworkMonitor {
2365
- // (undocumented)
2366
- addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
2367
- // (undocumented)
2368
- create(): void;
2369
- // (undocumented)
2370
- destroy(): void;
2371
- // (undocumented)
2372
- removeResource(resource: MonitoredResource): void;
2373
- // (undocumented)
2374
- runAllChecks(source?: unknown, force?: boolean): Promise<void>;
2375
- // (undocumented)
2376
- status: SystemHealthStatus;
2377
- }
2378
-
2379
- // @internal
2380
- export const NetworkMonitor: InterfaceSymbol<NetworkMonitor>;
2381
-
2382
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NetworkMonitorConfig" because one of its declarations is marked as @internal
2383
- //
2384
- // @public
2385
- export interface NetworkMonitorConfig {
2386
- checkInterval?: number;
2387
- checkTimeout?: number;
2388
- documentEvents?: (keyof DocumentEventMap)[];
2389
- eventEmitter?: HTMLElement;
2390
- genesisConnectEvents?: GenesisConnectEvents[];
2391
- ignoredGenesisResources?: string[];
2392
- logLevel?: LogLevel;
2393
- resourceChecks?: MonitoredResourceChecks;
2394
- resourceDataLogon?: MonitoredResourceDataLogon;
2395
- startDelay?: number;
2396
- windowEvents?: (keyof WindowEventHandlersEventMap)[];
2397
- }
2398
-
2399
- // @internal
2400
- export const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>;
2401
-
2402
- // @public
2403
- export function normaliseCriteria(criteria: string, delimiter?: string): string;
2404
-
2405
- // @public (undocumented)
2406
- export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
2407
- VERBOSE?: boolean;
2408
- [key: string]: any;
2409
- };
2410
-
2411
- // @public (undocumented)
2412
- export type PongMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'USER_NAME'> & {
2413
- IS_AUTHENTICATED?: boolean;
2414
- CREATED_AT?: number;
2415
- LAST_RECEIVED?: number;
2416
- LAST_SENT?: number;
2417
- RESOURCES?: Record<string, RESOURCE_DETAILS[]>;
2418
- };
2419
-
2420
- // @public
2421
- export type RawDataServerResult = {
2422
- MESSAGE_TYPE: string;
2423
- ROW: ServerRow[];
2424
- SOURCE_REF: string;
2425
- MORE_ROWS: boolean;
2426
- ROWS_COUNT: number;
2427
- SEQUENCE_ID: number;
2428
- };
2429
-
2430
- // @public
2431
- export type RefreshAuthInfo = {
2432
- type: AuthType & AuthType.REFRESH;
2433
- username: string;
2434
- refreshToken: string;
2435
- mfaToken: string;
2436
- };
2437
-
2438
- // @public
2439
- export type RefreshCredentialsInput = {
2440
- username: string;
2441
- refreshToken: string;
2442
- mfaToken?: string;
2443
- };
2444
-
2445
- // @public
2446
- export type ReplyDetail = {
2447
- DEFINITIONS?: Record<string, any>;
2448
- DESCRIPTION?: string;
2449
- FIELD: MetadataDetail[];
2450
- NAME: string;
2451
- [key: string]: any;
2452
- };
2453
-
2454
- // @public (undocumented)
2455
- export type RequestDetailsParam = {
2456
- MAX_ROWS?: number;
2457
- CRITERIA_MATCH?: string;
2458
- VIEW_NUMBER?: number;
2459
- };
2460
-
2461
- // @public
2462
- export type RequestParams = {
2463
- DETAILS?: RequestDetailsParam | any;
2464
- REQUEST?: any;
2465
- [key: string]: any;
2466
- };
2467
-
2468
- // @public
2469
- export type RequestServerResult = {
2470
- SOURCE_REF?: string;
2471
- REPLY: any[];
2472
- MESSAGE_TYPE?: string;
2473
- MORE_ROWS?: boolean;
2474
- NEXT_VIEW?: number;
2475
- PARAMETRIC_TYPE?: string;
2476
- ROWS_COUNT?: number;
2477
- SEQUENCE_ID?: number;
2478
- };
2479
-
2480
- // @public
2481
- export type ResourceHealth = MonitoredResourceChecksResult & {
2482
- name: string;
2483
- sourceRef: string[];
2484
- lastError?: any;
2485
- };
2486
-
2487
- // @public (undocumented)
2488
- export type ResourceItem = {
2489
- RESOURCE_NAME: string;
2490
- RESOURCE_TYPE: string;
2491
- };
2492
-
2493
- // @public (undocumented)
2494
- export type ResourcesMessage = {
2495
- MESSAGE_TYPE: EventMessageType.RESOURCES_REQUEST_ACK | EventMessageType.RESOURCES_REQUEST_NACK | MessageType.MSG_NACK;
2496
- SOURCE_REF: string;
2497
- RESOURCES: ResourceItem[];
2498
- };
2499
-
2500
- // @public
2501
- export enum ResourceType {
2502
- // (undocumented)
2503
- DATASERVER = "DATASERVER",
2504
- // (undocumented)
2505
- EVENT_HANDLER = "EVENT_HANDLER",
2506
- // (undocumented)
2507
- REQUEST_SERVER = "REQUEST_SERVER"
2508
- }
2509
-
2510
- // @public
2511
- export const retryInterval: (reconnectOptions: SocketReconnectOptions, scheduler: SocketReconnectScheduler) => Observable<number>;
2512
-
2513
- // @public
2514
- export type RowData = {
2515
- ROW_REF: string;
2516
- };
2517
-
2518
- // @public
2519
- export type SchemaResponse = {
2520
- INBOUND: JSONSchema7;
2521
- OUTBOUND: JSONSchema7;
2522
- MESSAGE_TYPE: string;
2523
- SOURCE_REF: string;
2524
- };
2525
-
2526
- // @public
2527
- export interface SerializedSocketStatus {
2528
- // (undocumented)
2529
- readonly closedClean: boolean;
2530
- // (undocumented)
2531
- readonly closedCode: number;
2532
- // (undocumented)
2533
- readonly closedReason: string;
2534
- // @deprecated (undocumented)
2535
- hasValidSession: boolean;
2536
- isConfigured: boolean;
2537
- // (undocumented)
2538
- isConnected: boolean;
2539
- // (undocumented)
2540
- isConnecting: boolean;
2541
- // (undocumented)
2542
- isDisconnected: boolean;
2543
- // (undocumented)
2544
- isDisconnectedByServer: boolean;
2545
- // (undocumented)
2546
- isReconnecting: boolean;
2547
- // (undocumented)
2548
- reconnectionLimitReached: boolean;
2549
- }
2550
-
2551
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Serializer" because one of its declarations is marked as @internal
2552
- //
2553
- // @public
2554
- export interface Serializer {
2555
- // @deprecated
2556
- deserialize<T = any>(response: Response): Promise<T>;
2557
- // @deprecated
2558
- deserialize<T = any>(event: MessageEvent): T;
2559
- // @deprecated
2560
- deserialize<T = any>(text: string): T;
2561
- // @deprecated
2562
- serialize(object: any): string;
2563
- }
2564
-
2565
- // @internal
2566
- export const Serializer: InterfaceSymbol<Serializer>;
2567
-
2568
- // @public
2569
- export type ServerRow = {
2570
- DETAILS: {
2571
- OPERATION: 'INSERT' | 'MODIFY' | 'DELETE';
2572
- ROW_REF: string;
2573
- };
2574
- [key: string]: any;
2575
- };
2576
-
2577
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Session" because one of its declarations is marked as @internal
2578
- //
2579
- // @public
2580
- export interface Session {
2581
- captureReturnUrl(): void;
2582
- deleteUserFromSessionStorage(): void;
2583
- getItem(key: string | UserInfoKeys, storage: StorageType): string;
2584
- getLocalStorageItem(key: string | UserInfoKeys): string;
2585
- getSessionStorageItem(key: string | UserInfoKeys): string;
2586
- removeItem(key: string | UserInfoKeys, storage: StorageType): void;
2587
- removeLocalStorageItem(key: string | UserInfoKeys): void;
2588
- removeSessionStorageItem(key: string | UserInfoKeys): void;
2589
- returnUrl: string;
2590
- setAuthResult(info: Message): void;
2591
- setItem(key: string | UserInfoKeys, value: string, storage: StorageType): void;
2592
- setLocalStorageItem(key: string | UserInfoKeys, value: string): void;
2593
- setSessionStorageItem(key: string | UserInfoKeys, value: string): void;
2594
- setStorageKeyPrefix(prefix: string): void;
2595
- }
2596
-
2597
- // @internal
2598
- export const Session: InterfaceSymbol<Session>;
2599
-
2600
- // Warning: (ae-internal-missing-underscore) The name "SessionMock" should be prefixed with an underscore because the declaration is marked as @internal
2601
- //
2602
- // @internal (undocumented)
2603
- export class SessionMock implements Session {
2604
- // (undocumented)
2605
- captureReturnUrl(): void;
2606
- // (undocumented)
2607
- deleteUserFromSessionStorage(): void;
2608
- // (undocumented)
2609
- getItem(key: string): string;
2610
- // (undocumented)
2611
- getLocalStorageItem(key: string): string;
2612
- // (undocumented)
2613
- getSessionStorageItem(key: string): string;
2614
- // (undocumented)
2615
- nextStorageItem: string;
2616
- // (undocumented)
2617
- removeItem(key: string): void;
2618
- // (undocumented)
2619
- removeLocalStorageItem(key: string): void;
2620
- // (undocumented)
2621
- removeSessionStorageItem(key: string): void;
2622
- // (undocumented)
2623
- returnUrl: string;
2624
- // (undocumented)
2625
- setAuthResult(loginResult: Message): void;
2626
- // (undocumented)
2627
- setItem(key: string, value: string): void;
2628
- // (undocumented)
2629
- setLocalStorageItem(key: string, value: string): void;
2630
- // (undocumented)
2631
- setSessionStorageItem(key: string, value: string): void;
2632
- // (undocumented)
2633
- setStorageKeyPrefix(prefix: string): void;
2634
- }
2635
-
2636
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Socket" because one of its declarations is marked as @internal
2637
- //
2638
- // @public
2639
- export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 'reconnectionLimitReached' | 'closedCode' | 'closedReason' | 'closedClean'> {
2640
- // (undocumented)
2641
- connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
2642
- // (undocumented)
2643
- host: string;
2644
- reset(): void;
2645
- // (undocumented)
2646
- send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
2647
- // (undocumented)
2648
- sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
2649
- // @alpha
2650
- sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
2651
- // (undocumented)
2652
- socketMessages(): SocketSubject<Message>;
2653
- }
2654
-
2655
- // @internal
2656
- export const Socket: InterfaceSymbol<Socket>;
2657
-
2658
- // @public
2659
- export type SocketConnectOptions = {
2660
- alwaysOn?: boolean;
2661
- connectObserver?: Observer_2<Message>;
2662
- enableHeartbeat?: boolean;
2663
- enableHeartbeatLogging?: boolean;
2664
- enableMessageLogging?: boolean;
2665
- heartbeatInterval?: number;
2666
- verboseHeartbeat?: boolean;
2667
- heartbeatPingCallback?: (message: PingMessage) => void;
2668
- heartbeatPongCallback?: (message: PongMessage) => void;
2669
- proxyPath?: string;
2670
- };
2671
-
2672
- // @public
2673
- export class SocketMessageHandler {
2674
- constructor(message: Message, onMessage: Function, onError: Function, isSubscription: boolean);
2675
- get isSubscription(): boolean;
2676
- get onReceivedError(): Function;
2677
- get onReceivedMessage(): Function;
2678
- get sentMessage(): Message;
2679
- }
2680
-
2681
- // Warning: (ae-internal-missing-underscore) The name "SocketMock" should be prefixed with an underscore because the declaration is marked as @internal
2682
- //
2683
- // @internal (undocumented)
2684
- export class SocketMock implements Socket {
2685
- // (undocumented)
2686
- connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
2687
- // (undocumented)
2688
- disconnect(): void;
2689
- // (undocumented)
2690
- hasValidSession: boolean;
2691
- // (undocumented)
2692
- host: string;
2693
- // (undocumented)
2694
- isConfigured: boolean;
2695
- // (undocumented)
2696
- isConnected: boolean;
2697
- // (undocumented)
2698
- isConnectedSubject: BehaviorSubject<boolean>;
2699
- // (undocumented)
2700
- isConnecting: boolean;
2701
- // (undocumented)
2702
- isDisconnected: boolean;
2703
- // (undocumented)
2704
- isDisconnectedByServer: boolean;
2705
- // (undocumented)
2706
- isReconnecting: boolean;
2707
- // (undocumented)
2708
- nextMessage: Message;
2709
- // (undocumented)
2710
- reset(): void;
2711
- // (undocumented)
2712
- send<T>(message: Message<any>): Promise<Message | any>;
2713
- // (undocumented)
2714
- sendForStream<T>(message: Message<any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
2715
- // (undocumented)
2716
- sendForStreamWithoutTeardown<T>(message: Message<any>, onMessage: Function, onError: Function): Observable<Message>;
2717
- // (undocumented)
2718
- socketMessages(): SocketSubject<Message>;
2719
- // (undocumented)
2720
- socketMessagesSubject: SocketSubject<Message>;
2721
- }
2722
-
2723
- // @public
2724
- export class SocketObservable<T> extends Observable<T> {
2725
- constructor(...args: any[]);
2726
- }
2727
-
2728
- // @public
2729
- export type SocketReconnectOptions = {
2730
- reconnectAttempts?: number;
2731
- reconnectInterval?: number;
2732
- reconnectObserver?: Observer_2<any>;
2733
- reconnectStreams?: boolean;
2734
- reconnectStrategy?: SocketReconnectStrategy;
2735
- };
2736
-
2737
- // @public
2738
- export type SocketReconnectScheduler = (reconnectOptions: SocketReconnectOptions, attempts?: number) => number;
2739
-
2740
- // @public
2741
- export enum SocketReconnectStrategy {
2742
- // (undocumented)
2743
- Exponential = "exponential",
2744
- // (undocumented)
2745
- Linear = "linear"
2746
- }
2747
-
2748
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "SocketStatus" because one of its declarations is marked as @internal
2749
- //
2750
- // @public
2751
- export interface SocketStatus extends SerializedSocketStatus {
2752
- // (undocumented)
2753
- isConnectedSubject: BehaviorSubject<boolean>;
2754
- // (undocumented)
2755
- onClose(closeEvent: CloseEvent): void;
2756
- // (undocumented)
2757
- serialize(): SerializedSocketStatus;
2758
- }
2759
-
2760
- // @internal
2761
- export const SocketStatus: InterfaceSymbol<SocketStatus>;
2762
-
2763
- // @public
2764
- export class SocketSubject<T> extends Subject<T> {
2765
- constructor();
2766
- }
2767
-
2768
- export { SocketSubscription }
2769
-
2770
- // @public
2771
- export type SsoAuthInfo = {
2772
- type: AuthType & AuthType.SSO;
2773
- ssoToken: string;
2774
- };
2775
-
2776
- // @public
2777
- export type SSOCredentialsInput = {
2778
- ssoToken: string;
2779
- };
2780
-
2781
- // @public
2782
- export type StorageType = 'local' | 'session';
2783
-
2784
- // @public (undocumented)
2785
- export type StreamCompleteEvent = CustomEvent<StreamCompleteEventDetail>;
2786
-
2787
- // @public (undocumented)
2788
- export type StreamCompleteEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'>;
2789
-
2790
- // @public (undocumented)
2791
- export const StreamCompleteEventType = "connect-stream-complete-event";
2792
-
2793
- // @public (undocumented)
2794
- export type StreamErrorEvent = CustomEvent<StreamErrorEventDetail>;
2795
-
2796
- // @public (undocumented)
2797
- export type StreamErrorEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'> & {
2798
- error: any;
2799
- };
2800
-
2801
- // @public (undocumented)
2802
- export const StreamErrorEventType = "connect-stream-error-event";
2803
-
2804
- // @public (undocumented)
2805
- export type StreamEvent = CustomEvent<StreamEventDetail>;
2806
-
2807
- // @public (undocumented)
2808
- export type StreamEventDetail = {
2809
- functions: StreamEventFunctions;
2810
- message: Message<MessageDetails.DataserverRequest>;
2811
- resourceName: string;
2812
- stream: SocketObservable<any>;
2813
- };
2814
-
2815
- // @public (undocumented)
2816
- export type StreamEventFunctions = {
2817
- onMessage?: Function;
2818
- onError?: Function;
2819
- resourceChecks?: MonitoredResourceChecks;
2820
- resourceDataLogon?: MonitoredResourceDataLogon;
2821
- };
2822
-
2823
- // @public (undocumented)
2824
- export const StreamEventType = "connect-stream-event";
2825
-
2826
- // @public
2827
- export const SystemHealthChanged = "system-health-changed";
2828
-
2829
- // @public
2830
- export type SystemHealthChangedEvent = CustomEvent<SystemHealthStatus>;
2831
-
2832
- // @public
2833
- export type SystemHealthStatus = {
2834
- isOnline: boolean;
2835
- browserInformation?: Bowser_2.Parser.ParsedResult;
2836
- isAuthenticated: boolean;
2837
- username?: string;
2838
- isHealthy: boolean;
2839
- socket: SerializedSocketStatus;
2840
- resources: Record<string, ResourceHealth>;
2841
- resourcesAllConnected: boolean;
2842
- lastUpdated: number;
2843
- nextUpdate: number;
2844
- firstUpdated: number;
2845
- runAllChecks(): void;
2846
- reportStabilityToGenesis(): Promise<boolean>;
2847
- };
2848
-
2849
- // @public
2850
- export const toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[];
2851
-
2852
- // @public
2853
- export const TYPES_MAP: {
2854
- STRING: FieldTypeEnum;
2855
- ENUM: FieldTypeEnum;
2856
- BOOLEAN: FieldTypeEnum;
2857
- INT: FieldTypeEnum;
2858
- LONG: FieldTypeEnum;
2859
- DOUBLE: FieldTypeEnum;
2860
- BIGDECIMAL: FieldTypeEnum;
2861
- DATE: FieldTypeEnum;
2862
- DATETIME: FieldTypeEnum;
2863
- NANO_TIMESTAMP: FieldTypeEnum;
2864
- };
2865
-
2866
- // Warning: (ae-internal-missing-underscore) The name "UnknownUserPermissions" should be prefixed with an underscore because the declaration is marked as @internal
2867
- //
2868
- // @internal (undocumented)
2869
- export type UnknownUserPermissions = string;
2870
-
2871
- // Warning: (ae-internal-missing-underscore) The name "UnknownUserProfiles" should be prefixed with an underscore because the declaration is marked as @internal
2872
- //
2873
- // @internal (undocumented)
2874
- export type UnknownUserProfiles = string;
2875
-
2876
- // @public
2877
- export function until(conditionFunc: () => boolean, timeoutMs?: number): Promise<any>;
2878
-
2879
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "User" because one of its declarations is marked as @internal
2880
- //
2881
- // @public @deprecated
2882
- export interface User extends User_2 {
2883
- }
2884
-
2885
- // @internal @deprecated
2886
- export const User: InterfaceSymbol<User>;
2887
-
2888
- // Warning: (ae-internal-missing-underscore) The name "UserPermission" should be prefixed with an underscore because the declaration is marked as @internal
2889
- //
2890
- // @internal (undocumented)
2891
- export type UserPermission = CoreUserPermissions | UnknownUserPermissions;
2892
-
2893
- // Warning: (ae-internal-missing-underscore) The name "UserProfile" should be prefixed with an underscore because the declaration is marked as @internal
2894
- //
2895
- // @internal (undocumented)
2896
- export type UserProfile = CoreUserProfiles | UnknownUserProfiles;
2897
-
2898
- // Warning: (ae-internal-missing-underscore) The name "WSConnect" should be prefixed with an underscore because the declaration is marked as @internal
2899
- //
2900
- // @internal
2901
- export const WSConnect: InterfaceSymbol<Connect>;
2902
-
2903
- // Warnings were encountered during analysis:
2904
- //
2905
- // src/connect/message.ts:291:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
2906
-
2907
- // (No @packageDocumentation comment for this package)
2908
-
2909
- ```