@sebbo2002/node-pyatv 4.3.4-develop.4 → 5.1.0-develop.1

package/package.json

@@ -9,32 +9,34 @@
   },
   "description": "A lightweight wrapper around pyatv…",
   "devDependencies": {
-    "@amanda-mitchell/semantic-release-npm-multiple": "^3.2.1",
-    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.2",
+    "@amanda-mitchell/semantic-release-npm-multiple": "^3.5.0",
+    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.3",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.31",
-    "@types/semver": "^7.3.9",
-    "@typescript-eslint/eslint-plugin": "^5.22.0",
-    "@typescript-eslint/parser": "^5.22.0",
-    "eslint": "^8.16.0",
-    "eslint-plugin-jsonc": "^2.3.0",
+    "@types/node": "^18.0.0",
+    "@types/semver": "^7.3.10",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "c8": "^7.11.3",
+    "eslint": "^8.19.0",
+    "eslint-plugin-jsonc": "^2.3.1",
+    "esm": "^3.2.25",
     "license-checker": "^25.0.1",
     "mocha": "^10.0.0",
     "mochawesome": "^7.1.3",
-    "nyc": "^15.1.0",
     "semantic-release": "^19.0.3",
     "semantic-release-license": "^1.0.3",
     "source-map-support": "^0.5.21",
-    "ts-node": "^10.8.0",
-    "typedoc": "^0.22.17",
-    "typescript": "^4.7.2"
+    "ts-node": "^10.8.2",
+    "typedoc": "^0.23.5",
+    "typescript": "^4.7.4"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": "^12.20.0 || >=14.13.1"
   },
+  "homepage": "https://github.com/sebbo2002/js-template#readme",
   "license": "MIT",
   "main": "./dist/lib/index.js",
   "name": "@sebbo2002/node-pyatv",
@@ -47,7 +49,7 @@
     "build": "tsc",
     "build-all": "./.github/workflows/build.sh",
     "check": "./check.sh",
-    "coverage": "nyc mocha",
+    "coverage": "c8 mocha",
     "develop": "ts-node ./src/bin/start.ts",
     "example": "node ./dist/examples/push.js",
     "license-check": "license-checker --production --summary",
@@ -55,5 +57,6 @@
     "postinstall": "./check.sh",
     "test": "mocha"
   },
-  "version": "4.3.4-develop.4"
+  "type": "module",
+  "version": "5.1.0-develop.1"
 }

package/release.config.cjs

@@ -0,0 +1,56 @@
+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(['@amanda-mitchell/semantic-release-npm-multiple', {
+    'registries': {
+        'github': {},
+        'public': {}
+    }
+}]);
+
+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,6 +1,6 @@
 'use strict';
 
