Skip to content
This repository has been archived by the owner on Nov 9, 2021. It is now read-only.

v1.0.0

Compare
Choose a tag to compare
@github-actions github-actions released this 03 Aug 07:59
· 106 commits to master since this release

Migration Guide

  • "authType": "password" is no longer supported. Please copy your clientSecret as shown in the installation steps below.

  • The settings have been further grouped under auth and common and it now looks like this:

    {
      "platform" : "NelloPlatform",
      "name" : "nello.io",
      "auth": {
        // auth settings move here, and username/password is not supported anymore
        "clientSecret": "<paste-client-secret-here>",
        "clientId": "<paste-client-id-here>"
      },
      "common": {
        // all other settings go here,
        // and enableAlwaysOpenSwitch is renamed to dangerouslyEnableAlwaysOpenSwitch
      },
      "video": {
        // video settings stay here
      }
    }
  • enableAlwaysOpenSwitch has been renamed to dangerouslyEnableAlwaysOpenSwitch (see #43)

Release Notes

BREAKING CHANGES:

  • #54 @nihalgonsalves
    • Drops support for ‘password’ authentication type
    • Config overhaul (see README for migration guide)
    • alwaysOpenSwitch renamed to dangerouslyEnableAlwaysOpenSwitch

Minor changes:

  • Automatically setup default snapshot image for the video doorbell
  • Better API rate-limit handling and logging
  • Local webhook URLs now have a unique ID
  • Webhook URLs are rotated periodically (same interval as the location updates)

Non-feature changes:

  • Convert to TypeScript
  • Add test server config generation for easy local testing
  • Add automatic doc generation for configuration and defaults
  • Refactor callbacks to async/await
  • Refactor prototype setup to ES6+ class
  • Move all API requests into single client
  • Deduplicate other code
  • Fix stray Buffer() call => Buffer.alloc()