@sebbo2002/node-pyatv 6.0.0-develop.2 → 6.0.0-develop.3

package/dist/lib/device.js

@@ -1,793 +0,0 @@
-'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());
-    });
-};
-import { NodePyATVExecutableType, NodePyATVInternalKeys, NodePyATVKeys } from './types.js';
-import { addRequestId, getParamters, parseState, removeRequestId, request } from './tools.js';
-import { NodePyATVDeviceEvents } from '../lib/index.js';
-/**
- * Represents an Apple TV. Use [[getState]] to query the current state (e.g. media
- * type and title). You can also use the attribute methods (e.g. [[getTitle]] to get
- * the state. If you want realtime updates, subscribe to it's events with an
- * `EventEmitter` like API, so for example by using [[on]], [[once]] or [[addListener]].
- * It's also possible to send key commands by using [[pressKey]] or methods like [[pause]].
- */
-export default class NodePyATVDevice {
-    constructor(options) {
-        this.options = Object.assign({}, options);
-        this.state = parseState({}, '', {});
-        this.events = new NodePyATVDeviceEvents(this.state, this, this.options);
-        // @todo basic validation
-    }
-    /**
-     * Get the name of the Apple TV.
-     *
-     * ```typescript
-     * import pyatv from '@sebbo2002/node-pyatv';
-     * const devices = await pyatv.find();
-     * devices.forEach(device =>
-     *     console.log(device.name)
-     * );
-     * ```
-     */
-    get name() {
-        return this.options.name;
-    }
-    /**
-     * Get the IP address of the Apple TV.
-     */
-    get host() {
-        return this.options.host;
-    }
-    /**
-     * Get the ID of the Apple TV.
-     */
-    get id() {
-        return this.options.id;
-    }
-    /**
-     * Get the used protocol to connect to the Apple TV.
-     */
-    get protocol() {
-        return this.options.protocol;
-    }
-    /**
-     * Get the model identifier of the device. Only set, if the
-     * device was found using [[find()]]. Requires pyatv ≧ 0.10.3.
-     *
-     * @example device.model → "Gen4K"
-     */
-    get model() {
-        return this.options.model;
-    }
-    /**
-     * Get the model name of the device. Only set, if the device
-     * was found with [[find()]]. Requires pyatv ≧ 0.10.3.
-     *
-     * @example device.modelName → "Apple TV 4K"
-     */
-    get modelName() {
-        return this.options.modelName;
-    }
-    /**
-     * Get the operating system of the device. Only set, if the
-     * device was found with [[find()]]. Requires pyatv ≧ 0.10.3.
-     *
-     * @example device.os → "TvOS"
-     */
-    get os() {
-        return this.options.os;
-    }
-    /**
-     * Get the device version. Only set, if the device was found
-     * during a scan using [[find()]]. Requires pyatv ≧ 0.10.3.
-     *
-     * @example device.version → "15.5.1"
-     */
-    get version() {
-        return this.options.version;
-    }
-    /**
-     * Returns a list of services supported by the device. Ony set, if
-     * the device was found during a scan using [[find()]]. Requires
-     * pyatv ≧ 0.10.3.
-     *
-     * @example device.services → [
-     *   {
-     *     "protocol": "airplay",
-     *     "port": 7000
-     *   },
-     *   {
-     *     "protocol": "dmap",
-     *     "port": 3689
-     *   }
-     * ]
-     */
-    get services() {
-        return this.options.services;
-    }
-    /**
-     * Returns true, if debugging is enabled. Returns the custom
-     * logging method, if one was specified. Otherwise, if debug
-     * log is disabled, returns undefined.
-     */
-    get debug() {
-        return this.options.debug;
-    }
-    /**
-     * Enable or disable debugging or set a custom
-     * debugging method to use.
-     *
-     * @param debug
-     */
-    set debug(debug) {
-        if (typeof debug === 'function') {
-            this.options.debug = debug;
-        }
-        else {
-            this.options.debug = Boolean(debug) || undefined;
-        }
-    }
-    /**
-     * Returns an object with `name`, `host`, `id` and `protocol`.
-     * Can be used to initiate a new device instance.
-     *
-     * @category Basic
-     */
-    toJSON() {
-        return {
-            name: this.name,
-            host: this.host,
-            id: this.id,
-            protocol: this.protocol
-        };
-    }
-    /**
-     * Returns a string. Just for debugging, etc.
-     *
-     * @category Basic
-     */
-    toString() {
-        return `NodePyATVDevice(${this.name}, ${this.host})`;
-    }
-    /**
-     * Returns an [[NodePyATVState]] object representing the current state
-     * of the device. Has an internal cache, which has a default TTL of 5s.
-     * You can change this default value by passing the `maxAge` option.
-     *
-     * ```typescript
-     * await device.getState({maxAge: 10000}); // cache TTL: 10s
-     * ```
-     *
-     * @param options
-     * @category State
-     */
-    getState(options = {}) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (((_a = this.state) === null || _a === void 0 ? void 0 : _a.dateTime) && new Date().getTime() - this.state.dateTime.getTime() < (options.maxAge || 5000)) {
-                let position = null;
-                if (this.state.position && this.state.dateTime) {
-                    position = Math.round(this.state.position +
-                        ((new Date().getTime() - this.state.dateTime.getTime()) / 1000));
-                }
-                return Object.assign({}, this.state, { position });
-            }
-            const id = addRequestId();
-            try {
-                const parameters = getParamters(this.options);
-                const result = yield request(id, NodePyATVExecutableType.atvscript, [...parameters, 'playing'], this.options);
-                const newState = parseState(result, id, this.options);
-                this.applyState(newState);
-                return newState;
-            }
-            finally {
-                removeRequestId(id);
-            }
-        });
-    }
-    /**
-     * Removes the state node-pyatv cached for this device.
-     *
-     * @category State
-     */
-    clearState() {
-        this.applyState(parseState({}, '', {}));
-    }
-    applyState(newState) {
-        this.events.applyStateAndEmitEvents(newState);
-    }
-    /**
-     * Get the date and time when the state was last updated.
-     * @param options
-     * @category State
-     */
-    getDateTime(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.dateTime;
-        });
-    }
-    /**
-     * Get the hash of the current media
-     * @param options
-     * @category State
-     */
-    getHash(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.hash;
-        });
-    }
-    /**
-     * Get the media type of the current media
-     * @param options
-     * @category State
-     */
-    getMediaType(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.mediaType;
-        });
-    }
-    /**
-     * Get the state of this device (e.g. playing, etc.)
-     * @param options
-     * @category State
-     */
-    getDeviceState(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.deviceState;
-        });
-    }
-    /**
-     * Returns the title of the current playing media
-     * @param options
-     * @category State
-     */
-    getTitle(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.title;
-        });
-    }
-    /**
-     * Returns the artist of the current playing media
-     * @param options
-     * @category State
-     */
-    getArtist(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.artist;
-        });
-    }
-    /**
-     * Returns the album of the current playing media
-     * @param options
-     * @category State
-     */
-    getAlbum(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.album;
-        });
-    }
-    /**
-     * Returns the genre of the current playing media
-     * @param options
-     * @category State
-     */
-    getGenre(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.genre;
-        });
-    }
-    /**
-     * Returns the media length of the current playing media
-     * @param options
-     * @category State
-     */
-    getTotalTime(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.totalTime;
-        });
-    }
-    /**
-     * Returns the title of the current playing media
-     * @param options
-     * @category State
-     */
-    getPosition(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.position;
-        });
-    }
-    /**
-     * Returns the shuffle state
-     * @param options
-     * @category State
-     */
-    getShuffle(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.shuffle;
-        });
-    }
-    /**
-     * Returns the repeat state
-     * @param options
-     * @category State
-     */
-    getRepeat(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.repeat;
-        });
-    }
-    /**
-     * Returns the currently used app
-     * @param options
-     * @category State
-     */
-    getApp(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.app;
-        });
-    }
-    /**
-     * Returns the id of the currently used app
-     * @param options
-     * @category State
-     */
-    getAppId(options = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const state = yield this.getState(options);
-            return state.appId;
-        });
-    }
-    /**
-     * Returns the list of installed apps on the Apple TV. Probably requires `companionCredentials`,
-     * see https://pyatv.dev/documentation/atvremote/#apps for more details.
-     */
-    listApps() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const id = addRequestId();
-            const parameters = getParamters(this.options);
-            const result = yield request(id, NodePyATVExecutableType.atvremote, [...parameters, 'app_list'], this.options);
-            if (typeof result !== 'string' || !result.startsWith('App: ')) {
-                throw new Error('Unexpected atvremote response: ' + result);
-            }
-            removeRequestId(id);
-            const regex = /(.+) \(([^\)]+)\)$/i;
-            const items = result.substring(5).split(', App: ').map(i => {
-                const m = i.match(regex);
-                if (m !== null) {
-                    return {
-                        id: m[2],
-                        name: m[1],
-                        launch: () => this.launchApp(m[2])
-                    };
-                }
-            });
-            return items.filter(Boolean);
-        });
-    }
-    _pressKey(key, executableType) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const id = addRequestId();
-            const parameters = getParamters(this.options);
-            const result = yield request(id, executableType, [...parameters, key], this.options);
-            if (executableType === NodePyATVExecutableType.atvscript &&
-                (typeof result !== 'object' || result.result !== 'success')) {
-                throw new Error(`Unable to parse pyatv response: ${JSON.stringify(result, null, '  ')}`);
-            }
-            removeRequestId(id);
-        });
-    }
-    /**
-     * Send a key press to the Apple TV
-     *
-     * ```typescript
-     * await device.pressKey(NodePyATVKeys.home);
-     * ```
-     *
-     * <br />
-     *
-     * ```javascript
-     * await device.pressKey('home');
-     * ```
-     *
-     * @param key
-     * @category Control
-     */
-    pressKey(key) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const internalKeyEntry = Object.entries(NodePyATVInternalKeys)
-                .find(([k]) => key === k);
-            if (!internalKeyEntry) {
-                throw new Error(`Unsupported key value ${key}!`);
-            }
-            const internalKey = internalKeyEntry[1];
-            const executableType = [NodePyATVKeys.turnOn, NodePyATVKeys.turnOff].includes(key) ?
-                NodePyATVExecutableType.atvremote :
-                NodePyATVExecutableType.atvscript;
-            yield this._pressKey(internalKey, executableType);
-        });
-    }
-    /**
-     * Send the "down" command
-     * @category Control
-     */
-    down() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.down, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "home" command
-     * @category Control
-     */
-    home() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.home, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "homeHold" command
-     * @category Control
-     */
-    homeHold() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.homeHold, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "left" command
-     * @category Control
-     */
-    left() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.left, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "menu" command
-     * @category Control
-     */
-    menu() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.menu, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "next" command
-     * @category Control
-     */
-    next() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.next, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "pause" command
-     * @category Control
-     */
-    pause() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.pause, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "play" command
-     * @category Control
-     */
-    play() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.play, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "playPause" command
-     * @category Control
-     */
-    playPause() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.playPause, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "previous" command
-     * @category Control
-     */
-    previous() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.previous, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "right" command
-     * @category Control
-     */
-    right() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.right, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "select" command
-     * @category Control
-     */
-    select() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.select, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "skipBackward" command
-     * @category Control
-     */
-    skipBackward() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.skipBackward, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "skipForward" command
-     * @category Control
-     */
-    skipForward() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.skipForward, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "stop" command
-     * @category Control
-     */
-    stop() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.stop, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "suspend" command
-     * @category Control
-     * @deprecated
-     */
-    suspend() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.suspend, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "topMenu" command
-     * @category Control
-     */
-    topMenu() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.topMenu, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "up" command
-     * @category Control
-     */
-    up() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.up, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "volumeDown" command
-     * @category Control
-     */
-    volumeDown() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.volumeDown, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "volumeUp" command
-     * @category Control
-     */
-    volumeUp() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.volumeUp, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "wakeup" command
-     * @category Control
-     * @deprecated
-     */
-    wakeup() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.wakeup, NodePyATVExecutableType.atvscript);
-        });
-    }
-    /**
-     * Send the "turn_off" command
-     * @category Control
-     */
-    turnOff() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.turnOff, NodePyATVExecutableType.atvremote);
-        });
-    }
-    /**
-     * Send the "turn_on" command
-     * @category Control
-     */
-    turnOn() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey(NodePyATVInternalKeys.turnOn, NodePyATVExecutableType.atvremote);
-        });
-    }
-    /**
-     * Launch an application. Probably requires `companionCredentials`, see
-     * https://pyatv.dev/documentation/atvremote/#apps for more details.
-     * @param id App identifier, e.g. `com.netflix.Netflix`
-     */
-    launchApp(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._pressKey('launch_app=' + id, NodePyATVExecutableType.atvremote);
-        });
-    }
-    /**
-     * Add an event listener. Will start the event subscription with the
-     * Apple TV as long as there are listeners for any event registered.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    addListener(event, listener) {
-        this.events.addListener(event, listener);
-        return this;
-    }
-    /**
-     * Emit an event.
-     * @param event
-     * @param payload
-     * @category Event
-     */
-    emit(event, payload) {
-        return this.events.emit(event, payload);
-    }
-    /**
-     * Get all event names which are currently known.
-     * @category Event
-     */
-    eventNames() {
-        return this.events.eventNames();
-    }
-    /**
-     * Get max number of listeners allowed
-     * @category Event
-     */
-    getMaxListeners() {
-        return this.events.getMaxListeners();
-    }
-    /**
-     * Get number of listeners for event
-     * @param event
-     * @category Event
-     */
-    listenerCount(event) {
-        return this.events.listenerCount(event);
-    }
-    /**
-     * Get listeners for event. Will also return
-     * node-pyatv wrappers (e.g. once)
-     *
-     * @param event
-     * @category Event
-     */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    listeners(event) {
-        return this.events.listeners(event);
-    }
-    /**
-     * Remove an event listener. Will stop the event subscription with the
-     * Apple TV if this was the last event listener.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    off(event, listener) {
-        this.events.off(event, listener);
-        return this;
-    }
-    /**
-     * Add an event listener. Will start the event subscription with the
-     * Apple TV as long as there are listeners for any event registered.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    on(event, listener) {
-        this.events.on(event, listener);
-        return this;
-    }
-    /**
-     * Add an event listener. Will start the event subscription with the
-     * Apple TV as long as there are listeners for any event registered.
-     * Removes the listener automatically after the first occurrence.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    once(event, listener) {
-        this.events.once(event, listener);
-        return this;
-    }
-    /**
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    prependListener(event, listener) {
-        this.events.prependListener(event, listener);
-        return this;
-    }
-    /**
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    prependOnceListener(event, listener) {
-        this.events.prependOnceListener(event, listener);
-        return this;
-    }
-    /**
-     * @param event
-     * @category Event
-     */
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    rawListeners(event) {
-        return this.events.rawListeners(event);
-    }
-    /**
-     * Removes all listeners, either for the given event or
-     * for every event. Will stop the event subscription with
-     * the Apple TV if this was the last event listener.
-     *
-     * @param event
-     * @category Event
-     */
-    removeAllListeners(event) {
-        this.events.removeAllListeners(event);
-        return this;
-    }
-    /**
-     * Remove an event listener. Will stop the event subscription with the
-     * Apple TV if this was the last event listener.
-     * @param event
-     * @param listener
-     * @category Event
-     */
-    removeListener(event, listener) {
-        this.events.removeListener(event, listener);
-        return this;
-    }
-    /**
-     * @param n
-     * @category Event
-     */
-    setMaxListeners(n) {
-        this.events.setMaxListeners(n);
-        return this;
-    }
-}
-//# sourceMappingURL=device.js.map