@smarthome.exchange/integrations 0.2.0 → 1.0.0

package/dist_ts/integrations/roku/roku.types.d.ts

@@ -1,12 +1,14 @@
 export interface IRokuConfig {
-    host?: string;
-    port?: number;
-    deviceInfo?: IRokuDeviceInfo;
-    apps?: IRokuApp[];
-    activeApp?: IRokuApp;
-    playMediaAppId?: string;
+    readonly host: string;
+    readonly port?: number;
+    readonly udn: string;
+    readonly requestTimeoutMs?: number;
+}
+export interface IRokuClientOptions {
+    abortSignal?: AbortSignal;
 }
 export interface IRokuDeviceInfo {
+    udn: string;
     serialNumber?: string;
     deviceId?: string;
     vendorName?: string;
@@ -14,10 +16,10 @@ export interface IRokuDeviceInfo {
     modelNumber?: string;
     friendlyDeviceName?: string;
     userDeviceName?: string;
-    deviceType?: string;
     softwareVersion?: string;
     powerMode?: string;
-    supportsSuspend?: boolean;
+    isTv?: boolean;
+    supportsAudioVolumeControl?: boolean;
 }
 export interface IRokuApp {
     id: string;
@@ -25,10 +27,17 @@ export interface IRokuApp {
     type?: string;
     version?: string;
 }
+export interface IRokuActiveApp {
+    id?: string;
+    name: string;
+    type?: string;
+    version?: string;
+}
 export interface IRokuSnapshot {
     deviceInfo: IRokuDeviceInfo;
     apps: IRokuApp[];
-    activeApp?: IRokuApp;
+    activeApp: IRokuActiveApp;
+    observedAt: string;
 }
 export interface IRokuSsdpRecord {
     st?: string;
@@ -37,11 +46,11 @@ export interface IRokuSsdpRecord {
     headers?: Record<string, string | undefined>;
 }
 export interface IRokuManualEntry {
+    integrationDomain?: string;
     host?: string;
     port?: number;
     id?: string;
     name?: string;
-    model?: string;
-    metadata?: Record<string, unknown>;
 }
-export type TRokuKeypress = 'Home' | 'Rev' | 'Fwd' | 'Play' | 'Select' | 'Left' | 'Right' | 'Down' | 'Up' | 'Back' | 'InstantReplay' | 'Info' | 'Backspace' | 'Search' | 'Enter' | 'PowerOn' | 'PowerOff' | 'Power' | 'VolumeUp' | 'VolumeDown' | 'VolumeMute';
+export type TRokuEffectOutcome = 'not-sent' | 'rejected' | 'indeterminate';
+export type TRokuKeypress = 'Home' | 'Rev' | 'Fwd' | 'Play' | 'Select' | 'Left' | 'Right' | 'Down' | 'Up' | 'Back' | 'InstantReplay' | 'Info' | 'Backspace' | 'Search' | 'Enter' | 'VolumeUp' | 'VolumeDown' | 'VolumeMute';

package/dist_ts/integrations/roku/roku.validation.d.ts

@@ -0,0 +1,9 @@
+import type { IRokuConfig, IRokuDeviceInfo, TRokuKeypress } from './roku.types.js';
+export declare const rokuKeys: readonly TRokuKeypress[];
+export declare const readRokuRecord: (inputArg: unknown, fieldsArg: readonly string[], allowOtherFieldsArg?: boolean) => Record<string, unknown>;
+export declare const normalizeRokuUdn: (valueArg: unknown) => string;
+export declare const validateRokuHost: (valueArg: unknown) => string;
+export declare const validateRokuPort: (valueArg: unknown) => number;
+export declare const validateRokuConfig: (valueArg: unknown) => IRokuConfig;
+export declare const validateRokuKey: (valueArg: unknown, deviceInfoArg?: IRokuDeviceInfo) => TRokuKeypress;
+export declare const validateRokuAppId: (valueArg: unknown) => string;

package/dist_ts/integrations/roku/roku.validation.js

@@ -0,0 +1,74 @@
+import * as plugins from '../../plugins.js';
+export const rokuKeys = Object.freeze([
+    'Home', 'Rev', 'Fwd', 'Play', 'Select', 'Left', 'Right', 'Down', 'Up', 'Back',
+    'InstantReplay', 'Info', 'Backspace', 'Search', 'Enter', 'VolumeUp', 'VolumeDown', 'VolumeMute',
+]);
+export const readRokuRecord = (inputArg, fieldsArg, allowOtherFieldsArg = false) => {
+    if (typeof inputArg !== 'object' || inputArg === null || Array.isArray(inputArg) ||
+        ![Object.prototype, null].includes(Object.getPrototypeOf(inputArg)) || Object.getOwnPropertySymbols(inputArg).length) {
+        throw new Error('Roku input must be a plain data object.');
+    }
+    const result = {};
+    for (const [key, descriptor] of Object.entries(Object.getOwnPropertyDescriptors(inputArg))) {
+        if (allowOtherFieldsArg && !fieldsArg.includes(key))
+            continue;
+        if (!fieldsArg.includes(key) || !('value' in descriptor) || !descriptor.enumerable) {
+            throw new Error('Roku input contains an unsupported field or accessor.');
+        }
+        const value = descriptor.value;
+        result[key] = value;
+    }
+    return result;
+};
+export const normalizeRokuUdn = (valueArg) => {
+    if (typeof valueArg !== 'string' || !/^(?:uuid:)?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(valueArg)) {
+        throw new Error('Roku udn must be the UUID reported by query/device-info.');
+    }
+    return valueArg.replace(/^uuid:/i, '').toLowerCase();
+};
+export const validateRokuHost = (valueArg) => {
+    if (typeof valueArg !== 'string' || plugins.net.isIPv4(valueArg) !== true) {
+        throw new Error('Roku host must be a literal local IPv4 address.');
+    }
+    const octets = valueArg.split('.').map(Number);
+    if (!(octets[0] === 10 || octets[0] === 127 || octets[0] === 192 && octets[1] === 168 ||
+        octets[0] === 172 && octets[1] >= 16 && octets[1] <= 31)) {
+        throw new Error('Roku host must be a private or loopback IPv4 address.');
+    }
+    return valueArg;
+};
+export const validateRokuPort = (valueArg) => {
+    if (valueArg === undefined)
+        return 8060;
+    if (typeof valueArg !== 'number' || !Number.isInteger(valueArg) || valueArg < 1 || valueArg > 65535) {
+        throw new Error('Roku port must be an integer between 1 and 65535.');
+    }
+    return valueArg;
+};
+export const validateRokuConfig = (valueArg) => {
+    const config = readRokuRecord(valueArg, ['host', 'port', 'udn', 'requestTimeoutMs']);
+    const requestTimeoutMs = config.requestTimeoutMs ?? 5000;
+    if (typeof requestTimeoutMs !== 'number' || !Number.isSafeInteger(requestTimeoutMs) || requestTimeoutMs < 1 || requestTimeoutMs > 60000) {
+        throw new Error('Roku requestTimeoutMs must be an integer between 1 and 60000.');
+    }
+    return Object.freeze({
+        host: validateRokuHost(config.host), port: validateRokuPort(config.port),
+        udn: normalizeRokuUdn(config.udn), requestTimeoutMs,
+    });
+};
+export const validateRokuKey = (valueArg, deviceInfoArg) => {
+    const key = rokuKeys.find((keyArg) => keyArg === valueArg);
+    if (!key)
+        throw new Error('Roku command must be one supported ECP key name.');
+    if (key.startsWith('Volume') && deviceInfoArg && !deviceInfoArg.isTv && !deviceInfoArg.supportsAudioVolumeControl) {
+        throw new Error('The connected Roku does not advertise audio volume control.');
+    }
+    return key;
+};
+export const validateRokuAppId = (valueArg) => {
+    if (typeof valueArg !== 'string' || !/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(valueArg)) {
+        throw new Error('Roku app id must be a nonempty ECP identifier.');
+    }
+    return valueArg;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm9rdS52YWxpZGF0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vdHMvaW50ZWdyYXRpb25zL3Jva3Uvcm9rdS52YWxpZGF0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sa0JBQWtCLENBQUM7QUFHNUMsTUFBTSxDQUFDLE1BQU0sUUFBUSxHQUE2QixNQUFNLENBQUMsTUFBTSxDQUFDO0lBQzlELE1BQU0sRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLE1BQU07SUFDN0UsZUFBZSxFQUFFLE1BQU0sRUFBRSxXQUFXLEVBQUUsUUFBUSxFQUFFLE9BQU8sRUFBRSxVQUFVLEVBQUUsWUFBWSxFQUFFLFlBQVk7Q0FDaEcsQ0FBQyxDQUFDO0FBRUgsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLENBQUMsUUFBaUIsRUFBRSxTQUE0QixFQUFFLG1CQUFtQixHQUFHLEtBQUssRUFBMkIsRUFBRTtJQUN0SSxJQUFJLE9BQU8sUUFBUSxLQUFLLFFBQVEsSUFBSSxRQUFRLEtBQUssSUFBSSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDO1FBQzlFLENBQUMsQ0FBQyxNQUFNLENBQUMsU0FBUyxFQUFFLElBQUksQ0FBQyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksTUFBTSxDQUFDLHFCQUFxQixDQUFDLFFBQVEsQ0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ3ZILE1BQU0sSUFBSSxLQUFLLENBQUMseUNBQXlDLENBQUMsQ0FBQztJQUM3RCxDQUFDO0lBQ0QsTUFBTSxNQUFNLEdBQTRCLEVBQUUsQ0FBQztJQUMzQyxLQUFLLE1BQU0sQ0FBQyxHQUFHLEVBQUUsVUFBVSxDQUFDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMseUJBQXlCLENBQUMsUUFBUSxDQUFDLENBQUMsRUFBRSxDQUFDO1FBQzNGLElBQUksbUJBQW1CLElBQUksQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQztZQUFFLFNBQVM7UUFDOUQsSUFBSSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sSUFBSSxVQUFVLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxVQUFVLEVBQUUsQ0FBQztZQUNuRixNQUFNLElBQUksS0FBSyxDQUFDLHVEQUF1RCxDQUFDLENBQUM7UUFDM0UsQ0FBQztRQUNELE1BQU0sS0FBSyxHQUFZLFVBQVUsQ0FBQyxLQUFLLENBQUM7UUFDeEMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEtBQUssQ0FBQztJQUN0QixDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUYsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxRQUFpQixFQUFVLEVBQUU7SUFDNUQsSUFBSSxPQUFPLFFBQVEsS0FBSyxRQUFRLElBQUksQ0FBQywyRUFBMkUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLEVBQUUsQ0FBQztRQUNoSSxNQUFNLElBQUksS0FBSyxDQUFDLDBEQUEwRCxDQUFDLENBQUM7SUFDOUUsQ0FBQztJQUNELE9BQU8sUUFBUSxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUMsV0FBVyxFQUFFLENBQUM7QUFDdkQsQ0FBQyxDQUFDO0FBRUYsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxRQUFpQixFQUFVLEVBQUU7SUFDNUQsSUFBSSxPQUFPLFFBQVEsS0FBSyxRQUFRLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDMUUsTUFBTSxJQUFJLEtBQUssQ0FBQyxpREFBaUQsQ0FBQyxDQUFDO0lBQ3JFLENBQUM7SUFDRCxNQUFNLE1BQU0sR0FBRyxRQUFRLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMvQyxJQUFJLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxJQUFJLE1BQU0sQ0FBQyxDQUFDLENBQUMsS0FBSyxHQUFHLElBQUksTUFBTSxDQUFDLENBQUMsQ0FBQyxLQUFLLEdBQUcsSUFBSSxNQUFNLENBQUMsQ0FBQyxDQUFDLEtBQUssR0FBRztRQUNuRixNQUFNLENBQUMsQ0FBQyxDQUFDLEtBQUssR0FBRyxJQUFJLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBSSxFQUFFLElBQUksTUFBTSxDQUFDLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxFQUFFLENBQUM7UUFDM0QsTUFBTSxJQUFJLEtBQUssQ0FBQyx1REFBdUQsQ0FBQyxDQUFDO0lBQzNFLENBQUM7SUFDRCxPQUFPLFFBQVEsQ0FBQztBQUNsQixDQUFDLENBQUM7QUFFRixNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRyxDQUFDLFFBQWlCLEVBQVUsRUFBRTtJQUM1RCxJQUFJLFFBQVEsS0FBSyxTQUFTO1FBQUUsT0FBTyxJQUFJLENBQUM7SUFDeEMsSUFBSSxPQUFPLFFBQVEsS0FBSyxRQUFRLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxJQUFJLFFBQVEsR0FBRyxDQUFDLElBQUksUUFBUSxHQUFHLEtBQUssRUFBRSxDQUFDO1FBQ3BHLE1BQU0sSUFBSSxLQUFLLENBQUMsbURBQW1ELENBQUMsQ0FBQztJQUN2RSxDQUFDO0lBQ0QsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFDO0FBRUYsTUFBTSxDQUFDLE1BQU0sa0JBQWtCLEdBQUcsQ0FBQyxRQUFpQixFQUFlLEVBQUU7SUFDbkUsTUFBTSxNQUFNLEdBQUcsY0FBYyxDQUFDLFFBQVEsRUFBRSxDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLGtCQUFrQixDQUFDLENBQUMsQ0FBQztJQUNyRixNQUFNLGdCQUFnQixHQUFHLE1BQU0sQ0FBQyxnQkFBZ0IsSUFBSSxJQUFJLENBQUM7SUFDekQsSUFBSSxPQUFPLGdCQUFnQixLQUFLLFFBQVEsSUFBSSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxnQkFBZ0IsR0FBRyxDQUFDLElBQUksZ0JBQWdCLEdBQUcsS0FBSyxFQUFFLENBQUM7UUFDeEksTUFBTSxJQUFJLEtBQUssQ0FBQywrREFBK0QsQ0FBQyxDQUFDO0lBQ25GLENBQUM7SUFDRCxPQUFPLE1BQU0sQ0FBQyxNQUFNLENBQUM7UUFDbkIsSUFBSSxFQUFFLGdCQUFnQixDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsZ0JBQWdCLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQztRQUN4RSxHQUFHLEVBQUUsZ0JBQWdCLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxFQUFFLGdCQUFnQjtLQUNwRCxDQUFDLENBQUM7QUFDTCxDQUFDLENBQUM7QUFFRixNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsQ0FBQyxRQUFpQixFQUFFLGFBQStCLEVBQWlCLEVBQUU7SUFDbkcsTUFBTSxHQUFHLEdBQUcsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUMsTUFBTSxLQUFLLFFBQVEsQ0FBQyxDQUFDO0lBQzNELElBQUksQ0FBQyxHQUFHO1FBQUUsTUFBTSxJQUFJLEtBQUssQ0FBQyxrREFBa0QsQ0FBQyxDQUFDO0lBQzlFLElBQUksR0FBRyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsSUFBSSxhQUFhLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxJQUFJLENBQUMsYUFBYSxDQUFDLDBCQUEwQixFQUFFLENBQUM7UUFDbEgsTUFBTSxJQUFJLEtBQUssQ0FBQyw2REFBNkQsQ0FBQyxDQUFDO0lBQ2pGLENBQUM7SUFDRCxPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUMsQ0FBQztBQUVGLE1BQU0sQ0FBQyxNQUFNLGlCQUFpQixHQUFHLENBQUMsUUFBaUIsRUFBVSxFQUFFO0lBQzdELElBQUksT0FBTyxRQUFRLEtBQUssUUFBUSxJQUFJLENBQUMsb0NBQW9DLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDekYsTUFBTSxJQUFJLEtBQUssQ0FBQyxnREFBZ0QsQ0FBQyxDQUFDO0lBQ3BFLENBQUM7SUFDRCxPQUFPLFFBQVEsQ0FBQztBQUNsQixDQUFDLENBQUMifQ==

package/dist_ts/integrations/samsungtv/samsungtv.classes.client.d.ts

@@ -1,41 +1,12 @@
-import type { ISamsungtvApp, ISamsungtvConfig, ISamsungtvDeviceInfoResponse, ISamsungtvSnapshot, TSamsungtvCommand, TSamsungtvCommandAction, TSamsungtvRemoteKey } from './samsungtv.types.js';
+import * as plugins from '../../plugins.js';
+import { NoSqlConfigStore } from '../../core/classes.configstore.js';
+import type { ISamsungtvConfig, ISamsungtvIntegrationOptions, ISamsungtvSnapshot, TSamsungtvRemoteKey } from './samsungtv.types.js';
 export declare class SamsungtvClient {
-    private readonly config;
-    private readonly sockets;
-    private token?;
-    constructor(config: ISamsungtvConfig);
-    getSnapshot(): Promise<ISamsungtvSnapshot>;
-    getDeviceInfo(): Promise<ISamsungtvDeviceInfoResponse>;
-    getApps(): Promise<ISamsungtvApp[]>;
-    sendKeys(keysArg: Array<TSamsungtvRemoteKey | string>, actionArg?: TSamsungtvCommandAction): Promise<void>;
-    sendCommand(commandArg: TSamsungtvCommand): Promise<void>;
-    turnOn(): Promise<void>;
-    turnOff(): Promise<void>;
-    play(): Promise<void>;
-    pause(): Promise<void>;
-    playPause(): Promise<void>;
-    setVolumeLevel(volumeLevelArg: number): Promise<void>;
-    launchApp(appIdArg: string, appTypeArg?: string, metaTagArg?: string): Promise<void>;
-    selectSource(sourceArg: string): Promise<void>;
+    #private;
+    constructor(configArg: ISamsungtvConfig, optionsArg?: ISamsungtvIntegrationOptions | NoSqlConfigStore, signalArg?: AbortSignal);
+    isHealthy(): boolean;
+    start(signalArg?: AbortSignal): Promise<void>;
+    getSnapshot(signalArg?: AbortSignal): Promise<ISamsungtvSnapshot>;
+    sendKey(keyArg: TSamsungtvRemoteKey, signalArg?: AbortSignal): Promise<plugins.ecobridgeDeviceManager.ISamsungTvKeyResult>;
     destroy(): Promise<void>;
-    private sendWebsocketCommands;
-    private withWebSocket;
-    private waitForChannelConnect;
-    private addSocketListener;
-    private createRemoteKeyCommand;
-    private assertLiveWebsocketSupported;
-    private websocketUrl;
-    private requestRestDeviceInfo;
-    private requestJson;
-    private restBaseUrl;
-    private manualDeviceInfo;
-    private getState;
-    private powerFromDeviceInfo;
-    private normalizeKey;
-    private parseWebSocketMessage;
-    private messageText;
-    private updateLocalState;
-    private setActiveApp;
-    private errorMessage;
-    private delay;
 }