Revive node-apple-sign

[renarsvilnis]

Revive node-apple-sign

:warning: Caution: Pull request still in progress! Feedback is welcomed!

Revive development of node-apple-signin!

After trying to contact the original node-apple-signin owner alaborderie about helping out maintaining the library, but didn't get back a response. As I saw that compared to other "apple sign in" libraries this one seemed to have the biggest community wanting to improve it. Multiple opened issues and pull-requests that are sitting opened for months.

As on npm there still isn't a go-to package for apple sign in, so taking matters in my own hands and forking library and implementing most changes from their PR and fixing issues. Trying to make it the go-to choice when you want to implement Apple Sign In.

^ Related

Changes

API

• Changed createClientSecret()

  • Now only takes in privateKey contents instead of a file path. Now you can use it to inject private key trough environmentals. Closes https://github.com/Techofficer/node-apple-signin/issues/4. https://github.com/Techofficer/node-apple-signin/pull/5

  • Support for privateKeyPath is kept in the library, but it is moved to a new function createClientSecretFromPath() (see below). It was done so we keep the function functional without overloading its behaviour depending on props.

• Added createClientSecretFromPath()

  • Similar to createClientSecret() but instead of a public key it takes in a path to it. Internally it synchronously (as before) reads the private key contents and calls createClientSecret().

  ❓ Like to see feedback on this, as I'm not yet 100% I want to separate the functions.

  • Added new optional expirationDuration option, which allows setting the clients secret expiration time, instead of using the max allowed 6 months. If not set, defaults back to 6 months.

• Removed getApplePublicKey() in-favour of getApplePublicKeys()

• Added getApplePublicKeys()

  • Now properly returns all public keys instead of just the first one. Closes https://github.com/Techofficer/node-apple-signin/pull/8 and https://github.com/Techofficer/node-apple-signin/pull/9

• Changed getAuthorizationToken():

  • made options.redirectUri optional. Closes https://github.com/Techofficer/node-apple-signin/pull/12, https://github.com/Techofficer/node-apple-signin/pull/7

• :bug: Fix getAuthorizationUrl():

  • 🐛 Bugfix didn't fallback scope to email if didn't limited
  • Removed openId scope, as I found no official documentation or their browser js library using that scope

• Misc:

  • Throughout all options renamed clientID to clientId to keep in consistent with teamId, clientSecret

Internal

• Dropped deprecated request-promise-native for axios

Improved Developer experience

• Source code now fully typed using typescript with support for Node.js >= 10 (a.k.a ES2018)

• Comes bundled with typescript types

• 📕Auto-generated docs using typedoc! Still needs work on documenting functions/interfaces to become more user friendly, so PR's welcomed!

  

• Improved formating by migrating from eslint-config-airbnb-base to standard + prettier

• 🔧Layed down the groundwork for unit tests using ts-jest

TO-DO

• [x] Rename library - to avoid conflicting search and having to publish under user scope @renarsvilnis/node-apple-signin.
• [x] Possibly implement - https://github.com/Techofficer/node-apple-signin/pull/2
• [x] Make redirectUri optional - https://github.com/Techofficer/node-apple-signin/pull/12, https://github.com/Techofficer/node-apple-signin/issues/6, https://github.com/Techofficer/node-apple-signin/pull/7
• [x] Implement https://github.com/Techofficer/node-apple-signin/pull/3 PR into code
• [x] Finish implementing changes from https://github.com/Techofficer/node-apple-signin/pull/8 and https://github.com/Techofficer/node-apple-signin/pull/9
• [x] Finish documenting API changes
• [x] Setup GH pages
• [x] Finish setup eslint
• Setup githooks, npm script hooks:
  • [x] Setup pre-commit linting
  • [x] Setup pre-commit documentation generation
  • [x] Figure out how to setup doc automatic build so on merges it's done automatically without merge issues.
  • [x] Setup npm hook for building lib before publishing
• [x] Validate LICENSE
• [x] Update README.md to reflect changes