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

package/package.json

@@ -9,32 +9,32 @@
   },
   "description": "A lightweight wrapper around pyatv…",
   "devDependencies": {
-    "@amanda-mitchell/semantic-release-npm-multiple": "^3.5.0",
-    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.3",
+    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.5",
     "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^9.0.2",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.11.10",
+    "@types/node": "^18.15.3",
     "@types/semver": "^7.3.13",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
-    "c8": "^7.12.0",
-    "eslint": "^8.29.0",
-    "eslint-plugin-jsonc": "^2.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.54.1",
+    "c8": "^7.13.0",
+    "eslint": "^8.35.0",
+    "eslint-plugin-jsonc": "^2.6.0",
     "esm": "^3.2.25",
     "license-checker": "^25.0.1",
-    "mocha": "^10.1.0",
+    "mocha": "^10.2.0",
     "mochawesome": "^7.1.3",
-    "semantic-release": "^19.0.5",
+    "semantic-release": "^20.1.1",
     "semantic-release-license": "^1.0.3",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.21",
-    "typescript": "^4.9.3"
+    "typedoc": "^0.23.26",
+    "typescript": "^4.9.5"
   },
   "engines": {
-    "node": "^12.20.0 || >=14.13.1"
+    "node": "^14.8.0 || >=16.0.0"
   },
   "homepage": "https://github.com/sebbo2002/js-template#readme",
   "license": "MIT",
@@ -58,5 +58,5 @@
     "test": "mocha"
   },
   "type": "module",
-  "version": "5.1.2-develop.3"
+  "version": "6.0.0-develop.2"
 }

package/release.config.cjs

@@ -25,12 +25,7 @@ configuration.plugins.push('@semantic-release/changelog');
 
 configuration.plugins.push('semantic-release-license');
 
-configuration.plugins.push(['@amanda-mitchell/semantic-release-npm-multiple', {
-    'registries': {
-        'github': {},
-        'public': {}
-    }
-}]);
+configuration.plugins.push('@semantic-release/npm');
 
 configuration.plugins.push(['@semantic-release/exec', {
     'prepareCmd': './.github/workflows/build.sh'

package/src/lib/device-events.ts

@@ -134,6 +134,9 @@ export default class NodePyATVDeviceEvents extends EventEmitter {
         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);

package/src/lib/device.ts

@@ -1,6 +1,7 @@
 'use strict';
 
 import {
+    NodePyATVApp,
     NodePyATVDeviceOptions,
     NodePyATVDeviceState,
     NodePyATVExecutableType,
@@ -378,7 +379,36 @@ export default class NodePyATVDevice implements EventEmitter{
         return state.appId;
     }
 
-    private async _pressKey(key: NodePyATVInternalKeys, executableType: NodePyATVExecutableType) {
+    /**
+     * Returns the list of installed apps on the Apple TV. Probably requires `companionCredentials`,
+     * see https://pyatv.dev/documentation/atvremote/#apps for more details.
+     */
+    async listApps(): Promise<NodePyATVApp[]> {
+        const id = addRequestId();
+        const parameters = getParamters(this.options);
+
+        const result = await 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])
+                };
+            }
+        }) as Array<NodePyATVApp | undefined>;
+
+        return items.filter(Boolean) as NodePyATVApp[];
+    }
+
+    private async _pressKey(key: NodePyATVInternalKeys | string, executableType: NodePyATVExecutableType) {
         const id = addRequestId();
         const parameters = getParamters(this.options);
 
@@ -611,6 +641,15 @@ export default class NodePyATVDevice implements EventEmitter{
         await 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`
+     */
+    async launchApp(id: string): Promise<void> {
+        await 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.

package/src/lib/tools.ts

@@ -11,7 +11,7 @@ import {
 } from './types.js';
 
 import {ChildProcess, spawn, SpawnOptions} from 'child_process';
-import {FakeChildProcess} from './fake-spawn';
+import {FakeChildProcess} from './fake-spawn.js';
 
 const requestIds: string[] = [];
 

package/src/lib/types.ts

@@ -1,5 +1,5 @@
 import {ChildProcess, SpawnOptions} from 'child_process';
-import {FakeChildProcess} from './fake-spawn';
+import {FakeChildProcess} from './fake-spawn.js';
 
 export enum NodePyATVExecutableType {
     atvremote = 'atvremote',
@@ -222,3 +222,9 @@ export interface NodePyATVState {
     appId: string | null,
     powerState: NodePyATVPowerState | null
 }
+
+export interface NodePyATVApp {
+    id: string;
+    name: string;
+    launch: () => Promise<void>;
+}

package/test/device.ts

@@ -726,6 +726,35 @@ describe('NodePyATVDevice', function () {
         });
     });
 
+    describe('listApps()', function () {
+        it('should work', async function () {
+            const device = new NodePyATVDevice({
+                name: 'My Testdevice',
+                host: '192.168.178.2',
+                spawn: createFakeSpawn(cp => {
+                    cp.end(
+                        'App: Fitness (com.apple.Fitness), App: Podcasts (com.apple.podcasts), ' +
+                        'App: Filme (com.apple.TVMovies), App: Prime Video (com.amazon.aiv.AIVApp), ' +
+                        'App: TV (com.apple.TVWatchList), App: Fotos (com.apple.TVPhotos), App: App Store ' +
+                        '(com.apple.TVAppStore), App: Arcade (com.apple.Arcade), App: TV-Sendungen (com.apple.TVShows), ' +
+                        'App: Suchen (com.apple.TVSearch), App: Live TV (de.couchfunk.WM2014), App: RTL+ ' +
+                        '(com.rtlinteractive.tvnow), App: Computer (com.apple.TVHomeSharing), App: ARTE ' +
+                        '(tv.arte.plus7), App: YouTube (com.google.ios.youtube), App: ARD Mediathek ' +
+                        '(de.swr.avp.ard.tablet), App: Disney+ (com.disney.disneyplus), App: Plex (com.plexapp.plex), ' +
+                        'App: Joyn (de.prosiebensat1digital.seventv), App: Einstellungen (com.apple.TVSettings), ' +
+                        'App: ZDFmediathek (de.zdf.mediathek.universal), App: Crossy Road (com.hipsterwhale.crossy), ' +
+                        'App: Netflix (com.netflix.Netflix), App: Infuse (com.firecore.infuse), ' +
+                        'App: Musik (com.apple.TVMusic)');
+                })
+            });
+
+            const result = await device.listApps();
+            assert.strictEqual(result.length, 25);
+            assert.strictEqual(result[0].id, 'com.apple.Fitness');
+            assert.strictEqual(result[0].name, 'Fitness');
+        });
+    });
+
     describe('pressKey()', function () {
         it('should work with valid key', async function () {
             const device = new NodePyATVDevice({
@@ -781,4 +810,17 @@ describe('NodePyATVDevice', function () {
         });
     });
 
+    describe('launchApp()', function () {
+        it('should work', async function () {
+            const device = new NodePyATVDevice({
+                name: 'My Testdevice',
+                host: '192.168.178.2',
+                spawn: createFakeSpawn(cp => {
+                    cp.end('');
+                })
+            });
+
+            await device.launchApp('com.apple.TVShows');
+        });
+    });
 });

package/tsconfig.json

@@ -3,7 +3,7 @@
         "declaration": true,
         "esModuleInterop": true,
         "module": "es2020",
-        "moduleResolution": "node",
+        "moduleResolution": "node16",
         "outDir": "./dist",
         "sourceMap": true,
         "strict": true,