daikin-controller-cloud - npm Package Compare versions

Comparing version 1.2.4 to 2.0.0-alpha.1

package.json

 {
   "name": "daikin-controller-cloud",
-  "version": "1.2.4",
+  "version": "2.0.0-alpha.1",
   "description": "Interact with Daikin Cloud devices and retrieve Tokens",
@@ -13,11 +13,9 @@ "author": "Apollon77 <[e-mail]>",
   "dependencies": {
-    "finalhandler": "^1.2.0",
-    "@esm2cjs/got": "^12.5.3",
-    "http-mitm-proxy": "^0.9.0",
-    "openid-client": "^5.4.3",
-    "serve-static": "^1.15.0"
+    "openid-client": "^5.6.5"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.6.0",
-    "pkg": "^5.8.1"
+    "@alcalzone/release-script": "^3.7.0",
+    "@types/node": "^20.14.9",
+    "pkg": "^5.8.1",
+    "typescript": "~5.5.3"
   },
@@ -32,11 +30,8 @@ "repository": {
   "scripts": {
+    "prepublish": "npm run build",
+    "build": "tsc -p .",
     "release": "release-script",
     "build-tokensaver": "pkg example/tokensaver.js"
   },
-  "main": "index.js",
-  "bin": "example/tokensaver.js",
-  "directories": {
-    "example": "example",
-    "lib": "lib"
-  }
+  "main": "dist/index.js"
 }

README.md

@@ -14,27 +14,45 @@ # daikin-controller-cloud
 ## Description
-The newer Daikin devices sold since 2020 contain a newer Wifi Adapter (e.g. BRP069C4x) which only connects to the Daikin Cloud and is no longer reachable locally. These devices are only controllable with the Daikin Onecta App.
+The newer Daikin devices sold since 2020 contain a newer Wifi Adapter
+(e.g. BRP069C4x) which only connects to the Daikin Cloud and is no longer
+reachable locally. These devices are only controllable through the Daikin
+Onecta API, which uses the OpenID Connect (OIDC) protocol for client
+authentication and authorization purposes.
 
-This library allows to initially (hopefully once) retrieve tokens by using a proxy to login to the Daikin Cloud. After that these tokens can be used and refreshed to interact with teh devices.
+This library facilitates interacting with the Onecta API by providing an
+abstraction over OIDC flows and token management.
 
-Note: For devices with older WLAN-Adapters like **BRP069A4x** which can only be used by the Daikin Controller App please use the [Daikin-Controller](https://github.com/Apollon77/daikin-controller) lib instead.
+Note: For devices with older WLAN-Adapters like **BRP069A4x** which can only be
+used by the Daikin Controller App please use the
+[Daikin-Controller](https://github.com/Apollon77/daikin-controller) lib instead.
 
-### Login with E-Mail/Password
-The easy mode is to use the `login`method of the `DaikinControllerCloud` class and provide the E-Mail and the Password.
+## IMPORTANT
 
-An automatic login is tried in this case and the tokens are retrieved.
+The Onecta API limits each client application to 200 requests per day.
 
-It can happen that this process do not work because the Daikin Website requires you to solve a captcha. In this can you can use the following trick:
-* Start the proxy
-* Call the proxy URL on port 8889
-* You **do not** need to import the certificate!
-* Just click on the `Login into the Daikin Cloud to retrieve the tokens` link at the end of the instructions page and login there once and solve the captcha.
-* Close the browser window and try the automatic login again
+## Pre-requisites
 
-### Login with Proxy
-**For more information on the Proxy progress for end users - because you need to trust and whitelist them and such - can be found in [PROXY.md](PROXY.md)!**
-Info: This project is not grabbing any username or password, just the created tokens after you logged in.
+This library acts as an OIDC client towards the Onecta API and uses OIDC's
+`Authorization` grant to obtain the initial pair of OIDC tokens.  As such, 
+you'll have to provide the following:
 
-## IMPORTANT
-When you integrate this library please make sure users do not refresh data out of the cloud too fast. Please still think about the needed resources and costs on Daikin side to operate the cloud services and only allow meaningful poll intervals!
+1. The `Client ID` and `Client Secret` of a registered application tied to your
+   Daiking Developer account. If you do not have such an account, yet, you can
+   create one in the [Daikin Developer Portal][p1]
+2. The ability for the process that uses this library to listen on a local TCP
+   port (configurable) in order to start an HTTP server that your browser will
+   be redirected to at the end of the `Authorization` grant flow
+3. A domain name that resolves to the machine that hosts the process using this
+   library (if running locally you will not be able to use `localhost` as it is 
+   rejected by the Onecta API)
 
+You will have to combine the port (point 2.) and domain name (point 3.) to
+create the URL to be set as the application's `Redirect URI` in the
+[Daikin Developer portal][p1]. Note that the same URL **must** also be passed
+as a configuration parameter of the `DaikinCloudController` class. Also note
+that the `Redirect URI` must use the secure `https:` protocol and that this
+library ships with its own self-signed SSL/TLS certificate, which will cause
+your browser to present you with a security warning.
+
+[p1]: https://developer.cloud.daikineurope.com
+
 ## Install
@@ -45,27 +63,5 @@ For now while being in basic development install from Github:
 
-## Using tokensaver.js
-
-If your only interest is to save the tokens exchanged by Daikin Cloud and yourself (for instance, when you want to use them with your own code or home automation), use the tokensaver.js in the `example` folder
-
-From within the main directory, run:
-
-`node example/tokensaver.js`
-
-Or, more conveniently, use one of the binaries (Linux, macOS and Windows) supplied with the [Releases](https://github.com/Apollon77/daikin-controller-cloud/releases).
-Alternatively you can execute `npx daikin-controller-cloud` which will also execute the tokensaver.js without the need to install the library (Node.js is required to be installed).
-
-Calling tokensaver.js without any parameters will open a proxy where you can login to the Daikin Cloud and the tokens will be fetched.
-
-Alternatively execute
-
-`node tokensaver.js "[e-mail]" "my-daikin-password"`
-
-(replace data with your daikin cloud login credentials) and we try to fetch the tokens without the proxy.
-
-
 ## Code-Usage example
-See example folder, check the settings (add your own IP at minimum!) and start it with `node example.js`.
+See [`src/example.ts`](./src/example.ts).
 
-When getting or setting data you need to look at the complete data structure returned by the device. SO best go a "getData()" and check the structure. The getData/setData parameters mirror the structure. In fact you awlways eed to provide the first two levels, maybe a "path style third level".
-
 ## Issue reporting and enhancements
@@ -76,10 +72,16 @@ * Create Issues here in Github
 ## Todos
-* Mooooaaar documentation, especially for proxy use for endusers and development
+* Mooooaaar documentation
 * Add Tests
-* Implement internal update of values when a new value is set? Or reload data after a set action automatically?
+* Implement internal update of values when a new value is set? Or reload data
+  after a set action automatically?
 * Implement interval data update in library or only from outside?
-* The mitm proxy library is not closing the proxy correct, so the promise never gets resolved ... need to check on that.
 
+## Changelog:
+### 2.0.0-alpha.1 (2024-07-02)
+* BREAKING: Username/Passwort and Proxy Authentications are removed and replaced by the new Daikin Portal Authentication! You need to re-authenticate!
+* BREAKING: DaikinCloudController class constructor changed and has new options structure!
+* (jacoscaz) Port to Typescript
+* (jacoscaz) Switch to Daikin's OIDC-based Onecta API
+* (Apollon77) Enhancements to restore some make sure former functionality is still possible to use
 
-## Changelog:
 ### 1.2.4 (2023-09-09)
@@ -86,0 +88,0 @@ * (Apollon77) Make sure to store only existing refresh tokens

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 3 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

decreased by-80%

Number of lines in readme file

138

increased by1.47%

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

1

decreased by-66.67%

Worsened metrics

Total package byte prevSize

54055

decreased by-91.98%

Dev dependency count

4

increased by100%

Lines of code

672

decreased by-43.43%

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• - Removed@esm2cjs/got@^12.5.3

• - Removedfinalhandler@^1.2.0

• - Removedhttp-mitm-proxy@^0.9.0

• - Removedserve-static@^1.15.0

• - Removed@esm2cjs/cacheable-lookup@7.0.0(transitive)

• - Removed@esm2cjs/cacheable-request@10.2.12(transitive)

• - Removed@esm2cjs/form-data-encoder@2.1.4(transitive)

• - Removed@esm2cjs/got@12.5.3(transitive)

• - Removed@esm2cjs/http-timer@5.0.1(transitive)

• - Removed@esm2cjs/is@5.6.0(transitive)

• - Removed@esm2cjs/lowercase-keys@3.0.0(transitive)

• - Removed@esm2cjs/mimic-response@4.0.0(transitive)

• - Removed@esm2cjs/normalize-url@8.0.0(transitive)

• - Removed@esm2cjs/p-cancelable@3.0.0(transitive)

• - Removed@esm2cjs/responselike@3.0.0(transitive)

• - Removed@types/http-cache-semantics@4.0.4(transitive)

• - Removedansi-regex@5.0.1(transitive)

• - Removedansi-styles@4.3.0(transitive)

• - Removedasync@3.2.6(transitive)

• - Removedasync-limiter@1.0.1(transitive)

• - Removedcliui@7.0.4(transitive)

• - Removedcolor-convert@2.0.1(transitive)

• - Removedcolor-name@1.1.4(transitive)

• - Removeddebug@2.6.94.4.0(transitive)

• - Removeddecompress-response@6.0.0(transitive)

• - Removeddefer-to-connect@2.0.1(transitive)

• - Removeddepd@2.0.0(transitive)

• - Removeddestroy@1.2.0(transitive)

• - Removedee-first@1.1.1(transitive)

• - Removedemoji-regex@8.0.0(transitive)

• - Removedencodeurl@1.0.22.0.0(transitive)

• - Removedescalade@3.2.0(transitive)

• - Removedescape-html@1.0.3(transitive)

• - Removedetag@1.8.1(transitive)

• - Removedfinalhandler@1.3.1(transitive)

• - Removedfresh@0.5.2(transitive)

• - Removedget-caller-file@2.0.5(transitive)

• - Removedget-stream@6.0.1(transitive)

• - Removedhttp-cache-semantics@4.1.1(transitive)

• - Removedhttp-errors@2.0.0(transitive)

• - Removedhttp-mitm-proxy@0.9.0(transitive)

• - Removedhttp2-wrapper@2.2.1(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedis-fullwidth-code-point@3.0.0(transitive)

• - Removedjson-buffer@3.0.1(transitive)

• - Removedkeyv@4.5.4(transitive)

• - Removedlowercase-keys@3.0.0(transitive)

• - Removedmime@1.6.0(transitive)

• - Removedmimic-response@3.1.0(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removedms@2.0.02.1.3(transitive)

• - Removednode-forge@0.10.0(transitive)

• - Removedon-finished@2.4.1(transitive)

• - Removedparseurl@1.3.3(transitive)

• - Removedquick-lru@5.1.1(transitive)

• - Removedrange-parser@1.2.1(transitive)

• - Removedrequire-directory@2.1.1(transitive)

• - Removedresolve-alpn@1.2.1(transitive)

• - Removedresponselike@3.0.0(transitive)

• - Removedsafe-buffer@5.1.2(transitive)

• - Removedsemaphore@1.1.0(transitive)

• - Removedsend@0.19.0(transitive)

• - Removedserve-static@1.16.2(transitive)

• - Removedsetprototypeof@1.2.0(transitive)

• - Removedstatuses@2.0.1(transitive)

• - Removedstring-width@4.2.3(transitive)

• - Removedstrip-ansi@6.0.1(transitive)

• - Removedtoidentifier@1.0.1(transitive)

• - Removedultron@1.1.1(transitive)

• - Removedunpipe@1.0.0(transitive)

• - Removedwrap-ansi@7.0.0(transitive)

• - Removedws@3.3.3(transitive)

• - Removedy18n@5.0.8(transitive)

• - Removedyargs@16.2.0(transitive)

• - Removedyargs-parser@20.2.9(transitive)

• Updatedopenid-client@^5.6.5