tv-app-core-types 1.0.0

package/dist/constants/consts.d.ts

@@ -0,0 +1,90 @@
+export declare enum ControlCommands {
+    VOLUME_UP = "VOLUME_UP",
+    VOLUME_DOWN = "VOLUME_DOWN",
+    VOLUME_MUTE_UNMUTE = "VOLUME_MUTE_UNMUTE",
+    SET_VOLUME = "SET_VOLUME",
+    CHANNEL_UP = "CHANNEL_UP",
+    CHANNEL_DOWN = "CHANNEL_DOWN",
+    SET_CHANNEL = "SET_CHANNEL",
+    STOP_UDP = "STOP_UDP",
+    GET_POWER = "GET_POWER",
+    POWER_ON = "POWER_ON",
+    POWER_OFF = "POWER_OFF",
+    GET_SOURCE = "GET_SOURCE",
+    SET_SOURCE = "SET_SOURCE",
+    GET_ALL_CHANNELS = "GET_ALL_CHANNELS",
+    LOCAL_CHANNEL_UP = "LOCAL_CHANNEL_UP",
+    LOCAL_CHANNEL_DOWN = "LOCAL_CHANNEL_DOWN",
+    GET_VERSION = "GET_VERSION",
+    HIDE_APPLICATION = "HIDE_APPLICATION",
+    POWER_STANDBY = "POWER_STANDBY",
+    UPDATE_FEED = "UPDATE_FEED",
+    GET_STATUS = "GET_STATUS",
+    UPDATE_FEED_NOTIFICATION = "UPDATE_FEED_NOTIFICATION",
+    LAUNCH_INBUILT_APPS = "LAUNCH_INBUILT_APPS"
+}
+export declare enum IdentifierStrings {
+    IP_CHANNEL_URL = "ipChannelUrl",
+    CHANNELS_PROFILE = "channelsProfile",
+    CHANNEL_IP_INDEX = "channelIpIndex",
+    IS_HIDDEN = "isHidden"
+}
+export declare enum Requests {
+    VOLUME_LEVEL = "volumeLevel"
+}
+export declare enum TvOperations {
+    CHANGE_VIEW = "changeview",
+    TV_ON_OFF = "tvonoff",
+    SET_VOLUME = "setvolume",
+    VOLUME_UP = "volumeUp",
+    VOLUME_DOWN = "volumeDown",
+    VOLUME_UP_BY_LEVEL = "volumeUpByLevel",
+    VOLUME_DOWN_BY_LEVEL = "volumeDownByLevel",
+    MUTE = "mute",
+    UNMUTE = "unmute",
+    SHIFT_SOURCE = "shiftSource",
+    CHANNEL_UP = "channelUp",
+    CHANNEL_DOWN = "channelDown",
+    PLAY_CHANNEL_ID = "playChannelId",
+    TV_OFF = "tvoff",
+    HIDE_APP = "hideApp",
+    STOP_UDP = "stopudp",
+    GET_SOURCE = "getSource",
+    TV_ON = "tvon",
+    POWER_STANDBY = "PowerStandby",
+    GET_VERSION = "getVersion",
+    GET_POWER = "getPower",
+    UPDATE_FEED = "updateFeed",
+    GET_STATUS = "getStatus",
+    UPDATE_FEED_NOTIFICATION = "updateFeedNotification",
+    LAUNCH_APP = "launch",
+    CHECK_OUT = "checkout",
+    CHECK_IN = "checkin",
+    AIRPLAY = "AirPlay",
+    REBOOT = "reboot",
+    GET_CURRENT_INPUT_SOURCE = "getCurrentInputSource",
+    PLAY_ENCRYPTED_CHANNEL = "playEncryptedChannel",
+    TV_APP_PUSH_UPDATE = "tvAppPushUpdate",
+    DEFAULT_CONFIGURATION = "defaultConfiguration"
+}
+export declare enum FileConsts {
+    GLOBAL = "global",
+    ENVIRONMENT_VARS_APC = "environmentVarsAPC",
+    PUBLIC_KEY = "publicKey",
+    SESSION_KEY = "sessionKey",
+    SERVER_DETAILS = "serverDetails",
+    TV_DATA = "tvData",
+    TV_REGISTERED = "tvRegistered",
+    WELCOME_LETTER_DETAILS = "welcomeLetterDetails",
+    IP_CHANNELS = "ipChannels",
+    IP_CHANNELS_VERSION = "ipChannelsVersion",
+    IS_ROOM_CHECKED_IN = "isRoomCheckedIn",
+    GUEST_INFO = "guestInfo",
+    APP_CONFIG_DATA = "appConfigData",
+    FIRST_INSTALLATION = "firstInstallation",
+    DEFAULT_CONFIGURATION = "defaultConfiguration",
+    APP_DETAILS = "appDetails",
+    AIRPLAY_QR_DATA = "airplayQRData",
+    LOGGING_LEVEL = "loggingLevel",
+    CURRENT_CHANNEL = "currentChannel"
+}

