@signageos/front-applet 7.2.0 → 8.0.1

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 (421) hide show
  1. package/dist/bundle.js +8 -4
  2. package/dist/bundle.js.map +1 -1
  3. package/docs/fpath/index.md +316 -0
  4. package/docs/index.md +19 -85
  5. package/docs/sos/browser.md +210 -0
  6. package/docs/sos/command.md +68 -0
  7. package/docs/sos/debug.md +25 -0
  8. package/docs/sos/deviceInfo.md +49 -0
  9. package/docs/sos/display.md +21 -0
  10. package/docs/sos/fileSystem.md +594 -0
  11. package/docs/sos/hardware/barcodeScanner.md +40 -0
  12. package/docs/sos/hardware/index.md +64 -0
  13. package/docs/sos/hardware/led.md +14 -0
  14. package/docs/sos/index.md +82 -0
  15. package/docs/sos/input.md +73 -0
  16. package/docs/sos/monitors.md +21 -0
  17. package/docs/sos/native/index.md +5 -0
  18. package/docs/sos/native/mdc.md +240 -0
  19. package/docs/sos/offline/cache.md +183 -0
  20. package/docs/sos/offline/index.md +188 -0
  21. package/docs/sos/osd.md +13 -0
  22. package/docs/sos/proofOfPlay.md +37 -0
  23. package/docs/sos/stream.md +960 -0
  24. package/docs/sos/sync.md +298 -0
  25. package/docs/sos/video.md +285 -0
  26. package/docs/sos_management/app.md +102 -0
  27. package/docs/sos_management/audio.md +29 -0
  28. package/docs/sos_management/debug.md +33 -0
  29. package/docs/sos_management/firmware.md +86 -0
  30. package/docs/sos_management/index.md +212 -0
  31. package/docs/sos_management/network.md +197 -0
  32. package/docs/sos_management/os.md +54 -0
  33. package/docs/sos_management/package.md +33 -0
  34. package/docs/sos_management/power.md +136 -0
  35. package/docs/sos_management/proxy.md +41 -0
  36. package/docs/sos_management/remoteControl.md +72 -0
  37. package/docs/sos_management/screen.md +198 -0
  38. package/docs/sos_management/security.md +47 -0
  39. package/docs/sos_management/time.md +101 -0
  40. package/docs/sos_management/wifi.md +366 -0
  41. package/es6/FrontApplet/Browser/Browser.d.ts +61 -8
  42. package/es6/FrontApplet/Browser/Browser.js +91 -39
  43. package/es6/FrontApplet/Browser/Browser.js.map +1 -1
  44. package/es6/FrontApplet/Browser/events.js +2 -2
  45. package/es6/FrontApplet/Browser/events.js.map +1 -1
  46. package/es6/FrontApplet/Command/Command.d.ts +37 -3
  47. package/es6/FrontApplet/Command/Command.js +49 -20
  48. package/es6/FrontApplet/Command/Command.js.map +1 -1
  49. package/es6/FrontApplet/Command/ICommandEvent.d.ts +6 -2
  50. package/es6/FrontApplet/Connect/Connect.d.ts +3 -0
  51. package/es6/FrontApplet/Connect/Connect.js +55 -7
  52. package/es6/FrontApplet/Connect/Connect.js.map +1 -1
  53. package/es6/FrontApplet/Connect/IConnectMessage.d.ts +1 -1
  54. package/es6/FrontApplet/Debug/Debug.d.ts +15 -1
  55. package/es6/FrontApplet/Debug/Debug.js +27 -17
  56. package/es6/FrontApplet/Debug/Debug.js.map +1 -1
  57. package/es6/FrontApplet/Debug/debugDecorator.d.ts +3 -3
  58. package/es6/FrontApplet/Debug/debugDecorator.js +13 -7
  59. package/es6/FrontApplet/Debug/debugDecorator.js.map +1 -1
  60. package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts +23 -0
  61. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js +36 -27
  62. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map +1 -1
  63. package/es6/FrontApplet/Dimensions/coordinationsHelper.js +1 -2
  64. package/es6/FrontApplet/Dimensions/coordinationsHelper.js.map +1 -1
  65. package/es6/FrontApplet/Display/Display.d.ts +25 -3
  66. package/es6/FrontApplet/Display/Display.js +35 -19
  67. package/es6/FrontApplet/Display/Display.js.map +1 -1
  68. package/es6/FrontApplet/Display/IDisplay.d.ts +3 -1
  69. package/es6/FrontApplet/Error/AppletCommandError.js +12 -3
  70. package/es6/FrontApplet/Error/AppletCommandError.js.map +1 -1
  71. package/es6/FrontApplet/Error/AppletError.js +10 -2
  72. package/es6/FrontApplet/Error/AppletError.js.map +1 -1
  73. package/es6/FrontApplet/Error/AppletHardwareError.js +12 -3
  74. package/es6/FrontApplet/Error/AppletHardwareError.js.map +1 -1
  75. package/es6/FrontApplet/Error/AppletOfflineCacheError.js +10 -2
  76. package/es6/FrontApplet/Error/AppletOfflineCacheError.js.map +1 -1
  77. package/es6/FrontApplet/Error/AppletResourcesError.js +12 -3
  78. package/es6/FrontApplet/Error/AppletResourcesError.js.map +1 -1
  79. package/es6/FrontApplet/Error/AppletSecurityError.js +12 -3
  80. package/es6/FrontApplet/Error/AppletSecurityError.js.map +1 -1
  81. package/es6/FrontApplet/Error/AppletStreamError.js +10 -2
  82. package/es6/FrontApplet/Error/AppletStreamError.js.map +1 -1
  83. package/es6/FrontApplet/Error/AppletVideoError.js +12 -3
  84. package/es6/FrontApplet/Error/AppletVideoError.js.map +1 -1
  85. package/es6/FrontApplet/Error/ErrorCodesMessages.js +4 -1
  86. package/es6/FrontApplet/Error/ErrorCodesMessages.js.map +1 -1
  87. package/es6/FrontApplet/Error/ErrorSuggestions.js +1 -0
  88. package/es6/FrontApplet/Error/ErrorSuggestions.js.map +1 -1
  89. package/es6/FrontApplet/Error/FileNotFoundError.js +10 -2
  90. package/es6/FrontApplet/Error/FileNotFoundError.js.map +1 -1
  91. package/es6/FrontApplet/Error/SosError.js +4 -0
  92. package/es6/FrontApplet/Error/SosError.js.map +1 -1
  93. package/es6/FrontApplet/Error/errorHelper.js +5 -6
  94. package/es6/FrontApplet/Error/errorHelper.js.map +1 -1
  95. package/es6/FrontApplet/Exchange/Exchange.js +7 -14
  96. package/es6/FrontApplet/Exchange/Exchange.js.map +1 -1
  97. package/es6/FrontApplet/FileSystem/FileSystem.d.ts +156 -1
  98. package/es6/FrontApplet/FileSystem/FileSystem.js +316 -193
  99. package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -1
  100. package/es6/FrontApplet/FileSystem/HashAlgorithm.d.ts +2 -0
  101. package/es6/FrontApplet/{Stream/streamListeners.js → FileSystem/HashAlgorithm.js} +1 -1
  102. package/es6/FrontApplet/FileSystem/HashAlgorithm.js.map +1 -0
  103. package/es6/FrontApplet/Font/fontFaceGenerator.js.map +1 -1
  104. package/es6/FrontApplet/FrontApplet.d.ts +55 -4
  105. package/es6/FrontApplet/FrontApplet.js +124 -47
  106. package/es6/FrontApplet/FrontApplet.js.map +1 -1
  107. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts +2 -0
  108. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js +35 -54
  109. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map +1 -1
  110. package/es6/FrontApplet/Hardware/Hardware.d.ts +16 -2
  111. package/es6/FrontApplet/Hardware/Hardware.js +31 -19
  112. package/es6/FrontApplet/Hardware/Hardware.js.map +1 -1
  113. package/es6/FrontApplet/Hardware/IHardware.d.ts +2 -2
  114. package/es6/FrontApplet/Hardware/ISerialPort.d.ts +16 -0
  115. package/es6/FrontApplet/Hardware/ISerialPortOptions.js +1 -1
  116. package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map +1 -1
  117. package/es6/FrontApplet/Hardware/Led/Led.d.ts +8 -0
  118. package/es6/FrontApplet/Hardware/Led/Led.js +20 -18
  119. package/es6/FrontApplet/Hardware/Led/Led.js.map +1 -1
  120. package/es6/FrontApplet/Hardware/SerialPort.d.ts +1 -1
  121. package/es6/FrontApplet/Hardware/SerialPort.js +15 -23
  122. package/es6/FrontApplet/Hardware/SerialPort.js.map +1 -1
  123. package/es6/FrontApplet/Hash/generator.js +1 -2
  124. package/es6/FrontApplet/Hash/generator.js.map +1 -1
  125. package/es6/FrontApplet/Iframe/Iframe.d.ts +9 -8
  126. package/es6/FrontApplet/Iframe/Iframe.js +10 -0
  127. package/es6/FrontApplet/Iframe/Iframe.js.map +1 -1
  128. package/es6/FrontApplet/Input/IInput.d.ts +1 -2
  129. package/es6/FrontApplet/Input/IKeyUpEvent.d.ts +32 -2
  130. package/es6/FrontApplet/Input/IKeyUpEvent.js +32 -0
  131. package/es6/FrontApplet/Input/IKeyUpEvent.js.map +1 -1
  132. package/es6/FrontApplet/Input/Input.d.ts +19 -3
  133. package/es6/FrontApplet/Input/Input.js +43 -22
  134. package/es6/FrontApplet/Input/Input.js.map +1 -1
  135. package/es6/FrontApplet/Management/App/App.d.ts +48 -10
  136. package/es6/FrontApplet/Management/App/App.js +45 -30
  137. package/es6/FrontApplet/Management/App/App.js.map +1 -1
  138. package/es6/FrontApplet/Management/App/IApp.d.ts +3 -1
  139. package/es6/FrontApplet/Management/Audio/Audio.d.ts +16 -0
  140. package/es6/FrontApplet/Management/Audio/Audio.js +30 -22
  141. package/es6/FrontApplet/Management/Audio/Audio.js.map +1 -1
  142. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.d.ts +4 -0
  143. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js +15 -22
  144. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js.map +1 -1
  145. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js +4 -1
  146. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js.map +1 -1
  147. package/es6/FrontApplet/Management/Debug/Debug.d.ts +19 -0
  148. package/es6/FrontApplet/Management/Debug/Debug.js +37 -30
  149. package/es6/FrontApplet/Management/Debug/Debug.js.map +1 -1
  150. package/es6/FrontApplet/Management/Firmware/Firmware.d.ts +37 -10
  151. package/es6/FrontApplet/Management/Firmware/Firmware.js +34 -30
  152. package/es6/FrontApplet/Management/Firmware/Firmware.js.map +1 -1
  153. package/es6/FrontApplet/Management/Firmware/IFirmware.d.ts +1 -2
  154. package/es6/FrontApplet/Management/IManagement.d.ts +3 -1
  155. package/es6/FrontApplet/Management/Management.d.ts +106 -15
  156. package/es6/FrontApplet/Management/Management.js +191 -113
  157. package/es6/FrontApplet/Management/Management.js.map +1 -1
  158. package/es6/FrontApplet/Management/Network/INetworkInfo.d.ts +1 -1
  159. package/es6/FrontApplet/Management/Network/Network.d.ts +56 -8
  160. package/es6/FrontApplet/Management/Network/Network.js +85 -67
  161. package/es6/FrontApplet/Management/Network/Network.js.map +1 -1
  162. package/es6/FrontApplet/Management/OS/OS.d.ts +20 -0
  163. package/es6/FrontApplet/Management/OS/OS.js +34 -27
  164. package/es6/FrontApplet/Management/OS/OS.js.map +1 -1
  165. package/es6/FrontApplet/Management/Package/Package.d.ts +20 -0
  166. package/es6/FrontApplet/Management/Package/Package.js +37 -22
  167. package/es6/FrontApplet/Management/Package/Package.js.map +1 -1
  168. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js +4 -1
  169. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js.map +1 -1
  170. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.d.ts +4 -0
  171. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js +15 -22
  172. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js.map +1 -1
  173. package/es6/FrontApplet/Management/Power/Power.d.ts +64 -0
  174. package/es6/FrontApplet/Management/Power/Power.js +160 -115
  175. package/es6/FrontApplet/Management/Power/Power.js.map +1 -1
  176. package/es6/FrontApplet/Management/Proxy/Proxy.d.ts +21 -0
  177. package/es6/FrontApplet/Management/Proxy/Proxy.js +41 -35
  178. package/es6/FrontApplet/Management/Proxy/Proxy.js.map +1 -1
  179. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.d.ts +43 -0
  180. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js +63 -39
  181. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map +1 -1
  182. package/es6/FrontApplet/Management/Screen/Screen.d.ts +127 -0
  183. package/es6/FrontApplet/Management/Screen/Screen.js +197 -89
  184. package/es6/FrontApplet/Management/Screen/Screen.js.map +1 -1
  185. package/es6/FrontApplet/Management/Security/Security.d.ts +20 -5
  186. package/es6/FrontApplet/Management/Security/Security.js +33 -31
  187. package/es6/FrontApplet/Management/Security/Security.js.map +1 -1
  188. package/es6/FrontApplet/Management/Time/Time.d.ts +31 -5
  189. package/es6/FrontApplet/Management/Time/Time.js +49 -40
  190. package/es6/FrontApplet/Management/Time/Time.js.map +1 -1
  191. package/es6/FrontApplet/Management/Wifi/IWifiEvent.d.ts +18 -0
  192. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js +19 -1
  193. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js.map +1 -1
  194. package/es6/FrontApplet/Management/Wifi/Wifi.d.ts +108 -7
  195. package/es6/FrontApplet/Management/Wifi/Wifi.js +162 -86
  196. package/es6/FrontApplet/Management/Wifi/Wifi.js.map +1 -1
  197. package/es6/FrontApplet/Management/helpers/DeviceHelper.js +2 -2
  198. package/es6/FrontApplet/Management/helpers/DeviceHelper.js.map +1 -1
  199. package/es6/FrontApplet/Management/helpers/SecurityHelper.js +8 -6
  200. package/es6/FrontApplet/Management/helpers/SecurityHelper.js.map +1 -1
  201. package/es6/FrontApplet/Management/helpers/TimerHelper.js +2 -2
  202. package/es6/FrontApplet/Management/helpers/TimerHelper.js.map +1 -1
  203. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js +35 -3
  204. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js.map +1 -1
  205. package/es6/FrontApplet/Management/helpers/VideoHelper.js +1 -1
  206. package/es6/FrontApplet/Management/helpers/VideoHelper.js.map +1 -1
  207. package/es6/FrontApplet/Monitors/Monitors.d.ts +9 -0
  208. package/es6/FrontApplet/Monitors/Monitors.js +16 -16
  209. package/es6/FrontApplet/Monitors/Monitors.js.map +1 -1
  210. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js +1 -1
  211. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js.map +1 -1
  212. package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts +51 -2
  213. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js +79 -38
  214. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map +1 -1
  215. package/es6/FrontApplet/NativeCommands/NativeCommands.d.ts +4 -0
  216. package/es6/FrontApplet/NativeCommands/NativeCommands.js +12 -2
  217. package/es6/FrontApplet/NativeCommands/NativeCommands.js.map +1 -1
  218. package/es6/FrontApplet/OSD/OSD.d.ts +9 -0
  219. package/es6/FrontApplet/OSD/OSD.js +15 -15
  220. package/es6/FrontApplet/OSD/OSD.js.map +1 -1
  221. package/es6/FrontApplet/Offline/Cache/Cache.d.ts +91 -2
  222. package/es6/FrontApplet/Offline/Cache/Cache.js +192 -130
  223. package/es6/FrontApplet/Offline/Cache/Cache.js.map +1 -1
  224. package/es6/FrontApplet/Offline/Flags/AppendFlagController.d.ts +1 -1
  225. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js +17 -25
  226. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js.map +1 -1
  227. package/es6/FrontApplet/Offline/Flags/IFlags.d.ts +4 -4
  228. package/es6/FrontApplet/Offline/IAddFont.d.ts +3 -1
  229. package/es6/FrontApplet/Offline/IAddFont.js.map +1 -1
  230. package/es6/FrontApplet/Offline/ISaveFile.js +5 -2
  231. package/es6/FrontApplet/Offline/ISaveFile.js.map +1 -1
  232. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js +2 -1
  233. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js.map +1 -1
  234. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js +2 -1
  235. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js.map +1 -1
  236. package/es6/FrontApplet/Offline/Offline.d.ts +75 -4
  237. package/es6/FrontApplet/Offline/Offline.js +116 -56
  238. package/es6/FrontApplet/Offline/Offline.js.map +1 -1
  239. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.d.ts +19 -1
  240. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js +41 -29
  241. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js.map +1 -1
  242. package/es6/FrontApplet/Sensors/Proximity.d.ts +4 -3
  243. package/es6/FrontApplet/Sensors/Proximity.js +12 -4
  244. package/es6/FrontApplet/Sensors/Proximity.js.map +1 -1
  245. package/es6/FrontApplet/Sensors/Sensors.d.ts +2 -0
  246. package/es6/FrontApplet/Sensors/Sensors.js +9 -2
  247. package/es6/FrontApplet/Sensors/Sensors.js.map +1 -1
  248. package/es6/FrontApplet/Stream/IStream.d.ts +10 -10
  249. package/es6/FrontApplet/Stream/Stream.d.ts +130 -15
  250. package/es6/FrontApplet/Stream/Stream.js +229 -130
  251. package/es6/FrontApplet/Stream/Stream.js.map +1 -1
  252. package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -1
  253. package/es6/FrontApplet/Sync/Sync.d.ts +152 -6
  254. package/es6/FrontApplet/Sync/Sync.js +196 -112
  255. package/es6/FrontApplet/Sync/Sync.js.map +1 -1
  256. package/es6/FrontApplet/Sync/syncEvents.d.ts +3 -1
  257. package/es6/FrontApplet/Sync/syncMessages.js +1 -1
  258. package/es6/FrontApplet/Sync/syncMessages.js.map +1 -1
  259. package/es6/FrontApplet/Timing/Timing.d.ts +1 -0
  260. package/es6/FrontApplet/Timing/Timing.js +9 -2
  261. package/es6/FrontApplet/Timing/Timing.js.map +1 -1
  262. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.d.ts +1 -1
  263. package/es6/FrontApplet/Timing/Triggers/Triggers.d.ts +9 -0
  264. package/es6/FrontApplet/Timing/Triggers/Triggers.js +16 -18
  265. package/es6/FrontApplet/Timing/Triggers/Triggers.js.map +1 -1
  266. package/es6/FrontApplet/Touch/Touch.d.ts +3 -0
  267. package/es6/FrontApplet/Touch/Touch.js +13 -3
  268. package/es6/FrontApplet/Touch/Touch.js.map +1 -1
  269. package/es6/FrontApplet/Validate/Validate.js +14 -11
  270. package/es6/FrontApplet/Validate/Validate.js.map +1 -1
  271. package/es6/FrontApplet/Validate/ValidateObjectInterface.js +7 -2
  272. package/es6/FrontApplet/Validate/ValidateObjectInterface.js.map +1 -1
  273. package/es6/FrontApplet/Video/IOptions.d.ts +8 -1
  274. package/es6/FrontApplet/Video/IVideo.d.ts +8 -8
  275. package/es6/FrontApplet/Video/IVideoEvent.js +3 -3
  276. package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -1
  277. package/es6/FrontApplet/Video/Video.d.ts +84 -12
  278. package/es6/FrontApplet/Video/Video.js +161 -102
  279. package/es6/FrontApplet/Video/Video.js.map +1 -1
  280. package/es6/FrontApplet/createFrontApplet.js +5 -2
  281. package/es6/FrontApplet/createFrontApplet.js.map +1 -1
  282. package/es6/Monitoring/Display/handleDisplayRequests.d.ts +2 -2
  283. package/es6/Monitoring/Display/handleDisplayRequests.js +5 -15
  284. package/es6/Monitoring/Display/handleDisplayRequests.js.map +1 -1
  285. package/es6/Monitoring/FileSystem/fileSystemCommands.d.ts +10 -1
  286. package/es6/Monitoring/FileSystem/fileSystemCommands.js +3 -1
  287. package/es6/Monitoring/FileSystem/fileSystemCommands.js.map +1 -1
  288. package/es6/Monitoring/FileSystem/handleFileSystemRequests.d.ts +2 -2
  289. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js +41 -45
  290. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js.map +1 -1
  291. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.d.ts +2 -2
  292. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js +4 -14
  293. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js.map +1 -1
  294. package/es6/Monitoring/Management/App/handleApplicationRequests.d.ts +2 -2
  295. package/es6/Monitoring/Management/App/handleApplicationRequests.js +9 -19
  296. package/es6/Monitoring/Management/App/handleApplicationRequests.js.map +1 -1
  297. package/es6/Monitoring/Management/Audio/handleAudioRequests.d.ts +2 -2
  298. package/es6/Monitoring/Management/Audio/handleAudioRequests.js +7 -17
  299. package/es6/Monitoring/Management/Audio/handleAudioRequests.js.map +1 -1
  300. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.d.ts +2 -2
  301. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js +7 -17
  302. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js.map +1 -1
  303. package/es6/Monitoring/Management/Debug/handleDebugRequests.d.ts +2 -2
  304. package/es6/Monitoring/Management/Debug/handleDebugRequests.js +9 -19
  305. package/es6/Monitoring/Management/Debug/handleDebugRequests.js.map +1 -1
  306. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.d.ts +2 -2
  307. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js +11 -21
  308. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js.map +1 -1
  309. package/es6/Monitoring/Management/Os/managementOsRequests.d.ts +2 -2
  310. package/es6/Monitoring/Management/Os/managementOsRequests.js +9 -19
  311. package/es6/Monitoring/Management/Os/managementOsRequests.js.map +1 -1
  312. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.d.ts +2 -2
  313. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js +7 -17
  314. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js.map +1 -1
  315. package/es6/Monitoring/Management/Power/handlePowerRequests.d.ts +2 -2
  316. package/es6/Monitoring/Management/Power/handlePowerRequests.js +19 -29
  317. package/es6/Monitoring/Management/Power/handlePowerRequests.js.map +1 -1
  318. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.d.ts +2 -2
  319. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js +15 -25
  320. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js.map +1 -1
  321. package/es6/Monitoring/Management/Screen/handleScreenRequests.d.ts +2 -2
  322. package/es6/Monitoring/Management/Screen/handleScreenRequests.js +19 -29
  323. package/es6/Monitoring/Management/Screen/handleScreenRequests.js.map +1 -1
  324. package/es6/Monitoring/Management/Security/handleSecurityCommands.d.ts +2 -2
  325. package/es6/Monitoring/Management/Security/handleSecurityCommands.js +9 -19
  326. package/es6/Monitoring/Management/Security/handleSecurityCommands.js.map +1 -1
  327. package/es6/Monitoring/Management/Time/handleTimeCommands.d.ts +2 -2
  328. package/es6/Monitoring/Management/Time/handleTimeCommands.js +9 -19
  329. package/es6/Monitoring/Management/Time/handleTimeCommands.js.map +1 -1
  330. package/es6/Monitoring/Management/handleManagementRequests.d.ts +2 -2
  331. package/es6/Monitoring/Management/handleManagementRequests.js +23 -33
  332. package/es6/Monitoring/Management/handleManagementRequests.js.map +1 -1
  333. package/es6/Monitoring/{Montoring.d.ts → Monitoring.d.ts} +1 -0
  334. package/es6/Monitoring/{Montoring.js → Monitoring.js} +12 -23
  335. package/es6/Monitoring/Monitoring.js.map +1 -0
  336. package/es6/Monitoring/NativeCommands/handleNativeCommands.d.ts +2 -2
  337. package/es6/Monitoring/NativeCommands/handleNativeCommands.js +5 -15
  338. package/es6/Monitoring/NativeCommands/handleNativeCommands.js.map +1 -1
  339. package/es6/Monitoring/OSD/handleOsdRequests.d.ts +2 -2
  340. package/es6/Monitoring/OSD/handleOsdRequests.js +5 -15
  341. package/es6/Monitoring/OSD/handleOsdRequests.js.map +1 -1
  342. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.d.ts +2 -2
  343. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js +23 -33
  344. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js.map +1 -1
  345. package/es6/Monitoring/Video/handleVideoRequests.d.ts +2 -2
  346. package/es6/Monitoring/Video/handleVideoRequests.js +36 -9
  347. package/es6/Monitoring/Video/handleVideoRequests.js.map +1 -1
  348. package/es6/Monitoring/handleMonitoringRequests.d.ts +2 -2
  349. package/es6/Monitoring/handleMonitoringRequests.js +6 -16
  350. package/es6/Monitoring/handleMonitoringRequests.js.map +1 -1
  351. package/es6/Sensors/IButton.js +1 -1
  352. package/es6/Sensors/IButton.js.map +1 -1
  353. package/es6/Sensors/IRfidAntenna.js +1 -1
  354. package/es6/Sensors/IRfidAntenna.js.map +1 -1
  355. package/es6/Util/Console/enhancer.js +1 -2
  356. package/es6/Util/Console/enhancer.js.map +1 -1
  357. package/es6/bundle.d.ts +1 -1
  358. package/es6/bundle.js +6 -3
  359. package/es6/bundle.js.map +1 -1
  360. package/es6/fpath.js +34 -1
  361. package/es6/fpath.js.map +1 -1
  362. package/es6/utils/types.d.ts +1 -0
  363. package/es6/{FrontApplet/Input/IKeyUpEventListener.js → utils/types.js} +1 -1
  364. package/es6/utils/types.js.map +1 -0
  365. package/package.json +27 -25
  366. package/CHANGELOG.md +0 -484
  367. package/docs/README.md +0 -5
  368. package/docs/applet-basics.md +0 -272
  369. package/docs/content/js-applet-resources.md +0 -154
  370. package/docs/content/js-browser.md +0 -163
  371. package/docs/content/js-command.md +0 -154
  372. package/docs/content/js-debug.md +0 -36
  373. package/docs/content/js-device-info.md +0 -56
  374. package/docs/content/js-display.md +0 -56
  375. package/docs/content/js-file-system.md +0 -670
  376. package/docs/content/js-fonts.md +0 -115
  377. package/docs/content/js-hardware.md +0 -55
  378. package/docs/content/js-iframes.md +0 -66
  379. package/docs/content/js-input.md +0 -71
  380. package/docs/content/js-offline-cache-media-files.md +0 -257
  381. package/docs/content/js-offline-cache-simple-data.md +0 -129
  382. package/docs/content/js-osd.md +0 -32
  383. package/docs/content/js-proof-of-play.md +0 -60
  384. package/docs/content/js-sensors.md +0 -70
  385. package/docs/content/js-serial.md +0 -165
  386. package/docs/content/js-sync-playback.md +0 -384
  387. package/docs/content/js-video-inputs-internal-ports.md +0 -131
  388. package/docs/content/js-video-stream.md +0 -618
  389. package/docs/content/js-video.md +0 -232
  390. package/docs/management/js-management-application.md +0 -107
  391. package/docs/management/js-management-audio.md +0 -44
  392. package/docs/management/js-management-debug.md +0 -40
  393. package/docs/management/js-management-firmware.md +0 -93
  394. package/docs/management/js-management-management.md +0 -178
  395. package/docs/management/js-management-monitoring-commands.md +0 -107
  396. package/docs/management/js-management-monitors.md +0 -55
  397. package/docs/management/js-management-native-commands-mdc.md +0 -90
  398. package/docs/management/js-management-network.md +0 -223
  399. package/docs/management/js-management-os.md +0 -62
  400. package/docs/management/js-management-package.md +0 -48
  401. package/docs/management/js-management-power.md +0 -175
  402. package/docs/management/js-management-proxy.md +0 -81
  403. package/docs/management/js-management-remote-control.md +0 -58
  404. package/docs/management/js-management-screen.md +0 -225
  405. package/docs/management/js-management-security.md +0 -71
  406. package/docs/management/js-management-time.md +0 -161
  407. package/docs/management/js-management-wifi.md +0 -341
  408. package/es6/FrontApplet/Command/ICommandEventListener.d.ts +0 -6
  409. package/es6/FrontApplet/Command/ICommandEventListener.js +0 -3
  410. package/es6/FrontApplet/Command/ICommandEventListener.js.map +0 -1
  411. package/es6/FrontApplet/Input/IKeyUpEventListener.d.ts +0 -5
  412. package/es6/FrontApplet/Input/IKeyUpEventListener.js.map +0 -1
  413. package/es6/FrontApplet/Management/Firmware/FirmwareType.d.ts +0 -4
  414. package/es6/FrontApplet/Management/Firmware/FirmwareType.js +0 -9
  415. package/es6/FrontApplet/Management/Firmware/FirmwareType.js.map +0 -1
  416. package/es6/FrontApplet/Stream/streamListeners.d.ts +0 -10
  417. package/es6/FrontApplet/Stream/streamListeners.js.map +0 -1
  418. package/es6/FrontApplet/Video/IVideoEventListener.d.ts +0 -5
  419. package/es6/FrontApplet/Video/IVideoEventListener.js +0 -3
  420. package/es6/FrontApplet/Video/IVideoEventListener.js.map +0 -1
  421. package/es6/Monitoring/Montoring.js.map +0 -1
