@signageos/front-applet 7.1.1 → 8.0.0

package/es6/FrontApplet/Hardware/Hardware.js

@@ -1,19 +1,24 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const events_1 = require("events");
-const Led_1 = require("./Led/Led");
-const SerialPort_1 = require("./SerialPort");
-const BarcodeScanner_1 = require("./BarcodeScanner/BarcodeScanner");
+const Led_1 = __importDefault(require("./Led/Led"));
+const SerialPort_1 = __importDefault(require("./SerialPort"));
+const BarcodeScanner_1 = __importDefault(require("./BarcodeScanner/BarcodeScanner"));
+// TODO: add warnings from the old docs
+/**
+ * The `sos.hardware` API groups together methods for working with hardware. It allows opening serials ports, using bar scanner or controlling LEDs.
+ */
 class Hardware {
+    messagePrefix;
+    postMessage;
+    static MESSAGE_PREFIX = 'hardware';
+    led;
+    barcodeScanner;
+    eventEmitter;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
@@ -21,15 +26,23 @@ class Hardware {
         this.led = new Led_1.default(this.getMessagePrefix(), this.postMessage);
         this.barcodeScanner = new BarcodeScanner_1.default(this.getMessagePrefix(), this.postMessage);
     }
-    openSerialPort(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { refid } = yield this.postMessage({
-                type: this.getMessage('serial_port.open'),
-                options,
-            });
-            return new SerialPort_1.default(refid, this.eventEmitter, this.getMessagePrefix(), this.postMessage);
+    /**
+     * The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns ISerialPort interface.
+     * @param options.device Specifies the address of the external device.
+     * @param options.baudRate Specifies the data transmission speed in bits per second.
+     * @param options.parity Specifies the form of error checking, whether (or what) extra bits are added to a byte.
+     * @param options.databits Specifies the number of bits in a byte.
+     * @param options.stopbits Specifies the number of bits used to signal the end of a communication packet.
+     * @param options.rtscts  Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign.
+     */
+    async openSerialPort(options) {
+        const { refid } = await this.postMessage({
+            type: this.getMessage('serial_port.open'),
+            options,
         });
+        return new SerialPort_1.default(refid, this.eventEmitter, this.getMessagePrefix(), this.postMessage);
     }
+    /** @internal */
     handleMessageData(data) {
         switch (data.type) {
             case this.getMessage('serial_port.data'):
@@ -47,5 +60,4 @@ class Hardware {
     }
 }
 exports.default = Hardware;
-Hardware.MESSAGE_PREFIX = 'hardware';
 //# sourceMappingURL=Hardware.js.map

package/es6/FrontApplet/Hardware/Hardware.js.map

@@ -1 +1 @@
-{"version":3,"file":"Hardware.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/Hardware.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAAsC;AAEtC,mCAA4B;AAC5B,6CAAsC;AAGtC,oEAA6D;AAI7D,MAAqB,QAAQ;IAQ5B,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,wBAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IAEY,cAAc,CAAC,OAA2B;;YACtD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACzC,OAAO;aACP,CAAC,CAAC;YACH,OAAO,IAAI,oBAAU,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5F,CAAC;KAAA;IAEM,iBAAiB,CAAC,IAAyD;QACjF,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpE,MAAM;YACP;gBACC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAkC,CAAC,CAAC;SAC3E;IACF,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,QAAQ,CAAC,cAAc,CAAC;IAC3D,CAAC;;AAzCF,2BA0CC;AAzCc,uBAAc,GAAW,UAAU,CAAC"}
+{"version":3,"file":"Hardware.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/Hardware.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oDAA4B;AAC5B,8DAAsC;AAGtC,qFAA6D;AAK7D,uCAAuC;AACvC;;GAEG;AACH,MAAqB,QAAQ;IAUnB;IACA;IAVF,MAAM,CAAC,cAAc,GAAW,UAAU,CAAC;IAElC,GAAG,CAAM;IAClB,cAAc,CAAiB;IAE9B,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;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,wBAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc,CAAC,OAA2B;QACtD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,OAAO;SACP,CAAC,CAAC;QACH,OAAO,IAAI,oBAAU,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5F,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAyD;QACjF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpE,MAAM;YACP;gBACC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAkC,CAAC,CAAC;QAC5E,CAAC;IACF,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,QAAQ,CAAC,cAAc,CAAC;IAC3D,CAAC;;AApDF,2BAqDC"}

package/es6/FrontApplet/Hardware/IHardware.d.ts

@@ -1,5 +1,5 @@
+import ISerialPort from './ISerialPort';
 import ISerialPortOptions from './ISerialPortOptions';
-import SerialPort from './SerialPort';
 export default interface IHardware {
-    openSerialPort(options: ISerialPortOptions): Promise<SerialPort>;
+    openSerialPort(options: ISerialPortOptions): Promise<ISerialPort>;
 }

package/es6/FrontApplet/Hardware/ISerialPort.d.ts

@@ -1,5 +1,21 @@
 export default interface ISerialPort {
+    /**
+     * The `onData()` method sets up a listener, which is called whenever new data are received. The listener will stop after the serial port
+     * is closed.
+     */
     onData(listener: (data: Uint8Array) => void): void;
+    /**
+     * The `write()` method writes data to the serial port. The data can be a string of hexadecimal digits, array of numbers or Uint8Array
+     *
+     * @example
+     * // serial port instance previously created via sos.hardware.openSerialPort()
+     * await serialPort.write('68656c6c6f'); // hexadecimal string
+     * await serialPort.write([ 10, 20, 30, 40 ]); // array of numbers
+     * await serialPort.write(Uint8Array.from([ 10, 20, 30, 40 ])); // Uint8Array
+     */
     write(data: string | number[] | Uint8Array): Promise<void>;
+    /**
+     * The `close()` method closes the serial port.
+     */
     close(): Promise<void>;
 }

package/es6/FrontApplet/Hardware/ISerialPortOptions.js

@@ -8,5 +8,5 @@ var Parity;
     Parity["MARK"] = "mark";
     Parity["ODD"] = "odd";
     Parity["SPACE"] = "space";
-})(Parity = exports.Parity || (exports.Parity = {}));
+})(Parity || (exports.Parity = Parity = {}));
 //# sourceMappingURL=ISerialPortOptions.js.map

package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISerialPortOptions.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/ISerialPortOptions.ts"],"names":[],"mappings":";;;AAAA,IAAY,MAMX;AAND,WAAY,MAAM;IACjB,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,qBAAW,CAAA;IACX,yBAAe,CAAA;AAChB,CAAC,EANW,MAAM,GAAN,cAAM,KAAN,cAAM,QAMjB"}
+{"version":3,"file":"ISerialPortOptions.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/ISerialPortOptions.ts"],"names":[],"mappings":";;;AAAA,IAAY,MAMX;AAND,WAAY,MAAM;IACjB,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,qBAAW,CAAA;IACX,yBAAe,CAAA;AAChB,CAAC,EANW,MAAM,sBAAN,MAAM,QAMjB"}

package/es6/FrontApplet/Hardware/Led/Led.d.ts

@@ -1,11 +1,19 @@
 import IPostMessage from '../../IPostMessage';
 import ISetColorMessage from './ISetColorMessage';
 import ILed from './ILed';
+/**
+ * The `sos.hardware.led` API groups together methods for controlling LEDs of the device. **This is currently only supported by Phillips
+ * devices.**
+ */
 export default class Led implements ILed {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<ISetColorMessage>);
+    /**
+     * The `setColor()` methods sets the LED color (if string is passed) or disabled (if null is passed).
+     */
     setColor(color: string | null): Promise<void>;
     private checkColorValidity;
     private getMessage;

package/es6/FrontApplet/Hardware/Led/Led.js

@@ -1,33 +1,36 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ErrorCodes_1 = require("../../Error/ErrorCodes");
-const Validate_1 = require("../../Validate/Validate");
+const ErrorCodes_1 = __importDefault(require("../../Error/ErrorCodes"));
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
+/**
+ * The `sos.hardware.led` API groups together methods for controlling LEDs of the device. **This is currently only supported by Phillips
+ * devices.**
+ */
 class Led {
+    messagePrefix;
+    postMessage;
+    static MESSAGE_PREFIX = 'led';
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    setColor(color) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.checkColorValidity(color);
-            yield this.postMessage({
-                type: this.getMessage('set_color'),
-                color: color ? color.toUpperCase() : null,
-            });
+    /**
+     * The `setColor()` methods sets the LED color (if string is passed) or disabled (if null is passed).
+     */
+    async setColor(color) {
+        this.checkColorValidity(color);
+        await this.postMessage({
+            type: this.getMessage('set_color'),
+            color: color ? color.toUpperCase() : null,
         });
     }
     checkColorValidity(color) {
-        Validate_1.default({ color }).canBeNull().string(null, ErrorCodes_1.default.HARDWARE_LED_COLOR_IS_NOT_STRING);
-        Validate_1.default({ color })
+        (0, Validate_1.default)({ color }).canBeNull().string(null, ErrorCodes_1.default.HARDWARE_LED_COLOR_IS_NOT_STRING);
+        (0, Validate_1.default)({ color })
             .canBeNull()
             .matchRegExp(/^#[0-9A-Fa-f]{6,6}$/, ErrorCodes_1.default.HARDWARE_LED_COLOR_IS_NOT_VALID);
     }
@@ -36,5 +39,4 @@ class Led {
     }
 }
 exports.default = Led;
-Led.MESSAGE_PREFIX = 'led';
 //# sourceMappingURL=Led.js.map

package/es6/FrontApplet/Hardware/Led/Led.js.map

@@ -1 +1 @@
-{"version":3,"file":"Led.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Hardware/Led/Led.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,uDAAgD;AAChD,sDAA+C;AAG/C,MAAqB,GAAG;IAGvB,YACS,aAAqB,EACrB,WAA2C;QAD3C,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAgC;IACjD,CAAC;IAES,QAAQ,CAAC,KAAoB;;YACzC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAClC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI;aACzC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,kBAAkB,CAAC,KAAoB;QAC9C,kBAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,oBAAU,CAAC,gCAAgC,CAAC,CAAC;QAC1F,kBAAQ,CAAC,EAAE,KAAK,EAAE,CAAC;aACjB,SAAS,EAAE;aACX,WAAW,CAAC,qBAAqB,EAAE,oBAAU,CAAC,+BAA+B,CAAC,CAAC;IAClF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AAzBF,sBA0BC;AAzBc,kBAAc,GAAW,KAAK,CAAC"}
+{"version":3,"file":"Led.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Hardware/Led/Led.ts"],"names":[],"mappings":";;;;;AAEA,wEAAgD;AAChD,uEAA+C;AAG/C;;;GAGG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA2C;QAD3C,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAgC;IACjD,CAAC;IAEJ;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,KAAoB;QACzC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI;SACzC,CAAC,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,KAAoB;QAC9C,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,oBAAU,CAAC,gCAAgC,CAAC,CAAC;QAC1F,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC;aACjB,SAAS,EAAE;aACX,WAAW,CAAC,qBAAqB,EAAE,oBAAU,CAAC,+BAA+B,CAAC,CAAC;IAClF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AA7BF,sBA8BC"}

package/es6/FrontApplet/Hardware/SerialPort.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import IPostMessage from '../IPostMessage';
 import ISerialPort from './ISerialPort';
