@flusys/ng-auth 7.0.2 → 7.1.0

package/README.md

@@ -45,11 +45,11 @@ import { AUTH_ROUTES, ADMINISTRATION_ROUTES, PROFILE_ROUTES } from '@flusys/ng-a
 export const routes: Routes = [
   {
     path: 'auth',
-    loadChildren: () => AUTH_ROUTES,        // login, register, forgot-password, reset-password, verify-email
+    loadChildren: () => AUTH_ROUTES,        // login, register, forgot-password, reset-password, verify-email, social/callback
   },
   {
     path: 'administration',
-    loadChildren: () => ADMINISTRATION_ROUTES, // users, company, branch (protected by authGuard)
+    loadChildren: () => ADMINISTRATION_ROUTES, // users, company, branch, social-config (protected by authGuard)
   },
   {
     path: 'profile',
@@ -127,7 +127,40 @@ authInit.initialize().subscribe(isAuthenticated => {
 
 The `initialized` signal is `true` after the first call completes (success or failure).
 
-## 7. Extend Registration / Profile (Optional)
+## 7. Social Sign-In
+
+The login page already renders `<lib-social-login-buttons />`. It asks the
+backend which providers an administrator enabled and renders nothing when the
+answer is none, so no configuration is needed to keep the page as it was. A
+provider list that fails to load never blocks password sign-in.
+
+Two routes make the rest of the flow work, and both come with the routes above:
+
+| Route                             | Purpose                                                             |
+| --------------------------------- | ------------------------------------------------------------------- |
+| `/auth/social/callback`           | Where every provider sends the browser back to; exchanges the code   |
+| `/administration/social-config`   | Provider credentials, behind the `social-config.read` permission     |
+
+The redirect URI is always `{origin}/auth/social/callback` — the social config
+page prints it so it can be pasted into the provider's own console. A sign-in
+that still needs a company hands the selection state to the login page, which
+already renders that step, so social and password sign-in end the same way.
+
+Whether an unknown email gets an account is decided by the backend's
+`bootstrapAppConfig.enableSignUp`, not by `APP_CONFIG.enableSignUp` — the frontend
+flag only hides the sign-up link and blocks `/auth/register`. Keep the two in sync,
+or the login page will offer a provider the backend then refuses.
+
+Drop the buttons into a page of your own with:
+
+```typescript
+import { SocialLoginButtonsComponent } from '@flusys/ng-auth';
+
+@Component({ imports: [SocialLoginButtonsComponent], template: `<lib-social-login-buttons />` })
+export class MySignInPage {}
+```
+
+## 8. Extend Registration / Profile (Optional)
 
 Inject custom fields and sections via extension tokens: