@signageos/front-applet 8.1.1 → 8.1.3

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 (74) hide show
  1. package/dist/bundle.js +1 -1
  2. package/dist/bundle.js.map +1 -1
  3. package/docs/sos/browser.md +66 -14
  4. package/docs/sos/command.md +52 -6
  5. package/docs/sos/debug.md +17 -2
  6. package/docs/sos/deviceInfo.md +27 -0
  7. package/docs/sos/display.md +34 -3
  8. package/docs/sos/fileSystem.md +1135 -59
  9. package/docs/sos/index.md +36 -12
  10. package/docs/sos/input.md +42 -1
  11. package/docs/sos/native/mdc.md +65 -19
  12. package/docs/sos/offline/cache.md +14 -8
  13. package/docs/sos/stream.md +1172 -37
  14. package/docs/sos/sync.md +2 -2
  15. package/docs/sos/video.md +515 -22
  16. package/docs/sos_management/security.md +4 -2
  17. package/docs/sos_management/wifi.md +9 -9
  18. package/es6/FrontApplet/Browser/Browser.d.ts +25 -9
  19. package/es6/FrontApplet/Browser/Browser.js +25 -9
  20. package/es6/FrontApplet/Browser/Browser.js.map +1 -1
  21. package/es6/FrontApplet/Browser/IOpenLinkOptions.d.ts +7 -0
  22. package/es6/FrontApplet/Browser/IOpenLinkOptions.js.map +1 -1
  23. package/es6/FrontApplet/Browser/events.d.ts +6 -0
  24. package/es6/FrontApplet/Browser/events.js.map +1 -1
  25. package/es6/FrontApplet/Command/Command.d.ts +15 -6
  26. package/es6/FrontApplet/Command/Command.js +15 -6
  27. package/es6/FrontApplet/Command/Command.js.map +1 -1
  28. package/es6/FrontApplet/Command/ICommand.d.ts +7 -0
  29. package/es6/FrontApplet/Command/ICommandEvent.d.ts +6 -0
  30. package/es6/FrontApplet/Debug/Debug.d.ts +11 -3
  31. package/es6/FrontApplet/Debug/Debug.js +11 -3
  32. package/es6/FrontApplet/Debug/Debug.js.map +1 -1
  33. package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts +15 -0
  34. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js +16 -2
  35. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map +1 -1
  36. package/es6/FrontApplet/Display/Display.d.ts +22 -14
  37. package/es6/FrontApplet/Display/Display.js +22 -14
  38. package/es6/FrontApplet/Display/Display.js.map +1 -1
  39. package/es6/FrontApplet/Display/IDisplay.d.ts +4 -0
  40. package/es6/FrontApplet/FileSystem/FileSystem.d.ts +429 -41
  41. package/es6/FrontApplet/FileSystem/FileSystem.js +427 -39
  42. package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -1
  43. package/es6/FrontApplet/FileSystem/HashAlgorithm.d.ts +4 -1
  44. package/es6/FrontApplet/FileSystem/types.d.ts +46 -0
  45. package/es6/FrontApplet/FileSystem/types.js.map +1 -1
  46. package/es6/FrontApplet/FrontApplet.d.ts +31 -7
  47. package/es6/FrontApplet/FrontApplet.js +32 -8
  48. package/es6/FrontApplet/FrontApplet.js.map +1 -1
  49. package/es6/FrontApplet/Input/IKeyUpEvent.d.ts +9 -0
  50. package/es6/FrontApplet/Input/IKeyUpEvent.js +6 -0
  51. package/es6/FrontApplet/Input/IKeyUpEvent.js.map +1 -1
  52. package/es6/FrontApplet/Input/Input.d.ts +17 -1
  53. package/es6/FrontApplet/Input/Input.js +17 -1
  54. package/es6/FrontApplet/Input/Input.js.map +1 -1
  55. package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts +32 -11
  56. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js +14 -11
  57. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map +1 -1
  58. package/es6/FrontApplet/Stream/IStreamTrackInfo.d.ts +34 -0
  59. package/es6/FrontApplet/Stream/Stream.d.ts +245 -20
  60. package/es6/FrontApplet/Stream/Stream.js +245 -20
  61. package/es6/FrontApplet/Stream/Stream.js.map +1 -1
  62. package/es6/FrontApplet/Stream/StreamProtocol.d.ts +4 -0
  63. package/es6/FrontApplet/Stream/StreamProtocol.js +4 -0
  64. package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -1
  65. package/es6/FrontApplet/Stream/streamEventProperties.d.ts +11 -1
  66. package/es6/FrontApplet/Stream/streamEvents.d.ts +26 -0
  67. package/es6/FrontApplet/Video/IOptions.d.ts +41 -0
  68. package/es6/FrontApplet/Video/IVideoEvent.d.ts +8 -0
  69. package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -1
  70. package/es6/FrontApplet/Video/IVideoProperties.d.ts +3 -0
  71. package/es6/FrontApplet/Video/Video.d.ts +256 -19
  72. package/es6/FrontApplet/Video/Video.js +258 -22
  73. package/es6/FrontApplet/Video/Video.js.map +1 -1
  74. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"FileSystem.js","sourceRoot":"","sources":["../../../src/FrontApplet/FileSystem/FileSystem.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,mCAUiB;AAEjB,oEAA4C;AAI5C,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;AAE5D;;;;;;;;;;;;;GAaG;AACH,MAAqB,UAAU;IAOrB;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,aAAa,CAAC;IAE7C,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB;QAC5B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,wBAAwB;QACpC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,QAAoB;QAChD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,iCAAiC,CAAC,QAAoB;QAC5D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACI,kBAAkB;QACxB,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,aAAwB;QAC9C,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,aAAa;SACb,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,QAAmB;QACtC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC/B,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,QAAmB;QACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACvC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,QAAQ;SACR,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACb,CAAC;QACD,OAAO;YACN,GAAG,IAAI;YACP,GAAG,QAAQ;SACX,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,QAAmB,EAAE,QAAgB;QAC3D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,QAAmB,EAAE,QAAgB;QAC5D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;YACpC,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,QAAmB;QACxC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CAAC,cAAyB,EAAE,mBAA8B,EAAE,UAA4B,EAAE;QAC9G,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC3D,IAAA,kBAAQ,EAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,yBAAiB,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,cAAc;YACd,mBAAmB;YACnB,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,cAAyB,EAAE,mBAA8B,EAAE,UAA4B,EAAE;QAC9G,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC3D,IAAA,kBAAQ,EAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,yBAAiB,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,cAAc;YACd,mBAAmB;YACnB,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,QAAmB,EAAE,SAAkB;QAC9D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;YACpC,QAAQ;YACR,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACI,KAAK,CAAC,YAAY,CAAC,QAAmB,EAAE,SAAiB,EAAE,OAAkB;QACnF,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACzC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACtC,QAAQ;YACR,SAAS;YACT,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,eAA0B,EAAE,wBAAmC,EAAE,MAAc;QACvG,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC5D,IAAA,kBAAQ,EAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC1D,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACzC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,eAAe;YACf,wBAAwB;YACxB,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CAAC,eAA0B,EAAE,cAA2B;QACjF,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC5D,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;YAC5C,eAAe;YACf,cAAc;SACd,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,QAAmB,EAAE,QAAuB;QACxE,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;YAC1C,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,aAAwB;QACpD,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,aAAa;SACb,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,QAAmB;QAC3C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,cAAyB,EAAE,mBAA8B;QAC1E,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC3D,IAAA,kBAAQ,EAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAChE,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC7B,cAAc;YACd,mBAAmB;SACnB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;SAChC,CAAC,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAgC;QACxD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBAC5C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;gBACpD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,UAAU,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IAC1E,CAAC;;AAlXF,6BAmXC"}