@@ -7,6 +6,7 @@ export default class SerialPort implements ISerialPort {
     private eventEmitter;
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(refid: string, eventEmitter: EventEmitter, messagePrefix: string, postMessage: IPostMessage<any>);
     onData(listener: (data: Uint8Array) => void): void;
     write(data: string | number[] | Uint8Array): Promise<void>;

package/es6/FrontApplet/Hardware/SerialPort.js

@@ -1,15 +1,11 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 class SerialPort {
+    refid;
+    eventEmitter;
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(refid, eventEmitter, messagePrefix, postMessage) {
         this.refid = refid;
         this.eventEmitter = eventEmitter;
@@ -19,23 +15,19 @@ class SerialPort {
     onData(listener) {
         this.eventEmitter.addListener('serial_port.data.' + this.refid, listener);
     }
-    write(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('serial_port.write'),
-                refid: this.refid,
-                data,
-            });
+    async write(data) {
+        await this.postMessage({
+            type: this.getMessage('serial_port.write'),
+            refid: this.refid,
+            data,
         });
     }
-    close() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('serial_port.close'),
-                refid: this.refid,
-            });
-            this.eventEmitter.removeAllListeners('serial_port.data.' + this.refid);
+    async close() {
+        await this.postMessage({
+            type: this.getMessage('serial_port.close'),
+            refid: this.refid,
         });
+        this.eventEmitter.removeAllListeners('serial_port.data.' + this.refid);
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

package/es6/FrontApplet/Hardware/SerialPort.js.map

@@ -1 +1 @@
-{"version":3,"file":"SerialPort.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/SerialPort.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,MAAqB,UAAU;IAC9B,YACS,KAAa,EACb,YAA0B,EAC1B,aAAqB,EACrB,WAA8B;QAH9B,UAAK,GAAL,KAAK,CAAQ;QACb,iBAAY,GAAZ,YAAY,CAAc;QAC1B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEG,MAAM,CAAC,QAAoC;QACjD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC3E,CAAC;IAEY,KAAK,CAAC,IAAoC;;YACtD,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC1C,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,IAAI;aACJ,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,KAAK;;YACjB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC1C,KAAK,EAAE,IAAI,CAAC,KAAK;aACjB,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACxE,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA/BD,6BA+BC"}
+{"version":3,"file":"SerialPort.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/SerialPort.ts"],"names":[],"mappings":";;AAKA,MAAqB,UAAU;IAGrB;IACA;IACA;IACA;IALT,gBAAgB;IAChB,YACS,KAAa,EACb,YAA0B,EAC1B,aAAqB,EACrB,WAA8B;QAH9B,UAAK,GAAL,KAAK,CAAQ;QACb,iBAAY,GAAZ,YAAY,CAAc;QAC1B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEG,MAAM,CAAC,QAAoC;QACjD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC3E,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,IAAoC;QACtD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;YAC1C,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI;SACJ,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK;QACjB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;YAC1C,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACxE,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAhCD,6BAgCC"}

package/es6/FrontApplet/Hash/generator.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateUniqueHash = void 0;
+exports.generateUniqueHash = generateUniqueHash;
 const crypto_1 = require("crypto");
 function generateUniqueHash(length = 50) {
-    const hash = crypto_1.createHash('sha256');
+    const hash = (0, crypto_1.createHash)('sha256');
     hash.update('' + new Date().valueOf() + Math.random());
     return hash.digest('hex').substring(0, length);
 }
-exports.generateUniqueHash = generateUniqueHash;
 //# sourceMappingURL=generator.js.map

package/es6/FrontApplet/Hash/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hash/generator.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,SAAgB,kBAAkB,CAAC,SAAiB,EAAE;IACrD,MAAM,IAAI,GAAG,mBAAU,CAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC;AAJD,gDAIC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hash/generator.ts"],"names":[],"mappings":";;AAEA,gDAIC;AAND,mCAAoC;AAEpC,SAAgB,kBAAkB,CAAC,SAAiB,EAAE;IACrD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC"}

package/es6/FrontApplet/Iframe/Iframe.d.ts

@@ -1,24 +1,25 @@
-import Display from '../Display/Display';
+import FrontApplet from '../FrontApplet';
+import ITouchEventMessage from '../Touch/ITouchEventMessage';
 /**
  * If some transformer returns undefined, transforming message will not be forwarded to certain target
  * window and next transformers will not be called.
  */
-export declare type Transformer = <T>(data: T, target: Window) => T | undefined;
+export type Transformer<T> = (data: T, target: Window) => T | undefined;
 export default class Iframe {
     private window;
     private messagePrefix;
     private base;
     private transformers;
     private frontAppletWindows;
-    constructor(window: Window, messagePrefix: string, base: {
-        apiJsUri: string;
-        config: Record<string, string | number>;
-        authHash: string | null;
-        display: Display;
-    }, transformers: Transformer[]);
+    /** @internal */
+    constructor(window: Window, messagePrefix: string, base: Pick<FrontApplet, 'config' | 'authHash' | 'display' | 'apiJsUri'>, transformers: Transformer<ITouchEventMessage>[]);
+    /** @internal */
     registerFrontAppletLoaderWindow(frontAppletWindow: Window): void;
+    /** @internal */
     registerBundledFrontAppletWindow(frontAppletWindow: Window): void;
+    /** @internal */
     forwardToFrontAppletWindows(originalData: any): void;
+    /** @internal */
     forwardFromFrontAppletWindows(frontAppletWindow: Window, data: any): void;
     private getMessage;
 }

package/es6/FrontApplet/Iframe/Iframe.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class Iframe {
+    window;
+    messagePrefix;
+    base;
+    transformers;
+    frontAppletWindows;
+    /** @internal */
     constructor(window, messagePrefix, base, transformers) {
         this.window = window;
         this.messagePrefix = messagePrefix;
@@ -8,12 +14,14 @@ class Iframe {
         this.transformers = transformers;
         this.frontAppletWindows = [];
     }
+    /** @internal */
     registerFrontAppletLoaderWindow(frontAppletWindow) {
         frontAppletWindow.postMessage({
             type: this.getMessage('api_js_uri'),
             uri: this.base.apiJsUri,
         }, '*');
     }
+    /** @internal */
     registerBundledFrontAppletWindow(frontAppletWindow) {
         this.frontAppletWindows.push(frontAppletWindow);
         frontAppletWindow.postMessage({
@@ -29,6 +37,7 @@ class Iframe {
             version: this.base.display.version,
         }, '*');
     }
+    /** @internal */
     forwardToFrontAppletWindows(originalData) {
         for (let frontAppletWindow of this.frontAppletWindows) {
             const transformedData = this.transformers.reduce((data, transformer) => (data ? transformer(data, frontAppletWindow) : data), originalData);
@@ -38,6 +47,7 @@ class Iframe {
             frontAppletWindow.postMessage(transformedData, '*');
         }
     }
+    /** @internal */
     forwardFromFrontAppletWindows(frontAppletWindow, data) {
         if (this.frontAppletWindows.indexOf(frontAppletWindow) !== -1) {
             this.window.parent.postMessage(data, '*');

package/es6/FrontApplet/Iframe/Iframe.js.map

@@ -1 +1 @@
-{"version":3,"file":"Iframe.js","sourceRoot":"","sources":["../../../src/FrontApplet/Iframe/Iframe.ts"],"names":[],"mappings":";;AAQA,MAAqB,MAAM;IAG1B,YACS,MAAc,EACd,aAAqB,EACrB,IAKP,EACO,YAA2B;QAR3B,WAAM,GAAN,MAAM,CAAQ;QACd,kBAAa,GAAb,aAAa,CAAQ;QACrB,SAAI,GAAJ,IAAI,CAKX;QACO,iBAAY,GAAZ,YAAY,CAAe;QAEnC,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC9B,CAAC;IAEM,+BAA+B,CAAC,iBAAyB;QAC/D,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;SACvB,EACD,GAAG,CACH,CAAC;IACH,CAAC;IAEM,gCAAgC,CAAC,iBAAyB;QAChE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAChD,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACtC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACxB,EACD,GAAG,CACH,CAAC;QACF,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;SAC5B,EACD,GAAG,CACH,CAAC;QACF,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;YACrD,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO;SAClC,EACD,GAAG,CACH,CAAC;IACH,CAAC;IAEM,2BAA2B,CAAC,YAAiB;QACnD,KAAK,IAAI,iBAAiB,IAAI,IAAI,CAAC,kBAAkB,EAAE;YACtD,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAC/C,CAAC,IAAS,EAAE,WAAwB,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAC7F,YAAY,CACZ,CAAC;YACF,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE;gBAC3C,SAAS;aACT;YACD,iBAAiB,CAAC,WAAW,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;SACpD;IACF,CAAC;IAEM,6BAA6B,CAAC,iBAAyB,EAAE,IAAS;QACxE,IAAI,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,EAAE;YAC9D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SAC1C;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA1ED,yBA0EC"}
+{"version":3,"file":"Iframe.js","sourceRoot":"","sources":["../../../src/FrontApplet/Iframe/Iframe.ts"],"names":[],"mappings":";;AASA,MAAqB,MAAM;IAKjB;IACA;IACA;IACA;IAPD,kBAAkB,CAAW;IAErC,gBAAgB;IAChB,YACS,MAAc,EACd,aAAqB,EACrB,IAAuE,EACvE,YAA+C;QAH/C,WAAM,GAAN,MAAM,CAAQ;QACd,kBAAa,GAAb,aAAa,CAAQ;QACrB,SAAI,GAAJ,IAAI,CAAmE;QACvE,iBAAY,GAAZ,YAAY,CAAmC;QAEvD,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC9B,CAAC;IAED,gBAAgB;IACT,+BAA+B,CAAC,iBAAyB;QAC/D,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YACnC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;SACvB,EACD,GAAG,CACH,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,gCAAgC,CAAC,iBAAyB;QAChE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAChD,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACtC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACxB,EACD,GAAG,CACH,CAAC;QACF,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;SAC5B,EACD,GAAG,CACH,CAAC;QACF,iBAAiB,CAAC,WAAW,CAC5B;YACC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;YACrD,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO;SAClC,EACD,GAAG,CACH,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,2BAA2B,CAAC,YAAiB;QACnD,KAAK,IAAI,iBAAiB,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACvD,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAC/C,CAAC,IAAS,EAAE,WAA4C,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EACjH,YAAY,CACZ,CAAC;YACF,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE,CAAC;gBAC5C,SAAS;YACV,CAAC;YACD,iBAAiB,CAAC,WAAW,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QACrD,CAAC;IACF,CAAC;IAED,gBAAgB;IACT,6BAA6B,CAAC,iBAAyB,EAAE,IAAS;QACxE,IAAI,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3C,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA1ED,yBA0EC"}

package/es6/FrontApplet/Input/IInput.d.ts

@@ -1,9 +1,8 @@
-import IKeyUpEventListener from './IKeyUpEventListener';
 import IInputKeyMessage from './IInputKeyMessage';
 import IKeyUpEvent from './IKeyUpEvent';
 export default interface IInput {
     window: Window;
-    onKeyUp(listener: IKeyUpEventListener): void;
+    onKeyUp(listener: (event: IKeyUpEvent) => void): void;
     handleMessageData(data: IInputKeyMessage): void;
     removeEventListeners(): void;
     removeEventListener(event: string, listener: (...args: any[]) => void): void;

package/es6/FrontApplet/Input/IKeyUpEvent.d.ts

@@ -1,6 +1,36 @@
 interface IKeyUpEvent {
     type: 'keyup';
-    keyCode: number;
-    keyName: string;
+    keyCode: KeyUpEventMap;
+    keyName: keyof typeof KeyUpEventMap;
 }
 export default IKeyUpEvent;
+export declare enum KeyUpEventMap {
+    UNKNOWN = 0,
+    NUM_0 = 1,
+    NUM_1 = 2,
+    NUM_2 = 3,
+    NUM_3 = 4,
+    NUM_4 = 5,
+    NUM_5 = 6,
+    NUM_6 = 7,
+    NUM_7 = 8,
+    NUM_8 = 9,
+    NUM_9 = 10,
+    ARROW_LEFT = 11,
+    ARROW_UP = 12,
+    ARROW_RIGHT = 13,
+    ARROW_DOWN = 14,
+    YELLOW = 16,
+    BLUE = 17,
+    RED = 18,
+    GREEN = 19,
+    VOLUME_DOWN = 20,
+    VOLUME_UP = 30,
+    POWER = 31,
+    POWER_OFF = 32,
+    HOME = 33,
+    EXIT = 34,
+    RETURN = 35,
+    BACKSPACE = 36,
+    LOCK = 37
+}

package/es6/FrontApplet/Input/IKeyUpEvent.js

@@ -1,3 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyUpEventMap = void 0;
+var KeyUpEventMap;
+(function (KeyUpEventMap) {
+    KeyUpEventMap[KeyUpEventMap["UNKNOWN"] = 0] = "UNKNOWN";
+    KeyUpEventMap[KeyUpEventMap["NUM_0"] = 1] = "NUM_0";
+    KeyUpEventMap[KeyUpEventMap["NUM_1"] = 2] = "NUM_1";
+    KeyUpEventMap[KeyUpEventMap["NUM_2"] = 3] = "NUM_2";
+    KeyUpEventMap[KeyUpEventMap["NUM_3"] = 4] = "NUM_3";
+    KeyUpEventMap[KeyUpEventMap["NUM_4"] = 5] = "NUM_4";
+    KeyUpEventMap[KeyUpEventMap["NUM_5"] = 6] = "NUM_5";
+    KeyUpEventMap[KeyUpEventMap["NUM_6"] = 7] = "NUM_6";
+    KeyUpEventMap[KeyUpEventMap["NUM_7"] = 8] = "NUM_7";
+    KeyUpEventMap[KeyUpEventMap["NUM_8"] = 9] = "NUM_8";
+    KeyUpEventMap[KeyUpEventMap["NUM_9"] = 10] = "NUM_9";
+    KeyUpEventMap[KeyUpEventMap["ARROW_LEFT"] = 11] = "ARROW_LEFT";
+    KeyUpEventMap[KeyUpEventMap["ARROW_UP"] = 12] = "ARROW_UP";
+    KeyUpEventMap[KeyUpEventMap["ARROW_RIGHT"] = 13] = "ARROW_RIGHT";
+    KeyUpEventMap[KeyUpEventMap["ARROW_DOWN"] = 14] = "ARROW_DOWN";
+    KeyUpEventMap[KeyUpEventMap["YELLOW"] = 16] = "YELLOW";
+    KeyUpEventMap[KeyUpEventMap["BLUE"] = 17] = "BLUE";
+    KeyUpEventMap[KeyUpEventMap["RED"] = 18] = "RED";
+    KeyUpEventMap[KeyUpEventMap["GREEN"] = 19] = "GREEN";
+    KeyUpEventMap[KeyUpEventMap["VOLUME_DOWN"] = 20] = "VOLUME_DOWN";
+    KeyUpEventMap[KeyUpEventMap["VOLUME_UP"] = 30] = "VOLUME_UP";
+    KeyUpEventMap[KeyUpEventMap["POWER"] = 31] = "POWER";
+    KeyUpEventMap[KeyUpEventMap["POWER_OFF"] = 32] = "POWER_OFF";
+    KeyUpEventMap[KeyUpEventMap["HOME"] = 33] = "HOME";
+    KeyUpEventMap[KeyUpEventMap["EXIT"] = 34] = "EXIT";
+    KeyUpEventMap[KeyUpEventMap["RETURN"] = 35] = "RETURN";
+    KeyUpEventMap[KeyUpEventMap["BACKSPACE"] = 36] = "BACKSPACE";
+    KeyUpEventMap[KeyUpEventMap["LOCK"] = 37] = "LOCK";
+})(KeyUpEventMap || (exports.KeyUpEventMap = KeyUpEventMap = {}));
 //# sourceMappingURL=IKeyUpEvent.js.map

package/es6/FrontApplet/Input/IKeyUpEvent.js.map

@@ -1 +1 @@
-{"version":3,"file":"IKeyUpEvent.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/IKeyUpEvent.ts"],"names":[],"mappings":""}
+{"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"}

package/es6/FrontApplet/Input/Input.d.ts

@@ -1,4 +1,3 @@
-import IKeyUpEventListener from './IKeyUpEventListener';
 import IInputKeyMessage from './IInputKeyMessage';
 import IKeyUpEvent from './IKeyUpEvent';
 import IInput from './IInput';
@@ -9,12 +8,29 @@ export default class Input implements IInput {
     private readonly eventEmitter;
     private readonly hasWindowEventListener;
     private alive;
+    /** @internal */
     constructor(window: Window, messagePrefix: string);
+    /** @internal */
     destroy(): void;
-    onKeyUp(listener: IKeyUpEventListener): void;
+    /**
+     * The `onKeyUp` method sets up a listeners, which is called on every key stroke of the remote controller. For the specific logic of an
+     * application (games for example), binding the remote control inputs can be helpful. Only a subset of all remote control keys is
+     * supported on the specific device. Only numerical digits are guaranteed to be supported.
+     *
+     * This feature must be tested by users on real devices.
+     */
+    onKeyUp(listener: (event: IKeyUpEvent) => void): void;
+    /** @internal */
     handleMessageData(data: IInputKeyMessage): void;
+    /**
+     * The `removeEventListeners()` method removes all event listeners bind on `sos.input` object.
+     */
     removeEventListeners(): void;
-    removeEventListener(event: string, listener: (...args: any[]) => void): void;
+    /**
+     * The `removeEventListener()` method removes all event listeners for a specific event (only `keyup` is supported).
+     */
+    removeEventListener(event: 'keyup', listener: (...args: any[]) => void): void;
+    /** @internal */
     emitKeyUpEvent(event: IKeyUpEvent): void;
     private isTopLevelFrame;
     private canAccessParentOrigin;