@nauth-toolkit/social-apple 0.2.0 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,4 +4,56 @@ Apple Sign In provider for [nauth-toolkit](https://nauth.dev).
4
4
 
5
5
  Adds Sign in with Apple with support for web redirect flows and native iOS token verification. Handles authorization code exchange, identity token validation, and user profile retrieval. Automatically links Apple accounts to existing users by email.
6
6
 
7
- **Docs:** [nauth.dev](https://nauth.dev) · **Examples:** [github.com/noorixorg/nauth](https://github.com/noorixorg/nauth) · **Live demo:** [demo.nauth.dev](https://demo.nauth.dev)
7
+ **[Documentation](https://nauth.dev/docs/guides/social/how-social-login-works)** · **[GitHub](https://github.com/noorixorg/nauth)**
8
+
9
+ > Part of [nauth-toolkit](https://www.npmjs.com/package/@nauth-toolkit/core). Requires `@nauth-toolkit/core`.
10
+
11
+ ---
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ npm install @nauth-toolkit/social-apple
17
+ ```
18
+
19
+ Enable in your auth config:
20
+
21
+ ```typescript
22
+ const authConfig = {
23
+ social: {
24
+ apple: {
25
+ enabled: true,
26
+ clientId: process.env.APPLE_CLIENT_ID,
27
+ teamId: process.env.APPLE_TEAM_ID,
28
+ keyId: process.env.APPLE_KEY_ID,
29
+ privateKey: process.env.APPLE_PRIVATE_KEY,
30
+ },
31
+ },
32
+ };
33
+ ```
34
+
35
+ **NestJS** — import the module and it auto-registers:
36
+
37
+ ```typescript
38
+ import { AppleSocialAuthModule } from '@nauth-toolkit/social-apple/nestjs';
39
+
40
+ @Module({
41
+ imports: [NAuthModule.forRoot(authConfig), AppleSocialAuthModule],
42
+ })
43
+ export class AuthModule {}
44
+ ```
45
+
46
+ ---
47
+
48
+ ## Related packages
49
+
50
+ | Package | Purpose |
51
+ | --- | --- |
52
+ | [`@nauth-toolkit/social-google`](https://www.npmjs.com/package/@nauth-toolkit/social-google) | Google OAuth 2.0 |
53
+ | [`@nauth-toolkit/social-facebook`](https://www.npmjs.com/package/@nauth-toolkit/social-facebook) | Facebook Login |
54
+
55
+ See the [full package list](https://www.npmjs.com/package/@nauth-toolkit/core#package-ecosystem) in the core README.
56
+
57
+ ---
58
+
59
+ Free to use. See [license](https://nauth.dev/docs/license).