feat: device-auth

[mattdavis90]

No description provided.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/mattdavis90/node-tado-client@119

commit: d62eded

[mattdavis90]

I've tweaked it so that

async authenticate(
    refreshToken?: string,
    timeout?: number,
  ): Promise<[DeviceVerification | undefined, Promise<Token>]> {

must be called first before anything else. Semantics are;

• Refresh token is provided
  • Try to use it, otherwise revert to device auth flow
  • If it works then return [undefined, Promise<Token>] - where the Promise will immediately resolve
• No refresh token
  • Start a device auth flow

Device auth flow will return the DeviceVerification object that has the relevant URL, and a Promise<Token> that will resolve on successful authentication. It uses a timeout of Math.min(timeout, tado.expires_in).

Also, all auth errors should be identifiable now;

• NotAuthenticated - if the authenticate method call wasn't made yet
• InvalidRefreshToken - either supplied refresh token has expired, was incorrectly typed, or you haven't made an API call in the last 30 days (see note 1 below)
• AuthTimeout - you didn't hit the URL quick enough

There's also now an example in examples/auth.ts because it may be a little fiddly for people not following this thread.

1. I haven't implemented any background polling to refresh the refresh token - you'll need to call the API once every 30 days

[mattdavis90]

@abn Did you see this? Not sure how it affects your work?

[nanoamp]

I've tested the PR code in my app, and it works perfectly 🌟