@signageos/front-applet 7.1.1 → 8.0.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 (457) hide show
  1. package/dist/bundle.js +5 -5
  2. package/dist/bundle.js.map +1 -1
  3. package/docs/fpath/index.md +316 -0
  4. package/docs/index.md +18 -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 +92 -40
  43. package/es6/FrontApplet/Browser/Browser.js.map +1 -1
  44. package/es6/FrontApplet/Browser/IOpenLinkOptions.d.ts +2 -2
  45. package/es6/FrontApplet/Browser/events.d.ts +1 -1
  46. package/es6/FrontApplet/Browser/events.js +2 -2
  47. package/es6/FrontApplet/Browser/events.js.map +1 -1
  48. package/es6/FrontApplet/Browser/messages.d.ts +2 -2
  49. package/es6/FrontApplet/Command/Command.d.ts +37 -3
  50. package/es6/FrontApplet/Command/Command.js +52 -23
  51. package/es6/FrontApplet/Command/Command.js.map +1 -1
  52. package/es6/FrontApplet/Command/ICommandEvent.d.ts +6 -2
  53. package/es6/FrontApplet/Connect/Connect.d.ts +19 -0
  54. package/es6/FrontApplet/Connect/Connect.js +162 -0
  55. package/es6/FrontApplet/Connect/Connect.js.map +1 -0
  56. package/es6/FrontApplet/Connect/IConnectMessage.d.ts +4 -0
  57. package/es6/FrontApplet/{Stream/streamListeners.js → Connect/IConnectMessage.js} +1 -1
  58. package/es6/FrontApplet/Connect/IConnectMessage.js.map +1 -0
  59. package/es6/FrontApplet/Debug/Debug.d.ts +15 -1
  60. package/es6/FrontApplet/Debug/Debug.js +28 -18
  61. package/es6/FrontApplet/Debug/Debug.js.map +1 -1
  62. package/es6/FrontApplet/Debug/debugDecorator.d.ts +3 -3
  63. package/es6/FrontApplet/Debug/debugDecorator.js +15 -9
  64. package/es6/FrontApplet/Debug/debugDecorator.js.map +1 -1
  65. package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts +23 -0
  66. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js +36 -27
  67. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map +1 -1
  68. package/es6/FrontApplet/Dimensions/coordinationsHelper.js +1 -2
  69. package/es6/FrontApplet/Dimensions/coordinationsHelper.js.map +1 -1
  70. package/es6/FrontApplet/Display/Display.d.ts +25 -3
  71. package/es6/FrontApplet/Display/Display.js +35 -19
  72. package/es6/FrontApplet/Display/Display.js.map +1 -1
  73. package/es6/FrontApplet/Display/IDisplay.d.ts +3 -1
  74. package/es6/FrontApplet/Error/AppletCommandError.js +12 -3
  75. package/es6/FrontApplet/Error/AppletCommandError.js.map +1 -1
  76. package/es6/FrontApplet/Error/AppletError.js +10 -2
  77. package/es6/FrontApplet/Error/AppletError.js.map +1 -1
  78. package/es6/FrontApplet/Error/AppletHardwareError.js +12 -3
  79. package/es6/FrontApplet/Error/AppletHardwareError.js.map +1 -1
  80. package/es6/FrontApplet/Error/AppletOfflineCacheError.js +10 -2
  81. package/es6/FrontApplet/Error/AppletOfflineCacheError.js.map +1 -1
  82. package/es6/FrontApplet/Error/AppletResourcesError.js +12 -3
  83. package/es6/FrontApplet/Error/AppletResourcesError.js.map +1 -1
  84. package/es6/FrontApplet/Error/AppletSecurityError.js +12 -3
  85. package/es6/FrontApplet/Error/AppletSecurityError.js.map +1 -1
  86. package/es6/FrontApplet/Error/AppletStreamError.js +10 -2
  87. package/es6/FrontApplet/Error/AppletStreamError.js.map +1 -1
  88. package/es6/FrontApplet/Error/AppletVideoError.js +12 -3
  89. package/es6/FrontApplet/Error/AppletVideoError.js.map +1 -1
  90. package/es6/FrontApplet/Error/ErrorCodesMessages.js +4 -1
  91. package/es6/FrontApplet/Error/ErrorCodesMessages.js.map +1 -1
  92. package/es6/FrontApplet/Error/ErrorSuggestions.js +1 -0
  93. package/es6/FrontApplet/Error/ErrorSuggestions.js.map +1 -1
  94. package/es6/FrontApplet/Error/FileNotFoundError.js +10 -2
  95. package/es6/FrontApplet/Error/FileNotFoundError.js.map +1 -1
  96. package/es6/FrontApplet/Error/SosError.js +5 -1
  97. package/es6/FrontApplet/Error/SosError.js.map +1 -1
  98. package/es6/FrontApplet/Error/errorHelper.js +5 -6
  99. package/es6/FrontApplet/Error/errorHelper.js.map +1 -1
  100. package/es6/FrontApplet/Exchange/Exchange.js +7 -14
  101. package/es6/FrontApplet/Exchange/Exchange.js.map +1 -1
  102. package/es6/FrontApplet/FileSystem/FileSystem.d.ts +156 -1
  103. package/es6/FrontApplet/FileSystem/FileSystem.js +318 -195
  104. package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -1
  105. package/es6/FrontApplet/FileSystem/HashAlgorithm.d.ts +2 -0
  106. package/es6/FrontApplet/{Input/IKeyUpEventListener.js → FileSystem/HashAlgorithm.js} +1 -1
  107. package/es6/FrontApplet/FileSystem/HashAlgorithm.js.map +1 -0
  108. package/es6/FrontApplet/Font/fontFaceGenerator.js.map +1 -1
  109. package/es6/FrontApplet/FrontApplet.d.ts +57 -4
  110. package/es6/FrontApplet/FrontApplet.js +129 -49
  111. package/es6/FrontApplet/FrontApplet.js.map +1 -1
  112. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts +2 -0
  113. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js +35 -54
  114. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map +1 -1
  115. package/es6/FrontApplet/Hardware/Hardware.d.ts +16 -2
  116. package/es6/FrontApplet/Hardware/Hardware.js +31 -19
  117. package/es6/FrontApplet/Hardware/Hardware.js.map +1 -1
  118. package/es6/FrontApplet/Hardware/IHardware.d.ts +2 -2
  119. package/es6/FrontApplet/Hardware/ISerialPort.d.ts +16 -0
  120. package/es6/FrontApplet/Hardware/ISerialPortOptions.js +1 -1
  121. package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map +1 -1
  122. package/es6/FrontApplet/Hardware/Led/Led.d.ts +8 -0
  123. package/es6/FrontApplet/Hardware/Led/Led.js +22 -20
  124. package/es6/FrontApplet/Hardware/Led/Led.js.map +1 -1
  125. package/es6/FrontApplet/Hardware/SerialPort.d.ts +1 -1
  126. package/es6/FrontApplet/Hardware/SerialPort.js +15 -23
  127. package/es6/FrontApplet/Hardware/SerialPort.js.map +1 -1
  128. package/es6/FrontApplet/Hash/generator.js +2 -3
  129. package/es6/FrontApplet/Hash/generator.js.map +1 -1
  130. package/es6/FrontApplet/Iframe/Iframe.d.ts +9 -8
  131. package/es6/FrontApplet/Iframe/Iframe.js +10 -0
  132. package/es6/FrontApplet/Iframe/Iframe.js.map +1 -1
  133. package/es6/FrontApplet/Input/IInput.d.ts +1 -2
  134. package/es6/FrontApplet/Input/IKeyUpEvent.d.ts +32 -2
  135. package/es6/FrontApplet/Input/IKeyUpEvent.js +32 -0
  136. package/es6/FrontApplet/Input/IKeyUpEvent.js.map +1 -1
  137. package/es6/FrontApplet/Input/Input.d.ts +19 -3
  138. package/es6/FrontApplet/Input/Input.js +44 -23
  139. package/es6/FrontApplet/Input/Input.js.map +1 -1
  140. package/es6/FrontApplet/Management/App/App.d.ts +48 -10
  141. package/es6/FrontApplet/Management/App/App.js +45 -30
  142. package/es6/FrontApplet/Management/App/App.js.map +1 -1
  143. package/es6/FrontApplet/Management/App/IApp.d.ts +3 -1
  144. package/es6/FrontApplet/Management/Audio/Audio.d.ts +16 -0
  145. package/es6/FrontApplet/Management/Audio/Audio.js +30 -22
  146. package/es6/FrontApplet/Management/Audio/Audio.js.map +1 -1
  147. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.d.ts +4 -0
  148. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js +15 -22
  149. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js.map +1 -1
  150. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.d.ts +1 -1
  151. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js +5 -2
  152. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js.map +1 -1
  153. package/es6/FrontApplet/Management/Debug/Debug.d.ts +19 -0
  154. package/es6/FrontApplet/Management/Debug/Debug.js +37 -30
  155. package/es6/FrontApplet/Management/Debug/Debug.js.map +1 -1
  156. package/es6/FrontApplet/Management/Firmware/Firmware.d.ts +37 -10
  157. package/es6/FrontApplet/Management/Firmware/Firmware.js +34 -30
  158. package/es6/FrontApplet/Management/Firmware/Firmware.js.map +1 -1
  159. package/es6/FrontApplet/Management/Firmware/IFirmware.d.ts +1 -2
  160. package/es6/FrontApplet/Management/IManagement.d.ts +3 -1
  161. package/es6/FrontApplet/Management/Management.d.ts +106 -15
  162. package/es6/FrontApplet/Management/Management.js +191 -113
  163. package/es6/FrontApplet/Management/Management.js.map +1 -1
  164. package/es6/FrontApplet/Management/Network/INetworkInfo.d.ts +2 -2
  165. package/es6/FrontApplet/Management/Network/Network.d.ts +56 -8
  166. package/es6/FrontApplet/Management/Network/Network.js +86 -68
  167. package/es6/FrontApplet/Management/Network/Network.js.map +1 -1
  168. package/es6/FrontApplet/Management/OS/OS.d.ts +20 -0
  169. package/es6/FrontApplet/Management/OS/OS.js +34 -27
  170. package/es6/FrontApplet/Management/OS/OS.js.map +1 -1
  171. package/es6/FrontApplet/Management/Package/Package.d.ts +20 -0
  172. package/es6/FrontApplet/Management/Package/Package.js +37 -22
  173. package/es6/FrontApplet/Management/Package/Package.js.map +1 -1
  174. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.d.ts +1 -1
  175. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js +5 -2
  176. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js.map +1 -1
  177. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.d.ts +4 -0
  178. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js +15 -22
  179. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js.map +1 -1
  180. package/es6/FrontApplet/Management/Power/Power.d.ts +64 -0
  181. package/es6/FrontApplet/Management/Power/Power.js +160 -115
  182. package/es6/FrontApplet/Management/Power/Power.js.map +1 -1
  183. package/es6/FrontApplet/Management/Proxy/Proxy.d.ts +21 -0
  184. package/es6/FrontApplet/Management/Proxy/Proxy.js +41 -35
  185. package/es6/FrontApplet/Management/Proxy/Proxy.js.map +1 -1
  186. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.d.ts +43 -0
  187. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js +63 -39
  188. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map +1 -1
  189. package/es6/FrontApplet/Management/Screen/IOrientation.d.ts +1 -1
  190. package/es6/FrontApplet/Management/Screen/Screen.d.ts +127 -0
  191. package/es6/FrontApplet/Management/Screen/Screen.js +197 -89
  192. package/es6/FrontApplet/Management/Screen/Screen.js.map +1 -1
  193. package/es6/FrontApplet/Management/Security/Security.d.ts +20 -5
  194. package/es6/FrontApplet/Management/Security/Security.js +33 -31
  195. package/es6/FrontApplet/Management/Security/Security.js.map +1 -1
  196. package/es6/FrontApplet/Management/Time/Time.d.ts +31 -5
  197. package/es6/FrontApplet/Management/Time/Time.js +49 -40
  198. package/es6/FrontApplet/Management/Time/Time.js.map +1 -1
  199. package/es6/FrontApplet/Management/Wifi/IWifiEvent.d.ts +19 -1
  200. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js +19 -1
  201. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js.map +1 -1
  202. package/es6/FrontApplet/Management/Wifi/Wifi.d.ts +108 -7
  203. package/es6/FrontApplet/Management/Wifi/Wifi.js +162 -86
  204. package/es6/FrontApplet/Management/Wifi/Wifi.js.map +1 -1
  205. package/es6/FrontApplet/Management/helpers/DeviceHelper.js +2 -2
  206. package/es6/FrontApplet/Management/helpers/DeviceHelper.js.map +1 -1
  207. package/es6/FrontApplet/Management/helpers/ProprietaryTimerHelper.d.ts +1 -1
  208. package/es6/FrontApplet/Management/helpers/SecurityHelper.js +8 -6
  209. package/es6/FrontApplet/Management/helpers/SecurityHelper.js.map +1 -1
  210. package/es6/FrontApplet/Management/helpers/TimerHelper.js +2 -2
  211. package/es6/FrontApplet/Management/helpers/TimerHelper.js.map +1 -1
  212. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js +35 -3
  213. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js.map +1 -1
  214. package/es6/FrontApplet/Management/helpers/VideoHelper.js +1 -1
  215. package/es6/FrontApplet/Management/helpers/VideoHelper.js.map +1 -1
  216. package/es6/FrontApplet/Monitors/Monitors.d.ts +9 -0
  217. package/es6/FrontApplet/Monitors/Monitors.js +16 -16
  218. package/es6/FrontApplet/Monitors/Monitors.js.map +1 -1
  219. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js +1 -1
  220. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js.map +1 -1
  221. package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts +52 -3
  222. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js +79 -38
  223. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map +1 -1
  224. package/es6/FrontApplet/NativeCommands/NativeCommands.d.ts +4 -0
  225. package/es6/FrontApplet/NativeCommands/NativeCommands.js +12 -2
  226. package/es6/FrontApplet/NativeCommands/NativeCommands.js.map +1 -1
  227. package/es6/FrontApplet/OSD/OSD.d.ts +9 -0
  228. package/es6/FrontApplet/OSD/OSD.js +15 -15
  229. package/es6/FrontApplet/OSD/OSD.js.map +1 -1
  230. package/es6/FrontApplet/Offline/Cache/Cache.d.ts +91 -2
  231. package/es6/FrontApplet/Offline/Cache/Cache.js +193 -131
  232. package/es6/FrontApplet/Offline/Cache/Cache.js.map +1 -1
  233. package/es6/FrontApplet/Offline/Flags/AppendFlagController.d.ts +1 -1
  234. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js +18 -26
  235. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js.map +1 -1
  236. package/es6/FrontApplet/Offline/Flags/IFlags.d.ts +5 -5
  237. package/es6/FrontApplet/Offline/IAddFont.d.ts +3 -1
  238. package/es6/FrontApplet/Offline/IAddFont.js.map +1 -1
  239. package/es6/FrontApplet/Offline/IFileType.d.ts +1 -1
  240. package/es6/FrontApplet/Offline/ISaveFile.js +5 -2
  241. package/es6/FrontApplet/Offline/ISaveFile.js.map +1 -1
  242. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js +2 -1
  243. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js.map +1 -1
  244. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js +2 -1
  245. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js.map +1 -1
  246. package/es6/FrontApplet/Offline/Offline.d.ts +79 -8
  247. package/es6/FrontApplet/Offline/Offline.js +119 -59
  248. package/es6/FrontApplet/Offline/Offline.js.map +1 -1
  249. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.d.ts +19 -1
  250. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js +41 -29
  251. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js.map +1 -1
  252. package/es6/FrontApplet/Sensors/Proximity.d.ts +4 -3
  253. package/es6/FrontApplet/Sensors/Proximity.js +13 -5
  254. package/es6/FrontApplet/Sensors/Proximity.js.map +1 -1
  255. package/es6/FrontApplet/Sensors/Sensors.d.ts +3 -1
  256. package/es6/FrontApplet/Sensors/Sensors.js +9 -2
  257. package/es6/FrontApplet/Sensors/Sensors.js.map +1 -1
  258. package/es6/FrontApplet/Stream/IStream.d.ts +10 -10
  259. package/es6/FrontApplet/Stream/IStreamMessage.d.ts +1 -1
  260. package/es6/FrontApplet/Stream/IStreamTrackInfo.d.ts +2 -2
  261. package/es6/FrontApplet/Stream/Stream.d.ts +130 -15
  262. package/es6/FrontApplet/Stream/Stream.js +262 -163
  263. package/es6/FrontApplet/Stream/Stream.js.map +1 -1
  264. package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -1
  265. package/es6/FrontApplet/Stream/streamEvents.d.ts +1 -1
  266. package/es6/FrontApplet/Sync/Sync.d.ts +152 -6
  267. package/es6/FrontApplet/Sync/Sync.js +199 -115
  268. package/es6/FrontApplet/Sync/Sync.js.map +1 -1
  269. package/es6/FrontApplet/Sync/syncEvents.d.ts +3 -1
  270. package/es6/FrontApplet/Sync/syncMessages.js +1 -1
  271. package/es6/FrontApplet/Sync/syncMessages.js.map +1 -1
  272. package/es6/FrontApplet/Timing/Timing.d.ts +1 -0
  273. package/es6/FrontApplet/Timing/Timing.js +9 -2
  274. package/es6/FrontApplet/Timing/Timing.js.map +1 -1
  275. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.d.ts +1 -1
  276. package/es6/FrontApplet/Timing/Triggers/Triggers.d.ts +9 -0
  277. package/es6/FrontApplet/Timing/Triggers/Triggers.js +16 -18
  278. package/es6/FrontApplet/Timing/Triggers/Triggers.js.map +1 -1
  279. package/es6/FrontApplet/Touch/Touch.d.ts +3 -0
  280. package/es6/FrontApplet/Touch/Touch.js +13 -3
  281. package/es6/FrontApplet/Touch/Touch.js.map +1 -1
  282. package/es6/FrontApplet/Validate/Validate.d.ts +5 -5
  283. package/es6/FrontApplet/Validate/Validate.js +27 -24
  284. package/es6/FrontApplet/Validate/Validate.js.map +1 -1
  285. package/es6/FrontApplet/Validate/ValidateObjectInterface.js +7 -2
  286. package/es6/FrontApplet/Validate/ValidateObjectInterface.js.map +1 -1
  287. package/es6/FrontApplet/Video/IOptions.d.ts +8 -1
  288. package/es6/FrontApplet/Video/IVideo.d.ts +8 -8
  289. package/es6/FrontApplet/Video/IVideoEvent.d.ts +1 -1
  290. package/es6/FrontApplet/Video/IVideoEvent.js +3 -3
  291. package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -1
  292. package/es6/FrontApplet/Video/IVideoMessage.d.ts +1 -1
  293. package/es6/FrontApplet/Video/Video.d.ts +84 -12
  294. package/es6/FrontApplet/Video/Video.js +196 -137
  295. package/es6/FrontApplet/Video/Video.js.map +1 -1
  296. package/es6/FrontApplet/createFrontApplet.js +5 -2
  297. package/es6/FrontApplet/createFrontApplet.js.map +1 -1
  298. package/es6/Monitoring/Console/consoleCommands.d.ts +1 -1
  299. package/es6/Monitoring/Display/displayCommands.d.ts +1 -1
  300. package/es6/Monitoring/Display/handleDisplayRequests.d.ts +2 -2
  301. package/es6/Monitoring/Display/handleDisplayRequests.js +5 -15
  302. package/es6/Monitoring/Display/handleDisplayRequests.js.map +1 -1
  303. package/es6/Monitoring/EmptyObject.d.ts +1 -1
  304. package/es6/Monitoring/FileSystem/fileSystemCommands.d.ts +10 -1
  305. package/es6/Monitoring/FileSystem/fileSystemCommands.js +3 -1
  306. package/es6/Monitoring/FileSystem/fileSystemCommands.js.map +1 -1
  307. package/es6/Monitoring/FileSystem/handleFileSystemRequests.d.ts +2 -2
  308. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js +41 -45
  309. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js.map +1 -1
  310. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.d.ts +2 -2
  311. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js +4 -14
  312. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js.map +1 -1
  313. package/es6/Monitoring/Management/App/applicationCommands.d.ts +1 -1
  314. package/es6/Monitoring/Management/App/handleApplicationRequests.d.ts +2 -2
  315. package/es6/Monitoring/Management/App/handleApplicationRequests.js +9 -19
  316. package/es6/Monitoring/Management/App/handleApplicationRequests.js.map +1 -1
  317. package/es6/Monitoring/Management/Audio/audioCommands.d.ts +1 -1
  318. package/es6/Monitoring/Management/Audio/handleAudioRequests.d.ts +2 -2
  319. package/es6/Monitoring/Management/Audio/handleAudioRequests.js +7 -17
  320. package/es6/Monitoring/Management/Audio/handleAudioRequests.js.map +1 -1
  321. package/es6/Monitoring/Management/AutoRecovery/autoRecoveryCommands.d.ts +1 -1
  322. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.d.ts +2 -2
  323. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js +7 -17
  324. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js.map +1 -1
  325. package/es6/Monitoring/Management/Debug/debugCommands.d.ts +1 -1
  326. package/es6/Monitoring/Management/Debug/handleDebugRequests.d.ts +2 -2
  327. package/es6/Monitoring/Management/Debug/handleDebugRequests.js +9 -19
  328. package/es6/Monitoring/Management/Debug/handleDebugRequests.js.map +1 -1
  329. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.d.ts +2 -2
  330. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js +11 -21
  331. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js.map +1 -1
  332. package/es6/Monitoring/Management/Network/managementNetworkCommands.d.ts +1 -1
  333. package/es6/Monitoring/Management/Os/managementOsRequests.d.ts +2 -2
  334. package/es6/Monitoring/Management/Os/managementOsRequests.js +9 -19
  335. package/es6/Monitoring/Management/Os/managementOsRequests.js.map +1 -1
  336. package/es6/Monitoring/Management/Os/osCommands.d.ts +1 -1
  337. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.d.ts +2 -2
  338. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js +7 -17
  339. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js.map +1 -1
  340. package/es6/Monitoring/Management/PeerRecovery/peerRecoveryCommands.d.ts +1 -1
  341. package/es6/Monitoring/Management/Power/handlePowerRequests.d.ts +2 -2
  342. package/es6/Monitoring/Management/Power/handlePowerRequests.js +19 -29
  343. package/es6/Monitoring/Management/Power/handlePowerRequests.js.map +1 -1
  344. package/es6/Monitoring/Management/Power/powerCommands.d.ts +1 -1
  345. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.d.ts +2 -2
  346. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js +15 -25
  347. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js.map +1 -1
  348. package/es6/Monitoring/Management/RemoteControl/remoteControlCommands.d.ts +1 -1
  349. package/es6/Monitoring/Management/Screen/handleScreenRequests.d.ts +2 -2
  350. package/es6/Monitoring/Management/Screen/handleScreenRequests.js +19 -29
  351. package/es6/Monitoring/Management/Screen/handleScreenRequests.js.map +1 -1
  352. package/es6/Monitoring/Management/Screen/screenCommands.d.ts +1 -1
  353. package/es6/Monitoring/Management/Security/handleSecurityCommands.d.ts +2 -2
  354. package/es6/Monitoring/Management/Security/handleSecurityCommands.js +9 -19
  355. package/es6/Monitoring/Management/Security/handleSecurityCommands.js.map +1 -1
  356. package/es6/Monitoring/Management/Security/securityCommands.d.ts +1 -1
  357. package/es6/Monitoring/Management/Time/handleTimeCommands.d.ts +2 -2
  358. package/es6/Monitoring/Management/Time/handleTimeCommands.js +9 -19
  359. package/es6/Monitoring/Management/Time/handleTimeCommands.js.map +1 -1
  360. package/es6/Monitoring/Management/Time/timeCommands.d.ts +1 -1
  361. package/es6/Monitoring/Management/handleManagementRequests.d.ts +2 -2
  362. package/es6/Monitoring/Management/handleManagementRequests.js +23 -33
  363. package/es6/Monitoring/Management/handleManagementRequests.js.map +1 -1
  364. package/es6/Monitoring/Management/managementCommands.d.ts +1 -1
  365. package/es6/Monitoring/{Montoring.d.ts → Monitoring.d.ts} +1 -0
  366. package/es6/Monitoring/Monitoring.js +83 -0
  367. package/es6/Monitoring/Monitoring.js.map +1 -0
  368. package/es6/Monitoring/NativeCommands/handleNativeCommands.d.ts +2 -2
  369. package/es6/Monitoring/NativeCommands/handleNativeCommands.js +5 -15
  370. package/es6/Monitoring/NativeCommands/handleNativeCommands.js.map +1 -1
  371. package/es6/Monitoring/NativeCommands/nativeMdcCommands.d.ts +1 -1
  372. package/es6/Monitoring/OSD/handleOsdRequests.d.ts +2 -2
  373. package/es6/Monitoring/OSD/handleOsdRequests.js +5 -15
  374. package/es6/Monitoring/OSD/handleOsdRequests.js.map +1 -1
  375. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.d.ts +2 -2
  376. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js +23 -33
  377. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js.map +1 -1
  378. package/es6/Monitoring/Video/handleVideoRequests.d.ts +2 -2
  379. package/es6/Monitoring/Video/handleVideoRequests.js +36 -9
  380. package/es6/Monitoring/Video/handleVideoRequests.js.map +1 -1
  381. package/es6/Monitoring/handleMonitoringRequests.d.ts +2 -2
  382. package/es6/Monitoring/handleMonitoringRequests.js +6 -16
  383. package/es6/Monitoring/handleMonitoringRequests.js.map +1 -1
  384. package/es6/Monitoring/monitoringCommands.d.ts +1 -1
  385. package/es6/Sensors/IButton.js +1 -1
  386. package/es6/Sensors/IButton.js.map +1 -1
  387. package/es6/Sensors/IRfidAntenna.d.ts +1 -1
  388. package/es6/Sensors/IRfidAntenna.js +1 -1
  389. package/es6/Sensors/IRfidAntenna.js.map +1 -1
  390. package/es6/Util/Console/enhancer.d.ts +11 -0
  391. package/es6/Util/Console/enhancer.js +23 -0
  392. package/es6/Util/Console/enhancer.js.map +1 -0
  393. package/es6/bundle.d.ts +1 -1
  394. package/es6/bundle.js +12 -5
  395. package/es6/bundle.js.map +1 -1
  396. package/es6/fpath.d.ts +1 -1
  397. package/es6/fpath.js +34 -1
  398. package/es6/fpath.js.map +1 -1
  399. package/es6/utils/types.d.ts +1 -0
  400. package/es6/{FrontApplet/Video/IVideoEventListener.js → utils/types.js} +1 -1
  401. package/es6/utils/types.js.map +1 -0
  402. package/package.json +28 -26
  403. package/CHANGELOG.md +0 -480
  404. package/docs/applet-basics.md +0 -272
  405. package/docs/content/js-applet-resources.md +0 -154
  406. package/docs/content/js-browser.md +0 -163
  407. package/docs/content/js-command.md +0 -154
  408. package/docs/content/js-debug.md +0 -36
  409. package/docs/content/js-device-info.md +0 -56
  410. package/docs/content/js-display.md +0 -56
  411. package/docs/content/js-file-system.md +0 -670
  412. package/docs/content/js-fonts.md +0 -115
  413. package/docs/content/js-hardware.md +0 -55
  414. package/docs/content/js-iframes.md +0 -66
  415. package/docs/content/js-input.md +0 -71
  416. package/docs/content/js-offline-cache-media-files.md +0 -257
  417. package/docs/content/js-offline-cache-simple-data.md +0 -129
  418. package/docs/content/js-osd.md +0 -32
  419. package/docs/content/js-proof-of-play.md +0 -60
  420. package/docs/content/js-sensors.md +0 -70
  421. package/docs/content/js-serial.md +0 -165
  422. package/docs/content/js-sync-playback.md +0 -384
  423. package/docs/content/js-video-inputs-internal-ports.md +0 -131
  424. package/docs/content/js-video-stream.md +0 -618
  425. package/docs/content/js-video.md +0 -232
  426. package/docs/management/js-management-application.md +0 -107
  427. package/docs/management/js-management-audio.md +0 -44
  428. package/docs/management/js-management-debug.md +0 -40
  429. package/docs/management/js-management-firmware.md +0 -93
  430. package/docs/management/js-management-management.md +0 -178
  431. package/docs/management/js-management-monitoring-commands.md +0 -107
  432. package/docs/management/js-management-monitors.md +0 -55
  433. package/docs/management/js-management-native-commands-mdc.md +0 -90
  434. package/docs/management/js-management-network.md +0 -223
  435. package/docs/management/js-management-os.md +0 -62
  436. package/docs/management/js-management-package.md +0 -48
  437. package/docs/management/js-management-power.md +0 -175
  438. package/docs/management/js-management-proxy.md +0 -81
  439. package/docs/management/js-management-remote-control.md +0 -58
  440. package/docs/management/js-management-screen.md +0 -225
  441. package/docs/management/js-management-security.md +0 -71
  442. package/docs/management/js-management-time.md +0 -161
  443. package/docs/management/js-management-wifi.md +0 -341
  444. package/es6/FrontApplet/Command/ICommandEventListener.d.ts +0 -6
  445. package/es6/FrontApplet/Command/ICommandEventListener.js +0 -3
  446. package/es6/FrontApplet/Command/ICommandEventListener.js.map +0 -1
  447. package/es6/FrontApplet/Input/IKeyUpEventListener.d.ts +0 -5
  448. package/es6/FrontApplet/Input/IKeyUpEventListener.js.map +0 -1
  449. package/es6/FrontApplet/Management/Firmware/FirmwareType.d.ts +0 -4
  450. package/es6/FrontApplet/Management/Firmware/FirmwareType.js +0 -9
  451. package/es6/FrontApplet/Management/Firmware/FirmwareType.js.map +0 -1
  452. package/es6/FrontApplet/Stream/streamListeners.d.ts +0 -10
  453. package/es6/FrontApplet/Stream/streamListeners.js.map +0 -1
  454. package/es6/FrontApplet/Video/IVideoEventListener.d.ts +0 -5
  455. package/es6/FrontApplet/Video/IVideoEventListener.js.map +0 -1
  456. package/es6/Monitoring/Montoring.js +0 -131
  457. package/es6/Monitoring/Montoring.js.map +0 -1