package/dist/constants/consts.js

@@ -0,0 +1,95 @@
+export var ControlCommands;
+(function (ControlCommands) {
+    ControlCommands["VOLUME_UP"] = "VOLUME_UP";
+    ControlCommands["VOLUME_DOWN"] = "VOLUME_DOWN";
+    ControlCommands["VOLUME_MUTE_UNMUTE"] = "VOLUME_MUTE_UNMUTE";
+    ControlCommands["SET_VOLUME"] = "SET_VOLUME";
+    ControlCommands["CHANNEL_UP"] = "CHANNEL_UP";
+    ControlCommands["CHANNEL_DOWN"] = "CHANNEL_DOWN";
+    ControlCommands["SET_CHANNEL"] = "SET_CHANNEL";
+    ControlCommands["STOP_UDP"] = "STOP_UDP";
+    ControlCommands["GET_POWER"] = "GET_POWER";
+    ControlCommands["POWER_ON"] = "POWER_ON";
+    ControlCommands["POWER_OFF"] = "POWER_OFF";
+    ControlCommands["GET_SOURCE"] = "GET_SOURCE";
+    ControlCommands["SET_SOURCE"] = "SET_SOURCE";
+    ControlCommands["GET_ALL_CHANNELS"] = "GET_ALL_CHANNELS";
+    ControlCommands["LOCAL_CHANNEL_UP"] = "LOCAL_CHANNEL_UP";
+    ControlCommands["LOCAL_CHANNEL_DOWN"] = "LOCAL_CHANNEL_DOWN";
+    ControlCommands["GET_VERSION"] = "GET_VERSION";
+    ControlCommands["HIDE_APPLICATION"] = "HIDE_APPLICATION";
+    ControlCommands["POWER_STANDBY"] = "POWER_STANDBY";
+    ControlCommands["UPDATE_FEED"] = "UPDATE_FEED";
+    ControlCommands["GET_STATUS"] = "GET_STATUS";
+    ControlCommands["UPDATE_FEED_NOTIFICATION"] = "UPDATE_FEED_NOTIFICATION";
+    ControlCommands["LAUNCH_INBUILT_APPS"] = "LAUNCH_INBUILT_APPS";
+})(ControlCommands || (ControlCommands = {}));
+export var IdentifierStrings;
+(function (IdentifierStrings) {
+    IdentifierStrings["IP_CHANNEL_URL"] = "ipChannelUrl";
+    IdentifierStrings["CHANNELS_PROFILE"] = "channelsProfile";
+    IdentifierStrings["CHANNEL_IP_INDEX"] = "channelIpIndex";
+    IdentifierStrings["IS_HIDDEN"] = "isHidden";
+})(IdentifierStrings || (IdentifierStrings = {}));
+export var Requests;
+(function (Requests) {
+    Requests["VOLUME_LEVEL"] = "volumeLevel";
+})(Requests || (Requests = {}));
+export var TvOperations;
+(function (TvOperations) {
+    TvOperations["CHANGE_VIEW"] = "changeview";
+    TvOperations["TV_ON_OFF"] = "tvonoff";
+    TvOperations["SET_VOLUME"] = "setvolume";
+    TvOperations["VOLUME_UP"] = "volumeUp";
+    TvOperations["VOLUME_DOWN"] = "volumeDown";
+    TvOperations["VOLUME_UP_BY_LEVEL"] = "volumeUpByLevel";
+    TvOperations["VOLUME_DOWN_BY_LEVEL"] = "volumeDownByLevel";
+    TvOperations["MUTE"] = "mute";
+    TvOperations["UNMUTE"] = "unmute";
+    TvOperations["SHIFT_SOURCE"] = "shiftSource";
+    TvOperations["CHANNEL_UP"] = "channelUp";
+    TvOperations["CHANNEL_DOWN"] = "channelDown";
+    TvOperations["PLAY_CHANNEL_ID"] = "playChannelId";
+    TvOperations["TV_OFF"] = "tvoff";
+    TvOperations["HIDE_APP"] = "hideApp";
+    TvOperations["STOP_UDP"] = "stopudp";
+    TvOperations["GET_SOURCE"] = "getSource";
+    TvOperations["TV_ON"] = "tvon";
+    TvOperations["POWER_STANDBY"] = "PowerStandby";
+    TvOperations["GET_VERSION"] = "getVersion";
+    TvOperations["GET_POWER"] = "getPower";
+    TvOperations["UPDATE_FEED"] = "updateFeed";
+    TvOperations["GET_STATUS"] = "getStatus";
+    TvOperations["UPDATE_FEED_NOTIFICATION"] = "updateFeedNotification";
+    TvOperations["LAUNCH_APP"] = "launch";
+    TvOperations["CHECK_OUT"] = "checkout";
+    TvOperations["CHECK_IN"] = "checkin";
+    TvOperations["AIRPLAY"] = "AirPlay";
+    TvOperations["REBOOT"] = "reboot";
+    TvOperations["GET_CURRENT_INPUT_SOURCE"] = "getCurrentInputSource";
+    TvOperations["PLAY_ENCRYPTED_CHANNEL"] = "playEncryptedChannel";
+    TvOperations["TV_APP_PUSH_UPDATE"] = "tvAppPushUpdate";
+    TvOperations["DEFAULT_CONFIGURATION"] = "defaultConfiguration";
+})(TvOperations || (TvOperations = {}));
+export var FileConsts;
+(function (FileConsts) {
+    FileConsts["GLOBAL"] = "global";
+    FileConsts["ENVIRONMENT_VARS_APC"] = "environmentVarsAPC";
+    FileConsts["PUBLIC_KEY"] = "publicKey";
+    FileConsts["SESSION_KEY"] = "sessionKey";
+    FileConsts["SERVER_DETAILS"] = "serverDetails";
+    FileConsts["TV_DATA"] = "tvData";
+    FileConsts["TV_REGISTERED"] = "tvRegistered";
+    FileConsts["WELCOME_LETTER_DETAILS"] = "welcomeLetterDetails";
+    FileConsts["IP_CHANNELS"] = "ipChannels";
+    FileConsts["IP_CHANNELS_VERSION"] = "ipChannelsVersion";
+    FileConsts["IS_ROOM_CHECKED_IN"] = "isRoomCheckedIn";
+    FileConsts["GUEST_INFO"] = "guestInfo";
+    FileConsts["APP_CONFIG_DATA"] = "appConfigData";
+    FileConsts["FIRST_INSTALLATION"] = "firstInstallation";
+    FileConsts["DEFAULT_CONFIGURATION"] = "defaultConfiguration";
+    FileConsts["APP_DETAILS"] = "appDetails";
+    FileConsts["AIRPLAY_QR_DATA"] = "airplayQRData";
+    FileConsts["LOGGING_LEVEL"] = "loggingLevel";
+    FileConsts["CURRENT_CHANNEL"] = "currentChannel";
+})(FileConsts || (FileConsts = {}));

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './interfaces/tv-controller-interface';
+export * from './constants/consts';
+export * from './interfaces/mqtt-interface';
+export * from './interfaces/tv-data-interface';
+export * from './interfaces/utils-interface';
+export * from './interfaces/logs-interface';

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from './interfaces/tv-controller-interface';
+export * from './constants/consts';
+export * from './interfaces/mqtt-interface';
+export * from './interfaces/tv-data-interface';
+export * from './interfaces/utils-interface';
+export * from './interfaces/logs-interface';

