@24i/bigscreen-sdk 1.0.34 → 1.0.35-alpha.2578

package/packages/driver-webos/src/types.ts

@@ -1,344 +1,344 @@
-import { ApiUrls } from './constants';
-
-export interface IWebOS {
-    /**
-     * A member representing the build version of the webOSTV.js library
-     */
-    readonly libVersion: '1.2.3',
-    /**
-     * A member representing the platform identification of webOS variants
-     */
-    readonly platform: {
-        /**
-         * Indicate whether the platform identification is webOS TV.
-         * If the platform identification is not webOS TV, undefined is returned.
-         */
-        tv?: true;
-    },
-    readonly keyboard: {
-        /**
-         * Checks whether the virtual keyboard is visible.
-         *
-         * @returns Indicates whether the virtual keyboard is displayed or hidden
-         * - true: the virtual keyboard is displayed
-         * - false: the virtual keyboard is hidden
-         */
-        isShowing(): boolean;
-    },
-    readonly service: {
-        /**
-         * Creates and sends a service request to the system of the webOS TV.
-         */
-        request<K extends keyof RequestTypeMap>(url: K, options: RequestTypeMap[K]): RequestObject,
-    },
-    /**
-     * Returns the device-specific information regarding the TV model,
-     * OS version, SDK version, screen size, and resolution
-     *
-     * @returns JSON object containing the device information details
-     */
-    deviceInfo(callback: (deviceInfo: DeviceInfo) => void): void,
-    /**
-     * Returns an app ID of an app calling this method
-     */
-    fetchAppId(): string,
-    /**
-     * Returns the full URI path of the caller app
-     *
-     * @returns The app's URI path where the app is located
-     */
-    fetchAppRootPath(): string,
-    /**
-     * Emulates the back key of the remote controller to move backward 1 level
-     */
-    platformBack(): void,
-    /**
-     * Returns the system-specific information regarding country, service country,
-     * and timezone
-     */
-    systemInfo(): SystemInfo,
-}
-
-/**
- * The system-specific information regarding country, service country, and timezone.
- */
-export type SystemInfo = Partial<{
-    /**
-     * The country that TV broadcasts.
-     * If the value does not exist, undefined is returned.
-     */
-    country?: string;
-    /**
-     * The country where the Smart service is provided.
-     * If the value does not exist, undefined is returned.
-     */
-    smartServiceCountry?: string;
-    /**
-     * The time zone that TV broadcasts.
-     * If the value does not exist, undefined is returned.
-     */
-    timezone?: string;
-}>;
-
-/**
- * The device-specific information regarding the TV model, OS version, SDK version,
- * screen size, and resolution.
- */
-export type DeviceInfo = Partial<{
-    /**
-     * The model name of the device in UTF-8 format.
-     */
-    modelName: string,
-    /**
-     * The model name of the device in ASCII format.
-     */
-    modelNameAscii: string,
-    /**
-     * The full name of OS firmware version.
-     */
-    version: string,
-    /**
-     * The webOS SDK version.
-     */
-    sdkVersion: string;
-    /**
-     * The screen width in pixels.
-     */
-    screenWidth: number,
-    /**
-     * The screen Height in pixels.
-     */
-    screenHeight: number,
-    /**
-     * Indicates whether the device supports Ultra HD resolution.
-     * - true: The device supports Ultra HD resolution.
-     * - false: The device does not support Ultra HD resolution.
-     */
-    uhd: boolean,
-    /**
-     * Indicates whether the device supports 8K UHD resolution.
-     * - true: The device supports 8K UHD resolution.
-     * - false: The device does not support 8K UHD resolution.
-     */
-    uhd8K: boolean,
-}>;
-
-export type ConnectionManager = {
-    /**
-     * Indicates whether the internet connection is available.
-     * - true: The internet connection is available.
-     * - false: The internet connection is unavailable.
-     */
-    isInternetConnectionAvailable: boolean;
-    /**
-     * The object that contains information about the state of the wired connection.
-     */
-    wired: WiredStatus;
-    /**
-     * The object that contains information about the state of the WiFi connection.
-     */
-    wifi: WifiStatus;
-    /**
-     * The object that contains information about the state of the WiFi direct connection.
-     */
-    wifiDirect: WifiDirectStatus;
-};
-
-export type CommonInterfaceStatus = {
-    /**
-     * If the interface connection is available it will be set to 'connected'.
-     * If the interface connection is not available, it will be set to 'disconnected'.
-     */
-    state: ConnectionState;
-    /**
-     * Name of the Interface name in use. For example, ppp0.
-     */
-    interfaceName?: string;
-    /**
-     * The IP address associated with the interface connection.
-     */
-    ipAddress?: string;
-    /**
-     * The netmask value for the interface connection.
-     */
-    netmask?: string;
-    /**
-     * The IP address of the gateway.
-     */
-    gateway?: string;
-    /**
-     * Primary DNS address for the interface connection.
-     */
-    dns1?: string;
-    /**
-     * Secondary DNS address for the interface connection.
-     */
-    dns2?: string;
-    /**
-     * Tertiary DNS address for the interface connection.
-     */
-    dns3?: string;
-    /**
-     * If the IP address was assigned using the manual mode, method will contain 'Manual'.
-     * If the IP Address was assigned through DHCP, method will contain 'dhcp'.
-     */
-    method?: 'Manual' | 'dhcp';
-    /**
-     * The captive portal technique forces an HTTP client on a network to see a special web page
-     * (usually for authentication purposes) before using the Internet normally.
-     * Captive portals are used at most Wi-Fi hotspots.
-     * The onInternet will contain one of the following values:
-     * - 'yes' - indicating the WiFi connection is connected to the Internet.
-     * - 'no' - indicating the WiFi connection is not connected to the Internet.
-     */
-    onInternet?: 'yes' | 'no';
-};
-
-/**
- * The wired object provides details on the status of the wired connections.
- * Only if the wired connection is available will all the fields of this object
- * contain the relevant information.
- * If the wired connection is not available, the state field of this object will
- * be set to disconnected and is the only value that is returned to the calling app.
- */
-export type WiredStatus = CommonInterfaceStatus;
-
-/**
- * The wifi object provides details on the status of the WiFi connection.
- * Only if the WiFi connection is available all the fields of this object will
- * contain the relevant information.
- * If the WiFi connection is not available, only the state field of this object
- * will be set to disconnected, and is the only value that is returned to the calling app.
- */
-export type WifiStatus = CommonInterfaceStatus & {
-    /**
-     * The SSID of the connected service (if known).
-     */
-    ssid?: string;
-    /**
-     * If the Wi-Fi interface was set to stay up even when suspended,
-     * isWakeOnWiFiEnabled will contain true.
-     * If the Wi-Fi interface was not set to stay up when suspended,
-     * isWakeOnWiFiEnabled will contain false.
-     */
-    isWakeOnWiFiEnabled?: boolean;
-};
-
-/**
- * The wifidirect object provides details on the status of the Wi-Fi direct connection.
- * Only if the Wi-Fi direct connection is available all the fields of this object
- * will contain the relevant information.
- * If the Wi-Fi direct connection is not available, only the state field of this
- * object will be set to disconnected,
- * and is the only value that is returned to the calling app.
- */
-export type WifiDirectStatus = {
-    /**
-     * If the Wi-Fi connection is available it will be set to 'connected'.
-     * If the Wi-Fi connection is not available, it will be set to 'disconnected'.
-     */
-    state: ConnectionState;
-    /**
-     * The IP address of the local connection endpoint.
-     */
-    localIp?: string;
-    /**
-     * A list of objects that provides information about connected peers.
-     */
-    connectedPeers?: any[];
-};
-
-type ConnectionState = 'connected' | 'disconnected';
-
-/**
- * Resulting request object. This object can be used to cancel subscriptions.
- */
-export type RequestObject = {
-    /**
-     * Sends the request. It is automatically called on creation. No argument
-     * is required.
-     */
-    send: Function,
-    /**
-     * Sends the request. It is automatically called on creation. No argument
-     * is required.
-     */
-    cancel: Function,
-};
-
-export type NegativeResponse = {
-    /**
-     * The flag that indicates the success/failure of the request.
-     */
-    returnValue: false,
-    /**
-     * errorCode contains the error code
-     */
-    errorCode: number | string,
-    /**
-     * errorText contains the error text
-     */
-    errorText: string,
-};
-
-export type PositiveResponse = {
-    /**
-     * The flag that indicates the success/failure of the request.
-     */
-    returnValue: true,
-};
-
-// MARK: ConnectionManager
-export type ConnectionManagerResponse = PositiveResponse & ConnectionManager;
-export type ConnectionManagerOptions = {
-    method: 'getStatus',
-    parameters: { subscribe: true },
-    onSuccess?: (response: NegativeResponse | ConnectionManagerResponse) => any,
-    onFailure?: (response: NegativeResponse) => any,
-    onComplete?: (response: NegativeResponse | ConnectionManagerResponse) => any,
-};
-
-// MARK: System property
-export type SystemPropertyResponse = PositiveResponse & {
-    modelName: string,
-    firmwareVersion: string,
-    UHD: 'true' | 'false',
-};
-export type SystemPropertyOptions = {
-    method: 'getSystemInfo',
-    parameters: {
-        keys: ['modelName', 'firmwareVersion', 'UHD'],
-    },
-    onSuccess?: (response: NegativeResponse | SystemPropertyResponse) => any,
-    onFailure?: (response: NegativeResponse) => any,
-    onComplete?: (response: NegativeResponse | SystemPropertyResponse) => any,
-};
-
-// MARK: DUID
-type Duid = {
-    idList: [
-        { idValue: string, idType: string },
-    ],
-};
-export type DuidResponse = PositiveResponse & Duid;
-export type DuidOptions = {
-    method: 'deviceid/getIDs',
-    parameters: {
-        idType: ['LGUDID'],
-    },
-    onSuccess?: (response: NegativeResponse | DuidResponse) => any,
-    onFailure?: (response: NegativeResponse) => any,
-    onComplete?: (response: NegativeResponse | DuidResponse) => any,
-};
-
-interface RequestTypeMap {
-    [ApiUrls.CONNECTION_MANAGER_PALM]: ConnectionManagerOptions,
-    [ApiUrls.CONNECTION_MANAGER_WEBOS]: ConnectionManagerOptions,
-    [ApiUrls.SYSTEM_PROPERTY]: SystemPropertyOptions,
-    [ApiUrls.SM]: DuidOptions,
-}
-
-// MARK: IPalmSystem
-export interface IPalmSystem {
-    deactivate: () => void,
-}
+import { ApiUrls } from './constants';
+
+export interface IWebOS {
+    /**
+     * A member representing the build version of the webOSTV.js library
+     */
+    readonly libVersion: '1.2.3',
+    /**
+     * A member representing the platform identification of webOS variants
+     */
+    readonly platform: {
+        /**
+         * Indicate whether the platform identification is webOS TV.
+         * If the platform identification is not webOS TV, undefined is returned.
+         */
+        tv?: true;
+    },
+    readonly keyboard: {
+        /**
+         * Checks whether the virtual keyboard is visible.
+         *
+         * @returns Indicates whether the virtual keyboard is displayed or hidden
+         * - true: the virtual keyboard is displayed
+         * - false: the virtual keyboard is hidden
+         */
+        isShowing(): boolean;
+    },
+    readonly service: {
+        /**
+         * Creates and sends a service request to the system of the webOS TV.
+         */
+        request<K extends keyof RequestTypeMap>(url: K, options: RequestTypeMap[K]): RequestObject,
+    },
+    /**
+     * Returns the device-specific information regarding the TV model,
+     * OS version, SDK version, screen size, and resolution
+     *
+     * @returns JSON object containing the device information details
+     */
+    deviceInfo(callback: (deviceInfo: DeviceInfo) => void): void,
+    /**
+     * Returns an app ID of an app calling this method
+     */
+    fetchAppId(): string,
+    /**
+     * Returns the full URI path of the caller app
+     *
+     * @returns The app's URI path where the app is located
+     */
+    fetchAppRootPath(): string,
+    /**
+     * Emulates the back key of the remote controller to move backward 1 level
+     */
+    platformBack(): void,
+    /**
+     * Returns the system-specific information regarding country, service country,
+     * and timezone
+     */
+    systemInfo(): SystemInfo,
+}
+
+/**
+ * The system-specific information regarding country, service country, and timezone.
+ */
+export type SystemInfo = Partial<{
+    /**
+     * The country that TV broadcasts.
+     * If the value does not exist, undefined is returned.
+     */
+    country?: string;
+    /**
+     * The country where the Smart service is provided.
+     * If the value does not exist, undefined is returned.
+     */
+    smartServiceCountry?: string;
+    /**
+     * The time zone that TV broadcasts.
+     * If the value does not exist, undefined is returned.
+     */
+    timezone?: string;
+}>;
+
+/**
+ * The device-specific information regarding the TV model, OS version, SDK version,
+ * screen size, and resolution.
+ */
+export type DeviceInfo = Partial<{
+    /**
+     * The model name of the device in UTF-8 format.
+     */
+    modelName: string,
+    /**
+     * The model name of the device in ASCII format.
+     */
+    modelNameAscii: string,
+    /**
+     * The full name of OS firmware version.
+     */
+    version: string,
+    /**
+     * The webOS SDK version.
+     */
+    sdkVersion: string;
+    /**
+     * The screen width in pixels.
+     */
+    screenWidth: number,
+    /**
+     * The screen Height in pixels.
+     */
+    screenHeight: number,
+    /**
+     * Indicates whether the device supports Ultra HD resolution.
+     * - true: The device supports Ultra HD resolution.
+     * - false: The device does not support Ultra HD resolution.
+     */
+    uhd: boolean,
+    /**
+     * Indicates whether the device supports 8K UHD resolution.
+     * - true: The device supports 8K UHD resolution.
+     * - false: The device does not support 8K UHD resolution.
+     */
+    uhd8K: boolean,
+}>;
+
+export type ConnectionManager = {
+    /**
+     * Indicates whether the internet connection is available.
+     * - true: The internet connection is available.
+     * - false: The internet connection is unavailable.
+     */
+    isInternetConnectionAvailable: boolean;
+    /**
+     * The object that contains information about the state of the wired connection.
+     */
+    wired: WiredStatus;
+    /**
+     * The object that contains information about the state of the WiFi connection.
+     */
+    wifi: WifiStatus;
+    /**
+     * The object that contains information about the state of the WiFi direct connection.
+     */
+    wifiDirect: WifiDirectStatus;
+};
+
+export type CommonInterfaceStatus = {
+    /**
+     * If the interface connection is available it will be set to 'connected'.
+     * If the interface connection is not available, it will be set to 'disconnected'.
+     */
+    state: ConnectionState;
+    /**
+     * Name of the Interface name in use. For example, ppp0.
+     */
+    interfaceName?: string;
+    /**
+     * The IP address associated with the interface connection.
+     */
+    ipAddress?: string;
+    /**
+     * The netmask value for the interface connection.
+     */
+    netmask?: string;
+    /**
+     * The IP address of the gateway.
+     */
+    gateway?: string;
+    /**
+     * Primary DNS address for the interface connection.
+     */
+    dns1?: string;
+    /**
+     * Secondary DNS address for the interface connection.
+     */
+    dns2?: string;
+    /**
+     * Tertiary DNS address for the interface connection.
+     */
+    dns3?: string;
+    /**
+     * If the IP address was assigned using the manual mode, method will contain 'Manual'.
+     * If the IP Address was assigned through DHCP, method will contain 'dhcp'.
+     */
+    method?: 'Manual' | 'dhcp';
+    /**
+     * The captive portal technique forces an HTTP client on a network to see a special web page
+     * (usually for authentication purposes) before using the Internet normally.
+     * Captive portals are used at most Wi-Fi hotspots.
+     * The onInternet will contain one of the following values:
+     * - 'yes' - indicating the WiFi connection is connected to the Internet.
+     * - 'no' - indicating the WiFi connection is not connected to the Internet.
+     */
+    onInternet?: 'yes' | 'no';
+};
+
+/**
+ * The wired object provides details on the status of the wired connections.
+ * Only if the wired connection is available will all the fields of this object
+ * contain the relevant information.
+ * If the wired connection is not available, the state field of this object will
+ * be set to disconnected and is the only value that is returned to the calling app.
+ */
+export type WiredStatus = CommonInterfaceStatus;
+
+/**
+ * The wifi object provides details on the status of the WiFi connection.
+ * Only if the WiFi connection is available all the fields of this object will
+ * contain the relevant information.
+ * If the WiFi connection is not available, only the state field of this object
+ * will be set to disconnected, and is the only value that is returned to the calling app.
+ */
+export type WifiStatus = CommonInterfaceStatus & {
+    /**
+     * The SSID of the connected service (if known).
+     */
+    ssid?: string;
+    /**
+     * If the Wi-Fi interface was set to stay up even when suspended,
+     * isWakeOnWiFiEnabled will contain true.
+     * If the Wi-Fi interface was not set to stay up when suspended,
+     * isWakeOnWiFiEnabled will contain false.
+     */
+    isWakeOnWiFiEnabled?: boolean;
+};
+
+/**
+ * The wifidirect object provides details on the status of the Wi-Fi direct connection.
+ * Only if the Wi-Fi direct connection is available all the fields of this object
+ * will contain the relevant information.
+ * If the Wi-Fi direct connection is not available, only the state field of this
+ * object will be set to disconnected,
+ * and is the only value that is returned to the calling app.
+ */
+export type WifiDirectStatus = {
+    /**
+     * If the Wi-Fi connection is available it will be set to 'connected'.
+     * If the Wi-Fi connection is not available, it will be set to 'disconnected'.
+     */
+    state: ConnectionState;
+    /**
+     * The IP address of the local connection endpoint.
+     */
+    localIp?: string;
+    /**
+     * A list of objects that provides information about connected peers.
+     */
+    connectedPeers?: any[];
+};
+
+type ConnectionState = 'connected' | 'disconnected';
+
+/**
+ * Resulting request object. This object can be used to cancel subscriptions.
+ */
+export type RequestObject = {
+    /**
+     * Sends the request. It is automatically called on creation. No argument
+     * is required.
+     */
+    send: Function,
+    /**
+     * Sends the request. It is automatically called on creation. No argument
+     * is required.
+     */
+    cancel: Function,
+};
+
+export type NegativeResponse = {
+    /**
+     * The flag that indicates the success/failure of the request.
+     */
+    returnValue: false,
+    /**
+     * errorCode contains the error code
+     */
+    errorCode: number | string,
+    /**
+     * errorText contains the error text
+     */
+    errorText: string,
+};
+
+export type PositiveResponse = {
+    /**
+     * The flag that indicates the success/failure of the request.
+     */
+    returnValue: true,
+};
+
+// MARK: ConnectionManager
+export type ConnectionManagerResponse = PositiveResponse & ConnectionManager;
+export type ConnectionManagerOptions = {
+    method: 'getStatus',
+    parameters: { subscribe: true },
+    onSuccess?: (response: NegativeResponse | ConnectionManagerResponse) => any,
+    onFailure?: (response: NegativeResponse) => any,
+    onComplete?: (response: NegativeResponse | ConnectionManagerResponse) => any,
+};
+
+// MARK: System property
+export type SystemPropertyResponse = PositiveResponse & {
+    modelName: string,
+    firmwareVersion: string,
+    UHD: 'true' | 'false',
+};
+export type SystemPropertyOptions = {
+    method: 'getSystemInfo',
+    parameters: {
+        keys: ['modelName', 'firmwareVersion', 'UHD'],
+    },
+    onSuccess?: (response: NegativeResponse | SystemPropertyResponse) => any,
+    onFailure?: (response: NegativeResponse) => any,
+    onComplete?: (response: NegativeResponse | SystemPropertyResponse) => any,
+};
+
+// MARK: DUID
+type Duid = {
+    idList: [
+        { idValue: string, idType: string },
+    ],
+};
+export type DuidResponse = PositiveResponse & Duid;
+export type DuidOptions = {
+    method: 'deviceid/getIDs',
+    parameters: {
+        idType: ['LGUDID'],
+    },
+    onSuccess?: (response: NegativeResponse | DuidResponse) => any,
+    onFailure?: (response: NegativeResponse) => any,
+    onComplete?: (response: NegativeResponse | DuidResponse) => any,
+};
+
+interface RequestTypeMap {
+    [ApiUrls.CONNECTION_MANAGER_PALM]: ConnectionManagerOptions,
+    [ApiUrls.CONNECTION_MANAGER_WEBOS]: ConnectionManagerOptions,
+    [ApiUrls.SYSTEM_PROPERTY]: SystemPropertyOptions,
+    [ApiUrls.SM]: DuidOptions,
+}
+
+// MARK: IPalmSystem
+export interface IPalmSystem {
+    deactivate: () => void,
+}