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

package/release.config.cjs

@@ -1,51 +0,0 @@
-const configuration = {
-    'branches': [
-        'main',
-        {
-            'name': 'develop',
-            'channel': 'next',
-            'prerelease': true
-        }
-    ],
-    'plugins': []
-};
-
-configuration.plugins.push(['@semantic-release/commit-analyzer', {
-    'releaseRules': [
-        {'type': 'chore', 'scope': 'deps', 'release': 'patch'},
-        {'type': 'chore', 'scope': 'package', 'release': 'patch'},
-        {'type': 'build', 'scope': 'deps', 'release': 'patch'},
-        {'type': 'docs', 'release': 'patch'}
-    ]
-}]);
-
-configuration.plugins.push('@semantic-release/release-notes-generator');
-
-configuration.plugins.push('@semantic-release/changelog');
-
-configuration.plugins.push('semantic-release-license');
-
-configuration.plugins.push('@semantic-release/npm');
-
-configuration.plugins.push(['@semantic-release/exec', {
-    'prepareCmd': './.github/workflows/build.sh'
-}]);
-
-configuration.plugins.push(['@semantic-release/github', {
-    'labels': false,
-    'assignees': process.env.GH_OWNER
-}]);
-
-configuration.plugins.push(['@semantic-release/git', {
-    'assets': ['CHANGELOG.md', 'LICENSE'],
-    'message': 'chore(release): :bookmark: ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
-}]);
-
-configuration.plugins.push(['@qiwi/semantic-release-gh-pages-plugin', {
-    'msg': 'docs: Updated for <%= nextRelease.gitTag %>',
-    'src': './docs',
-    'dst': `./${process.env.BRANCH}`,
-    'pullTagsBranch': 'main'
-}]);
-
-module.exports = configuration;

package/src/bin/check.ts

@@ -1,41 +0,0 @@
-'use strict';
-
-import NodePyATVInstance from '../lib/instance.js';
-
-(async () => {
-    try {
-        await NodePyATVInstance.check();
-
-        console.log('');
-        console.log('✔ node-pyatv seems to be ready to use!');
-        console.log('  Thank you and have a great day. Or night. Whatever.');
-        console.log('');
-    }
-    catch(error) {
-        console.log('');
-        console.log('#'.repeat(60));
-        console.log('#' + ' '.repeat(58) + '#');
-        console.log('# ⚠ Warning: node-pyatv is not ready to be used!' + ' '.repeat(10) + '#');
-        console.log('#' + ' '.repeat(58) + '#');
-        console.log('# To use the JavaScript module, pyatv >= 0.6.0 must be     #');
-        console.log('# installed. Unfortunately this could not be found. During #');
-        console.log('# the check following error message was reported:          #');
-        console.log('#' + ' '.repeat(58) + '#');
-        console.log(
-            String(error)
-                .replace('Error: ', '')
-                .replace(/(.{1,54})/g, '$1\n')
-                .split('\n')
-                .map(l => l.trim())
-                .filter(l => Boolean(l))
-                .map(l => `# > ${l}${' '.repeat(55 - l.length)}#`)
-                .join('\n')
-        );
-        console.log('#' + ' '.repeat(58) + '#');
-        console.log('# You can probably find more information here:             #');
-        console.log('# https://github.com/sebbo2002/node-pyatv                  #');
-        console.log('#' + ' '.repeat(58) + '#');
-        console.log('#'.repeat(60));
-        console.log('');
-    }
-})();

package/src/examples/push.ts