package/dist/interfaces/logs-interface.d.ts

@@ -0,0 +1,16 @@
+export interface ILogDataStream {
+    streams: [
+        {
+            stream: {
+                hotel_name: string;
+                component: string;
+                detected_level: string;
+                room_number: string;
+                room_type: string;
+                tv_id: string;
+                level: string;
+            };
+            values: Array<Array<string>>;
+        }
+    ];
+}

package/dist/interfaces/logs-interface.js

@@ -0,0 +1,2 @@
+;
+export {};

package/dist/interfaces/mqtt-interface.d.ts

@@ -0,0 +1,62 @@
+export interface ILastWillMessage {
+    method: string;
+    params: {};
+    payload: {
+        timestamp: Number;
+        response: [
+            {
+                details: {
+                    metaData: {
+                        displayMessage: string;
+                        isDeviceConnected: boolean;
+                    };
+                };
+                tvid: string;
+                feature: string;
+            }
+        ];
+    };
+    deviceID: string;
+    identifier: string;
+}
+export interface MqttData {
+    mqtt_ip: string;
+    mqtt_package_port: string;
+    mqtt_password: string;
+    mqtt_tv_port: string;
+    mqtt_user: string;
+}
+export interface MqttBrokerTopicsHeader {
+    request_topic_header: string;
+    response_topic_header: string;
+    service_request_topic_header: string;
+}
+export interface IMqttResponse {
+    method: string;
+    params: {};
+    payload: {
+        timestamp: number;
+        response: [
+            {
+                details: {
+                    isDeviceMute: boolean;
+                    isDeviceOn: boolean;
+                    source: string | null;
+                    application: string | null;
+                    isRoomCheckedIn: boolean;
+                    volumeLevel: number | void;
+                    isChromecastStreaming: boolean;
+                    channelFeedVersion: string | boolean;
+                    channelId: string | null;
+                    isChannelPlayerActive: boolean;
+                    channelName: string | null;
+                    isWelcomeLetterOpen: boolean;
+                };
+                feature: string;
+                tvid: string;
+            }
+        ];
+    };
+    deviceID: string;
+    identifier: string;
+}

