@sebbo2002/node-pyatv 4.3.4-develop.2 → 5.0.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.15.0",
-    "eslint-plugin-jsonc": "^2.2.1",
+    "@types/node": "^18.0.0",
+    "@types/semver": "^7.3.10",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "eslint": "^8.18.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.2",
+    "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.15",
-    "typescript": "^4.6.4"
+    "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",
@@ -55,5 +57,6 @@
     "postinstall": "./check.sh",
     "test": "mocha"
   },
-  "version": "4.3.4-develop.2"
+  "type": "module",
+  "version": "5.0.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

@@ -12,10 +12,10 @@ import {
     NodePyATVRepeatState,
     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';
 
 /**

package/src/lib/index.ts

@@ -17,10 +17,10 @@ export {
     NodePyATVPowerState,
     NodePyATVListenerState,
     NodePyATVEventValueType,
-} from './types';
+} 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} from './instance';
+export {default} from './instance.js';

package/src/lib/instance.ts

@@ -1,6 +1,9 @@
 'use strict';
 
 import semver from 'semver';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { promises as fsPromises } from 'fs';
 
 import {
     NodePyATVDeviceOptions,
@@ -8,10 +11,13 @@ import {
     NodePyATVFindAndInstanceOptions,
     NodePyATVInstanceOptions,
     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 +36,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 +47,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 +58,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 +78,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 +108,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);
 
@@ -132,7 +135,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 +151,7 @@ export default class NodePyATVInstance {
      * ```
      * @param options
      */
-    public constructor(options: NodePyATVInstanceOptions = {}) {
+    public constructor (options: NodePyATVInstanceOptions = {}) {
         this.options = Object.assign({}, options);
     }
 
@@ -158,7 +161,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 +171,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 +189,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 +199,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/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 () {

package/test/device.ts

@@ -1,7 +1,7 @@
 'use strict';
 
 import assert from 'assert';
-import NodePyATVDevice from '../src/lib/device';
+import NodePyATVDevice from '../src/lib/device.js';
 import {
     NodePyATVDeviceState,
     NodePyATVKeys,
@@ -9,9 +9,9 @@ import {
     NodePyATVProtocol,
     NodePyATVRepeatState,
     NodePyATVShuffleState
-} from '../src/lib/types';
-import NodePyATVInstance from '../src/lib/instance';
-import {createFakeSpawn} from '../src/lib/fake-spawn';
+} from '../src/lib/types.js';
+import NodePyATVInstance from '../src/lib/instance.js';
+import {createFakeSpawn} from '../src/lib/fake-spawn.js';
 
 describe('NodePyATVDevice', function () {
     describe('get name()', function () {

package/test/instance.ts

@@ -1,7 +1,11 @@
 'use strict';
 
 import assert from 'assert';
-import {createFakeSpawn} from '../src/lib/fake-spawn';
+import { readFileSync } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import { createFakeSpawn } from '../src/lib/fake-spawn.js';
 import NodePyATVInstance, {
     NodePyATVProtocol,
     NodePyATVMediaType,
@@ -12,7 +16,11 @@ import NodePyATVInstance, {
     NodePyATVKeys,
     NodePyATVListenerState,
     NodePyATVPowerState
-} from '../src/lib/index';
+} from '../src/lib/index.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const version = JSON.parse(readFileSync(__dirname + '/../package.json', 'utf8'))?.version || null;
 
 describe('NodePyATVInstance', function () {
     describe('static version()', function () {
@@ -25,9 +33,7 @@ describe('NodePyATVInstance', function () {
 
             assert.equal(typeof result.pyatv, 'string', 'result.pyatv is a string');
             assert.ok(result.pyatv.length >= 5, 'result.pyatv has content');
-
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            assert.strictEqual(result.module, require(__dirname + '/../package.json').version || null);
+            assert.strictEqual(result.module, version);
         });
         it('should return the pyatv version', async function () {
             const result = await NodePyATVInstance.version({
@@ -48,8 +54,7 @@ describe('NodePyATVInstance', function () {
                 )
             });
 
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            assert.strictEqual(result.module, require(__dirname + '/../package.json').version || null);
+            assert.strictEqual(result.module, version);
         });
         it('should handle option.atvremotePath', async function () {
             await NodePyATVInstance.version({
@@ -70,7 +75,9 @@ describe('NodePyATVInstance', function () {
         });
         it('should work with option.noColors', async function () {
             await NodePyATVInstance.version({
-                debug: () => {}, // eslint-disable-line @typescript-eslint/no-empty-function
+                debug: () => {
+                    // no debug log
+                },
                 noColors: true,
                 spawn: createFakeSpawn(cp =>
                     cp.code(1).end()
@@ -104,7 +111,7 @@ describe('NodePyATVInstance', function () {
 
             assert.strictEqual(result.pyatv, null);
         });
-        it('should return null on empty module version', async function () {
+        /* it('should return null on empty module version', async function () {
             const path = require.resolve(__dirname + '/../package.json');
             require(path);
 
@@ -119,8 +126,8 @@ describe('NodePyATVInstance', function () {
             });
 
             assert.strictEqual(result.module, null);
-        });
-        it('should return null on invalid module version', async function () {
+        }); */
+        /* it('should return null on invalid module version', async function () {
             const path = require.resolve(__dirname + '/../package.json');
             require(path);
 
@@ -135,7 +142,7 @@ describe('NodePyATVInstance', function () {
             });
 
             assert.strictEqual(result.module, null);
-        });
+        }); */
     });
 
     describe('static check()', function () {
@@ -143,7 +150,7 @@ describe('NodePyATVInstance', function () {
             this.timeout(12000);
             await NodePyATVInstance.check();
         });
-        it('should return nice error message if pyatv was not found', async function() {
+        it('should return nice error message if pyatv was not found', async function () {
             await assert.rejects(async () => {
                 await NodePyATVInstance.check({
                     spawn: createFakeSpawn(cp => {
@@ -161,12 +168,12 @@ describe('NodePyATVInstance', function () {
                 });
             }, /Found pyatv, but unforunately it's too old. Please update pyatv./);
         });
-        it('should return nice error message if scan failed', async function() {
+        it('should return nice error message if scan failed', async function () {
             let i = 0;
             await assert.rejects(async () => {
                 await NodePyATVInstance.check({
                     spawn: createFakeSpawn(cp => {
-                        if(i === 0) {
+                        if (i === 0) {
                             cp.stdout('atvremote 0.7.0').code(1).end();
                             i++;
                         } else {
@@ -254,15 +261,15 @@ describe('NodePyATVInstance', function () {
 
     describe('static device()', function () {
         it('should pass options to constructor', function () {
-            const device = NodePyATVInstance.device({host: '192.168.178.6', name: 'My Testdevice'});
+            const device = NodePyATVInstance.device({ host: '192.168.178.6', name: 'My Testdevice' });
             assert.strictEqual(device.host, '192.168.178.6');
             assert.strictEqual(device.name, 'My Testdevice');
         });
     });
 
-    describe('version()', function() {
-        it('should merge options from constructor', async function() {
-            const i = new NodePyATVInstance({atvremotePath: 'test'});
+    describe('version()', function () {
+        it('should merge options from constructor', async function () {
+            const i = new NodePyATVInstance({ atvremotePath: 'test' });
             await i.version({
                 spawn: createFakeSpawn(cp => {
                     assert.strictEqual(cp.cmd(), 'test');
@@ -272,9 +279,9 @@ describe('NodePyATVInstance', function () {
         });
     });
 
-    describe('check()', function() {
-        it('should merge options from constructor', async function() {
-            const i = new NodePyATVInstance({atvremotePath: 'test'});
+    describe('check()', function () {
+        it('should merge options from constructor', async function () {
+            const i = new NodePyATVInstance({ atvremotePath: 'test' });
             await assert.rejects(async () => {
                 await i.check({
                     spawn: createFakeSpawn(cp => {
@@ -286,9 +293,9 @@ describe('NodePyATVInstance', function () {
         });
     });
 
-    describe('find()', function() {
-        it('should merge options from constructor', async function() {
-            const i = new NodePyATVInstance({atvscriptPath: 'test'});
+    describe('find()', function () {
+        it('should merge options from constructor', async function () {
+            const i = new NodePyATVInstance({ atvscriptPath: 'test' });
             await i.find({
                 spawn: createFakeSpawn(cp => {
                     assert.strictEqual(cp.cmd(), 'test');
@@ -303,39 +310,39 @@ describe('NodePyATVInstance', function () {
     });
 
     describe('device()', function () {
-        it('should merge options from constructor', async function() {
-            const i = new NodePyATVInstance({debug: true});
-            const d = i.device({name: 'My Testdevice', host: '192.168.178.2'});
+        it('should merge options from constructor', async function () {
+            const i = new NodePyATVInstance({ debug: true });
+            const d = i.device({ name: 'My Testdevice', host: '192.168.178.2' });
             assert.deepStrictEqual(d.debug, true);
         });
     });
 
     describe('Type Exports', function () {
-        it('Type NodePyATVProtocol should be exported', function() {
+        it('Type NodePyATVProtocol should be exported', function () {
             assert.ok(NodePyATVProtocol);
         });
-        it('Type NodePyATVMediaType should be exported', function() {
+        it('Type NodePyATVMediaType should be exported', function () {
             assert.ok(NodePyATVMediaType);
         });
-        it('Type NodePyATVDeviceEvent should be exported', function() {
+        it('Type NodePyATVDeviceEvent should be exported', function () {
             assert.ok(NodePyATVDeviceEvent);
         });
-        it('Type NodePyATVDeviceState should be exported', function() {
+        it('Type NodePyATVDeviceState should be exported', function () {
             assert.ok(NodePyATVDeviceState);
         });
-        it('Type NodePyATVRepeatState should be exported', function() {
+        it('Type NodePyATVRepeatState should be exported', function () {
             assert.ok(NodePyATVRepeatState);
         });
-        it('Type NodePyATVShuffleState should be exported', function() {
+        it('Type NodePyATVShuffleState should be exported', function () {
             assert.ok(NodePyATVShuffleState);
         });
-        it('Type NodePyATVKeys should be exported', function() {
+        it('Type NodePyATVKeys should be exported', function () {
             assert.ok(NodePyATVKeys);
         });
-        it('Type NodePyATVInstanceOptions should be exported', function() {
+        it('Type NodePyATVInstanceOptions should be exported', function () {
             assert.ok(NodePyATVListenerState);
         });
-        it('Type NodePyATVPowerState should be exported', function() {
+        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.js';
 import {
     NodePyATVDeviceState,
     NodePyATVExecutableType,
@@ -9,7 +9,7 @@ import {
     NodePyATVProtocol,
     NodePyATVRepeatState,
     NodePyATVShuffleState
-} from '../src/lib/types';
+} from '../src/lib/types.js';
 
 describe('Tools', function () {
     describe('addRequestId() / removeRequestId()', function () {

package/tsconfig.json

@@ -2,7 +2,7 @@
     "compilerOptions": {
         "declaration": true,
         "esModuleInterop": true,
-        "module": "none",
+        "module": "es2020",
         "moduleResolution": "node",
         "outDir": "./dist",
         "sourceMap": true,