@@ -1,46 +0,0 @@
-'use strict';
-
-// import pyatv, {NodePyATVDeviceEvent} from '@sebbo2002/node-pyatv';
-import pyatv, {NodePyATVDeviceEvent} from '../lib/index.js';
-
-(async () => {
-    const devices = await pyatv.find(/*{debug: true}*/);
-    if (!devices.length) {
-        throw new Error('Oh no. Unable to find any devices. If you find devices with atvremote, please enable the debug log.');
-    }
-
-    console.log(`🔍 Found ${devices.length} device${devices.length > 1 ? 's' : ''}:`);
-    if(devices.length > 1) {
-        for (const i in devices) {
-            const device = devices[i];
-            console.log(`   - ${device.name} (${device.host})`);
-        }
-    }
-
-    const device = devices.find(d => d.name === 'Wohnzimmer') || devices[0];
-    console.log(`\n⚡️ Subscribe to live events on ${device.name} (press any key to stop)`);
-    await new Promise((resolve, reject) => {
-        const errorListener = (error: NodePyATVDeviceEvent | Error) => reject(error);
-        const updateListener = (event: NodePyATVDeviceEvent | Error) => {
-            if(event instanceof Error || event.key === 'dateTime') return;
-            console.log(`   ${event.key}: ${event?.value} (was ${event?.oldValue})`);
-        };
-        const keyPressListener = () => {
-            console.log('\n⏳ Remove event listeners…');
-            device.off('update', updateListener);
-            device.off('error', errorListener);
-            process.stdin.off('data', keyPressListener);
-            resolve(undefined);
-        };
-
-        device.on('update', updateListener);
-        device.on('error', errorListener);
-        process.stdin.on('data', keyPressListener);
-    });
-
-    console.log('🎉 Thank you');
-    process.exit(0);
-})().catch(error => {
-    console.log(`🚨 Error: ${error.stack || error}`);
-    process.exit(1);
-});

package/src/lib/device-event.ts

@@ -1,57 +0,0 @@
-'use strict';
-
-import {NodePyATVDevice} from '../lib/index.js';
-import type {NodePyATVEventValueType, NodePyATVStateIndex} from './types.js';
-
-export default class NodePyATVDeviceEvent {
-    protected readonly values: {key: NodePyATVStateIndex, old: NodePyATVEventValueType, new: NodePyATVEventValueType, device: NodePyATVDevice};
-
-    /**
-     *
-     * @param values
-     * @internal
-     */
-    constructor(values: {key: NodePyATVStateIndex, old: NodePyATVEventValueType, new: NodePyATVEventValueType, device: NodePyATVDevice}) {
-        this.values = Object.assign({}, values, {
-            key: values.key as NodePyATVStateIndex
-        });
-    }
-
-    /**
-     * References the attribute name which was changed. So if the
-     * title has been updated, this would be `title`.
-     */
-    get key(): NodePyATVStateIndex {
-        return this.values.key;
-    }
-
-    /**
-     * Holds the old value which was there
-     * before the value was changed.
-     */
-    get oldValue(): NodePyATVEventValueType {
-        return this.values.old;
-    }
-
-    /**
-     * @alias value
-     */
-    get newValue(): NodePyATVEventValueType {
-        return this.values.new;
-    }
-
-    /**
-     * New, current value for `key`
-     */
-    get value(): NodePyATVEventValueType {
-        return this.values.new;
-    }
-
-    /**
-     * References the device instance this
-     * event originates from
-     */
-    get device(): NodePyATVDevice {
-        return this.values.device;
-    }
-}

package/src/lib/device-events.ts