1
+ {"version":3,"file":"FileSystem.js","sourceRoot":"","sources":["../../../src/FrontApplet/FileSystem/FileSystem.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,mCAWiB;AAEjB,oEAA4C;AAI5C,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAqB,UAAU;IAOrB;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,aAAa,CAAC;IAE7C,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,gBAAgB;QAC5B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,wBAAwB;QACpC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,QAAoB;QAChD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACI,iCAAiC,CAAC,QAAoB;QAC5D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACI,kBAAkB;QACxB,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,SAAS,CAAC,aAAwB;QAC9C,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,aAAa;SACb,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,MAAM,CAAC,QAAmB;QACtC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC/B,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,OAAO,CAAC,QAAmB;QACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACvC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,QAAQ;SACR,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACb,CAAC;QACD,OAAO;YACN,GAAG,IAAI;YACP,GAAG,QAAQ;SACX,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,SAAS,CAAC,QAAmB,EAAE,QAAgB;QAC3D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,UAAU,CAAC,QAAmB,EAAE,QAAgB;QAC5D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;YACpC,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,QAAQ,CAAC,QAAmB;QACxC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,QAAQ,CAAC,cAAyB,EAAE,mBAA8B,EAAE,UAA4B,EAAE;QAC9G,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC3D,IAAA,kBAAQ,EAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,yBAAiB,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,cAAc;YACd,mBAAmB;YACnB,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,QAAQ,CAAC,cAAyB,EAAE,mBAA8B,EAAE,UAA4B,EAAE;QAC9G,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC3D,IAAA,kBAAQ,EAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,yBAAiB,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,cAAc;YACd,mBAAmB;YACnB,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,UAAU,CAAC,QAAmB,EAAE,SAAkB;QAC9D,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC7C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;YACpC,QAAQ;YACR,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACI,KAAK,CAAC,YAAY,CAAC,QAAmB,EAAE,SAAiB,EAAE,OAAkB;QACnF,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACzC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACtC,QAAQ;YACR,SAAS;YACT,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,WAAW,CAAC,eAA0B,EAAE,wBAAmC,EAAE,MAAyB;QAClH,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC5D,IAAA,kBAAQ,EAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC1D,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACzC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,eAAe;YACf,wBAAwB;YACxB,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACI,KAAK,CAAC,aAAa,CAAC,eAA0B,EAAE,cAA2B;QACjF,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC5D,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;YAC5C,eAAe;YACf,cAAc;SACd,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,eAAe,CAAC,QAAmB,EAAE,QAAuB;QACxE,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;YAC1C,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,eAAe,CAAC,aAAwB;QACpD,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,aAAa;SACb,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,WAAW,CAAC,QAAmB;QAC3C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QACrD,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,QAAQ;SACR,CAAC,CAAC;QACH,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,IAAI,CAAC,cAAyB,EAAE,mBAA8B;QAC1E,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAC3D,IAAA,kBAAQ,EAAC,EAAE,mBAAmB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC;QAChE,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC7B,cAAc;YACd,mBAAmB;SACnB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;SAChC,CAAC,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAgC;QACxD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBAC5C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;gBACpD,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,UAAU,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IAC1E,CAAC;;AAluBF,6BAmuBC"}
@@ -1,2 +1,5 @@
1
1
  import { AnyString } from '../../utils/types';
2
- export type HashAlgorithm = 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'crc32' | AnyString;
2
+ /**
3
+ * Represents the supported hash algorithms by Core Apps.
4
+ */
5
+ export type HashAlgorithm = 'md5' | 'crc32' | AnyString;
@@ -1,8 +1,27 @@
1
+ import { AnyString } from '../../utils/types';
2
+ /**
3
+ * File System Storage Unit returned by the File System API.
4
+ */
1
5
  export interface IStorageUnit {
6
+ /**
7
+ * The type of the storage unit, e.g., "internal" or "external".
8
+ */
2
9
  type: string;
10
+ /**
11
+ * The total capacity of the storage unit in bytes.
12
+ */
3
13
  capacity: number;
14
+ /**
15
+ * The amount of free space available in the storage unit in bytes.
16
+ */
4
17
  freeSpace: number;
18
+ /**
19
+ * The amount of usable space in the storage unit in bytes.
20
+ */
5
21
  usableSpace: number;
22
+ /**
23
+ * Indicates whether the storage unit is removable (e.g., an SD card).
24
+ */
6
25
  removable: boolean;
7
26
  }
8
27
  export declare const VIStorageUnit: {
@@ -12,14 +31,41 @@ export declare const VIStorageUnit: {
12
31
  usableSpace: string;
13
32
  removable: string;
14
33
  };
34
+ /**
35
+ * Base File System interface for methods.
36
+ */
15
37
  export interface IFilePath {
38
+ /**
39
+ * Storage unit which is selected for performing file operations.
40
+ */
16
41
  storageUnit: IStorageUnit;
42
+ /**
43
+ * File path within the storage unit.
44
+ */
17
45
  filePath: string;
18
46
  }
47
+ /**
48
+ * Allowed extract method types for `extractFile()` operations.
49
+ */
50
+ export type ExtractMethodType = 'zip' | AnyString;
51
+ /**
52
+ * Properties of returned file from File System API.
53
+ */
19
54
  export interface IFile extends IFilePath {
20
55
  localUri: string;
56
+ /**
57
+ * Image thumbnail URI of the file, which can be used to display a preview of the file.
58
+ * Note: Supported only on Linux.
59
+ */
21
60
  imageThumbnailUriTemplate?: string;
61
+ /**
62
+ * Video thumbnail URI of the file, which can be used to display a preview of the file.
63
+ * Note: Supported only on Linux.
64
+ */
22
65
  videoThumbnailUriTemplate?: string;
66
+ /**
67
+ * Date and time when the file was created in milliseconds since the epoch.
68
+ */
23
69
  createdAt?: number;
24
70
  lastModifiedAt?: number;
25
71
  sizeBytes?: number;
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/FrontApplet/FileSystem/types.ts"],"names":[],"mappings":";;;AAQa,QAAA,aAAa,GAAG;IAC5B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,QAAQ;IACnB,WAAW,EAAE,QAAQ;IACrB,SAAS,EAAE,SAAS;CACpB,CAAC;AAkCW,QAAA,UAAU,GAAG;IACzB,WAAW,EAAE,EAAE,MAAM,EAAE,qBAAa,EAAE;IACtC,QAAQ,EAAE,QAAQ;CAClB,CAAC;AAMW,QAAA,iBAAiB,GAAG;IAChC,SAAS,EAAE,UAAU;CACrB,CAAC;AAMW,QAAA,iBAAiB,GAAG;IAChC,SAAS,EAAE,UAAU;CACrB,CAAC"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/FrontApplet/FileSystem/types.ts"],"names":[],"mappings":";;;AA4Ba,QAAA,aAAa,GAAG;IAC5B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,QAAQ;IACnB,WAAW,EAAE,QAAQ;IACrB,SAAS,EAAE,SAAS;CACpB,CAAC;AAqEW,QAAA,UAAU,GAAG;IACzB,WAAW,EAAE,EAAE,MAAM,EAAE,qBAAa,EAAE;IACtC,QAAQ,EAAE,QAAQ;CAClB,CAAC;AAMW,QAAA,iBAAiB,GAAG;IAChC,SAAS,EAAE,UAAU;CACrB,CAAC;AAMW,QAAA,iBAAiB,GAAG;IAChC,SAAS,EAAE,UAAU;CACrB,CAAC"}
@@ -23,18 +23,30 @@ import NativeCommands from './NativeCommands/NativeCommands';
23
23
  import { WeinreData } from './Debug/IDebug';
24
24
  import Connect from './Connect/Connect';
25
25
  /**
26
- * The `sos` API groups together all functionality the \@signageos/front-applet offers.
26
+ * The `sos` API groups together all functionality the \@signageos/front-applet offers. This is a basic object that provides you with access to
27
+ * all the applet functionality, such as device information, display control, video playback, and more.
27
28
  *
28
- * @tutorial https://developers.signageos.io/docs/applets/getting-started/#using-the-sos-sdk
29
+ * :::warning
30
+ * All calls to the sos object need to happen after `sos.onReady()` is resolved. After the sOS object is ready, there are global properties available, which can be used for applet customization and device identification.
31
+ * :::
32
+ *
33
+ * @example
34
+ * // Simple example of using the sos API to play a video.
35
+ * import sos from '@signageos/front-applet';
36
+ *
37
+ * sos.onReady().then(async function () {
38
+ * startYourApplet(); // Example method to run
39
+ * // Any other code
40
+ * }
29
41
  */
30
42
  export default class FrontApplet {
31
43
  readonly window: Window & WeinreData;
32
44
  private messagePrefix;
33
45
  /**
34
- * The `config` property is a Key-value dictionary of the applet configuration.
46
+ * The `config` property is a Key-value dictionary of the applet configuration. It is assigned on the device with timing via Box or SDK/Rest API.
35
47
  *
36
48
  * @since 1.5.0
37
- * @tutorial https://developers.signageos.io/docs/applets/configuration/
49
+ * @example // {@link https://developers.signageos.io/docs/sos-guides/configuration/ | How to use configuration}
38
50
  */
39
51
  readonly config: Record<string, number | string | boolean>;
40
52
  /**
@@ -46,13 +58,17 @@ export default class FrontApplet {
46
58
  * 3. The `authHash` can be used as a universal identifier for your Applet application.
47
59
  *
48
60
  * @since 1.0.0
49
- * @tutorial https://developers.signageos.io/docs/applets/api-guides/device-identification
61
+ * @tutorial https://developers.signageos.io/docs/sos-guides/device-identification
50
62
  */
51
63
  readonly authHash: string;
52
64
  /**
53
65
  * The `appletVersion` is the version of the current applet.
54
66
  *
55
67
  * @since 4.5.0
68
+ * @example
69
+ * sos.onReady().then(async function () {
70
+ * console.log(sos.appletVersion); // e.g. "4.5.0"
71
+ * });
56
72
  */
57
73
  readonly appletVersion: string;
58
74
  readonly apiJsUri: string | undefined;
@@ -89,6 +105,8 @@ export default class FrontApplet {
89
105
  * The `onReady()` method accepts an optional listener which is called after the sos API are loaded and ready. It also returns a promise
90
106
  * which is resolved at the same time as the listener.
91
107
  *
108
+ * @param listener Optional listener which is called when the sos API is ready.
109
+ * @return {Promise<void>} Promise which is resolved when the sos API is ready.
92
110
  * @since 1.0.0
93
111
  *
94
112
  * @example
@@ -110,11 +128,17 @@ export default class FrontApplet {
110
128
  * needs to be restarted as it's completely switching the playback 'loop/playlist'.
111
129
  *
112
130
  * @example
113
- * sos.restore();
131
+ * sos.onReady(async function () {
132
+ * // Some function which is called when the applet is ready
133
+ * sos.restore();
134
+ * });
114
135
  */
115
136
  restore(): void;
116
137
  /**
117
- * The `refresh()` method initializes refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
138
+ * The `refresh()` method initializes the refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
139
+ *
140
+ * @return {Promise<void>} Promise that is resolved when the refresh is completed.
141
+ * @since 1.0.0
118
142
  *
119
143
  * @example
120
144
  * await sos.refresh();
@@ -31,18 +31,30 @@ const ProofOfPlay_1 = __importDefault(require("./ProofOfPlay/ProofOfPlay"));
31
31
  const NativeCommands_1 = __importDefault(require("./NativeCommands/NativeCommands"));
32
32
  const Connect_1 = __importDefault(require("./Connect/Connect"));
33
33
  /**
34
- * The `sos` API groups together all functionality the \@signageos/front-applet offers.
34
+ * The `sos` API groups together all functionality the \@signageos/front-applet offers. This is a basic object that provides you with access to
35
+ * all the applet functionality, such as device information, display control, video playback, and more.
35
36
  *
36
- * @tutorial https://developers.signageos.io/docs/applets/getting-started/#using-the-sos-sdk
37
+ * :::warning
38
+ * All calls to the sos object need to happen after `sos.onReady()` is resolved. After the sOS object is ready, there are global properties available, which can be used for applet customization and device identification.
39
+ * :::
40
+ *
41
+ * @example
42
+ * // Simple example of using the sos API to play a video.
43
+ * import sos from '@signageos/front-applet';
44
+ *
45
+ * sos.onReady().then(async function () {
46
+ * startYourApplet(); // Example method to run
47
+ * // Any other code
48
+ * }
37
49
  */
38
50
  class FrontApplet {
39
51
  window;
40
52
  messagePrefix;
41
53
  /**
42
- * The `config` property is a Key-value dictionary of the applet configuration.
54
+ * The `config` property is a Key-value dictionary of the applet configuration. It is assigned on the device with timing via Box or SDK/Rest API.
43
55
  *
44
56
  * @since 1.5.0
45
- * @tutorial https://developers.signageos.io/docs/applets/configuration/
57
+ * @example // {@link https://developers.signageos.io/docs/sos-guides/configuration/ | How to use configuration}
46
58
  */
47
59
  config = undefined;
48
60
  /**
@@ -54,16 +66,20 @@ class FrontApplet {
54
66
  * 3. The `authHash` can be used as a universal identifier for your Applet application.
55
67
  *
56
68
  * @since 1.0.0
57
- * @tutorial https://developers.signageos.io/docs/applets/api-guides/device-identification
69
+ * @tutorial https://developers.signageos.io/docs/sos-guides/device-identification
58
70
  */
59
71
  authHash = undefined;
60
72
  /**
61
73
  * The `appletVersion` is the version of the current applet.
62
74
  *
63
75
  * @since 4.5.0
76
+ * @example
77
+ * sos.onReady().then(async function () {
78
+ * console.log(sos.appletVersion); // e.g. "4.5.0"
79
+ * });
64
80
  */
65
81
  appletVersion = undefined;
66
- // volatile, set if the FrontApplet is running inside of an iframe
82
+ // volatile, set if the FrontApplet is running inside an iframe
67
83
  apiJsUri;
68
84
  debug;
69
85
  deviceInfo;
@@ -151,6 +167,8 @@ class FrontApplet {
151
167
  * The `onReady()` method accepts an optional listener which is called after the sos API are loaded and ready. It also returns a promise
152
168
  * which is resolved at the same time as the listener.
153
169
  *
170
+ * @param listener Optional listener which is called when the sos API is ready.
171
+ * @return {Promise<void>} Promise which is resolved when the sos API is ready.
154
172
  * @since 1.0.0
155
173
  *
156
174
  * @example
@@ -182,7 +200,10 @@ class FrontApplet {
182
200
  * needs to be restarted as it's completely switching the playback 'loop/playlist'.
183
201
  *
184
202
  * @example
185
- * sos.restore();
203
+ * sos.onReady(async function () {
204
+ * // Some function which is called when the applet is ready
205
+ * sos.restore();
206
+ * });
186
207
  */
187
208
  restore() {
188
209
  void this.postMessage({ type: this.getMessage('restore') });
@@ -190,7 +211,10 @@ class FrontApplet {
190
211
  this.forwardRestoreToFrontAppletWindows();
191
212
  }
192
213
  /**
193
- * The `refresh()` method initializes refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
214
+ * The `refresh()` method initializes the refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
215
+ *
216
+ * @return {Promise<void>} Promise that is resolved when the refresh is completed.
217
+ * @since 1.0.0
194
218
  *
195
219
  * @example
196
220
  * await sos.refresh();
@@ -1 +1 @@
1
- {"version":3,"file":"FrontApplet.js","sourceRoot":"","sources":["../../src/FrontApplet/FrontApplet.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AACtC,gDAAsD;AAEtD,0DAAkC;AAClC,6DAAqC;AACrC,gEAAwC;AAExC,mHAA2F;AAC3F,gEAAwC;AACxC,mEAA2C;AAC3C,gEAAwC;AACxC,6DAAqC;AACrC,0DAAkC;AAClC,0DAAkC;AAClC,0DAAkC;AAClC,yEAAiD;AACjD,gEAAwC;AACxC,6DAAqC;AACrC,uDAA+B;AAC/B,yEAAiD;AACjD,qDAA2E;AAC3E,yEAAiD;AACjD,mEAA2C;AAC3C,gEAAwC;AACxC,kDAAqD;AACrD,oDAA4B;AAC5B,4EAAoD;AACpD,qFAA6D;AAE7D,gEAAwC;AAExC;;;;GAIG;AACH,MAAqB,WAAW;IA6Dd;IACR;IA7DT;;;;;OAKG;IACa,MAAM,GAA8C,SAAU,CAAC;IAE/E;;;;;;;;;;OAUG;IACa,QAAQ,GAAW,SAAU,CAAC;IAE9C;;;;OAIG;IACa,aAAa,GAAW,SAAU,CAAC;IAEnD,kEAAkE;IAClD,QAAQ,CAAqB;IAE7B,KAAK,CAAQ;IACb,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,KAAK,CAAQ;IACb,OAAO,CAAU;IACjB,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,MAAM,CAAS;IACf,IAAI,CAAO;IACX,UAAU,CAAa;IACvB,UAAU,CAAa;IACvB,QAAQ,CAAW;IACnB,GAAG,CAAM;IACT,WAAW,CAAc;IACzB,OAAO,CAAU;IACjB,MAAM,CAAiB;IACvB,OAAO,CAAU;IAEzB,YAAY,CAAe;IAC3B,yBAAyB,CAAe;IACxC,4BAA4B,CAAsB;IAE1D,gBAAgB;IAChB,YACiB,MAA2B,EACnC,aAAqB;QADb,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QAE7B,MAAM,YAAY,GAAG,IAAA,yBAAc,EAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhF,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,yBAAyB,GAAG,IAAI,qBAAY,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnH,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAc,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5D,IAAI,CAAC,4BAA4B,GAAG,IAAI,sCAA4B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5F,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,aAAa,GAAG,YAAY,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,WAAW,CAAC,IAAc;QAChC,MAAM,aAAa,GAAG,IAAA,8BAAkB,GAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,UAAU,CACrB,GAAG,EAAE,CACJ,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CACnC;YACC,aAAa;YACb,GAAG,IAAI;SACP,EACD,GAAG,CACH,CACF,CAAC;QACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAoC,EAAE,MAA4B,EAAE,EAAE;YACzF,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,YAAiB,EAAE,EAAE;gBACxE,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;oBACxB,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;wBAC9B,MAAM,CAAC,IAAA,yBAAW,EAAC,YAAY,CAAC,KAAK,CAAC,KAAgC,CAAC,CAAC,CAAC;oBAC1E,CAAC;yBAAM,CAAC;wBACP,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBAC5B,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC/B,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,OAAO,CAAC,QAAqB;QACnC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAmB,EAAE,EAAE;YAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACpC,OAAO,EAAE,CAAC;gBACV,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;oBACrC,QAAQ,EAAE,CAAC;gBACZ,CAAC;YACF,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,OAAO;QACb,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,kCAAkC,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACvC,CAAC,CAAC;IACJ,CAAC;IAEO,kCAAkC;QACzC,MAAM,IAAI,GAAG;YACZ,IAAI,EAAE,IAAI,CAAC,aAAa,GAAG,SAAS;SACpC,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAEO,oBAAoB;QAC3B,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAEO,YAAY;QACnB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACpG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACF,CAAC;IAEO,aAAa,CAAC,KAAmB;QACxC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAC5B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;wBACzC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC3E,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;wBACvC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;wBACzE,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;wBACpC,mBAAmB;wBACnB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;wBAC1B,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;wBACvC,mBAAmB;wBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;wBACnD,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;wBACpC,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;wBAC5C,mBAAmB;wBACnB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC;wBAClC,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;wBAC9B,kDAAkD;wBAClD,IAAI,CAAC,oBAAoB,EAAE,CAAC;wBAC5B,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;wBACrC,KAAK,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBACjF,MAAM;oBACP;wBACC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAClC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACpC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACxC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAC7C,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACtC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBACvC,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;iBAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,IAAI,CAAC,aAAa,GAAG,eAAe;wBACxC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;wBACpD,MAAM;oBACP,KAAK,IAAI,CAAC,aAAa,GAAG,YAAY;wBACrC,IAAI,CAAC,MAAM,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;wBACrD,MAAM;oBACP;wBACC,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC1D,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;IAEO,YAAY;QACnB,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtC,KAAK,MAAM,EAAE,CAAC;IACf,CAAC;CACD;AAtRD,8BAsRC;AAED,SAAS,QAAQ,CAAC,MAAiC;IAClD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC"}
1
+ {"version":3,"file":"FrontApplet.js","sourceRoot":"","sources":["../../src/FrontApplet/FrontApplet.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AACtC,gDAAsD;AAEtD,0DAAkC;AAClC,6DAAqC;AACrC,gEAAwC;AAExC,mHAA2F;AAC3F,gEAAwC;AACxC,mEAA2C;AAC3C,gEAAwC;AACxC,6DAAqC;AACrC,0DAAkC;AAClC,0DAAkC;AAClC,0DAAkC;AAClC,yEAAiD;AACjD,gEAAwC;AACxC,6DAAqC;AACrC,uDAA+B;AAC/B,yEAAiD;AACjD,qDAA2E;AAC3E,yEAAiD;AACjD,mEAA2C;AAC3C,gEAAwC;AACxC,kDAAqD;AACrD,oDAA4B;AAC5B,4EAAoD;AACpD,qFAA6D;AAE7D,gEAAwC;AAExC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAqB,WAAW;IAiEd;IACR;IAjET;;;;;OAKG;IACa,MAAM,GAA8C,SAAU,CAAC;IAE/E;;;;;;;;;;OAUG;IACa,QAAQ,GAAW,SAAU,CAAC;IAE9C;;;;;;;;OAQG;IACa,aAAa,GAAW,SAAU,CAAC;IAEnD,+DAA+D;IAC/C,QAAQ,CAAqB;IAE7B,KAAK,CAAQ;IACb,UAAU,CAAa;IACvB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,KAAK,CAAQ;IACb,OAAO,CAAU;IACjB,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IACjB,MAAM,CAAS;IACf,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,MAAM,CAAS;IACf,IAAI,CAAO;IACX,UAAU,CAAa;IACvB,UAAU,CAAa;IACvB,QAAQ,CAAW;IACnB,GAAG,CAAM;IACT,WAAW,CAAc;IACzB,OAAO,CAAU;IACjB,MAAM,CAAiB;IACvB,OAAO,CAAU;IAEzB,YAAY,CAAe;IAC3B,yBAAyB,CAAe;IACxC,4BAA4B,CAAsB;IAE1D,gBAAgB;IAChB,YACiB,MAA2B,EACnC,aAAqB;QADb,WAAM,GAAN,MAAM,CAAqB;QACnC,kBAAa,GAAb,aAAa,CAAQ;QAE7B,MAAM,YAAY,GAAG,IAAA,yBAAc,EAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhF,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,yBAAyB,GAAG,IAAI,qBAAY,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnH,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,aAAa,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAc,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5D,IAAI,CAAC,4BAA4B,GAAG,IAAI,sCAA4B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5F,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,aAAa,GAAG,YAAY,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,WAAW,CAAC,IAAc;QAChC,MAAM,aAAa,GAAG,IAAA,8BAAkB,GAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,UAAU,CACrB,GAAG,EAAE,CACJ,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CACnC;YACC,aAAa;YACb,GAAG,IAAI;SACP,EACD,GAAG,CACH,CACF,CAAC;QACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAoC,EAAE,MAA4B,EAAE,EAAE;YACzF,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,YAAiB,EAAE,EAAE;gBACxE,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;oBACxB,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;wBAC9B,MAAM,CAAC,IAAA,yBAAW,EAAC,YAAY,CAAC,KAAK,CAAC,KAAgC,CAAC,CAAC,CAAC;oBAC1E,CAAC;yBAAM,CAAC;wBACP,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBAC5B,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC/B,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,OAAO,CAAC,QAAqB;QACnC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAmB,EAAE,EAAE;YAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACpC,OAAO,EAAE,CAAC;gBACV,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;oBACrC,QAAQ,EAAE,CAAC;gBACZ,CAAC;YACF,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,OAAO;QACb,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,kCAAkC,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACvC,CAAC,CAAC;IACJ,CAAC;IAEO,kCAAkC;QACzC,MAAM,IAAI,GAAG;YACZ,IAAI,EAAE,IAAI,CAAC,aAAa,GAAG,SAAS;SACpC,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAEO,oBAAoB;QAC3B,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;IACnC,CAAC;IAEO,YAAY;QACnB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACpG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACF,CAAC;IAEO,aAAa,CAAC,KAAmB;QACxC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAC5B,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;wBACzC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;wBAC3E,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;wBACvC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;wBACzE,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;wBACpC,mBAAmB;wBACnB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;wBAC1B,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;wBACvC,mBAAmB;wBACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;wBACnD,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;wBACpC,IAAI,CAAC,YAAY,EAAE,CAAC;wBACpB,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;wBAC5C,mBAAmB;wBACnB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC;wBAClC,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;wBAC9B,kDAAkD;wBAClD,IAAI,CAAC,oBAAoB,EAAE,CAAC;wBAC5B,MAAM;oBACP,KAAK,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;wBACrC,KAAK,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBACjF,MAAM;oBACP;wBACC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAClC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACpC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACxC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBAC7C,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACtC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBACvC,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;iBAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,IAAI,CAAC,aAAa,GAAG,eAAe;wBACxC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;wBACpD,MAAM;oBACP,KAAK,IAAI,CAAC,aAAa,GAAG,YAAY;wBACrC,IAAI,CAAC,MAAM,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;wBACrD,MAAM;oBACP;wBACC,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC1D,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;IAEO,YAAY;QACnB,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtC,KAAK,MAAM,EAAE,CAAC;IACf,CAAC;CACD;AAlSD,8BAkSC;AAED,SAAS,QAAQ,CAAC,MAAiC;IAClD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC"}
@@ -1,9 +1,18 @@
1
+ /**
2
+ * KeyUp event interface for handling key release events.
3
+ */
1
4
  interface IKeyUpEvent {
2
5
  type: 'keyup';
3
6
  keyCode: KeyUpEventMap;
4
7
  keyName: keyof typeof KeyUpEventMap;
5
8
  }
6
9
  export default IKeyUpEvent;
10
+ /**
11
+ * Enum of supported key codes for KeyUp events.
12
+ *
13
+ * @remarks
14
+ * If a key is not listed here, it will show warning in the console.
15
+ */
7
16
  export declare enum KeyUpEventMap {
8
17
  UNKNOWN = 0,
9
18
  NUM_0 = 1,
@@ -1,6 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.KeyUpEventMap = void 0;
4
+ /**
5
+ * Enum of supported key codes for KeyUp events.
6
+ *
7
+ * @remarks
8
+ * If a key is not listed here, it will show warning in the console.
9
+ */
4
10
  var KeyUpEventMap;
5
11
  (function (KeyUpEventMap) {
6
12
  KeyUpEventMap[KeyUpEventMap["UNKNOWN"] = 0] = "UNKNOWN";
@@ -1 +1 @@
1
- {"version":3,"file":"IKeyUpEvent.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/IKeyUpEvent.ts"],"names":[],"mappings":";;;AAQA,IAAY,aA6BX;AA7BD,WAAY,aAAa;IACxB,uDAAW,CAAA;IACX,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,oDAAU,CAAA;IACV,8DAAe,CAAA;IACf,0DAAa,CAAA;IACb,gEAAgB,CAAA;IAChB,8DAAe,CAAA;IACf,sDAAW,CAAA;IACX,kDAAS,CAAA;IACT,gDAAQ,CAAA;IACR,oDAAU,CAAA;IACV,gEAAgB,CAAA;IAChB,4DAAc,CAAA;IACd,oDAAU,CAAA;IACV,4DAAc,CAAA;IACd,kDAAS,CAAA;IACT,kDAAS,CAAA;IACT,sDAAW,CAAA;IACX,4DAAc,CAAA;IACd,kDAAS,CAAA;AACV,CAAC,EA7BW,aAAa,6BAAb,aAAa,QA6BxB"}
1
+ {"version":3,"file":"IKeyUpEvent.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/IKeyUpEvent.ts"],"names":[],"mappings":";;;AAcA;;;;;GAKG;AACH,IAAY,aA6BX;AA7BD,WAAY,aAAa;IACxB,uDAAW,CAAA;IACX,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,mDAAS,CAAA;IACT,oDAAU,CAAA;IACV,8DAAe,CAAA;IACf,0DAAa,CAAA;IACb,gEAAgB,CAAA;IAChB,8DAAe,CAAA;IACf,sDAAW,CAAA;IACX,kDAAS,CAAA;IACT,gDAAQ,CAAA;IACR,oDAAU,CAAA;IACV,gEAAgB,CAAA;IAChB,4DAAc,CAAA;IACd,oDAAU,CAAA;IACV,4DAAc,CAAA;IACd,kDAAS,CAAA;IACT,kDAAS,CAAA;IACT,sDAAW,CAAA;IACX,4DAAc,CAAA;IACd,kDAAS,CAAA;AACV,CAAC,EA7BW,aAAa,6BAAb,aAAa,QA6BxB"}
@@ -1,6 +1,10 @@
1
1
  import IInputKeyMessage from './IInputKeyMessage';
2
2
  import IKeyUpEvent from './IKeyUpEvent';
3
3
  import IInput from './IInput';
4
+ /**
5
+ * The `sos.input` API groups together all input-related functionality, such as remote control key events. With this API, you can
6
+ * listen to key events from the remote control and handle them in your application.
7
+ */
4
8
  export default class Input implements IInput {
5
9
  readonly window: Window;
6
10
  private readonly messagePrefix;
@@ -13,11 +17,19 @@ export default class Input implements IInput {
13
17
  /** @internal */
14
18
  destroy(): void;
15
19
  /**
16
- * The `onKeyUp` method sets up a listeners, which is called on every key stroke of the remote controller. For the specific logic of an
20
+ * The `onKeyUp` method sets up a listeners, which is called on every keystroke of the remote controller. For the specific logic of an
17
21
  * application (games for example), binding the remote control inputs can be helpful. Only a subset of all remote control keys is
18
22
  * supported on the specific device. Only numerical digits are guaranteed to be supported.
19
23
  *
24
+ * :::note
20
25
  * This feature must be tested by users on real devices.
26
+ * :::
27
+ *
28
+ * @param listener The listener function that will be called on every key up event.
29
+ * @returns {void} Resolves when the listener is successfully set up.
30
+ * @throws {Error} If listener is not valid function.
31
+ * @throws {Error} If listener is unregistered.
32
+ * @since 1.3.0
21
33
  */
22
34
  onKeyUp(listener: (event: IKeyUpEvent) => void): void;
23
35
  /** @internal */
@@ -28,6 +40,10 @@ export default class Input implements IInput {
28
40
  removeEventListeners(): void;
29
41
  /**
30
42
  * The `removeEventListener()` method removes all event listeners for a specific event (only `keyup` is supported).
43
+ *
44
+ * @param event The name of the event to remove the listener for. Currently, only `keyup` is supported.
45
+ * @param listener The listener function to remove.
46
+ * @returns {void} Resolves when the listener is successfully removed.
31
47
  */
32
48
  removeEventListener(event: 'keyup', listener: (...args: any[]) => void): void;
33
49
  /** @internal */
@@ -5,6 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const events_1 = require("events");
7
7
  const Validate_1 = __importDefault(require("../Validate/Validate"));
8
+ /**
9
+ * The `sos.input` API groups together all input-related functionality, such as remote control key events. With this API, you can
10
+ * listen to key events from the remote control and handle them in your application.
11
+ */
8
12
  class Input {
9
13
  window;
10
14
  messagePrefix;
@@ -32,11 +36,19 @@ class Input {
32
36
  }
33
37
  }
34
38
  /**
35
- * The `onKeyUp` method sets up a listeners, which is called on every key stroke of the remote controller. For the specific logic of an
39
+ * The `onKeyUp` method sets up a listeners, which is called on every keystroke of the remote controller. For the specific logic of an
36
40
  * application (games for example), binding the remote control inputs can be helpful. Only a subset of all remote control keys is
37
41
  * supported on the specific device. Only numerical digits are guaranteed to be supported.
38
42
  *
43
+ * :::note
39
44
  * This feature must be tested by users on real devices.
45
+ * :::
46
+ *
47
+ * @param listener The listener function that will be called on every key up event.
48
+ * @returns {void} Resolves when the listener is successfully set up.
49
+ * @throws {Error} If listener is not valid function.
50
+ * @throws {Error} If listener is unregistered.
51
+ * @since 1.3.0
40
52
  */
41
53
  onKeyUp(listener) {
42
54
  this.checkAlive();
@@ -65,6 +77,10 @@ class Input {
65
77
  }
66
78
  /**
67
79
  * The `removeEventListener()` method removes all event listeners for a specific event (only `keyup` is supported).
80
+ *
81
+ * @param event The name of the event to remove the listener for. Currently, only `keyup` is supported.
82
+ * @param listener The listener function to remove.
83
+ * @returns {void} Resolves when the listener is successfully removed.
68
84
  */
69
85
  removeEventListener(event, listener) {
70
86
  this.eventEmitter.removeListener(event, listener);
@@ -1 +1 @@
1
- {"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/Input.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAGtC,oEAA4C;AAG5C,MAAqB,KAAK;IAUR;IACC;IAVX,MAAM,CAAU,cAAc,GAAW,OAAO,CAAC;IAEvC,YAAY,GAAiB,IAAI,qBAAY,EAAE,CAAC;IAChD,sBAAsB,GAAY,KAAK,CAAC;IAEjD,KAAK,GAAY,IAAI,CAAC;IAE9B,gBAAgB;IAChB,YACiB,MAAc,EACb,aAAqB;QADtB,WAAM,GAAN,MAAM,CAAQ;QACb,kBAAa,GAAb,aAAa,CAAQ;QAEtC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YAC7D,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACnE,CAAC;IACF,CAAC;IAED,gBAAgB;IACT,OAAO;QACb,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACjC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACtE,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,QAAsC;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAsB;QAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,MAAM,UAAU,GAAgB;oBAC/B,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAqC;iBACnD,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBAChC,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAED;;OAEG;IACI,oBAAoB;QAC1B,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,KAAc,EAAE,QAAkC;QAC5E,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAkB;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,eAAe;QACtB,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C,CAAC;IAEO,qBAAqB;QAC5B,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBAChB,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,YAAY,EAAE,CAAC;gBAC/B,yEAAyE;gBACzE,8FAA8F;gBAC9F,yFAAyF;gBACzF,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBAClD,OAAO,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;IACF,CAAC;IAEO,qBAAqB,GAAG,CAAC,KAAoB,EAAE,EAAE;QACxD,IAAI,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;gBACjC,0DAA0D;gBAC1D,oDAAoD;gBACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;IACF,CAAC,CAAC;IAEM,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;IAEO,UAAU;QACjB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;IACF,CAAC;;AA5HF,wBA6HC"}
1
+ {"version":3,"file":"Input.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/Input.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAGtC,oEAA4C;AAG5C;;;GAGG;AACH,MAAqB,KAAK;IAUR;IACC;IAVX,MAAM,CAAU,cAAc,GAAW,OAAO,CAAC;IAEvC,YAAY,GAAiB,IAAI,qBAAY,EAAE,CAAC;IAChD,sBAAsB,GAAY,KAAK,CAAC;IAEjD,KAAK,GAAY,IAAI,CAAC;IAE9B,gBAAgB;IAChB,YACiB,MAAc,EACb,aAAqB;QADtB,WAAM,GAAN,MAAM,CAAQ;QACb,kBAAa,GAAb,aAAa,CAAQ;QAEtC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YAC7D,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACnE,CAAC;IACF,CAAC;IAED,gBAAgB;IACT,OAAO;QACb,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACjC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACtE,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,OAAO,CAAC,QAAsC;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAsB;QAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,MAAM,UAAU,GAAgB;oBAC/B,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAqC;iBACnD,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBAChC,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAED;;OAEG;IACI,oBAAoB;QAC1B,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAC,KAAc,EAAE,QAAkC;QAC5E,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,gBAAgB;IACT,cAAc,CAAC,KAAkB;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEO,eAAe;QACtB,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C,CAAC;IAEO,qBAAqB;QAC5B,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBAChB,OAAO,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,YAAY,EAAE,CAAC;gBAC/B,yEAAyE;gBACzE,8FAA8F;gBAC9F,yFAAyF;gBACzF,OAAO,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;gBAClD,OAAO,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;IACF,CAAC;IAEO,qBAAqB,GAAG,CAAC,KAAoB,EAAE,EAAE;QACxD,IAAI,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9E,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;gBACjC,0DAA0D;gBAC1D,oDAAoD;gBACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACP,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;IACF,CAAC,CAAC;IAEM,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACrE,CAAC;IAEO,UAAU;QACjB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC;IACF,CAAC;;AAxIF,wBAyIC"}
@@ -1,25 +1,39 @@
1
1
  import IPostMessage from '../../IPostMessage';
2
2
  import { CodesMDC } from './CodesMDC';
3
3
  import INativeMdcCommands from './INativeMdcCommands';
4
+ /**
5
+ * Type representing the IP address to which MDC commands can be sent.
6
+ * It can be either 'localhost' or a valid string representing an IP address.
7
+ */
4
8
  export type IpAddressType = 'localhost' | string;
9
+ /**
10
+ * Response object returned by Tizen Core App.
11
+ */
5
12
  export interface IMDCResponse {
13
+ /**
14
+ * The type of the response, either 'ACK' for acknowledgment or 'NACK' for negative acknowledgment.
15
+ */
6
16
  type: 'ACK' | 'NACK';
17
+ /**
18
+ * The command type that was executed, represented as a number.
19
+ * Should match the command number in {@link CodesMDC}.
20
+ */
7
21
  commandType: number;
22
+ /**
23
+ * The result of the command execution, represented as a number.
24
+ * This value can vary depending on the command executed.
25
+ */
8
26
  result: number;
9
27
  }
10
28
  /**
11
29
  * The `sos.native.mdc` API groups together methods for controlling Tizen devices using MDC commands.
12
30
  *
13
31
  * :::warning
14
- *
15
32
  * This API is currently available on Tizen devices only.
16
- *
17
33
  * :::
18
34
  *
19
35
  * :::info
20
- *
21
36
  * You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
22
- *
23
37
  * :::
24
38
  */
25
39
  export default class Mdc implements INativeMdcCommands {
@@ -32,18 +46,21 @@ export default class Mdc implements INativeMdcCommands {
32
46
  * The `sendOne()` method sends an MDC command to another Tizen device on the same network or to the localhost.
33
47
  *
34
48
  * @param ipAddress The IP address of the device to send the command to.
35
- * @param command The MDC command to send.
49
+ * @param command The MDC command to send {@link CodesMDC}.
36
50
  * @param data The optional data to send with the command.
37
- *
51
+ * @throws {Error} If the `ipAddress` is not a valid string or if the `command` is not a valid number.
52
+ * @throws {Error} If the `data` is not an array of numbers.
53
+ * @throws {Error} If any error occurs during the command execution.
54
+ * @returns {Promise<IMDCResponse>} MDC response object containing the result of the command execution.
38
55
  * @since 6.5.1
39
56
  *
40
57
  * @example
41
- * await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
42
- * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
43
- * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
58
+ * await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL);
59
+ * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]);
60
+ * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]);
44
61
  *
45
62
  * // You can also send custom number if we don't have predefined command in our enum
46
- * await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
63
+ * await sos.native.mdc.sendOne('192.168.0.10', 0x01, []);
47
64
  */
48
65
  sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[]): Promise<IMDCResponse>;
49
66
  /**
@@ -51,7 +68,11 @@ export default class Mdc implements INativeMdcCommands {
51
68
  * but without explicitly specifying the command.
52
69
  *
53
70
  * @param ipAddress The IP address of the device to send the command to.
54
- * @param data The data to send with the command.
71
+ * @param data The data as array of numbers to send with the command. It can be also empty array.
72
+ * @throws {Error} If the `ipAddress` is not a valid string or if the `command` is not a valid number.
73
+ * @throws {Error} If the `data` is not an array of numbers.
74
+ * @throws {Error} If any error occurs during the command execution.
75
+ * @returns {Promise<IMDCResponse>} MDC response object containing the result of the command execution.
55
76
  *
56
77
  * @since 6.5.1
57
78
  *
@@ -8,15 +8,11 @@ const Validate_1 = __importDefault(require("../../Validate/Validate"));
8
8
  * The `sos.native.mdc` API groups together methods for controlling Tizen devices using MDC commands.
9
9
  *
10
10
  * :::warning
11
- *
12
11
  * This API is currently available on Tizen devices only.
13
- *
14
12
  * :::
15
13
  *
16
14
  * :::info
17
- *
18
15
  * You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
19
- *
20
16
  * :::
21
17
  */
22
18
  class Mdc {
@@ -32,18 +28,21 @@ class Mdc {
32
28
  * The `sendOne()` method sends an MDC command to another Tizen device on the same network or to the localhost.
33
29
  *
34
30
  * @param ipAddress The IP address of the device to send the command to.
35
- * @param command The MDC command to send.
31
+ * @param command The MDC command to send {@link CodesMDC}.
36
32
  * @param data The optional data to send with the command.
37
- *
33
+ * @throws {Error} If the `ipAddress` is not a valid string or if the `command` is not a valid number.
34
+ * @throws {Error} If the `data` is not an array of numbers.
35
+ * @throws {Error} If any error occurs during the command execution.
36
+ * @returns {Promise<IMDCResponse>} MDC response object containing the result of the command execution.
38
37
  * @since 6.5.1
39
38
  *
40
39
  * @example
41
- * await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
42
- * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
43
- * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
40
+ * await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL);
41
+ * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]);
42
+ * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]);
44
43
  *
45
44
  * // You can also send custom number if we don't have predefined command in our enum
46
- * await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
45
+ * await sos.native.mdc.sendOne('192.168.0.10', 0x01, []);
47
46
  */
48
47
  async sendOne(ipAddress, command, data) {
49
48
  (0, Validate_1.default)({ ipAddress }).required().string();
@@ -67,7 +66,11 @@ class Mdc {
67
66
  * but without explicitly specifying the command.
68
67
  *
69
68
  * @param ipAddress The IP address of the device to send the command to.
70
- * @param data The data to send with the command.
69
+ * @param data The data as array of numbers to send with the command. It can be also empty array.
70
+ * @throws {Error} If the `ipAddress` is not a valid string or if the `command` is not a valid number.
71
+ * @throws {Error} If the `data` is not an array of numbers.
72
+ * @throws {Error} If any error occurs during the command execution.
73
+ * @returns {Promise<IMDCResponse>} MDC response object containing the result of the command execution.
71
74
  *
72
75
  * @since 6.5.1
73
76
  *
@@ -1 +1 @@
1
- {"version":3,"file":"Mdc.js","sourceRoot":"","sources":["../../../../src/FrontApplet/NativeCommands/MDC/Mdc.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAW/C;;;;;;;;;;;;;;GAcG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,OAAO,CAAC,SAAwB,EAAE,OAAiB,EAAE,IAAe;QAChF,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,IAAI,GAAG,EAAE,CAAC;QACX,CAAC;QAED,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,SAAS;YACT,OAAO;YACP,IAAI;SACJ,CAAC,CAAC;QACH,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,UAAU,CAAC,SAAwB,EAAE,IAAmB;QACpE,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE9C,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,SAAS;YACT,IAAI;SACJ,CAAC,CAAC;QACH,OAAO,eAAe,CAAC;IACxB,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,GAAG,CAAC,cAAc,CAAC;IACtD,CAAC;;AAlFF,sBAmFC"}
1
+ {"version":3,"file":"Mdc.js","sourceRoot":"","sources":["../../../../src/FrontApplet/NativeCommands/MDC/Mdc.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAgC/C;;;;;;;;;;GAUG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,OAAO,CAAC,SAAwB,EAAE,OAAiB,EAAE,IAAe;QAChF,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,IAAI,GAAG,EAAE,CAAC;QACX,CAAC;QAED,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,SAAS;YACT,OAAO;YACP,IAAI;SACJ,CAAC,CAAC;QACH,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,UAAU,CAAC,SAAwB,EAAE,IAAmB;QACpE,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE9C,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,SAAS;YACT,IAAI;SACJ,CAAC,CAAC;QACH,OAAO,eAAe,CAAC;IACxB,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,GAAG,CAAC,cAAc,CAAC;IACtD,CAAC;;AAzFF,sBA0FC"}