package/dist/interfaces/mqtt-interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/tv-controller-interface.d.ts

@@ -0,0 +1,30 @@
+export interface ITVController {
+    setPowerOn(): void;
+    setPowerOff(): void;
+    reboot(): void;
+    getVolume(): void;
+    setVolume(volume: number): void;
+    volumeUp(): void;
+    volumeDown(): void;
+    isMute(): void;
+    setMute(mute?: boolean): void;
+    setInputSource(source: string): void;
+    getInputSource(): string | null;
+    playIPChannel(ip: string, port: string): void;
+    playEncrypted(ip: string, port: string): void;
+    launchApplication(appId: string): void;
+    getPowerState(): boolean;
+    getAVPlayerState(): string | boolean;
+}
+export interface IRequestHandler {
+    tvOnOperation(): void;
+    tvOffOperation(): void;
+    volumeDownOperation(): void;
+    volumeUpOperation(): void;
+    muteOperation(): void;
+    unmuteOperation(): void;
+    rebootOperation(): void;
+    setVolumeOperation(details: any): void;
+    shiftSourceOperation(details: any): void;
+    playChannelIdOperation(details: any): void;
+}

package/dist/interfaces/tv-controller-interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/tv-data-interface.d.ts

@@ -0,0 +1,93 @@
+import { MqttBrokerTopicsHeader } from "./mqtt-interface";
+export interface TvData {
+    display_name: string;
+    in_room_device_id: string;
+    device_type_id: string;
+    key_id: string;
+    number: string;
+    via_dvc: string;
+    room_type_id: string;
+    room_type: string;
+    ip: string;
+    unique_id: string;
+    is_registered: string;
+    is_deregistering: string;
+    is_online: string;
+    is_active: string;
+    mqtt: string;
+    topics_identifier: string;
+    airplayBroker_details: string;
+    hotelWifiSSID: string;
+    hotelCode: string;
+    device_category: string;
+    dvs_device_id: string;
+}
+export interface AppConfigData {
+    apc_server: ApcServer;
+    mqtt_broker: MqttBrokerTopicsHeader;
+    proidiom: ProIdiom;
+    airplay: AirplayConfig;
+    chromecast: Chromecast;
+    procentric: Procentric;
+    property_details: PropertyDetails;
+}
+export interface AppConfigData {
+    apc_server: ApcServer;
+    mqtt_broker: MqttBrokerTopicsHeader;
+    proidiom: ProIdiom;
+    airplay: AirplayConfig;
+    chromecast: Chromecast;
+    procentric: Procentric;
+    property_details: PropertyDetails;
+}
+export interface ApcServer {
+    fqdn: string;
+    get_environment_endpoint: string;
+    get_public_key_endpoint: string;
+    exchange_session_key: string;
+    get_server_details: string;
+    device_token: string;
+    iv: string;
+}
+export interface PropertyDetails {
+    property_name: string;
+    component: string;
+}
+export interface AirplayConfig {
+    x_api_key: string;
+    is_airplay_configured: string;
+}
+export interface Procentric {
+    protocol: string;
+    non_dvc: boolean;
+    loki_url: string;
+}
+export interface Chromecast {
+    default_source: string;
+}
+export interface ProIdiom {
+    proidiom_session_id: string;
+}
+export interface TvChannelDetail {
+    alexaCallSignCode: string;
+    channelName: string;
+    channelType: string;
+    directCable: string;
+    epgCode: string;
+    filters: Object;
+    hls: boolean;
+    iptv: IpTvDetail;
+    "isEncrypted": boolean;
+    "language": string;
+    "pid": string;
+    "primaryImage": string;
+    "stb": string;
+    "translation": string;
+    "tvChannelSensonicId": string;
+    "positionIndex": number;
+}
+export interface IpTvDetail {
+    ipAddress: string;
+    port: number;
+    protocol: string;
+}

