@nauth-toolkit/social-facebook 0.2.1 → 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,54 @@ Facebook Login provider for [nauth-toolkit](https://nauth.dev).
4
4
 
5
5
  Adds Facebook Login with web redirect flows. Handles OAuth authorization, access token exchange, and user profile retrieval. Automatically links Facebook 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-facebook
17
+ ```
18
+
19
+ Enable in your auth config:
20
+
21
+ ```typescript
22
+ const authConfig = {
23
+ social: {
24
+ facebook: {
25
+ enabled: true,
26
+ appId: process.env.FACEBOOK_APP_ID,
27
+ appSecret: process.env.FACEBOOK_APP_SECRET,
28
+ },
29
+ },
30
+ };
31
+ ```
32
+
33
+ **NestJS** — import the module and it auto-registers:
34
+
35
+ ```typescript
36
+ import { FacebookSocialAuthModule } from '@nauth-toolkit/social-facebook/nestjs';
37
+
38
+ @Module({
39
+ imports: [NAuthModule.forRoot(authConfig), FacebookSocialAuthModule],
40
+ })
41
+ export class AuthModule {}
42
+ ```
43
+
44
+ ---
45
+
46
+ ## Related packages
47
+
48
+ | Package | Purpose |
49
+ | --- | --- |
50
+ | [`@nauth-toolkit/social-google`](https://www.npmjs.com/package/@nauth-toolkit/social-google) | Google OAuth 2.0 |
51
+ | [`@nauth-toolkit/social-apple`](https://www.npmjs.com/package/@nauth-toolkit/social-apple) | Sign in with Apple |
52
+
53
+ See the [full package list](https://www.npmjs.com/package/@nauth-toolkit/core#package-ecosystem) in the core README.
54
+
55
+ ---
56
+
57
+ Free to use. See [license](https://nauth.dev/docs/license).