@sebbo2002/node-pyatv 4.0.0 → 4.2.0-develop.2

package/package.json

@@ -9,27 +9,28 @@
   },
   "description": "A lightweight wrapper around pyatv…",
   "devDependencies": {
-    "@amanda-mitchell/semantic-release-npm-multiple": "^2.11.0",
-    "@qiwi/semantic-release-gh-pages-plugin": "^5.1.1",
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/exec": "^5.0.0",
-    "@semantic-release/git": "^9.0.0",
+    "@amanda-mitchell/semantic-release-npm-multiple": "^2.15.0",
+    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.0",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/exec": "^6.0.2",
+    "@semantic-release/git": "^10.0.1",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.4.3",
-    "@types/semver": "^7.3.8",
-    "@typescript-eslint/eslint-plugin": "^4.28.4",
-    "@typescript-eslint/parser": "^4.28.4",
-    "eslint": "^7.31.0",
-    "eslint-plugin-jsonc": "^1.4.0",
+    "@types/node": "^16.11.9",
+    "@types/semver": "^7.3.9",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "eslint": "^8.3.0",
+    "eslint-plugin-jsonc": "^2.0.0",
     "license-checker": "^25.0.1",
-    "mocha": "^9.0.3",
-    "mochawesome": "^6.2.2",
+    "mocha": "^9.1.3",
+    "mochawesome": "^7.0.1",
     "nyc": "^15.1.0",
-    "semantic-release": "^17.4.2",
+    "semantic-release": "^18.0.0",
     "semantic-release-license": "^1.0.3",
-    "ts-node": "^10.1.0",
-    "typedoc": "^0.21.4",
-    "typescript": "^4.3.5"
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.4.0",
+    "typedoc": "^0.22.9",
+    "typescript": "^4.5.2"
   },
   "engines": {
     "node": ">=12.0.0"
@@ -54,5 +55,5 @@
     "postinstall": "./check.sh",
     "test": "mocha"
   },
-  "version": "4.0.0"
+  "version": "4.2.0-develop.2"
 }