@@ -1,15 +1,49 @@
1
1
  import ICommand from './ICommand';
2
2
  import IPostMessage from '../IPostMessage';
3
3
  import ICommandDispatchToAppletMessage from './ICommandDispatchToAppletMessage';
4
- import ICommandEventListener from './ICommandEventListener';
4
+ import ICommandEvent from './ICommandEvent';
5
+ /**
6
+ * The `sos.command` API groups together methods for sending logs and receiving commands from signageOS.
7
+ */
5
8
  export default class Command {
6
9
  private messagePrefix;
7
10
  private postMessage;
8
11
  static MESSAGE_PREFIX: string;
9
12
  private eventEmitter;
13
+ /** @internal */
10
14
  constructor(messagePrefix: string, postMessage: IPostMessage<void>);
11
- dispatch<TCommand extends ICommand = ICommand>(command: TCommand): Promise<void>;
12
- onCommand<TCommand extends ICommand = ICommand>(listener: ICommandEventListener<TCommand>): void;
15
+ /**
16
+ * The `dispatch()` method dispatches a new log record to the signageOS.
17
+ *
18
+ * :::warning[Dispatch throttling]
19
+ *
20
+ * Sending commands from an applet is throttled, this means that after if the dispatch frequency is too high, some commands may be
21
+ * discarded. Currently the limit is 30 commands per 30 seconds, although this may not be fully accurate and it's not possible to know the
22
+ * exact limit.
23
+ *
24
+ * :::
25
+ *
26
+ * @since 1.0.3
27
+ *
28
+ * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/ |Sending commands}
29
+ *
30
+ * @example
31
+ * await sos.command.dispatch({
32
+ * type: 'Files.StartLoading',
33
+ * fileName: 'my-file',
34
+ * fileType: 'txt'
35
+ * });
36
+ */
37
+ dispatch<TCommand extends ICommand>(command: TCommand): Promise<void>;
38
+ /**
39
+ * The `onCommand()` method sets up a listener, which is called whenever a new command from signageOS is received.
40
+ *
41
+ * @since 1.0.3
42
+ *
43
+ * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving |Receiving commands}
44
+ */
45
+ onCommand(listener: (command: ICommandEvent) => void): void;
46
+ /** @internal */
13
47
  handleMessageData(data: ICommandDispatchToAppletMessage): void;
14
48
  private getMessage;
15
49
  private checkTypeValidity;
@@ -1,38 +1,68 @@
1
1
  "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
10
4
  };
