Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation should be adapted to the new changes #152

Open
aliasbody opened this issue Oct 11, 2018 · 1 comment
Open

Documentation should be adapted to the new changes #152

aliasbody opened this issue Oct 11, 2018 · 1 comment

Comments

@aliasbody
Copy link

aliasbody commented Oct 11, 2018

I think most of the people who use the library will face a lot of problems because of the changes in the V8+ and the fact that the documentation (and examples) are still reporting to the v7.

As an example, this is what I was doing before:

google: {
  clientId: environment.GOOGLE_CLIENTID,
  url: XXXX,
  optionalUrlParams: ['access_type', 'approval_prompt'],
  redirectUri: XXXX
  requiredUrlParams: ['scope'],
  authorizationEndpoint: 'https://accounts.google.com/o/oauth2/auth',
  scopePrefix: 'openid',
  scopeDelimiter: ' ',
  scope: [
    'email',
    'profile',
  ],
  accessType: 'offline',
  oauthType: '2.0',
  approvalPrompt: 'force',
},

But because of the changes now we have to do this:

google: {
  clientId: environment.GOOGLE_CLIENTID,
  url: 'XXXX',
  redirectUri: 'XXX',
  authorizationEndpoint: 'https://accounts.google.com/o/oauth2/auth',
  scopeDelimiter: ' ',
  scope: [
    'https://www.googleapis.com/auth/userinfo.email',
    'https://www.googleapis.com/auth/userinfo.profile'
  ],
  additionalUrlParams: {
    'access_type': 'offline',
    'approval_prompt': 'force',
  },
},

The new additionalUrlParams is really a plus in a way of the parameters are handled, and it's really easier, but I lost a lot of hours trying to understand how to make this work along with the rest since the project wouldn't compile with the accessType (since it's not in IPartialConfigOptions).

@ronzeidman
Copy link
Owner

You're right, things got in the way and this library didn't get the love it deserves. I'll try to clear out some time and document everything better + getting the example up-to-date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants