freeathome-local-api-client 1.7.0 → 1.9.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/README.md +17 -0
- package/dist/index.js +1 -789
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -756
- package/dist/index.mjs.map +1 -1
- package/package.json +30 -19
package/README.md
CHANGED
|
@@ -38,6 +38,23 @@ npm install --save freeathome-local-api-client
|
|
|
38
38
|
The client library is documented using JSDoc, the generated documentation is available at https://pgerke.github.io/freeathome-local-api-client/.
|
|
39
39
|
There is also a sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample. It illustrates usage for ESM as well as CommonJs.
|
|
40
40
|
|
|
41
|
+
## Publishing
|
|
42
|
+
|
|
43
|
+
This package uses npm Trusted Publisher authentication for secure, token-free publishing to npmjs.org. The publishing process is fully automated through GitHub Actions when a version change is detected in a merged pull request to the main branch.
|
|
44
|
+
|
|
45
|
+
### How it works
|
|
46
|
+
|
|
47
|
+
- The release workflow automatically publishes to npm when the version in `package.json` changes
|
|
48
|
+
- Authentication uses OpenID Connect (OIDC) instead of long-lived tokens
|
|
49
|
+
- Provenance statements are automatically generated for supply chain security
|
|
50
|
+
- No manual npm tokens need to be managed
|
|
51
|
+
|
|
52
|
+
### Requirements
|
|
53
|
+
|
|
54
|
+
- npm >= 11.5.1 (the CI workflow ensures this for automated publishing; for local/manual publishing, ensure your npm version is >= 11.5.1)
|
|
55
|
+
- GitHub Actions workflow with `id-token: write` permission
|
|
56
|
+
- npm Trusted Publisher configured on npmjs.org for this package
|
|
57
|
+
|
|
41
58
|
## I found a bug, what do I do?
|
|
42
59
|
|
|
43
60
|
I'm happy to hear any feedback regarding the library or it's implementation, be it critizism, praise or rants. Please create a [GitHub issue](https://github.com/pgerke/freeathome-local-api-client/issues) or drop me an [email](mailto:info@philipgerke.com) if you would like to contact me.
|