11
5
  Object.defineProperty(exports, "__esModule", { value: true });
12
6
  const events_1 = require("events");
13
- const AppletCommandError_1 = require("../Error/AppletCommandError");
14
- const ErrorCodes_1 = require("../Error/ErrorCodes");
15
- const ErrorSuggestions_1 = require("../Error/ErrorSuggestions");
16
- const Validate_1 = require("../Validate/Validate");
7
+ const AppletCommandError_1 = __importDefault(require("../Error/AppletCommandError"));
8
+ const ErrorCodes_1 = __importDefault(require("../Error/ErrorCodes"));
9
+ const ErrorSuggestions_1 = __importDefault(require("../Error/ErrorSuggestions"));
10
+ const Validate_1 = __importDefault(require("../Validate/Validate"));
11
+ /**
12
+ * The `sos.command` API groups together methods for sending logs and receiving commands from signageOS.
13
+ */
17
14
  class Command {
15
+ messagePrefix;
16
+ postMessage;
17
+ static MESSAGE_PREFIX = 'command';
18
+ eventEmitter;
19
+ /** @internal */
18
20
  constructor(messagePrefix, postMessage) {
19
21
  this.messagePrefix = messagePrefix;
20
22
  this.postMessage = postMessage;
21
23
  this.eventEmitter = new events_1.EventEmitter();
22
24
  }
23
- dispatch(command) {
24
- return __awaiter(this, void 0, void 0, function* () {
25
- this.checkTypeValidity(command.type);
26
- yield this.postMessage({
27
- type: this.getMessage('dispatch'),
28
- command,
29
- });
25
+ /**
26
+ * The `dispatch()` method dispatches a new log record to the signageOS.
27
+ *
28
+ * :::warning[Dispatch throttling]
29
+ *
30
+ * Sending commands from an applet is throttled, this means that after if the dispatch frequency is too high, some commands may be
31
+ * discarded. Currently the limit is 30 commands per 30 seconds, although this may not be fully accurate and it's not possible to know the
32
+ * exact limit.
33
+ *
34
+ * :::
35
+ *
36
+ * @since 1.0.3
37
+ *
38
+ * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/sending/ |Sending commands}
39
+ *
40
+ * @example
41
+ * await sos.command.dispatch({
42
+ * type: 'Files.StartLoading',
43
+ * fileName: 'my-file',
44
+ * fileType: 'txt'
45
+ * });
46
+ */
47
+ async dispatch(command) {
48
+ this.checkTypeValidity(command.type);
49
+ await this.postMessage({
50
+ type: this.getMessage('dispatch'),
51
+ command,
30
52
  });
31
53
  }
54
+ /**
55
+ * The `onCommand()` method sets up a listener, which is called whenever a new command from signageOS is received.
56
+ *
57
+ * @since 1.0.3
58
+ *
59
+ * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving |Receiving commands}
60
+ */
32
61
  onCommand(listener) {
33
62
  (0, Validate_1.default)({ listener }).required().function();
34
63
  this.eventEmitter.addListener('command', listener);
35
64
  }
65
+ /** @internal */
36
66
  handleMessageData(data) {
37
67
  switch (data.type) {
38
68
  case this.getMessage('dispatch_to_applet'):
@@ -69,6 +99,5 @@ class Command {
69
99
  .lengthMax(100);
70
100
  }
71
101
  }
72
- Command.MESSAGE_PREFIX = 'command';
73
102
  exports.default = Command;
74
103
  //# sourceMappingURL=Command.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../src/FrontApplet/Command/Command.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAAsC;AAKtC,oEAA6D;AAC7D,oDAA6C;AAC7C,gEAAyD;AACzD,mDAA4C;AAE5C,MAAqB,OAAO;IAK3B,YACS,aAAqB,EACrB,WAA+B;QAD/B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAoB;QAEvC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAEY,QAAQ,CAAuC,OAAiB;;YAC5E,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;gBACjC,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;KAAA;IAEM,SAAS,CAAuC,QAAyC;QAC/F,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEM,iBAAiB,CAAC,IAAqC;QAC7D,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;gBACzC,MAAM,YAAY,GAAG;oBACpB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gBAChD,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;IAEO,iBAAiB,CAAC,IAAY;QACrC,MAAM,KAAK,GAAG,sBAAsB,CAAC;QAErC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,oBAAU,CAAC,sBAAsB;YACvC,UAAU,EAAE,0BAAgB,CAAC,sBAAsB;SACnD,CAAC,CACF;aACA,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,KAAK,CAAC,CAAC;QAErB,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,qCAAqC;YAC9C,IAAI,EAAE,oBAAU,CAAC,wBAAwB;SACzC,CAAC,CACF;aACA,SAAS,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;;AAlEa,sBAAc,GAAW,SAAS,CAAC;kBAD7B,OAAO"}
1
+ {"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../src/FrontApplet/Command/Command.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAItC,qFAA6D;AAC7D,qEAA6C;AAC7C,iFAAyD;AACzD,oEAA4C;AAG5C;;GAEG;AACH,MAAqB,OAAO;IAOlB;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEzC,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA+B;QAD/B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAoB;QAEvC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,QAAQ,CAA4B,OAAiB;QACjE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,QAA0C;QAC1D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAqC;QAC7D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;gBACzC,MAAM,YAAY,GAAG;oBACpB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gBAChD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;IAEO,iBAAiB,CAAC,IAAY;QACrC,MAAM,KAAK,GAAG,sBAAsB,CAAC;QAErC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,mCAAmC;YAC5C,IAAI,EAAE,oBAAU,CAAC,sBAAsB;YACvC,UAAU,EAAE,0BAAgB,CAAC,sBAAsB;SACnD,CAAC,CACF;aACA,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,KAAK,CAAC,CAAC;QAErB,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,CACR,IAAI,4BAAkB,CAAC;YACtB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,qCAAqC;YAC9C,IAAI,EAAE,oBAAU,CAAC,wBAAwB;SACzC,CAAC,CACF;aACA,SAAS,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;;AAlGF,0BAmGC"}
@@ -1,6 +1,10 @@
1
1
  import ICommand from './ICommand';
2
- interface ICommandEvent<TCommand extends ICommand> {
2
+ interface ICommandEvent {
3
3
  type: 'command';
4
- command: TCommand;
4
+ command: ICommand;
5
5
  }
6
6
  export default ICommandEvent;
7
+ export interface ITypedCommandEvent<T extends ICommand> {
8
+ type: 'command';
9
+ command: T;
10
+ }
@@ -5,12 +5,15 @@ export default class Connect {
5
5
  static MESSAGE_PREFIX: string;
6
6
  private connectedBaseUrl;
7
7
  private errorsMap;
8
+ /** @internal */
8
9
  constructor(window: Window, messagePrefix: string);
10
+ /** @internal */
9
11
  handleMessageData(data: IConnectMessage): void;
10
12
  private updateConnectedBaseUrl;
11
13
  private interceptConsoleLogging;
12
14
  private bindErrorHandling;
13
15
  private polyfillErrorWithStack;
14
16
  private polyfillErrorEvent;
17
+ private pushError;
15
18
  private getMessage;
16
19
  }
@@ -1,18 +1,57 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
2
35
  Object.defineProperty(exports, "__esModule", { value: true });
3
36
  const enhancer_1 = require("../../Util/Console/enhancer");
4
- const util = require("util");
37
+ const util = __importStar(require("util"));
38
+ const MAX_ERRORS_BUFFER_COUNT = 50;
5
39
  class Connect {
40
+ window;
41
+ messagePrefix;
42
+ static MESSAGE_PREFIX = 'connect';
43
+ connectedBaseUrl = null;
44
+ errorsMap = {};
45
+ /** @internal */
6
46
  constructor(window, messagePrefix) {
7
47
  this.window = window;
8
48
  this.messagePrefix = messagePrefix;
9
- this.connectedBaseUrl = null;
10
- this.errorsMap = {};
11
49
  this.polyfillErrorWithStack();
12
50
  this.polyfillErrorEvent();
13
51
  this.interceptConsoleLogging();
14
52
  this.bindErrorHandling();
15
53
  }
54
+ /** @internal */
16
55
  handleMessageData(data) {
17
56
  switch (data.type) {
18
57
  case this.getMessage('update'):
@@ -28,7 +67,7 @@ class Connect {
28
67
  (0, enhancer_1.enhanceStandardConsoleLogging)((type, ...args) => {
29
68
  if (this.connectedBaseUrl) {
30
69
  const serializedArgs = args.map((message) => util.inspect(message, true, 5, false));
31
- fetch(`${this.connectedBaseUrl}/log`, {
70
+ void fetch(`${this.connectedBaseUrl}/log`, {
32
71
  method: 'POST',
33
72
  headers: {
34
73
  'Content-Type': 'application/json',
@@ -44,7 +83,7 @@ class Connect {
44
83
  bindErrorHandling() {
45
84
  this.window.addEventListener('error', (event) => {
46
85
  if (this.connectedBaseUrl) {
47
- fetch(`${this.connectedBaseUrl}/error`, {
86
+ void fetch(`${this.connectedBaseUrl}/error`, {
48
87
  method: 'POST',
49
88
  headers: {
50
89
  'Content-Type': 'application/json',
@@ -82,7 +121,7 @@ class Connect {
82
121
  this.constructor = ErrorWithStack;
83
122
  this.message = message;
84
123
  this.stack = stack;
85
- self.errorsMap[message] = this;
124
+ self.pushError(this);
86
125
  }
87
126
  const ErrorWithStack = ErrorWithStackImpl;
88
127
  ErrorWithStack.prototype = ErrorOrig.prototype;
@@ -101,14 +140,23 @@ class Connect {
101
140
  const error = this.errorsMap[errorMessage];
102
141
  delete this.errorsMap[errorMessage];
103
142
  event.error = error;
143
+ console.warn('Error was polyfilled with not exact algorithm and may not be accurate', error);
104
144
  }
105
145
  }
106
146
  });
107
147
  }
148
+ pushError(error) {
149
+ this.errorsMap[error.message] = error;
150
+ const keys = Object.keys(this.errorsMap);
151
+ if (keys.length > MAX_ERRORS_BUFFER_COUNT) {
152
+ // Remove the oldest error
153
+ const oldestKey = keys[0];
154
+ delete this.errorsMap[oldestKey];
155
+ }
156
+ }
108
157
  getMessage(name) {
109
158
  return this.messagePrefix + '.' + Connect.MESSAGE_PREFIX + '.' + name;
110
159
  }
111
160
  }
112
- Connect.MESSAGE_PREFIX = 'connect';
113
161
  exports.default = Connect;
114
162
  //# sourceMappingURL=Connect.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Connect.js","sourceRoot":"","sources":["../../../src/FrontApplet/Connect/Connect.ts"],"names":[],"mappings":";;AAAA,0DAA4E;AAE5E,6BAA6B;AAE7B,MAAqB,OAAO;IAM3B,YACiB,MAAc,EACtB,aAAqB;QADb,WAAM,GAAN,MAAM,CAAQ;QACtB,kBAAa,GAAb,aAAa,CAAQ;QALtB,qBAAgB,GAAkB,IAAI,CAAC;QACvC,cAAS,GAA0B,EAAE,CAAC;QAM7C,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC1B,CAAC;IAEM,iBAAiB,CAAC,IAAqB;QAC7C,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAC7B,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACnD,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEO,sBAAsB,CAAC,gBAA+B;QAC7D,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC1C,CAAC;IAEO,uBAAuB;QAC9B,IAAA,wCAA6B,EAAC,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;gBACpF,KAAK,CAAC,GAAG,IAAI,CAAC,gBAAgB,MAAM,EAAE;oBACrC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACR,cAAc,EAAE,kBAAkB;qBAClC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,IAAI;wBACJ,IAAI,EAAE,cAAc;qBACpB,CAAC;iBACF,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,iBAAiB;QACxB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBAC1B,KAAK,CAAC,GAAG,IAAI,CAAC,gBAAgB,QAAQ,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACR,cAAc,EAAE,kBAAkB;qBAClC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,OAAO,EAAE,KAAK,CAAC,OAAO;wBACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;wBACxB,MAAM,EAAE,KAAK,CAAC,MAAM;wBACpB,KAAK,EAAE,KAAK,CAAC,KAAK;wBAClB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC;qBAChD,CAAC;iBACF,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,sBAAsB;QAC7B,MAAM,SAAS,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,SAAS,CAAC,KAAK,KAAK,SAAS,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC;YAClB,+DAA+D;YAC/D,MAAM,SAAS,GAAG,KAAK,CAAC;YAExB,SAAS,kBAAkB,CAAmC,OAAe;gBAC5E,IAAI,CAAC,CAAC,IAAI,YAAY,cAAc,CAAC,EAAE;oBACtC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;iBACnC;gBACD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;gBACpB,IAAI,KAAK,CAAC;gBACV,IAAI;oBACH,sDAAsD;oBACtD,MAAM,IAAI,SAAS,EAAE,CAAC;iBACtB;gBAAC,OAAO,KAAK,EAAE;oBACf,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;iBACpB;gBACD,IAAI,CAAC,WAAW,GAAG,cAAc,CAAC;gBAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;gBACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;gBACnB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YAChC,CAAC;YACD,MAAM,cAAc,GAAG,kBAA+C,CAAC;YACvE,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;YAC9C,IAAI,CAAC,MAAc,CAAC,KAAK,GAAG,cAAc,CAAC;SAC5C;IACF,CAAC;IAEO,kBAAkB;QACzB,4EAA4E;QAC5E,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC9B,uHAAuH;gBACvH,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,GAAG;oBAClE,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1C,CAAC,CAAC,CAAC;gBACH,IAAI,YAAY,EAAE;oBACjB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;oBAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;oBACnC,KAA4B,CAAC,KAAK,GAAG,KAAK,CAAC;iBAC5C;aACD;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;;AAnHa,sBAAc,GAAW,SAAS,AAApB,CAAqB;kBAD7B,OAAO"}
1
+ {"version":3,"file":"Connect.js","sourceRoot":"","sources":["../../../src/FrontApplet/Connect/Connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAA4E;AAE5E,2CAA6B;AAE7B,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAEnC,MAAqB,OAAO;IAQV;IACR;IARF,MAAM,CAAC,cAAc,GAAW,SAAS,CAAC;IAEzC,gBAAgB,GAAkB,IAAI,CAAC;IACvC,SAAS,GAA0B,EAAE,CAAC;IAE9C,gBAAgB;IAChB,YACiB,MAAc,EACtB,aAAqB;QADb,WAAM,GAAN,MAAM,CAAQ;QACtB,kBAAa,GAAb,aAAa,CAAQ;QAE7B,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC1B,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAqB;QAC7C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAC7B,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACnD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,sBAAsB,CAAC,gBAA+B;QAC7D,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC1C,CAAC;IAEO,uBAAuB;QAC9B,IAAA,wCAA6B,EAAC,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;gBACpF,KAAK,KAAK,CAAC,GAAG,IAAI,CAAC,gBAAgB,MAAM,EAAE;oBAC1C,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACR,cAAc,EAAE,kBAAkB;qBAClC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,IAAI;wBACJ,IAAI,EAAE,cAAc;qBACpB,CAAC;iBACF,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,iBAAiB;QACxB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,KAAK,KAAK,CAAC,GAAG,IAAI,CAAC,gBAAgB,QAAQ,EAAE;oBAC5C,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACR,cAAc,EAAE,kBAAkB;qBAClC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,OAAO,EAAE,KAAK,CAAC,OAAO;wBACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;wBACxB,MAAM,EAAE,KAAK,CAAC,MAAM;wBACpB,KAAK,EAAE,KAAK,CAAC,KAAK;wBAClB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC;qBAChD,CAAC;iBACF,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,sBAAsB;QAC7B,MAAM,SAAS,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,SAAS,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC;YAClB,+DAA+D;YAC/D,MAAM,SAAS,GAAG,KAAK,CAAC;YAExB,SAAS,kBAAkB,CAAmC,OAAe;gBAC5E,IAAI,CAAC,CAAC,IAAI,YAAY,cAAc,CAAC,EAAE,CAAC;oBACvC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;gBACpC,CAAC;gBACD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;gBACpB,IAAI,KAAyB,CAAC;gBAC9B,IAAI,CAAC;oBACJ,sDAAsD;oBACtD,MAAM,IAAI,SAAS,EAAE,CAAC;gBACvB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBAChB,KAAK,GAAI,KAAe,CAAC,KAAK,CAAC;gBAChC,CAAC;gBACD,IAAI,CAAC,WAAW,GAAG,cAAc,CAAC;gBAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;gBACvB,IAAI,CAAC,KAAK,GAAG,KAAM,CAAC;gBACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YACD,MAAM,cAAc,GAAG,kBAA+C,CAAC;YACvE,cAAc,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;YAC9C,IAAI,CAAC,MAAc,CAAC,KAAK,GAAG,cAAc,CAAC;QAC7C,CAAC;IACF,CAAC;IAEO,kBAAkB;QACzB,4EAA4E;QAC5E,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,uHAAuH;gBACvH,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,GAAG;oBAClE,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1C,CAAC,CAAC,CAAC;gBACH,IAAI,YAAY,EAAE,CAAC;oBAClB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;oBAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;oBACnC,KAA4B,CAAC,KAAK,GAAG,KAAK,CAAC;oBAC5C,OAAO,CAAC,IAAI,CAAC,uEAAuE,EAAE,KAAK,CAAC,CAAC;gBAC9F,CAAC;YACF,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,SAAS,CAAC,KAAY;QAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,MAAM,GAAG,uBAAuB,EAAE,CAAC;YAC3C,0BAA0B;YAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACvE,CAAC;;AAjIF,0BAkIC"}
@@ -1,4 +1,4 @@
1
- import IMessage from "../IMessage";
1
+ import IMessage from '../IMessage';
2
2
  export interface IConnectMessage extends IMessage {
3
3
  connectedBaseUrl: string | null;
4
4
  }
@@ -1,18 +1,32 @@
1
- /// <reference types="node" />
2
1
  import { EventEmitter } from 'events';
3
2
  import IPostMessage from '../IPostMessage';
4
3
  import IDebug, { IDebugSetWeinreMessage, WeinreData } from './IDebug';
4
+ /**
5
+ * The `sos.debug` API groups together methods for checking the state of remote debug mode.
6
+ */
5
7
  export default class Debug extends EventEmitter implements IDebug {
6
8
  readonly window: Window & WeinreData;
7
9
  private messagePrefix;
8
10
  private postMessage;
9
11
  static MESSAGE_PREFIX: string;
10
12
  static DEBUG_CHANGED: string;
13
+ /** @internal */
11
14
  constructor(window: Window & WeinreData, messagePrefix: string, postMessage: IPostMessage<any>);
15
+ /**
16
+ * The `isRemoteDebugEnabled()` method returns the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug).
17
+ *
18
+ * @since 5.8.0
19
+ */
12
20
  isRemoteDebugEnabled(): Promise<boolean>;
21
+ /**
22
+ * The `onRemoteDebugChanged()` method sets up a listener, which is called whenever the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug) is changed.
23
+ *
24
+ * @since
25
+ */
13
26
  onRemoteDebugChanged(listener: (data: {
14
27
  enabled: boolean;
15
28
  }) => void): void;
29
+ /** @internal */
16
30
  handleMessageData(data: IDebugSetWeinreMessage): void;
17
31
  private getMessage;
18
32
  }
@@ -1,35 +1,47 @@
1
1
  "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
10
4
  };
11
5
  Object.defineProperty(exports, "__esModule", { value: true });
12
6
  const events_1 = require("events");
13
- const Validate_1 = require("../Validate/Validate");
7
+ const Validate_1 = __importDefault(require("../Validate/Validate"));
8
+ /**
9
+ * The `sos.debug` API groups together methods for checking the state of remote debug mode.
10
+ */
14
11
  class Debug extends events_1.EventEmitter {
12
+ window;
13
+ messagePrefix;
14
+ postMessage;
15
+ static MESSAGE_PREFIX = 'debug';
16
+ static DEBUG_CHANGED = 'debug.changed';
17
+ /** @internal */
15
18
  constructor(window, messagePrefix, postMessage) {
16
19
  super();
17
20
  this.window = window;
18
21
  this.messagePrefix = messagePrefix;
19
22
  this.postMessage = postMessage;
20
23
  }
21
- isRemoteDebugEnabled() {
22
- return __awaiter(this, void 0, void 0, function* () {
23
- const { isEnabled } = yield this.postMessage({
24
- type: this.getMessage('is_remote_enabled'),
25
- });
26
- return isEnabled;
24
+ /**
25
+ * The `isRemoteDebugEnabled()` method returns the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug).
26
+ *
27
+ * @since 5.8.0
28
+ */
29
+ async isRemoteDebugEnabled() {
30
+ const { isEnabled } = await this.postMessage({
31
+ type: this.getMessage('is_remote_enabled'),
27
32
  });
33
+ return isEnabled;
28
34
  }
35
+ /**
36
+ * The `onRemoteDebugChanged()` method sets up a listener, which is called whenever the state of the [Device debug](https://docs.signageos.io/hc/en-us/articles/4416366711442-Device-debug) is changed.
37
+ *
38
+ * @since
39
+ */
29
40
  onRemoteDebugChanged(listener) {
30
41
  (0, Validate_1.default)({ listener }).required().function();
31
42
  this.addListener(Debug.DEBUG_CHANGED, (data) => listener({ enabled: data.enabled }));
32
43
  }
44
+ /** @internal */
33
45
  handleMessageData(data) {
34
46
  switch (data.type) {
35
47
  case this.getMessage('configure'):
@@ -58,7 +70,5 @@ class Debug extends events_1.EventEmitter {
58
70
  return this.messagePrefix + '.' + Debug.MESSAGE_PREFIX + '.' + name;
59
71
  }
60
72
  }
61
- Debug.MESSAGE_PREFIX = 'debug';
62
- Debug.DEBUG_CHANGED = 'debug.changed';
63
73
  exports.default = Debug;
64
74
  //# sourceMappingURL=Debug.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../src/FrontApplet/Debug/Debug.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAAsC;AAEtC,mDAA4C;AAG5C,MAAqB,KAAM,SAAQ,qBAAY;IAI9C,YACiB,MAA2B,EACnC,aAAqB,EACrB,WAA8B;QAEtC,KAAK,EAAE,CAAC;QAJQ,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IAGvC,CAAC;IAEY,oBAAoB;;YAChC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;aAC1C,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QAClB,CAAC;KAAA;IAEM,oBAAoB,CAAC,QAA8C;QACzE,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACtF,CAAC;IAEM,iBAAiB,CAAC,IAA4B;QACpD,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE;oBAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,OAAO,EAAE;oBACjB,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC;oBACvC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,EAAE,CAAC;oBACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;wBAChC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;wBAC5D,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,8BAA8B,CAAC;wBACvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;wBAE9C,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;qBAClC;iBACD;qBAAM;oBACN,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,SAAS,CAAC;iBACvC;gBACD,MAAM;YACP,QAAQ;SACR;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;;AAnDa,oBAAc,GAAW,OAAO,CAAC;AACjC,mBAAa,GAAW,eAAe,CAAC;kBAFlC,KAAK"}
1
+ {"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../src/FrontApplet/Debug/Debug.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oEAA4C;AAG5C;;GAEG;AACH,MAAqB,KAAM,SAAQ,qBAAY;IAM7B;IACR;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,OAAO,CAAC;IACxC,MAAM,CAAC,aAAa,GAAW,eAAe,CAAC;IAEtD,gBAAgB;IAChB,YACiB,MAA2B,EACnC,aAAqB,EACrB,WAA8B;QAEtC,KAAK,EAAE,CAAC;QAJQ,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IAGvC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB;QAChC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,QAA8C;QACzE,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAA4B;QACpD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE;oBAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;iBACrB,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClB,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC;oBACvC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,EAAE,CAAC;oBACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;wBACjC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;wBAC5D,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,8BAA8B,CAAC;wBACvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;wBAE9C,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;oBACnC,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,SAAS,CAAC;gBACxC,CAAC;gBACD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;;AAhEF,wBAiEC"}
@@ -1,4 +1,4 @@
1
- import * as Debug from 'debug';
1
+ import Debug from 'debug';
2
2
  export interface DebugConfig {
3
3
  /**
4
4
  * Globally changes logs to contain serialized arguments when logging method calls.
@@ -17,8 +17,8 @@ export declare const createDebugMethod: (localDebug: Debug.IDebugger) => (origin
17
17
  * @param namespace Namespace of the debug logs. Run program with env variable DEBUG=<namespace> to enable the logs.
18
18
  */
19
19
  export declare function debug(namespace: string, debugFactory?: Debug.Debug & {
20
- debug: Debug.Debug;
21
- default: Debug.Debug;
20
+ debug: debug.Debug;
21
+ default: debug.Debug;
22
22
  }): (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
23
23
  export declare function getDebugConfig(): {
24
24
  serialize: boolean;
@@ -1,7 +1,13 @@
1
1
  "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.setDebugConfig = exports.getDebugConfig = exports.debug = exports.createDebugMethod = void 0;
4
- const Debug = require("debug");
6
+ exports.createDebugMethod = void 0;
7
+ exports.debug = debug;
8
+ exports.getDebugConfig = getDebugConfig;
9
+ exports.setDebugConfig = setDebugConfig;
10
+ const debug_1 = __importDefault(require("debug"));
5
11
  const generator_1 = require("../Hash/generator");
6
12
  let config = {
7
13
  serialize: false,
@@ -58,7 +64,7 @@ function serializeArgsIfEnabled(args) {
58
64
  *
59
65
  * @param namespace Namespace of the debug logs. Run program with env variable DEBUG=<namespace> to enable the logs.
60
66
  */
61
- function debug(namespace, debugFactory = Debug) {
67
+ function debug(namespace, debugFactory = debug_1.default) {
62
68
  const debugMethod = (0, exports.createDebugMethod)(debugFactory(namespace));
63
69
  return function (_target, propertyKey, descriptor) {
64
70
  const originalMethod = descriptor.value;
@@ -67,13 +73,13 @@ function debug(namespace, debugFactory = Debug) {
67
73
  };
68
74
  };
69
75
  }
70
- exports.debug = debug;
71
76
  function getDebugConfig() {
72
77
  return config;
73
78
  }
74
- exports.getDebugConfig = getDebugConfig;
75
79
  function setDebugConfig(newConfig) {
76
- config = Object.assign(Object.assign({}, config), newConfig);
80
+ config = {
81
+ ...config,
82
+ ...newConfig,
83
+ };
77
84
  }
78
- exports.setDebugConfig = setDebugConfig;
79
85
  //# sourceMappingURL=debugDecorator.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"debugDecorator.js","sourceRoot":"","sources":["../../../src/FrontApplet/Debug/debugDecorator.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,iDAAuD;AAYvD,IAAI,MAAM,GAAG;IACZ,SAAS,EAAE,KAAK;IAChB,WAAW,EAAE,KAAK;CAClB,CAAC;AAEF,SAAS,cAAc,CAAC,KAAW;IAClC,IAAI,MAAM,CAAC,WAAW,EAAE;QACvB,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QACxD,OAAO,KAAK,QAAQ,KAAK,CAAC;KAC1B;AACF,CAAC;AAEM,MAAM,iBAAiB,GAAG,CAAC,UAA2B,EAAE,EAAE,CAAC,CAAC,cAAwB,EAAE,IAAS,EAAE,KAAa,EAAE,IAAW,EAAE,EAAE;IACrI,MAAM,aAAa,GAAG,IAAA,8BAAkB,EAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC;IAEzB,UAAU,CAAC,YAAY,KAAK,KAAK,aAAa,GAAG,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,IAAI;QACH,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,WAAW,YAAY,OAAO,EAAE;YACnC,OAAO,WAAW;iBAChB,IAAI,CAAC,CAAC,MAAW,EAAE,EAAE;gBACrB,UAAU,CAAC,WAAW,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;gBAClF,OAAO,MAAM,CAAC;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE;gBACrB,UAAU,CAAC,QAAQ,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC9E,MAAM,KAAK,CAAC;YACb,CAAC,CAAC,CAAC;SACJ;aAAM;YACN,UAAU,CAAC,WAAW,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;YACvF,OAAO,WAAW,CAAC;SACnB;KACD;IAAC,OAAO,KAAK,EAAE;QACf,UAAU,CAAC,QAAQ,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC9E,MAAM,KAAK,CAAC;KACZ;AACF,CAAC,CAAC;AAzBW,QAAA,iBAAiB,qBAyB5B;AAEF,SAAS,sBAAsB,CAAC,IAAW;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,EAAE;YAChE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;SAC3B;aAAM;YACN,OAAO,GAAG,CAAC;SACX;IACF,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,KAAK,CAAC,SAAiB,EAAE,YAAY,GAAG,KAAK;IAC5D,MAAM,WAAW,GAAG,IAAA,yBAAiB,EAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/D,OAAO,UAAU,OAAY,EAAE,WAAmB,EAAE,UAA8B;QACjF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;YAC1C,OAAO,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;QAC3F,CAAC,CAAC;IACH,CAAC,CAAC;AACH,CAAC;AARD,sBAQC;AAED,SAAgB,cAAc;IAC7B,OAAO,MAAM,CAAC;AACf,CAAC;AAFD,wCAEC;AAED,SAAgB,cAAc,CAAC,SAA+B;IAC7D,MAAM,mCACF,MAAM,GACN,SAAS,CACZ,CAAC;AACH,CAAC;AALD,wCAKC"}
1
+ {"version":3,"file":"debugDecorator.js","sourceRoot":"","sources":["../../../src/FrontApplet/Debug/debugDecorator.ts"],"names":[],"mappings":";;;;;;AAqEA,sBAQC;AAED,wCAEC;AAED,wCAKC;AAxFD,kDAA0B;AAC1B,iDAAuD;AAYvD,IAAI,MAAM,GAAG;IACZ,SAAS,EAAE,KAAK;IAChB,WAAW,EAAE,KAAK;CAClB,CAAC;AAEF,SAAS,cAAc,CAAC,KAAW;IAClC,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;QACxD,OAAO,KAAK,QAAQ,KAAK,CAAC;IAC3B,CAAC;AACF,CAAC;AAEM,MAAM,iBAAiB,GAAG,CAAC,UAA2B,EAAE,EAAE,CAAC,CAAC,cAAwB,EAAE,IAAS,EAAE,KAAa,EAAE,IAAW,EAAE,EAAE;IACrI,MAAM,aAAa,GAAG,IAAA,8BAAkB,EAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC;IAEzB,UAAU,CAAC,YAAY,KAAK,KAAK,aAAa,GAAG,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,IAAI,CAAC;QACJ,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,WAAW,YAAY,OAAO,EAAE,CAAC;YACpC,OAAO,WAAW;iBAChB,IAAI,CAAC,CAAC,MAAW,EAAE,EAAE;gBACrB,UAAU,CAAC,WAAW,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;gBAClF,OAAO,MAAM,CAAC;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE;gBACrB,UAAU,CAAC,QAAQ,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC9E,MAAM,KAAK,CAAC;YACb,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACP,UAAU,CAAC,WAAW,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;YACvF,OAAO,WAAW,CAAC;QACpB,CAAC;IACF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,UAAU,CAAC,QAAQ,KAAK,KAAK,aAAa,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC9E,MAAM,KAAK,CAAC;IACb,CAAC;AACF,CAAC,CAAC;AAzBW,QAAA,iBAAiB,qBAyB5B;AAEF,SAAS,sBAAsB,CAAC,IAAW;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACjE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACP,OAAO,GAAG,CAAC;QACZ,CAAC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,KAAK,CAAC,SAAiB,EAAE,YAAY,GAAG,eAAK;IAC5D,MAAM,WAAW,GAAG,IAAA,yBAAiB,EAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/D,OAAO,UAAU,OAAY,EAAE,WAAmB,EAAE,UAA8B;QACjF,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;YAC1C,OAAO,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;QAC3F,CAAC,CAAC;IACH,CAAC,CAAC;AACH,CAAC;AAED,SAAgB,cAAc;IAC7B,OAAO,MAAM,CAAC;AACf,CAAC;AAED,SAAgB,cAAc,CAAC,SAA+B;IAC7D,MAAM,GAAG;QACR,GAAG,MAAM;QACT,GAAG,SAAS;KACZ,CAAC;AACH,CAAC"}
@@ -1,12 +1,35 @@
1
1
  import IPostMessage from '../IPostMessage';
2
2
  import { IDeviceInfo, IDeviceLocation, IOrganizationTag } from './IDeviceInfo';
3
+ /**
4
+ * The `sos.deviceInfo` API groups together methods for retrieving information about the device set in the CloudControl, such as location or
5
+ * tags.
6
+ */
3
7
  export default class DeviceInfo implements IDeviceInfo {
4
8
  private messagePrefix;
5
9
  private postMessage;
6
10
  static MESSAGE_PREFIX: string;
11
+ /** @internal */
7
12
  constructor(messagePrefix: string, postMessage: IPostMessage<any>);
13
+ /**
14
+ * The `getLocation()` method returns location of the device. Location is requested from server on application start, automatically
15
+ * updated when changed and persisted in local storage.
16
+ *
17
+ * @since 5.2.0
18
+ */
8
19
  getLocation(): Promise<IDeviceLocation | null>;
20
+ /**
21
+ * The `getOrganizationTags()` method returns all tags assigned to the device. Tags are requested from server on application start, automatically
22
+ * updated when changed and persisted in local storage.
23
+ *
24
+ * @since 5.2.0
25
+ */
9
26
  getOrganizationTags(): Promise<IOrganizationTag[]>;
27
+ /**
28
+ * The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
29
+ * updated when changed and persisted in local storage.
30
+ *
31
+ * @since 6.6.0
32
+ */
10
33
  getDeviceName(): Promise<string>;
11
34
  private getMessage;
12
35
  private geDeviceNameFromTittle;
@@ -1,48 +1,57 @@
1
1
  "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ /**
4
+ * The `sos.deviceInfo` API groups together methods for retrieving information about the device set in the CloudControl, such as location or
5
+ * tags.
6
+ */
12
7
  class DeviceInfo {
8
+ messagePrefix;
9
+ postMessage;
10
+ static MESSAGE_PREFIX = 'device_info';
11
+ /** @internal */
13
12
  constructor(messagePrefix, postMessage) {
14
13
  this.messagePrefix = messagePrefix;
15
14
  this.postMessage = postMessage;
16
15
  }
17
- getLocation() {
18
- return __awaiter(this, void 0, void 0, function* () {
19
- const { location } = yield this.postMessage({ type: this.getMessage('get_location') });
20
- return location;
21
- });
16
+ /**
17
+ * The `getLocation()` method returns location of the device. Location is requested from server on application start, automatically
18
+ * updated when changed and persisted in local storage.
19
+ *
20
+ * @since 5.2.0
21
+ */
22
+ async getLocation() {
23
+ const { location } = await this.postMessage({ type: this.getMessage('get_location') });
24
+ return location;
22
25
  }
23
- getOrganizationTags() {
24
- return __awaiter(this, void 0, void 0, function* () {
25
- const { tags } = yield this.postMessage({ type: this.getMessage('get_organization_tags') });
26
- return tags;
27
- });
26
+ /**
27
+ * The `getOrganizationTags()` method returns all tags assigned to the device. Tags are requested from server on application start, automatically
28
+ * updated when changed and persisted in local storage.
29
+ *
30
+ * @since 5.2.0
31
+ */
32
+ async getOrganizationTags() {
33
+ const { tags } = await this.postMessage({ type: this.getMessage('get_organization_tags') });
34
+ return tags;
28
35
  }
29
- getDeviceName() {
30
- return __awaiter(this, void 0, void 0, function* () {
31
- const deviceName = this.geDeviceNameFromTittle();
32
- return deviceName;
33
- });
36
+ /**
37
+ * The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
38
+ * updated when changed and persisted in local storage.
39
+ *
40
+ * @since 6.6.0
41
+ */
42
+ async getDeviceName() {
43
+ const deviceName = this.geDeviceNameFromTittle();
44
+ return deviceName;
34
45
  }
35
46
  getMessage(name) {
36
47
  return [this.messagePrefix, DeviceInfo.MESSAGE_PREFIX, name].join('.');
37
48
  }
38
49
  geDeviceNameFromTittle() {
39
- var _a;
40
50
  const rootDocument = window.parent.document;
41
51
  const titleElement = rootDocument.head.getElementsByTagName('title')[0];
42
52
  const parentElement = titleElement.parentElement;
43
- return (_a = parentElement.getElementsByTagName('title')[0].innerHTML) !== null && _a !== void 0 ? _a : '';
53
+ return parentElement.getElementsByTagName('title')[0].innerHTML ?? '';
44
54
  }
45
55
  }
46
- DeviceInfo.MESSAGE_PREFIX = 'device_info';
47
56
  exports.default = DeviceInfo;
48
57
  //# sourceMappingURL=DeviceInfo.js.map