amazon-archives / amazon-cognito-auth-js

The Amazon Cognito Auth SDK for JavaScript simplifies adding sign-up, sign-in with user profile functionality to web apps.
Apache License 2.0
423 stars 232 forks source link

1.1.3->1.1.4 introduced a backwards-incompatible breaking change #99

Open ankon opened 6 years ago

ankon commented 6 years ago

Removed the dependency on the CognitoIdentityServiceProvider service from the AWS SDK for JavaScript.

The way one needs to instantiate the CognitoAuth has changed massively, and people using npm as installation method will get hit with that unsuspectingly -- semver and thereby npm considers 1.1.3->1.1.4 a patch change that can be done without expecting any breakage in existing code.

Some ideas on how to retroactively improve this, let me know what you think and I might be able to work on that:

  1. Add a big note in README.md about this change, so people coming here with issues such as 'Uncaught TypeError: AWSCognito.CognitoIdentityServiceProvider.CognitoAuth is not a constructor' will be able to find the cause.
  2. Create a major version, and retract the patch update
  3. ... ?