package/dist/interfaces/tv-data-interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/utils-interface.d.ts

@@ -0,0 +1,38 @@
+import { ILogDataStream } from "./logs-interface";
+import { TvChannelDetail } from "./tv-data-interface";
+export interface IUtils {
+    getPublicIP(): Promise<string> | string;
+    getSystemIP(): Promise<string | null>;
+    getDeviceMac(): Promise<string | null>;
+    getDeviceDetails(): Promise<string> | string;
+    getSerialNo(): string | boolean;
+    getModelNo(): string | null;
+    fetchEnvironmentFromAPC(): Promise<object>;
+    getPublicKey(): Promise<string>;
+    exchangeSessionKey(): void;
+    fetchServerDetails(): void;
+    fetchDeviceDetailsFromDVS(): void;
+    generateKongToken(): void;
+    generateSessionKey(): void;
+    encryptSessionKey(sessionKey: string): Promise<string | boolean>;
+    getAppConfig(): void;
+    waitUntilCallbackNotResolved(cb: Function, conditionFn: Function, onError: Function, pollingInterval: number): void;
+    isTvRegistered(): void;
+    fetchIPChannels(): void;
+    addRegisteredTv(isRegistered: boolean, isFailed: boolean): void;
+    getCurrentChannel(): Promise<TvChannelDetail | boolean>;
+    getChannelVersion(): Promise<string | boolean>;
+    getTizenAppVersion(): void;
+    getCpuUsage(): void;
+    createLogData(logType: string, detectedLevel: string): Promise<ILogDataStream>;
+    postLogs(logData: Array<any>): void;
+    ipChannelUp(): void;
+    ipChannelDown(): void;
+    getCustomAppServerIP(): void;
+    getTvData(): void;
+    getServerInfo(): void;
+    fetchWelcomeLetter(): void;
+    setMinVolume(): void;
+    setMaxVolume(): void;
+    getCurrentScreen(): string | boolean;
+}

package/dist/interfaces/utils-interface.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "tv-app-core-types",
+  "version": "1.0.0",
+  "description": "DigiValet TV App package for common utilities, functions and interfaces.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^22.13.9",
+    "typescript": "^5.8.2"
+  },
+  "files": [
+    "dist"
+  ]
+}