-import NodePyATVInstance from '../lib/instance';
+import NodePyATVInstance from '../lib/instance.js';
 
 (async () => {
     try {

package/src/examples/push.ts

@@ -1,7 +1,7 @@
 'use strict';
 
 // import pyatv, {NodePyATVDeviceEvent} from '@sebbo2002/node-pyatv';
-import pyatv, {NodePyATVDeviceEvent} from '../lib/index';
+import pyatv, {NodePyATVDeviceEvent} from '../lib/index.js';
 
 (async () => {
     const devices = await pyatv.find(/*{debug: true}*/);

package/src/lib/device-event.ts

@@ -1,7 +1,7 @@
 'use strict';
 
-import {NodePyATVDevice} from '../lib';
-import {NodePyATVEventValueType, NodePyATVStateIndex} from './types';
+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};

package/src/lib/device-events.ts

@@ -7,13 +7,13 @@ import {
     NodePyATVListenerState,
     NodePyATVState,
     NodePyATVStateIndex
-} from './types';
+} from './types.js';
 import {ChildProcess} from 'child_process';
 
 import {EventEmitter} from 'events';
-import {NodePyATVDevice, NodePyATVDeviceEvent} from '../lib';
-import {addRequestId, debug, execute, getParamters, parseState, removeRequestId} from './tools';
-import {FakeChildProcess} from './fake-spawn';
+import {NodePyATVDevice, NodePyATVDeviceEvent} from '../lib/index.js';
+import {addRequestId, debug, execute, getParamters, parseState, removeRequestId} from './tools.js';
+import {FakeChildProcess} from './fake-spawn.js';
 
 /**
  * @internal

package/src/lib/device.ts

@@ -10,12 +10,13 @@ import {
     NodePyATVMediaType,
     NodePyATVProtocol,
     NodePyATVRepeatState,
+    NodePyATVService,
     NodePyATVShuffleState,
     NodePyATVState
-} from './types';
+} from './types.js';
 
-import { addRequestId, getParamters, parseState, removeRequestId, request } from './tools';
-import { NodePyATVDeviceEvent, NodePyATVDeviceEvents } from '../lib';
+import { addRequestId, getParamters, parseState, removeRequestId, request } from './tools.js';
+import { NodePyATVDeviceEvent, NodePyATVDeviceEvents } from '../lib/index.js';
 import { EventEmitter } from 'events';
 
 /**
@@ -74,6 +75,67 @@ export default class NodePyATVDevice implements EventEmitter{
         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(): string | undefined {
+        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(): string | undefined {
+        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(): string | undefined {
+        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(): string | undefined {
+        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(): NodePyATVService[] | undefined {
+        return this.options.services;
+    }
+
+
     /**
      * Returns true, if debugging is enabled. Returns the custom
      * logging method, if one was specified. Otherwise, if debug

package/src/lib/index.ts

@@ -1,26 +1,29 @@
 'use strict';
 
 export {
-    NodePyATVProtocol,
-    NodePyATVMediaType,
+    NodePyATVDeviceOptions,
     NodePyATVDeviceState,
-    NodePyATVRepeatState,
-    NodePyATVShuffleState,
-    NodePyATVKeys,
-    NodePyATVInstanceOptions,
-    NodePyATVVersionResponse,
-    NodePyATVFindOptions,
+    NodePyATVEventValueType,
+    NodePyATVExecutableType,
     NodePyATVFindAndInstanceOptions,
-    NodePyATVDeviceOptions,
+    NodePyATVFindOptions,
     NodePyATVGetStateOptions,
-    NodePyATVState,
-    NodePyATVPowerState,
+    NodePyATVInstanceOptions,
+    NodePyATVKeys,
     NodePyATVListenerState,
-    NodePyATVEventValueType,
-} from './types';
+    NodePyATVMediaType,
+    NodePyATVPowerState,
+    NodePyATVProtocol,
+    NodePyATVRepeatState,
+    NodePyATVService,
+    NodePyATVShuffleState,
+    NodePyATVState,
+    NodePyATVVersionResponse
+} from './types.js';
 
-export {default as NodePyATVDeviceEvent} from './device-event';
-export {default as NodePyATVDeviceEvents} from './device-events';
-export {default as NodePyATVDevice} from './device';
+export {default as NodePyATVDeviceEvent} from './device-event.js';
+export {default as NodePyATVDeviceEvents} from './device-events.js';
+export {default as NodePyATVDevice} from './device.js';
+export {default as NodePyATVInstance} from './instance.js';
 
-export {default} from './instance';
+export {default} from './instance.js';

package/src/lib/instance.ts

@@ -1,17 +1,24 @@
 'use strict';
 
 import semver from 'semver';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { promises as fsPromises } from 'fs';
 
 import {
     NodePyATVDeviceOptions,
     NodePyATVExecutableType,
     NodePyATVFindAndInstanceOptions,
     NodePyATVInstanceOptions,
+    NodePyATVInternalScanDevice,
     NodePyATVVersionResponse
-} from './types';
+} from './types.js';
 
-import {addRequestId, debug, getParamters, removeRequestId, request} from './tools';
-import {NodePyATVDevice} from '../lib';
+import { addRequestId, debug, getParamters, removeRequestId, request } from './tools.js';
+import { NodePyATVDevice } from '../lib/index.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 
 /**
  * Default class exported by `@sebbo2002/node-pyatv`. Use [[find]] to scan for devices in your local network. Use
@@ -30,7 +37,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public static async check(options: NodePyATVInstanceOptions = {}): Promise<void> {
+    public static async check (options: NodePyATVInstanceOptions = {}): Promise<void> {
         const versions = await this.version(options);
         if (!versions.pyatv) {
             throw new Error('Unable to find pyatv. Is it installed?');
@@ -41,8 +48,7 @@ export default class NodePyATVInstance {
 
         try {
             await this.find(options);
-        }
-        catch (error) {
+        } catch (error) {
             throw new Error(`Unable to scan for devices: ${String(error).replace('Error: ', '')}`);
         }
     }
@@ -53,15 +59,14 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public static async version(options: NodePyATVInstanceOptions = {}): Promise<NodePyATVVersionResponse> {
+    public static async version (options: NodePyATVInstanceOptions = {}): Promise<NodePyATVVersionResponse> {
         const id = addRequestId();
         let pyatv = null;
         let module = null;
 
         try {
             pyatv = await request(id, NodePyATVExecutableType.atvremote, ['--version'], options) as string;
-        }
-        catch (error) {
+        } catch (error) {
             debug(id, `Unable to get pyatv version due to ${error}`, options);
         }
 
@@ -74,10 +79,9 @@ export default class NodePyATVInstance {
         }
 
         try {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            module = require(__dirname + '/../../package.json').version || null;
-        }
-        catch (error) {
+            const json = JSON.parse(await fsPromises.readFile(__dirname + '/../../package.json', 'utf8'));
+            module = json?.version || null;
+        } catch (error) {
             debug(id, `Unable to get module version due to ${error}`, options);
         }
         if (module && !semver.valid(module)) {
@@ -105,7 +109,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public static async find(options: NodePyATVFindAndInstanceOptions = {}): Promise<NodePyATVDevice[]> {
+    public static async find (options: NodePyATVFindAndInstanceOptions = {}): Promise<NodePyATVDevice[]> {
         const id = addRequestId();
         const parameters = getParamters(options);
 
@@ -114,11 +118,16 @@ export default class NodePyATVInstance {
             throw new Error(`Unable to parse pyatv response: ${JSON.stringify(result, null, '  ')}`);
         }
 
-        const objects = result.devices.map((device: { address: string, identifier: string, name: string }) =>
+        const objects = result.devices.map((device: NodePyATVInternalScanDevice) =>
             this.device(Object.assign({}, options, {
                 host: device.address,
                 id: device.identifier,
-                name: device.name
+                name: device.name,
+                model: device.device_info?.model,
+                modelName: device.device_info?.model_str,
+                os: device.device_info?.operating_system,
+                version: device.device_info?.version,
+                services: device.services
             }))
         );
 
@@ -132,7 +141,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public static device(options: NodePyATVDeviceOptions): NodePyATVDevice {
+    public static device (options: NodePyATVDeviceOptions): NodePyATVDevice {
         return new NodePyATVDevice(options);
     }
 
@@ -148,7 +157,7 @@ export default class NodePyATVInstance {
      * ```
      * @param options
      */
-    public constructor(options: NodePyATVInstanceOptions = {}) {
+    public constructor (options: NodePyATVInstanceOptions = {}) {
         this.options = Object.assign({}, options);
     }
 
@@ -158,7 +167,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public async check(options: NodePyATVInstanceOptions = {}): Promise<void> {
+    public async check (options: NodePyATVInstanceOptions = {}): Promise<void> {
         return NodePyATVInstance.check(Object.assign({}, this.options, options));
     }
 
@@ -168,7 +177,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public async version(options: NodePyATVInstanceOptions = {}): Promise<NodePyATVVersionResponse> {
+    public async version (options: NodePyATVInstanceOptions = {}): Promise<NodePyATVVersionResponse> {
         return NodePyATVInstance.version(Object.assign({}, this.options, options));
     }
 
@@ -186,7 +195,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public async find(options: NodePyATVFindAndInstanceOptions = {}): Promise<NodePyATVDevice[]> {
+    public async find (options: NodePyATVFindAndInstanceOptions = {}): Promise<NodePyATVDevice[]> {
         return NodePyATVInstance.find(Object.assign({}, this.options, options));
     }
 
@@ -196,7 +205,7 @@ export default class NodePyATVInstance {
      *
      * @param options
      */
-    public device(options: NodePyATVDeviceOptions): NodePyATVDevice {
+    public device (options: NodePyATVDeviceOptions): NodePyATVDevice {
         return NodePyATVInstance.device(Object.assign({}, this.options, options));
     }
 }

package/src/lib/tools.ts

@@ -8,7 +8,7 @@ import {
     NodePyATVInternalState,
     NodePyATVMediaType, NodePyATVPowerState, NodePyATVRepeatState, NodePyATVShuffleState,
     NodePyATVState
-} from './types';
+} from './types.js';
 
 import {ChildProcess, spawn, SpawnOptions} from 'child_process';
 import {FakeChildProcess} from './fake-spawn';

package/src/lib/types.ts

@@ -147,12 +147,38 @@ export interface NodePyATVFindAndInstanceOptions extends NodePyATVInstanceOption
 export interface NodePyATVDeviceOptions extends NodePyATVFindAndInstanceOptions {
     host: string;
     name: string;
+    model?: string;
+    modelName?: string;
+    os?: string;
+    version?: string;
+    services?: NodePyATVService[];
 }
 
 export interface NodePyATVGetStateOptions {
     maxAge?: number;
 }
 
+export interface NodePyATVService {
+    protocol: NodePyATVProtocol;
+    port: number;
+}
+
+/**
+ * @internal
+ */
+export interface NodePyATVInternalScanDevice {
+    name: string;
+    address: string;
+    identifier: string;
+    device_info?: {
+        model: string;
+        model_str: string;
+        operating_system: string;
+        version: string;
+    };
+    services?: NodePyATVService[];
+}
+
 /**
  * @internal
  */

package/test/device-event.ts

@@ -1,8 +1,8 @@
 'use strict';
 
 import assert from 'assert';
-import NodePyATVDevice from '../src/lib/device';
-import NodePyATVDeviceEvent from '../src/lib/device-event';
+import NodePyATVDevice from '../src/lib/device.js';
+import NodePyATVDeviceEvent from '../src/lib/device-event.js';
 
 describe('NodePyATVDeviceEvent', function () {
     describe('get key()', function () {

package/test/device-events.ts

@@ -1,8 +1,8 @@
 'use strict';
 
 import assert from 'assert';
-import {createFakeSpawn} from '../src/lib/fake-spawn';
-import {NodePyATVDeviceEvent, NodePyATVPowerState, NodePyATVDevice} from '../src/lib';
+import {createFakeSpawn} from '../src/lib/fake-spawn.js';
+import {NodePyATVDeviceEvent, NodePyATVPowerState, NodePyATVDevice} from '../src/lib/index.js';
 
 describe('NodePyATVDeviceEvents', function () {
     describe('applyStateAndEmitEvents()', function () {