package/src/lib/device-event.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-import NodePyATVDevice from './device';
+import {NodePyATVDevice} from '../lib';
 import {NodePyATVEventValueType, NodePyATVStateIndex} from './types';
 
 export default class NodePyATVDeviceEvent {

package/src/lib/device-events.ts

@@ -11,8 +11,7 @@ import {
 import {ChildProcess} from 'child_process';
 
 import {EventEmitter} from 'events';
-import NodePyATVDevice from './device';
-import NodePyATVDeviceEvent from './device-event';
+import {NodePyATVDevice, NodePyATVDeviceEvent} from '../lib';
 import {addRequestId, debug, execute, getParamters, parseState, removeRequestId} from './tools';
 import {FakeChildProcess} from './fake-spawn';
 
@@ -91,8 +90,13 @@ export default class NodePyATVDeviceEvents extends EventEmitter {
     }
 
     private applyPushUpdate(update: NodePyATVInternalState, reqId: string): void {
-        const newState = parseState(update, reqId, this.options);
-        this.applyStateAndEmitEvents(newState);
+        try {
+            const newState = parseState(update, reqId, this.options);
+            this.applyStateAndEmitEvents(newState);
+        }
+        catch(error) {
+            this.emit('error', error);
+        }
     }
 
     private checkListener(): void {

package/src/lib/device.ts

@@ -14,8 +14,7 @@ import {
 } from './types';
 
 import {addRequestId, getParamters, parseState, removeRequestId, request} from './tools';
-import NodePyATVDeviceEvents from './device-events';
-import NodePyATVDeviceEvent from './device-event';
+import {NodePyATVDeviceEvents, NodePyATVDeviceEvent} from '../lib';
 import { EventEmitter } from 'events';
 
 /**
@@ -148,14 +147,19 @@ export default class NodePyATVDevice implements EventEmitter{
         }
 
         const id = addRequestId();
-        const parameters = getParamters(this.options);
 
-        const result = await request(id, NodePyATVExecutableType.atvscript, [...parameters, 'playing'], this.options);
-        const newState = parseState(result, id, this.options);
-        this.applyState(newState);
+        try {
+            const parameters = getParamters(this.options);
 
-        removeRequestId(id);
-        return newState;
+            const result = await request(id, NodePyATVExecutableType.atvscript, [...parameters, 'playing'], this.options);
+            const newState = parseState(result, id, this.options);
+
+            this.applyState(newState);
+            return newState;
+        }
+        finally {
+            removeRequestId(id);
+        }
     }
 
     /**

package/src/lib/index.ts

@@ -13,9 +13,14 @@ export {
     NodePyATVFindAndInstanceOptions,
     NodePyATVDeviceOptions,
     NodePyATVGetStateOptions,
-    NodePyATVState
+    NodePyATVState,
+    NodePyATVPowerState,
+    NodePyATVListenerState,
+    NodePyATVEventValueType,
 } from './types';
 
 export {default as NodePyATVDeviceEvent} from './device-event';
+export {default as NodePyATVDeviceEvents} from './device-events';
+export {default as NodePyATVDevice} from './device';
 
 export {default} from './instance';

package/src/lib/instance.ts

@@ -11,7 +11,7 @@ import {
 } from './types';
 
 import {addRequestId, debug, getParamters, removeRequestId, request} from './tools';
-import NodePyATVDevice from './device';
+import {NodePyATVDevice} from '../lib';
 
 /**
  * Default class exported by `@sebbo2002/node-pyatv`. Use [[find]] to scan for devices in your local network. Use

package/src/lib/tools.ts

@@ -205,6 +205,12 @@ export function getParamters(options: NodePyATVFindAndInstanceOptions = {}): str
     if (options.airplayCredentials) {
         parameters.push('--airplay-credentials', options.airplayCredentials);
     }
+    if (options.companionCredentials) {
+        parameters.push('--companion-credentials', options.companionCredentials);
+    }
+    if (options.raopCredentials) {
+        parameters.push('--raop-credentials', options.raopCredentials);
+    }
 
     return parameters;
 }
@@ -246,6 +252,14 @@ export function parseState(input: NodePyATVInternalState, id: string, options: N
     if (!input || typeof input !== 'object') {
         return result;
     }
+    if(input.exception) {
+        let errorStr = 'Got pyatv Error: ' + input.exception;
+        if(input.stacktrace) {
+            errorStr += '\n\npyatv Stacktrace:\n' + input.stacktrace;
+        }
+
+        throw new Error(errorStr);
+    }
 
     // datetime
     if (typeof input.datetime === 'string') {

package/src/lib/types.ts

@@ -132,6 +132,8 @@ export interface NodePyATVFindOptions {
     dmapCredentials?: string;
     mrpCredentials?: string;
     airplayCredentials?: string;
+    companionCredentials?: string;
+    raopCredentials?: string;
 }
 
 export interface NodePyATVFindAndInstanceOptions extends NodePyATVInstanceOptions, NodePyATVFindOptions {
@@ -169,6 +171,7 @@ export interface NodePyATVInternalState {
     power_state?: string | unknown,
     push_updates?: string | unknown,
     exception?: string | unknown,
+    stacktrace?: string | unknown,
     connection?: string | unknown
 }
 

package/test/device-events.ts

@@ -1,10 +1,8 @@
 'use strict';
 
 import assert from 'assert';
-import NodePyATVDevice from '../src/lib/device';
 import {createFakeSpawn} from '../src/lib/fake-spawn';
-import NodePyATVDeviceEvent from '../src/lib/device-event';
-import {NodePyATVPowerState} from '../src/lib/types';
+import {NodePyATVDeviceEvent, NodePyATVPowerState, NodePyATVDevice} from '../src/lib';
 
 describe('NodePyATVDeviceEvents', function () {
     describe('applyStateAndEmitEvents()', function () {
@@ -89,6 +87,29 @@ describe('NodePyATVDeviceEvents', function () {
 
             assert.deepStrictEqual(sort, ['update:title', 'update']);
         });
+        it('should emit error events on failures', async function () {
+            const device = new NodePyATVDevice({
+                name: 'My Testdevice',
+                host: '192.168.178.2',
+                spawn: createFakeSpawn(cp => {
+                    cp.onStdIn(() => cp.end());
+                    cp.stdout({
+                        result: 'failure',
+                        datetime: '2021-11-24T21:13:36.424576+03:00',
+                        exception: 'invalid credentials: 321',
+                        stacktrace: 'Traceback (most recent call last):\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 302, in appstart\n    print(args.output(await _handle_command(args, abort_sem, loop)), flush=True)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 196, in _handle_command\n    atv = await connect(config, loop, protocol=Protocol.MRP)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/__init__.py\", line 96, in connect\n    for setup_data in proto_methods.setup(\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 192, in setup\n    stream = AirPlayStream(config, service)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 79, in __init__\n    self._credentials: HapCredentials = parse_credentials(self.service.credentials)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/auth/hap_pairing.py\", line 139, in parse_credentials\n    raise exceptions.InvalidCredentialsError(\"invalid credentials: \" + detail_string)\npyatv.exceptions.InvalidCredentialsError: invalid credentials: 321\n'
+                    });
+                })
+            });
+
+            await new Promise(cb => {
+                device.once('error', error => {
+                    assert.ok(error instanceof Error);
+                    assert.ok(error.toString().includes('invalid credentials: 321'));
+                    cb(undefined);
+                });
+            });
+        });
         it('should not emit an update if new value is same as old one', async function () {
             let spawnCounter = 0;
             let eventCounter = 0;

package/test/device.ts

@@ -237,6 +237,24 @@ describe('NodePyATVDevice', function () {
                 powerState: null
             });
         });
+        it('should reject with error if pyatv fails', async function () {
+            const device = new NodePyATVDevice({
+                name: 'My Testdevice',
+                host: '192.168.178.2',
+                spawn: createFakeSpawn(cp => {
+                    cp.end({
+                        result: 'failure',
+                        datetime: '2021-11-24T21:13:36.424576+03:00',
+                        exception: 'invalid credentials: 321',
+                        stacktrace: 'Traceback (most recent call last):\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 302, in appstart\n    print(args.output(await _handle_command(args, abort_sem, loop)), flush=True)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 196, in _handle_command\n    atv = await connect(config, loop, protocol=Protocol.MRP)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/__init__.py\", line 96, in connect\n    for setup_data in proto_methods.setup(\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 192, in setup\n    stream = AirPlayStream(config, service)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 79, in __init__\n    self._credentials: HapCredentials = parse_credentials(self.service.credentials)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/auth/hap_pairing.py\", line 139, in parse_credentials\n    raise exceptions.InvalidCredentialsError(\"invalid credentials: \" + detail_string)\npyatv.exceptions.InvalidCredentialsError: invalid credentials: 321\n'
+                    });
+                })
+            });
+
+            assert.rejects(async () => {
+                await device.getState();
+            }, /Got pyatv Error: invalid credentials: 321/);
+        });
         it('should cache requests for a bit', async function () {
             let executions = 0;
             const device = new NodePyATVDevice({

package/test/instance.ts

@@ -9,7 +9,9 @@ import NodePyATVInstance, {
     NodePyATVDeviceState,
     NodePyATVRepeatState,
     NodePyATVShuffleState,
-    NodePyATVKeys
+    NodePyATVKeys,
+    NodePyATVListenerState,
+    NodePyATVPowerState
 } from '../src/lib/index';
 
 describe('NodePyATVInstance', function () {
@@ -330,5 +332,11 @@ describe('NodePyATVInstance', function () {
         it('Type NodePyATVKeys should be exported', function() {
             assert.ok(NodePyATVKeys);
         });
+        it('Type NodePyATVInstanceOptions should be exported', function() {
+            assert.ok(NodePyATVListenerState);
+        });
+        it('Type NodePyATVPowerState should be exported', function() {
+            assert.ok(NodePyATVPowerState);
+        });
     });
 });

package/test/tools.ts

@@ -1,7 +1,7 @@
 'use strict';
 
 import assert from 'assert';
-import {addRequestId, debug, getExecutable, getParamters, parseState, removeRequestId} from '../src/lib/tools';
+import { addRequestId, debug, getExecutable, getParamters, parseState, removeRequestId } from '../src/lib/tools';
 import {
     NodePyATVDeviceState,
     NodePyATVExecutableType,
@@ -28,7 +28,7 @@ describe('Tools', function () {
             debug('TEST', 'Hello World.', {});
         });
         it('should work with default logger', function () {
-            debug('TEST', 'Hello World.', {debug: true});
+            debug('TEST', 'Hello World.', { debug: true });
         });
         it('should work with custom logger', function () {
             debug('TEST', 'Hello World.', {
@@ -39,7 +39,7 @@ describe('Tools', function () {
             });
         });
         it('should work with colors disabled', function () {
-            debug('TEST', 'Hello World.', {noColors: true});
+            debug('TEST', 'Hello World.', { noColors: true });
         });
         it('should work with custom logger and colors disabled', function () {
             debug('TEST', 'Hello World.', {
@@ -103,7 +103,9 @@ describe('Tools', function () {
                 protocol: NodePyATVProtocol.mrp,
                 dmapCredentials: '****',
                 mrpCredentials: '****',
-                airplayCredentials: '****'
+                airplayCredentials: '****',
+                companionCredentials: '1234',
+                raopCredentials: '::foo:'
             });
             assert.deepEqual(result, [
                 '-s', '192.168.178.2,192.168.178.3',
@@ -111,7 +113,9 @@ describe('Tools', function () {
                 '--protocol', 'mrp',
                 '--dmap-credentials', '****',
                 '--mrp-credentials', '****',
-                '--airplay-credentials', '****'
+                '--airplay-credentials', '****',
+                '--companion-credentials', '1234',
+                '--raop-credentials', '::foo:'
             ]);
         });
     });
@@ -197,8 +201,19 @@ describe('Tools', function () {
                 powerState: null
             });
         });
+        it('should throw an error for pyatv exceptions', function () {
+            const input = {
+                result: 'failure',
+                datetime: '2021-11-24T21:13:36.424576+03:00',
+                exception: 'invalid credentials: 321',
+                stacktrace: 'Traceback (most recent call last):\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 302, in appstart\n    print(args.output(await _handle_command(args, abort_sem, loop)), flush=True)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/scripts/atvscript.py\", line 196, in _handle_command\n    atv = await connect(config, loop, protocol=Protocol.MRP)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/__init__.py\", line 96, in connect\n    for setup_data in proto_methods.setup(\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 192, in setup\n    stream = AirPlayStream(config, service)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/protocols/airplay/__init__.py\", line 79, in __init__\n    self._credentials: HapCredentials = parse_credentials(self.service.credentials)\n  File \"/Users/free/Library/Python/3.8/lib/python/site-packages/pyatv/auth/hap_pairing.py\", line 139, in parse_credentials\n    raise exceptions.InvalidCredentialsError(\"invalid credentials: \" + detail_string)\npyatv.exceptions.InvalidCredentialsError: invalid credentials: 321\n'
+            };
+            assert.throws(() => {
+                parseState(input, '', {});
+            }, /Got pyatv Error: invalid credentials: 321/);
+        });
         it('should ignore date if it\'s an invalid date', function () {
-            const input = {datetime: 'today'};
+            const input = { datetime: 'today' };
             const result = parseState(input, '', {});
             assert.deepStrictEqual(result, {
                 dateTime: null,

package/typedoc.json

@@ -7,9 +7,9 @@
     "excludePrivate": true,
     "excludeProtected": true,
     "includeVersion": true,
-    "name": "",
+    "name": "node-pyatv",
     "out": "./docs/reference",
     "plugin": [],
     "readme": "README.md",
-    "theme": "minimal"
+    "theme": "default"
 }