@@ -1,32 +1,52 @@
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
- const Firmware_1 = require("./Firmware/Firmware");
13
- const Audio_1 = require("./Audio/Audio");
14
- const Screen_1 = require("./Screen/Screen");
15
- const RemoteControl_1 = require("./RemoteControl/RemoteControl");
16
- const Time_1 = require("./Time/Time");
17
- const App_1 = require("./App/App");
18
- const OS_1 = require("./OS/OS");
19
- const Debug_1 = require("./Debug/Debug");
20
- const Package_1 = require("./Package/Package");
21
- const Power_1 = require("./Power/Power");
22
- const Network_1 = require("./Network/Network");
23
- const Wifi_1 = require("./Wifi/Wifi");
24
- const Security_1 = require("./Security/Security");
25
- const Validate_1 = require("../Validate/Validate");
26
- const Proxy_1 = require("./Proxy/Proxy");
27
- const PeerRecovery_1 = require("./PeerRecovery/PeerRecovery");
28
- const AutoRecovery_1 = require("./AutoRecovery/AutoRecovery");
6
+ const Validate_1 = __importDefault(require("../Validate/Validate"));
7
+ const App_1 = __importDefault(require("./App/App"));
8
+ const Audio_1 = __importDefault(require("./Audio/Audio"));
9
+ const AutoRecovery_1 = __importDefault(require("./AutoRecovery/AutoRecovery"));
10
+ const Debug_1 = __importDefault(require("./Debug/Debug"));
11
+ const Firmware_1 = __importDefault(require("./Firmware/Firmware"));
12
+ const Network_1 = __importDefault(require("./Network/Network"));
13
+ const OS_1 = __importDefault(require("./OS/OS"));
14
+ const Package_1 = __importDefault(require("./Package/Package"));
15
+ const PeerRecovery_1 = __importDefault(require("./PeerRecovery/PeerRecovery"));
16
+ const Power_1 = __importDefault(require("./Power/Power"));
17
+ const Proxy_1 = __importDefault(require("./Proxy/Proxy"));
18
+ const RemoteControl_1 = __importDefault(require("./RemoteControl/RemoteControl"));
19
+ const Screen_1 = __importDefault(require("./Screen/Screen"));
20
+ const Security_1 = __importDefault(require("./Security/Security"));
21
+ const Time_1 = __importDefault(require("./Time/Time"));
22
+ const Wifi_1 = __importDefault(require("./Wifi/Wifi"));
23
+ /**
24
+ * The `sos.management` API group provides methods for managing the device. Through this API things like device firmware,
25
+ * battery status, brightness, network information, remote control, power, time or volume can be monitored.
26
+ *
27
+ * @example // {@link https://developers.signageos.io/sdk/management/js-management-management Example of the App API}
28
+ */
29
29
  class Management {
30
+ messagePrefix;
31
+ postMessage;
32
+ static MESSAGE_PREFIX = 'management';
33
+ app;
34
+ os;
35
+ audio;
36
+ debug;
37
+ firmware;
38
+ package;
39
+ power;
40
+ remoteControl;
41
+ screen;
42
+ time;
43
+ network;
44
+ wifi;
45
+ security;
46
+ proxy;
47
+ autoRecovery;
48
+ peerRecovery;
49
+ /** @internal */
30
50
  constructor(messagePrefix, postMessage) {
31
51
  this.messagePrefix = messagePrefix;
32
52
  this.postMessage = postMessage;
@@ -47,109 +67,168 @@ class Management {
47
67
  this.autoRecovery = new AutoRecovery_1.default(this.getMessagePrefix(), this.postMessage);
48
68
  this.peerRecovery = new PeerRecovery_1.default(this.getMessagePrefix(), this.postMessage);
49
69
  }
50
- supports(capability) {
51
- return __awaiter(this, void 0, void 0, function* () {
52
- Validate_1.default({ capability }).required().string();
53
- const { supports } = yield this.postMessage({
54
- type: this.getMessage('supports'),
55
- capability,
56
- });
57
- return supports;
70
+ /**
71
+ * The `supports()` method determines whether a queried capability is supported.
72
+ *
73
+ * @param capability The capability to check for support.
74
+ *
75
+ * @since 2.0.0
76
+ */
77
+ async supports(capability) {
78
+ (0, Validate_1.default)({ capability }).required().string();
79
+ const { supports } = await this.postMessage({
80
+ type: this.getMessage('supports'),
81
+ capability,
58
82
  });
59
- }
60
- getModel() {
61
- return __awaiter(this, void 0, void 0, function* () {
62
- const { model } = yield this.postMessage({
63
- type: this.getMessage('get_model'),
64
- });
65
- return model;
83
+ return supports;
84
+ }
85
+ /**
86
+ * The `getModel()` method returns the model of the device.
87
+ *
88
+ * @since 2.0.0
89
+ */
90
+ async getModel() {
91
+ const { model } = await this.postMessage({
92
+ type: this.getMessage('get_model'),
66
93
  });
67
- }
68
- getSerialNumber() {
69
- return __awaiter(this, void 0, void 0, function* () {
70
- const { serialNumber } = yield this.postMessage({
71
- type: this.getMessage('get_serial_number'),
72
- });
73
- return serialNumber;
94
+ return model;
95
+ }
96
+ /**
97
+ * The `getSerialNumber()` method returns the serial number of the device.
98
+ *
99
+ * @since 2.1.0
100
+ */
101
+ async getSerialNumber() {
102
+ const { serialNumber } = await this.postMessage({
103
+ type: this.getMessage('get_serial_number'),
74
104
  });
75
- }
76
- /** @deprecated Use sos.management.network.getActiveInfo() instead */
77
- getNetworkInfo() {
78
- return __awaiter(this, void 0, void 0, function* () {
79
- return yield this.network.getActiveInfo();
105
+ return serialNumber;
106
+ }
107
+ /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
108
+ async getNetworkInfo() {
109
+ return await this.network.getActiveInfo();
110
+ }
111
+ /**
112
+ * The `getBatteryStatus()` method returns information about the battery of the device.
113
+ *
114
+ * @since 2.1.0
115
+ */
116
+ async getBatteryStatus() {
117
+ const { batteryStatus } = await this.postMessage({
118
+ type: this.getMessage('get_battery_status'),
80
119
  });
81
- }
82
- getBatteryStatus() {
83
- return __awaiter(this, void 0, void 0, function* () {
84
- const { batteryStatus } = yield this.postMessage({
85
- type: this.getMessage('get_battery_status'),
86
- });
87
- return batteryStatus;
120
+ return batteryStatus;
121
+ }
122
+ /**
123
+ * The `getTemperature()` method returns the temperature of the device (in 0-100 range of degrees Celsius).
124
+ *
125
+ * @since 3.0.0
126
+ */
127
+ async getTemperature() {
128
+ const { currentTemperature } = await this.postMessage({
129
+ type: this.getMessage('get_current_temperature'),
88
130
  });
89
- }
90
- getTemperature() {
91
- return __awaiter(this, void 0, void 0, function* () {
92
- const { currentTemperature } = yield this.postMessage({
93
- type: this.getMessage('get_current_temperature'),
94
- });
95
- return currentTemperature;
131
+ return currentTemperature;
132
+ }
133
+ /**
134
+ * The `getBrand()` method returns the manufacturer brand of the device.
135
+ *
136
+ * @since 5.7.0
137
+ */
138
+ async getBrand() {
139
+ const { brand } = await this.postMessage({
140
+ type: this.getMessage('get_brand'),
96
141
  });
97
- }
98
- getBrand() {
99
- return __awaiter(this, void 0, void 0, function* () {
100
- const { brand } = yield this.postMessage({
101
- type: this.getMessage('get_brand'),
102
- });
103
- return brand;
104
- });
105
- }
106
- resetSettings() {
107
- return __awaiter(this, void 0, void 0, function* () {
108
- yield this.postMessage({
109
- type: this.getMessage('reset_settings'),
110
- });
142
+ return brand;
143
+ }
144
+ // TODO: Used only by NEC, can be eventually removed?
145
+ /**
146
+ * The `resetSettings()` method initializes the reset of the specific device settings.
147
+ *
148
+ * :::info
149
+ *
150
+ * This is currently only implemented on Linux platform.
151
+ *
152
+ * :::
153
+ *
154
+ * @since 4.0.0
155
+ */
156
+ async resetSettings() {
157
+ await this.postMessage({
158
+ type: this.getMessage('reset_settings'),
111
159
  });
112
160
  }
113
- factoryReset() {
114
- return __awaiter(this, void 0, void 0, function* () {
115
- yield this.postMessage({
116
- type: this.getMessage('factory_reset'),
117
- });
161
+ /**
162
+ * The `factoryReset()` method initializes the factory reset of the device.
163
+ *
164
+ * @since 4.0.0
165
+ */
166
+ async factoryReset() {
167
+ await this.postMessage({
168
+ type: this.getMessage('factory_reset'),
118
169
  });
119
170
  }
120
- getExtendedManagementUrl() {
121
- return __awaiter(this, void 0, void 0, function* () {
122
- const { url } = yield this.postMessage({
123
- type: this.getMessage('get_extendedmanagement_url'),
124
- });
125
- return url;
171
+ /**
172
+ * The `getExtendedManagementUrl()` method returns the management url of the device.
173
+ *
174
+ * :::info
175
+ *
176
+ * This is currently only implemented for the MagicInfo on Tizen platform.
177
+ *
178
+ * :::
179
+ *
180
+ * @since 6.2.0
181
+ */
182
+ async getExtendedManagementUrl() {
183
+ const { url } = await this.postMessage({
184
+ type: this.getMessage('get_extendedmanagement_url'),
126
185
  });
127
- }
128
- setExtendedManagementUrl(url) {
129
- return __awaiter(this, void 0, void 0, function* () {
130
- Validate_1.default({ url }).string().canBeNull();
131
- yield this.postMessage({
132
- type: this.getMessage('set_extendedmanagement_url'),
133
- url,
134
- });
186
+ return url;
187
+ }
188
+ /**
189
+ * The `getExtendedManagementUrl()` set the management url of the device.
190
+ *
191
+ * :::info
192
+ *
193
+ * This is currently only implemented for the MagicInfo on Tizen platform.
194
+ *
195
+ * :::
196
+ *
197
+ * @param url The management URL to set.
198
+ *
199
+ * @since 6.2.0
200
+ */
201
+ async setExtendedManagementUrl(url) {
202
+ (0, Validate_1.default)({ url }).string().canBeNull();
203
+ await this.postMessage({
204
+ type: this.getMessage('set_extendedmanagement_url'),
205
+ url,
135
206
  });
136
207
  }
137
- setHardwareAcceleration(enabled) {
138
- return __awaiter(this, void 0, void 0, function* () {
139
- Validate_1.default({ enabled }).required().boolean();
140
- yield this.postMessage({
141
- type: this.getMessage('set_hardware_acceleration'),
142
- enabled,
143
- });
208
+ /**
209
+ * The `setHardwareAcceleration()` method enables or disables hardware acceleration.
210
+ *
211
+ * @param enabled Whether hardware acceleration should be enabled.
212
+ *
213
+ * @since 7.1.0
214
+ */
215
+ async setHardwareAcceleration(enabled) {
216
+ (0, Validate_1.default)({ enabled }).required().boolean();
217
+ await this.postMessage({
218
+ type: this.getMessage('set_hardware_acceleration'),
219
+ enabled,
144
220
  });
145
221
  }
146
- isHardwareAccelerationEnabled() {
147
- return __awaiter(this, void 0, void 0, function* () {
148
- const { enabled } = yield this.postMessage({
149
- type: this.getMessage('is_hardware_acceleration_enabled'),
150
- });
151
- return enabled;
222
+ /**
223
+ * The `isHardwareAccelerationEnabled()` method returns whether hardware acceleration is enabled.
224
+ *
225
+ * @since 7.1.0
226
+ */
227
+ async isHardwareAccelerationEnabled() {
228
+ const { enabled } = await this.postMessage({
229
+ type: this.getMessage('is_hardware_acceleration_enabled'),
152
230
  });
231
+ return enabled;
153
232
  }
154
233
  getMessage(name) {
155
234
  return this.getMessagePrefix() + '.' + name;
@@ -159,5 +238,4 @@ class Management {
159
238
  }
160
239
  }
161
240
  exports.default = Management;
162
- Management.MESSAGE_PREFIX = 'management';
163
241
  //# sourceMappingURL=Management.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Management.js","sourceRoot":"","sources":["../../../src/FrontApplet/Management/Management.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,kDAA2C;AAC3C,yCAAkC;AAClC,4CAAqC;AACrC,iEAA0D;AAC1D,sCAA+B;AAC/B,mCAA4B;AAC5B,gCAAyB;AACzB,yCAAkC;AAClC,+CAAwC;AACxC,yCAAkC;AAClC,+CAAwC;AACxC,sCAA+B;AAC/B,kDAA2C;AAC3C,mDAA4C;AAC5C,yCAAkC;AAClC,8DAAuD;AACvD,8DAAuD;AAGvD,MAAqB,UAAU;IAoB9B,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,EAAE,GAAG,IAAI,YAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACjF,CAAC;IAEY,QAAQ,CAAC,UAAkB;;YACvC,kBAAQ,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAE7C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;gBACjC,UAAU;aACV,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QACjB,CAAC;KAAA;IAEY,QAAQ;;YACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;aAClC,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACd,CAAC;KAAA;IAEY,eAAe;;YAC3B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;aAC1C,CAAC,CAAC;YAEH,OAAO,YAAY,CAAC;QACrB,CAAC;KAAA;IAED,qEAAqE;IACxD,cAAc;;YAC1B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QAC3C,CAAC;KAAA;IAEY,gBAAgB;;YAC5B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;aAC3C,CAAC,CAAC;YAEH,OAAO,aAAa,CAAC;QACtB,CAAC;KAAA;IAEY,cAAc;;YAC1B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;aAChD,CAAC,CAAC;YAEH,OAAO,kBAAkB,CAAC;QAC3B,CAAC;KAAA;IAEY,QAAQ;;YACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;aAClC,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;QACd,CAAC;KAAA;IAEY,aAAa;;YACzB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;aACvC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,YAAY;;YACxB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;aACtC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,wBAAwB;;YACpC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;aACnD,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACZ,CAAC;KAAA;IAEY,wBAAwB,CAAC,GAAkB;;YACvD,kBAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;gBACnD,GAAG;aACH,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,uBAAuB,CAAC,OAAgB;;YACpD,kBAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;gBAClD,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,6BAA6B;;YACzC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC;aACzD,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;QAChB,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7D,CAAC;;AAjJF,6BAkJC;AAjJc,yBAAc,GAAW,YAAY,CAAC"}
1
+ {"version":3,"file":"Management.js","sourceRoot":"","sources":["../../../src/FrontApplet/Management/Management.ts"],"names":[],"mappings":";;;;;AACA,oEAA4C;AAC5C,oDAA4B;AAC5B,0DAAkC;AAClC,+EAAuD;AACvD,0DAAkC;AAClC,mEAA2C;AAI3C,gEAAwC;AACxC,iDAAyB;AACzB,gEAAwC;AACxC,+EAAuD;AACvD,0DAAkC;AAClC,0DAAkC;AAClC,kFAA0D;AAC1D,6DAAqC;AACrC,mEAA2C;AAC3C,uDAA+B;AAC/B,uDAA+B;AAE/B;;;;;GAKG;AACH,MAAqB,UAAU;IAsBrB;IACA;IAtBF,MAAM,CAAC,cAAc,GAAW,YAAY,CAAC;IAEpC,GAAG,CAAM;IACT,EAAE,CAAK;IACP,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,KAAK,CAAQ;IACb,aAAa,CAAgB;IAC7B,MAAM,CAAS;IACf,IAAI,CAAO;IACX,OAAO,CAAU;IACjB,IAAI,CAAO;IACX,QAAQ,CAAW;IACnB,KAAK,CAAQ;IACb,YAAY,CAAe;IAC3B,YAAY,CAAe;IAE3C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,EAAE,GAAG,IAAI,YAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAgC;QACrD,IAAA,kBAAQ,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE7C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,UAAU;SACV,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe;QAC3B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,yEAAyE;IAClE,KAAK,CAAC,cAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC5B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAChD,CAAC,CAAC;QAEH,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACd,CAAC;IAED,qDAAqD;IACrD;;;;;;;;;;OAUG;IACI,KAAK,CAAC,aAAa;QACzB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACvC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY;QACxB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,wBAAwB;QACpC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACtC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;SACnD,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,wBAAwB,CAAC,GAAkB;QACvD,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,GAAG;SACH,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,uBAAuB,CAAC,OAAgB;QACpD,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;YAClD,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,6BAA6B;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC;SACzD,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7D,CAAC;;AAvOF,6BAwOC"}
@@ -1,7 +1,7 @@
1
- export declare type NetworkInterface = 'wifi' | 'ethernet';
1
+ export type NetworkInterface = 'wifi' | 'ethernet';
2
2
  export declare const VNetworkInterface: string[];
3
3
  /**
4
- * @deprecated use INetworkInterface instead
4
+ * @deprecated use `INetworkInterface` instead
5
5
  */
6
6
  export default interface INetworkInfo {
7
7
  localAddress: string;
@@ -1,28 +1,76 @@
1
1
  import IPostMessage from '../../IPostMessage';
2
2
  import INetworkInfo, { INetworkInterface, INetworkOptions, INetworkOptionsLegacy, NetworkInterface } from './INetworkInfo';
3
3
  import INetwork from './INetwork';
4
+ /**
5
+ * The `sos.management.network` API groups together methods for networking.
6
+ *
7
+ * :::info
8
+ *
9
+ * Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
10
+ *
11
+ * :::
12
+ */
4
13
  export default class Network implements INetwork {
5
14
  private messagePrefix;
6
15
  private postMessage;
16
+ /** @internal */
7
17
  constructor(messagePrefix: string, postMessage: IPostMessage<any>);
8
- /** @deprecated use sos.management.network.listInterfaces() instead */
18
+ /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
9
19
  getActiveInfo(): Promise<INetworkInfo>;
20
+ /**
21
+ * The `listInterface()` method returns list of all network interfaces, and their information like MAC address, IP address, etc. Wifi
22
+ * connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on
23
+ * platform.
24
+ *
25
+ * @since 4.9.0
26
+ */
10
27
  listInterfaces(): Promise<INetworkInterface[]>;
11
- /** @deprecated use sos.management.network.setManual2() instead */
28
+ /** @deprecated Use `sos.management.network.setManual(interfaceName, options)` instead. */
12
29
  setManual(options: INetworkOptionsLegacy): Promise<void>;
13
30
  /**
14
- * Manually configure a network interface
15
- * @param interfaceName can be retrieved from the list of interfaces returned by listInterfaces()
16
- * @param options
31
+ * The `setManual()` method manually configures a network interface.
32
+ *
33
+ * :::warning
34
+ *
35
+ * Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
36
+ *
37
+ * :::
38
+ *
39
+ * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
40
+ * @param options The network configuration options.
41
+ *
42
+ * @since 4.0.0
17
43
  */
18
44
  setManual(interfaceName: string, options: INetworkOptions): Promise<void>;
19
- /** @deprecated use sos.management.network.setDHCP2() instead */
45
+ /** @deprecated Use `sos.management.network.setDHCP(interfaceName)` instead. */
20
46
  setDHCP(networkInterface: NetworkInterface): Promise<void>;
21
47
  /**
22
- * Configure a network interface to use DHCP
23
- * @param interfaceName can be retrieved from the list of interfaces returned by listInterfaces()
48
+ * The `setDHCP()` method configures a network interface to use DHCP.
49
+ *
50
+ * :::warning
51
+ *
52
+ * Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
53
+ *
54
+ * :::
55
+ *
56
+ * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
57
+ *
58
+ * @since 4.0.0
24
59
  */
25
60
  setDHCP(interfaceName: string): Promise<void>;
61
+ /**
62
+ * The `disableInterface()` disables a network interface.
63
+ *
64
+ * :::warning
65
+ *
66
+ * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
67
+ *
68
+ * :::
69
+ *
70
+ * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
71
+ *
72
+ * @since 4.13.0
73
+ */
26
74
  disableInterface(interfaceName: string): Promise<void>;
27
75
  private getMessage;
28
76
  }
@@ -1,87 +1,105 @@
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 INetworkInfo_1 = require("./INetworkInfo");
13
- const Validate_1 = require("../../Validate/Validate");
7
+ const Validate_1 = __importDefault(require("../../Validate/Validate"));
8
+ /**
9
+ * The `sos.management.network` API groups together methods for networking.
10
+ *
11
+ * :::info
12
+ *
13
+ * Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
14
+ *
15
+ * :::
16
+ */
14
17
  class Network {
18
+ messagePrefix;
19
+ postMessage;
20
+ /** @internal */
15
21
  constructor(messagePrefix, postMessage) {
16
22
  this.messagePrefix = messagePrefix;
17
23
  this.postMessage = postMessage;
18
24
  }
19
- /** @deprecated use sos.management.network.listInterfaces() instead */
20
- getActiveInfo() {
21
- return __awaiter(this, void 0, void 0, function* () {
22
- const { networkInfo } = yield this.postMessage({
23
- type: this.getMessage('get_network_info'),
24
- });
25
- return networkInfo;
25
+ /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
26
+ async getActiveInfo() {
27
+ const { networkInfo } = await this.postMessage({
28
+ type: this.getMessage('get_network_info'),
26
29
  });
30
+ return networkInfo;
27
31
  }
28
- listInterfaces() {
29
- return __awaiter(this, void 0, void 0, function* () {
30
- const { interfaces } = yield this.postMessage({
31
- type: this.getMessage('get_network_interfaces'),
32
- });
33
- return interfaces;
32
+ /**
33
+ * The `listInterface()` method returns list of all network interfaces, and their information like MAC address, IP address, etc. Wifi
34
+ * connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on
35
+ * platform.
36
+ *
37
+ * @since 4.9.0
38
+ */
39
+ async listInterfaces() {
40
+ const { interfaces } = await this.postMessage({
41
+ type: this.getMessage('get_network_interfaces'),
34
42
  });
43
+ return interfaces;
35
44
  }
36
- setManual(...args) {
37
- return __awaiter(this, void 0, void 0, function* () {
38
- if (typeof args[0] === 'string') {
39
- const [interfaceName, options] = args;
40
- Validate_1.default({ interfaceName }).required().string();
41
- Validate_1.default({ options }).required().object(INetworkInfo_1.VINetworkOptions);
42
- yield this.postMessage({
43
- type: this.getMessage('set_network_manual_v2'),
44
- interfaceName,
45
- options,
46
- });
47
- }
48
- else {
49
- const [options] = args;
50
- Validate_1.default({ options }).required().object(INetworkInfo_1.VINetworkOptionsLegacy);
51
- yield this.postMessage({
52
- type: this.getMessage('set_network_manual'),
53
- options,
54
- });
55
- }
56
- });
57
- }
58
- setDHCP(...args) {
59
- return __awaiter(this, void 0, void 0, function* () {
60
- if (args[0] === 'ethernet' || args[0] === 'wifi') {
61
- const [networkInterface] = args;
62
- Validate_1.default({ networkInterface }).required().string(INetworkInfo_1.VNetworkInterface);
63
- yield this.postMessage({
64
- type: this.getMessage('set_network_dhcp'),
65
- networkInterface,
66
- });
67
- }
68
- else {
69
- const [interfaceName] = args;
70
- Validate_1.default({ interfaceName }).required().string();
71
- yield this.postMessage({
72
- type: this.getMessage('set_network_dhcp_v2'),
73
- interfaceName,
74
- });
75
- }
76
- });
45
+ /** @internal */
46
+ async setManual(...args) {
47
+ if (typeof args[0] === 'string') {
48
+ const [interfaceName, options] = args;
49
+ (0, Validate_1.default)({ interfaceName }).required().string();
50
+ (0, Validate_1.default)({ options }).required().object(INetworkInfo_1.VINetworkOptions);
51
+ await this.postMessage({
52
+ type: this.getMessage('set_network_manual_v2'),
53
+ interfaceName,
54
+ options,
55
+ });
56
+ }
57
+ else {
58
+ const [options] = args;
59
+ (0, Validate_1.default)({ options }).required().object(INetworkInfo_1.VINetworkOptionsLegacy);
60
+ await this.postMessage({
61
+ type: this.getMessage('set_network_manual'),
62
+ options,
63
+ });
64
+ }
77
65
  }
78
- disableInterface(interfaceName) {
79
- return __awaiter(this, void 0, void 0, function* () {
80
- Validate_1.default({ interfaceName }).required().string();
81
- yield this.postMessage({
82
- type: this.getMessage('disable_network_interface'),
66
+ /** @internal */
67
+ async setDHCP(...args) {
68
+ if (args[0] === 'ethernet' || args[0] === 'wifi') {
69
+ const [networkInterface] = args;
70
+ (0, Validate_1.default)({ networkInterface }).required().string(INetworkInfo_1.VNetworkInterface);
71
+ await this.postMessage({
72
+ type: this.getMessage('set_network_dhcp'),
73
+ networkInterface,
74
+ });
75
+ }
76
+ else {
77
+ const [interfaceName] = args;
78
+ (0, Validate_1.default)({ interfaceName }).required().string();
79
+ await this.postMessage({
80
+ type: this.getMessage('set_network_dhcp_v2'),
83
81
  interfaceName,
84
82
  });
83
+ }
84
+ }
85
+ /**
86
+ * The `disableInterface()` disables a network interface.
87
+ *
88
+ * :::warning
89
+ *
90
+ * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
91
+ *
92
+ * :::
93
+ *
94
+ * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
95
+ *
96
+ * @since 4.13.0
97
+ */
98
+ async disableInterface(interfaceName) {
99
+ (0, Validate_1.default)({ interfaceName }).required().string();
100
+ await this.postMessage({
101
+ type: this.getMessage('disable_network_interface'),
102
+ interfaceName,
85
103
  });
86
104
  }
87
105
  getMessage(name) {