search

smartcar / javascript-sdk

Client-side JS SDK for OAuth dialogs.
MIT License
9 stars 5 forks source link

refactor(constructor): replace development with testMode #36

Closed gurpreetatwal closed 5 years ago

gurpreetatwal commented 5 years ago

BREAKING CHANGE: The constructor no longer takes the development flag, but instead takes the testMode flag. For most purposes the switch from the development flag to the testMode flag will be a drop in replacement.

The development flag (now depcreated) instructs the Smartcar authorization flow (https://smartcar.com/docs#authentication) to display the special 'Mock' brand. The new 'mode' flag on the other hand, puts the entire authorization flow into a test mode meaning every brand now behaves in a manner similar to the special 'Mock' brand.

See https://smartcar.com/docs#testing for more information

@esonmez can you review the description above, that will go into the changelog

emrebsonmez commented 5 years ago

One suggestion for the changelog comment:

The new 'mode' flag on the other
- hand, puts the entire authorization flow into a test mode meaning every
+ hand, runs the entire authorization flow in test mode.
+ This means you can log in with test credentials (any email and any password)
+ for any brand.
- meaning every brand now behaves in a manner similar to the special 'Mock' brand.
emrebsonmez commented 5 years ago

^ Feel free to ignore if not as clear