matterbridge-example-accessory-platform 1.1.9 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,9 +1,49 @@
1
- # Changelog
1
+ # <img src="matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge accessory platform example plugin changelog
2
+
3
+ [![npm version](https://img.shields.io/npm/v/matterbridge-example-accessory-platform.svg)](https://www.npmjs.com/package/matterbridge-example-accessory-platform)
4
+ [![npm downloads](https://img.shields.io/npm/dt/matterbridge-example-accessory-platform.svg)](https://www.npmjs.com/package/matterbridge-example-accessory-platform)
5
+ [![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
6
+ [![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
7
+ ![Node.js CI](https://github.com/Luligu/matterbridge-example-accessory-platform/actions/workflows/build-matterbridge-plugin.yml/badge.svg)
8
+ ![CodeQL](https://github.com/Luligu/matterbridge-example-accessory-platform/actions/workflows/codeql.yml/badge.svg)
9
+ [![codecov](https://codecov.io/gh/Luligu/matterbridge-example-accessory-platform/branch/main/graph/badge.svg)](https://codecov.io/gh/Luligu/matterbridge-example-accessory-platformr)
10
+
11
+ [![power by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)
12
+ [![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
13
+ [![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
14
+ [![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
15
+
16
+ ---
2
17
 
3
18
  All notable changes to this project will be documented in this file.
4
19
 
5
20
  If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
6
21
 
22
+ ## [1.2.0] - 2025-05-25
23
+
24
+ ### Added
25
+
26
+ - [DevContainer]: Added support for the **Matterbridge Dev Container** with an optimized named volume for `node_modules`.
27
+ - [GitHub]: Added GitHub issue templates for bug reports and feature requests.
28
+ - [ESLint]: Refactored the flat config.
29
+ - [ESLint]: Added the plugins `eslint-plugin-promise`, `eslint-plugin-jsdoc`, and `@vitest/eslint-plugin`.
30
+ - [Jest]: Refactored the flat config.
31
+ - [Vitest]: Added Vitest for TypeScript project testing. It will replace Jest, which does not work correctly with ESM module mocks.
32
+ - [JSDoc]: Added missing JSDoc comments, including `@param` and `@returns` tags.
33
+ - [CodeQL]: Added CodeQL badge in the readme.
34
+ - [Codecov]: Added Codecov badge in the readme.
35
+
36
+ ### Changed
37
+
38
+ - [package]: Updated package to Automator v. 2.0.1.
39
+ - [package]: Updated dependencies.
40
+ - [storage]: Bumped `node-storage-manager` to 2.0.0.
41
+ - [logger]: Bumped `node-ansi-logger` to 3.1.1.
42
+
43
+ <a href="https://www.buymeacoffee.com/luligugithub">
44
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
45
+ </a>
46
+
7
47
  ## [1.1.9] - 2025-04-30
8
48
 
9
49
  ### Changed
@@ -13,7 +53,7 @@ If you like this project and find it useful, please consider giving it a star on
13
53
  - [package]: Updated dependencies.
14
54
 
15
55
  <a href="https://www.buymeacoffee.com/luligugithub">
16
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
56
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
17
57
  </a>
18
58
 
19
59
  ## [1.1.8] - 2025-04-07
@@ -25,7 +65,7 @@ If you like this project and find it useful, please consider giving it a star on
25
65
  - [package]: Updated dependencies.
26
66
 
27
67
  <a href="https://www.buymeacoffee.com/luligugithub">
28
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
68
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
29
69
  </a>
30
70
 
31
71
  ## [1.1.7] - 2025-03-05
@@ -37,7 +77,7 @@ If you like this project and find it useful, please consider giving it a star on
37
77
  - [package]: Updated dependencies.
38
78
 
39
79
  <a href="https://www.buymeacoffee.com/luligugithub">
40
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
80
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
41
81
  </a>
42
82
 
43
83
  ## [1.1.6] - 2025-02-02
@@ -49,7 +89,7 @@ If you like this project and find it useful, please consider giving it a star on
49
89
  - [package]: Updated dependencies.
50
90
 
51
91
  <a href="https://www.buymeacoffee.com/luligugithub">
52
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
92
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
53
93
  </a>
54
94
 
55
95
  ## [1.1.4] - 2025-01-21
@@ -61,7 +101,7 @@ If you like this project and find it useful, please consider giving it a star on
61
101
  - [package]: Updated package.
62
102
 
63
103
  <a href="https://www.buymeacoffee.com/luligugithub">
64
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
104
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
65
105
  </a>
66
106
 
67
107
  ## [1.1.3] - 2024-12-21
@@ -76,7 +116,7 @@ If you like this project and find it useful, please consider giving it a star on
76
116
  - [package]: Updated package.
77
117
 
78
118
  <a href="https://www.buymeacoffee.com/luligugithub">
79
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
119
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
80
120
  </a>
81
121
 
82
122
  ## [1.1.2] - 2024-12-12
@@ -88,7 +128,7 @@ If you like this project and find it useful, please consider giving it a star on
88
128
  - [package]: Updated dependencies.
89
129
 
90
130
  <a href="https://www.buymeacoffee.com/luligugithub">
91
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
131
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
92
132
  </a>
93
133
 
94
134
  ## [1.1.0] - 2024-11-25
@@ -100,7 +140,7 @@ If you like this project and find it useful, please consider giving it a star on
100
140
  - [package]: Updated dependencies.
101
141
 
102
142
  <a href="https://www.buymeacoffee.com/luligugithub">
103
- <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
143
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
104
144
  </a>
105
145
 
106
146
  <!-- Commented out section
package/README.md CHANGED
@@ -1,11 +1,12 @@
1
- # <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge accessory platform example plugin
1
+ # <img src="matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge accessory platform example plugin
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/matterbridge-example-accessory-platform.svg)](https://www.npmjs.com/package/matterbridge-example-accessory-platform)
4
4
  [![npm downloads](https://img.shields.io/npm/dt/matterbridge-example-accessory-platform.svg)](https://www.npmjs.com/package/matterbridge-example-accessory-platform)
5
5
  [![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
6
6
  [![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
7
7
  ![Node.js CI](https://github.com/Luligu/matterbridge-example-accessory-platform/actions/workflows/build-matterbridge-plugin.yml/badge.svg)
8
- ![Coverage](https://img.shields.io/badge/Jest%20coverage-100%25-brightgreen)
8
+ ![CodeQL](https://github.com/Luligu/matterbridge-example-accessory-platform/actions/workflows/codeql.yml/badge.svg)
9
+ [![codecov](https://codecov.io/gh/Luligu/matterbridge-example-accessory-platform/branch/main/graph/badge.svg)](https://codecov.io/gh/Luligu/matterbridge-example-accessory-platform)
9
10
 
10
11
  [![power by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)
11
12
  [![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
@@ -18,8 +19,14 @@ Matterbridge accessory platform example plugin is a template to develop your own
18
19
 
19
20
  It exposes a cover device that continuously moves position and shows how to use the command handlers (you can control the device).
20
21
 
22
+ If you want to write your plugin, the easiest way to start create a new plugin is to clone the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template) which has **Dev Container support for instant development environment** and all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest and Vitest) already loaded and configured.
23
+
21
24
  If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-accessory-platform and sponsoring it.
22
25
 
26
+ <a href="https://www.buymeacoffee.com/luligugithub">
27
+ <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
28
+ </a>
29
+
23
30
  ## Prerequisites
24
31
 
25
32
  ### Matterbridge
@@ -1,19 +1,19 @@
1
1
  {
2
2
  "name": "matterbridge-example-accessory-platform",
3
- "version": "1.1.9",
3
+ "version": "1.2.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "matterbridge-example-accessory-platform",
9
- "version": "1.1.9",
10
- "license": "MIT",
9
+ "version": "1.2.0",
10
+ "license": "Apache-2.0",
11
11
  "dependencies": {
12
- "node-ansi-logger": "3.0.1",
13
- "node-persist-manager": "1.0.8"
12
+ "node-ansi-logger": "3.1.1",
13
+ "node-persist-manager": "2.0.0"
14
14
  },
15
15
  "engines": {
16
- "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0"
16
+ "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
17
17
  },
18
18
  "funding": {
19
19
  "type": "buymeacoffee",
@@ -21,12 +21,13 @@
21
21
  }
22
22
  },
23
23
  "node_modules/node-ansi-logger": {
24
- "version": "3.0.1",
25
- "resolved": "https://registry.npmjs.org/node-ansi-logger/-/node-ansi-logger-3.0.1.tgz",
26
- "integrity": "sha512-Nx7nkO6Sby8Eti1UFFdff3gImEC35izuvf+aRFh3mrDZ8hgXM/cZdflkpDMnDdxnabYl91LVi4RhB/dm5Yk9iA==",
27
- "license": "MIT",
24
+ "version": "3.1.1",
25
+ "resolved": "https://registry.npmjs.org/node-ansi-logger/-/node-ansi-logger-3.1.1.tgz",
26
+ "integrity": "sha512-tFeCSxwiRg5XaNda5nC27alzraZP76nLtUk1JDZqb9byhW4WYaSGL7/lmxFHEI16gypQDMEYljuF+wcG+cPPHw==",
27
+ "hasShrinkwrap": true,
28
+ "license": "Apache-2.0",
28
29
  "engines": {
29
- "node": ">=18.0.0"
30
+ "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
30
31
  },
31
32
  "funding": {
32
33
  "type": "buymeacoffee",
@@ -46,15 +47,15 @@
46
47
  }
47
48
  },
48
49
  "node_modules/node-persist-manager": {
49
- "version": "1.0.8",
50
- "resolved": "https://registry.npmjs.org/node-persist-manager/-/node-persist-manager-1.0.8.tgz",
51
- "integrity": "sha512-J0wjdxOloD6aw4s2kljbV3nvHfguWph8LnfmTL+6MZiBsh46wjaIaZd/cHU0HWonrNfktCv7Zuvn0sEH0f2s+A==",
50
+ "version": "2.0.0",
51
+ "resolved": "https://registry.npmjs.org/node-persist-manager/-/node-persist-manager-2.0.0.tgz",
52
+ "integrity": "sha512-jpgOqCCn4ZEnIr4WcvqkyyGmmLJarV6aUyBlDQdG1G84X9UUmOmI1W2OZtc9K0z375CYWhjtGEXaY7GXNiEOfA==",
52
53
  "license": "MIT",
53
54
  "dependencies": {
54
- "node-persist": "^4.0.2"
55
+ "node-persist": "4.0.4"
55
56
  },
56
57
  "engines": {
57
- "node": ">=18.0.0"
58
+ "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
58
59
  },
59
60
  "funding": {
60
61
  "type": "buymeacoffee",
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "matterbridge-example-accessory-platform",
3
- "version": "1.1.9",
3
+ "version": "1.2.0",
4
4
  "description": "Matterbridge accessory plugin",
5
5
  "author": "https://github.com/Luligu",
6
- "license": "MIT",
6
+ "license": "Apache-2.0",
7
7
  "homepage": "https://www.npmjs.com/package/matterbridge-example-accessory-platform",
8
8
  "type": "module",
9
9
  "main": "dist/index.js",
@@ -27,10 +27,10 @@
27
27
  "plugin"
28
28
  ],
29
29
  "engines": {
30
- "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0"
30
+ "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
31
31
  },
32
32
  "dependencies": {
33
- "node-ansi-logger": "3.0.1",
34
- "node-persist-manager": "1.0.8"
33
+ "node-ansi-logger": "3.1.1",
34
+ "node-persist-manager": "2.0.0"
35
35
  }
36
36
  }
Binary file
@@ -1,8 +0,0 @@
1
- {
2
- "extends": "./tsconfig.json",
3
- "compilerOptions": {
4
- // enable isolatedModules just for ts-jest
5
- "isolatedModules": true
6
- },
7
- "include": ["**/*.spec.ts", "**/*.test.ts", "**/__test__/*"]
8
- }