@@ -1,295 +0,0 @@
-'use strict';
-
-import {
-    NodePyATVDeviceOptions,
-    NodePyATVExecutableType,
-    NodePyATVInternalState,
-    NodePyATVListenerState,
-    NodePyATVState,
-    NodePyATVStateIndex
-} from './types.js';
-import {ChildProcess} from 'child_process';
-
-import {EventEmitter} from 'events';
-import {NodePyATVDevice, NodePyATVDeviceEvent} from '../lib/index.js';
-import {addRequestId, debug, execute, getParamters, parseState, removeRequestId} from './tools.js';
-import {FakeChildProcess} from './fake-spawn.js';
-
-/**
- * @internal
- */
-export default class NodePyATVDeviceEvents extends EventEmitter {
-    private readonly options: NodePyATVDeviceOptions;
-    private readonly state: NodePyATVState;
-    private readonly device: NodePyATVDevice;
-    private pyatv: ChildProcess | FakeChildProcess | undefined;
-    private timeout: NodeJS.Timeout | undefined;
-    private listenerState: NodePyATVListenerState;
-
-    constructor(state: NodePyATVState, device: NodePyATVDevice, options: NodePyATVDeviceOptions) {
-        super();
-
-        this.state = state;
-        this.device = device;
-        this.options = Object.assign({}, options);
-        this.listenerState = NodePyATVListenerState.stopped;
-    }
-
-    applyStateAndEmitEvents(newState: NodePyATVState): void {
-        Object.keys(this.state).forEach((key: string) => {
-
-            // @ts-ignore
-            const oldValue = this.state[key];
-
-            // @ts-ignore
-            const newValue = newState[key];
-
-            if(oldValue === undefined || newValue === undefined || oldValue === newValue) {
-                return;
-            }
-
-            const event = new NodePyATVDeviceEvent({
-                key: key as NodePyATVStateIndex,
-                old: oldValue,
-                new: newValue,
-                device: this.device
-            });
-
-            // @ts-ignore
-            this.state[key] = newState[key];
-
-            try {
-                this.emit('update:' + key, event);
-                this.emit('update', event);
-            }
-            catch(error) {
-                this.emit('error', error);
-            }
-        });
-    }
-
-    private parsePushUpdate(reqId: string, data: string): void {
-        let json: NodePyATVInternalState;
-
-        try {
-            json = JSON.parse(data);
-        }
-        catch(error) {
-            const msg = `Unable to parse stdout json: ${error}`;
-            debug(reqId, msg, this.options);
-            this.emit('error', new Error(msg));
-            return;
-        }
-
-        this.applyPushUpdate(json, reqId);
-
-        if(this.listenerState === NodePyATVListenerState.starting) {
-            this.listenerState = NodePyATVListenerState.started;
-            this.checkListener();
-        }
-    }
-
-    private applyPushUpdate(update: NodePyATVInternalState, reqId: string): void {
-        try {
-            const newState = parseState(update, reqId, this.options);
-            this.applyStateAndEmitEvents(newState);
-        }
-        catch(error) {
-            this.emit('error', error);
-        }
-    }
-
-    private checkListener(): void {
-        if(this.listenerState === NodePyATVListenerState.stopped && this.listenerCount() === 0 && this.timeout) {
-            clearTimeout(this.timeout);
-            this.timeout = undefined;
-        }
-        else if(this.listenerState === NodePyATVListenerState.stopped && this.listenerCount() > 0) {
-            const id = addRequestId();
-            debug(id, `Start listeing to events from device ${this.options.name}`, this.options);
-
-            this.startListening(id);
-            removeRequestId(id);
-        }
-        else if(
-            [NodePyATVListenerState.starting, NodePyATVListenerState.started].includes(this.listenerState) &&
-            this.listenerCount() === 0
-        ) {
-            const id = addRequestId();
-            debug(id, `Stop listening to events from device ${this.options.name}`, this.options);
-
-            this.stopListening(id)
-                .catch(error => debug(id, `Unable to stop listeing: ${error}`, this.options))
-                .finally(() => removeRequestId(id));
-        }
-    }
-
-    private startListening(reqId: string): void {
-        if(this.listenerState !== NodePyATVListenerState.stopped) {
-            return;
-        }
-
-        this.listenerState = NodePyATVListenerState.starting;
-
-        const listenStart = new Date().getTime();
-        const parameters = getParamters(this.options);
-        this.pyatv = execute(reqId, NodePyATVExecutableType.atvscript, [...parameters, 'push_updates'], this.options);
-        if(!this.pyatv) {
-            throw new Error('Unable to start listener: Unable to start atvscript');
-        }
-
-        const onError = (error: Error) => {
-            debug(reqId, `Got error from child process: ${error}`, this.options);
-            this.emit('error', error);
-        };
-
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const onStdErr = (data: any) => {
-            const error = new Error(`Got stderr output from pyatv: ${data}`);
-            debug(reqId, data.toString(), this.options);
-            this.emit('error', error);
-        };
-
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const onStdOut = (data: any) => {
-            String(data)
-                .split('\n')
-                .map(s => s.trim())
-                .filter(Boolean)
-                .forEach(s => this.parsePushUpdate(reqId, s));
-        };
-        const onClose = (code: number) => {
-            if(this.pyatv === undefined) {
-                // this should never happen… :/
-                return;
-            }
-
-            this.listenerState = NodePyATVListenerState.stopped;
-            debug(reqId, `Listening with atvscript exited with code ${code}`, this.options);
-            if(this.timeout !== undefined) {
-                clearTimeout(this.timeout);
-                this.timeout = undefined;
-            }
-
-            if (this.pyatv.stdout) {
-                this.pyatv.stdout.off('data', onStdOut);
-            }
-            if (this.pyatv.stderr) {
-                this.pyatv.stderr.off('data', onStdErr);
-            }
-            this.pyatv.off('error', onError);
-            this.pyatv.off('close', onClose);
-
-
-            if(this.listenerCount() > 0 && new Date().getTime() - listenStart < 30000) {
-                debug(reqId, `Wait 15s and restart listeing to events from device ${this.options.name}`, this.options);
-
-                this.timeout = setTimeout(() => {
-                    this.checkListener();
-                }, 15000);
-            }
-            else if(this.listenerCount() > 0) {
-                debug(reqId, `Restart listeing to events from device ${this.options.name}`, this.options);
-                this.checkListener();
-            }
-
-            removeRequestId(reqId);
-        };
-
-        this.pyatv.on('error', onError);
-        this.pyatv.on('close', onClose);
-
-        if (this.pyatv.stdout) {
-            this.pyatv.stdout.on('data', onStdOut);
-        }
-        if (this.pyatv.stderr) {
-            this.pyatv.stderr.on('data', onStdErr);
-        }
-    }
-
-    protected async stopListening(reqId: string): Promise<void> {
-        if(
-            this.listenerState !== NodePyATVListenerState.starting &&
-            this.listenerState !== NodePyATVListenerState.started
-        ) {
-            return;
-        }
-
-        this.listenerState = NodePyATVListenerState.stopping;
-        if(this.pyatv === undefined) {
-            throw new Error(
-                'Unable to stop listening due to internal error: state is stopping, but there\'s no child process. ' +
-                'This should never happen, please report this.'
-            );
-        }
-
-        if(this.pyatv.stdin) {
-            debug(reqId, 'Pressing enter to close atvscript…', this.options);
-            this.pyatv.stdin.write('\n');
-
-            await new Promise(cb => this.timeout = setTimeout(cb, 250));
-        }
-
-        if(this.listenerState === NodePyATVListenerState.stopping && this.pyatv) {
-            this.pyatv.kill();
-        }
-
-        this.listenerState = NodePyATVListenerState.stopped;
-        return;
-    }
-
-    addListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this {
-        super.addListener(event, listener);
-        this.checkListener();
-        return this;
-    }
-
-    on(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this {
-        super.on(event, listener);
-        this.checkListener();
-        return this;
-    }
-
-    once(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this {
-        super.once(event, (event: NodePyATVDeviceEvent) => {
-            listener(event);
-            setTimeout(() => this.checkListener(), 0);
-        });
-        this.checkListener();
-        return this;
-    }
-
-    prependListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this {
-        super.prependListener(event, listener);
-        this.checkListener();
-        return this;
-    }
-
-    off(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this {
-        super.off(event, listener);
-        this.checkListener();
-        return this;
-    }
-
-    removeAllListeners(event?: string | symbol): this {
-        super.removeAllListeners(event);
-        this.checkListener();
-        return this;
-    }
-
-    removeListener(event: string | symbol, listener: (event: NodePyATVDeviceEvent) => void): this {
-        super.removeListener(event, listener);
-        this.checkListener();
-        return this;
-    }
-
-    listenerCount(event?: string | symbol): number {
-        if(event !== undefined) {
-            return super.listenerCount(event);
-        }
-
-        return this.eventNames()
-            .map(event => this.listenerCount(event))
-            .reduce((a, b) => a + b, 0);
-    }
-}